From 076d9e7ade1b04c0bacd390fa6f1d7e4c492ef6b Mon Sep 17 00:00:00 2001 From: John Goerzen Date: Thu, 13 Mar 2008 14:14:32 +0000 Subject: [PATCH] This patch takes the RedmineWikiFormatting page and makes it available as a static HTML file locally. This way, intranet deployments, or other deployments do not need to be dependent upon redmine.org in order to display this help. Closes #815. git-svn-id: http://redmine.rubyforge.org/svn/trunk@1244 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- public/help/wiki_syntax.html | 2 +- public/help/wiki_syntax_detailed.html | 240 ++++++++++++++++++++++++++ 2 files changed, 241 insertions(+), 1 deletion(-) create mode 100644 public/help/wiki_syntax_detailed.html diff --git a/public/help/wiki_syntax.html b/public/help/wiki_syntax.html index a3cc40326..caafacec4 100644 --- a/public/help/wiki_syntax.html +++ b/public/help/wiki_syntax.html @@ -59,7 +59,7 @@ table td h3 { font-size: 1.2em; text-align: left; } !attached_image! -

diff --git a/public/help/wiki_syntax_detailed.html b/public/help/wiki_syntax_detailed.html new file mode 100644 index 000000000..deb15aca9 --- /dev/null +++ b/public/help/wiki_syntax_detailed.html @@ -0,0 +1,240 @@ + + + +RedmineWikiFormatting + + + + +

Wiki formatting

+ + + +

Links

+ + +

Redmine links

+ + +

Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.

+ + +

Link to an issue: #124 (displays ~~#124~~, link is striked-through if the issue is closed)
Link to a changeset: r758 (displays r758)

+ + +

Wiki links:

+ + +

[[Guide]] displays a link to the page named 'Guide': Guide
[[Guide|User manual]] displays a link to the same page but with a different text: User manual

+ + +

You can also link to pages of an other project wiki:

+ + +

[[sandbox:some page]] displays a link to the page named 'Some page' of the Sandbox wiki
[[sandbox:]] displays a link to the Sandbox wiki main page

+ + +

Wiki links are displayed in red if the page doesn't exist yet, eg: Nonexistent page.

+ + +

Links to others resources (0.6.devel.1064 and above):

+ + +

Documents: + +
- document#17 (link to document with id 17)
- document:Greetings (link to the document with title "Greetings")
- document:"Some document" (double quotes can be used when document title contains spaces)

+ + +

Versions: + +
- version#3 (link to version with id 3)
- version:1.0.0 (link to version named "1.0.0")
- version:"1.0 beta 2"

+ + +

Attachments: + +
- attachment:file.zip (link to the attachment of the current object named file.zip)
- For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)

+ + +

Escaping (0.6.devel.1064 and above):

+ + +

You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !

+ + +

External links

+ + +

HTTP URLs and email addresses are automatically turned into clickable links:

+ + +

+http://www.redmine.org, someone@foo.bar
+

+ +

displays: http://www.redmine.org, someone@foo.bar

+ + +

If you want to display a specific text instead of the URL, you can use the standard textile syntax:

+ + +

+"Redmine web site":http://www.redmine.org
+

+ +

displays: Redmine web site

+ + +

Text formatting

+ + +

For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See http://hobix.com/textile/ for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.

+ + +

Font style

+ + +

* *bold*
+* _italic_
+* _*bold italic*_
+* +underline+
+* -strike-through-
+</code>


+
+	Display:
+
+
+	
+	bold
+		italic
+		*bold italic*
+		underline
+		strike-through
+	
+
+
+	Inline images
+
+
+	
+	!image_url! displays an image located at image_url (textile syntax)
+		!>image_url! right floating image
+		If you have an image attached to your wiki page, it can be displayed inline using its filename: !attached_image.png!
+	
+
+
+	Headings
+
+
+h1. Heading
+h2. Subheading
+h3. Subheading
+</code>

+
+	Paragraphs
+
+
+p>. right aligned
+p=. centered
+</code>

+
+	This is centered paragraph.
+
+
+	Blockquotes
+
+
+	Start the paragraph with bq.
+
+
+bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
+To go live, all you need to add is a database and a web server.
+</code>

+
+	Display:
+
+
+	
+		Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.
+	
+
+
+	Table of content
+
+
+{{toc}} => left aligned toc
+{{>toc}} => right aligned toc
+</code>

+
+	Macros
+
+
+	Redmine has the following builtin macros:
+
+
+	
hello_world
Sample macro.
include
Include a wiki page. Example:
+
+
+	{{include(Foo)}}
macro_list
Displays a list of all available macros, including description if available.

+
+
+	Code highlighting
+
+
+	Code highlightment relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports c, html, javascript, rhtml, ruby, scheme, xml languages.
+
+
+	You can highlight code in your wiki page using this syntax:
+
+
+<pre><code class="ruby">
+  Place you code here.
+</code></pre>
+
</code>
+
+	Example:
+
+
+ 1 # The Greeter class
+ 2 class Greeter
+ 3   def initialize(name)
+ 4     @name = name.capitalize
+ 5   end
+ 6 
+ 7   def salute
+ 8     puts "Hello #{@name}!" 
+ 9   end
+10 end
+
</code>
+
+
-- 
2.39.5