diff --git a/public/help/wiki_syntax.html b/public/help/wiki_syntax.html index a3cc40326b410948f745f91d94af0c72c3c976ee..caafacec468a43c4e41e7085ee7d5126cb523ede 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! -

More Information

+

More Information

diff --git a/public/help/wiki_syntax_detailed.html b/public/help/wiki_syntax_detailed.html new file mode 100644 index 0000000000000000000000000000000000000000..deb15aca904855c3d513b7ebbd372fe4fd1da7f0 --- /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.

+ + + + + +

Wiki links:

+ + + + + +

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

+ + + + + +

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):

+ + + + + + + + + + + +

Escaping (0.6.devel.1064 and above):

+ + + + + +

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:

+ + + + + +

Inline images

+ + + + + +

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> + +