Chris@0: Chris@0: Chris@0: Chris@0: RedmineWikiFormatting Chris@0: Chris@0: Chris@0: Chris@0: Chris@0: Chris@0:

Wiki formatting

Chris@0: Chris@0:

Links

Chris@0: Chris@0:

Redmine links

Chris@0: Chris@0:

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

Chris@0: Chris@0: Chris@0:

Wiki links:

Chris@0: Chris@0: Chris@0: Chris@0:

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

Chris@0: Chris@0: Chris@0: Chris@0:

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

Chris@0: chris@37:

Links to other resources:

Chris@0: Chris@0: Chris@0: Chris@0: Chris@0: Chris@0: Chris@0: Chris@0: Chris@0: Chris@0: chris@37: chris@37: chris@37: chris@37: chris@37:

Escaping:

chris@37: chris@37: Chris@0: Chris@0: Chris@0:

External links

Chris@0: Chris@0:

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

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

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

Chris@0: Chris@0:

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

Chris@0: Chris@0: 
Chris@0: "Redmine web site":http://www.redmine.org
Chris@0:
Chris@0: Chris@0:

displays: Redmine web site

Chris@0: Chris@0: Chris@0:

Text formatting

Chris@0: Chris@0: Chris@0:

For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See http://www.textism.com/tools/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.

Chris@0: Chris@0:

Font style

Chris@0: Chris@0: 
Chris@0: * *bold*
Chris@0: * _italic_
Chris@0: * _*bold italic*_
Chris@0: * +underline+
Chris@0: * -strike-through-
Chris@0:
Chris@0: Chris@0:

Display:

Chris@0: Chris@0: Chris@0: Chris@0:

Inline images

Chris@0: Chris@0: Chris@0: Chris@0:

Headings

Chris@0: Chris@0: 
Chris@0: h1. Heading
Chris@0: h2. Subheading
Chris@0: h3. Subsubheading
Chris@0:
Chris@0: Chris@0:

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

Chris@0: Chris@0: Chris@0:

Paragraphs

Chris@0: Chris@0: 
Chris@0: p>. right aligned
Chris@0: p=. centered
Chris@0:
Chris@0: Chris@441:

This is a centered paragraph.

Chris@0: Chris@0: Chris@0:

Blockquotes

Chris@0: Chris@0:

Start the paragraph with bq.

Chris@0: Chris@0: 
Chris@0: bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
Chris@0: To go live, all you need to add is a database and a web server.
Chris@0:
Chris@0: Chris@0:

Display:

Chris@0: Chris@0:
Chris@0:

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.

Chris@0:
Chris@0: Chris@0: Chris@0:

Table of content

Chris@0: Chris@0: 
Chris@0: {{toc}} => left aligned toc
Chris@0: {{>toc}} => right aligned toc
Chris@0:
Chris@0: Chris@0:

Macros

Chris@0: Chris@0:

Redmine has the following builtin macros:

Chris@0: Chris@0:

hello_world

Sample macro.

include

Include a wiki page. Example:

Chris@0: Chris@0: 
{{include(Foo)}}
macro_list

Displays a list of all available macros, including description if available.

Chris@0: Chris@0: Chris@0:

Code highlighting

Chris@0: chris@37:

Code highlightment relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.

Chris@0: Chris@0:

You can highlight code in your wiki page using this syntax:

Chris@0: Chris@0: 
Chris@0: <pre><code class="ruby">
Chris@0:   Place you code here.
Chris@0: </code></pre>
Chris@0:
Chris@0: Chris@0:

Example:

Chris@0: Chris@0: 
 1 # The Greeter class
Chris@0:  2 class Greeter
Chris@0:  3   def initialize(name)
Chris@0:  4     @name = name.capitalize
Chris@0:  5   end
Chris@0:  6 
Chris@0:  7   def salute
Chris@0:  8     puts "Hello #{@name}!" 
Chris@0:  9   end
Chris@0: 10 end
Chris@0: 
Chris@0:
Chris@0: Chris@0: