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:

Link to an issue: #124 (displays ~~#124~~, link is striked-through if the issue is closed)
Link to a changeset: r758 (displays r758)
Link to a changeset with a non-numeric hash: commit:c6f4d0fd (displays c6f4d0fd).
Link to a changeset of another project: sandbox:r758 (displays sandbox:r758)
Link to a changeset with a non-numeric hash: sandbox:c6f4d0fd (displays sandbox:c6f4d0fd).

Chris@0: Chris@0:

Wiki links:

Chris@0: Chris@0:

[[Guide]] displays a link to the page named 'Guide': Guide
[[Guide#further-reading]] takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: Guide
[[Guide|User manual]] displays a link to the same page but with a different text: User manual

Chris@0: Chris@0:

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

Chris@0: Chris@0:

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

Chris@0: Chris@0:

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

Chris@0: luis@725:

Links to other resources:

Chris@0: Chris@0:

Documents: Chris@0:
- 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)
- sandbox:document:"Some document" (link to a document with title "Some document" in other project "sandbox")

Chris@0: Chris@0:

Versions: Chris@0:
- version#3 (link to version with id 3)
- version:1.0.0 (link to version named "1.0.0")
- version:"1.0 beta 2"
- sandbox:version:1.0.0 (link to version "1.0.0" in the project "sandbox")

Chris@0: Chris@0:

Attachments: Chris@0:
- 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)

Chris@0: Chris@0:

Repository files: Chris@0:
- source:some/file (link to the file located at /some/file in the project's repository)
- source:some/file@52 (link to the file's revision 52)
- source:some/file#L120 (link to line 120 of the file)
- source:some/file@52#L120 (link to line 120 of the file's revision 52)
- source:"some file@52#L120" (use double quotes when the URL contains spaces
- export:some/file (force the download of the file)
- sandbox:source:some/file (link to the file located at /some/file in the repository of the project "sandbox")
- sandbox:export:some/file (force the download of the file)

Chris@0: Chris@0:

Forum messages: luis@725:
- message#1218 (link to message with id 1218)

luis@725: luis@725:

Projects: luis@725:
- project#3 (link to project with id 3)
- project:someproject (link to project named "someproject")

luis@725: luis@725: luis@725:

Escaping:

luis@725: luis@725:

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

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:

bold
italic
*bold italic*
underline
~~strike-through~~

Chris@0: Chris@0:

Inline images

Chris@0: Chris@0:

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

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: luis@725: luis@725: luis@725:

Bullets and Numbering

luis@725: luis@725:

luis@725: * First Level Bullet
luis@725: ** Second Level Bullet
luis@725: ** Another Second Level Bullet
luis@725: *** Third Level Bullet
luis@725: ** Back to 2nd Level Bullet
luis@725: * Back to 1st Level Bullet
luis@725:

luis@725: luis@725:

First Level Bullet

Second Level Bullet
Another Second Level Bullet

Third Level Bullet

Back to 2nd Level Bullet

Back to 1st Level Bullet

luis@725: luis@725:

luis@725: # First Level Numbering
luis@725: ## Second Level Numbering
luis@725: ## Another Second Level Numbering
luis@725: ### Third Level Numbering
luis@725: ## Back to 2nd Level Numbering
luis@725: # Back to 1st Level Numbering
luis@725:

luis@725: luis@725:

First Level Numbering

Second Level Numbering
Another Second Level Numbering

Third Level Numbering

Back to 2nd Level Numbering

Back to 1st Level Numbering

luis@725: luis@725:

luis@725: # First Level Numbering
luis@725: #* Bullet inside numbering environment
luis@725: #* Another Bullet inside numbering environment
luis@725: # Back to 1st Level Numbering
luis@725:

luis@725: luis@725:

First Level Numbering

Bullet inside numbering environment
Another Bullet inside numbering environment

Back to 1st Level Numbering

luis@725: luis@725: luis@725: luis@725: luis@725: luis@725: luis@725: 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: luis@725:

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: