From 1169ff05aff25f6f580869bc4e8227a4c9e87f10 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Lang Date: Tue, 11 Nov 2008 13:37:10 +0000 Subject: [PATCH] Documents Wiki page anchors (#1647). git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@2015 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- public/help/wiki_syntax_detailed.html | 599 +++++++++++--------------- 1 file changed, 247 insertions(+), 352 deletions(-) diff --git a/public/help/wiki_syntax_detailed.html b/public/help/wiki_syntax_detailed.html index ce416b573..581da8582 100644 --- a/public/help/wiki_syntax_detailed.html +++ b/public/help/wiki_syntax_detailed.html @@ -1,352 +1,247 @@ - - - -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.7):

- - - - - - - - - - - - - - - -

Escaping (0.7):

- - - - - -

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,

- - -

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

Display:

- - - - - -

Inline images

- - - - - -

Headings

- - -
-h1. Heading
-h2. Subheading
-h3. Subheading
-
- -

Paragraphs

- - -
-p>. right aligned
-p=. centered
-
- -

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

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

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

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

+ + + + + + + + + +

Escaping (0.7):

+ + + + +

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,

+ +

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

Display:

+ + + +

Inline images

+ + + +

Headings

+ +
+h1. Heading
+h2. Subheading
+h3. Subsubheading
+
+ +

Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.

+ + +

Paragraphs

+ +
+p>. right aligned
+p=. centered
+
+ +

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

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

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

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