Wiki formatting

Disabling wiki formatting

You can disable textile text formating using the <notextile> tag. For example, writing <notextile>+this+</notextile> will generate +this+ instead of this.

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:

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

Attachments and Images

On the current version of Redmine, it is not possible to attach files while on "edit mode". You have to be on "browse mode" (for example, by clicking on "Save").

When you are on browse mode, a link called "New File" will allow you to add attachments to the post.

If you want to put direct links to the attachments on your wiki pages, you can do so by writing:

attachment:file.zip

Where file.zip is the filename of the attached file.

Image uploading steps

  1. First edit some text on your wiki page, and press "Save". You will get presented with the page on "browse mode"
  2. Scroll down until you see the "New File" link. Use that link to attach files to an specific Wiki page (you can add more than one file using the "Add another file" link)
  3. Once you are done adding files, enter the "edit mode again" by pressing the "edit" link
  4. You can place images by putting the file name of the attached images between exclamation marks in your code:
  !diagram.jpg!

Text formatting

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.

Font style

* *bold*
* _italic_
* _*bold italic*_
* +underline+
* -strike-through-

Displays:

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.

Remember to leave a blank line before and after a heading - otherwise it might not get properly parsed.

Colored text

We have added 6 small classes to the stylesheet that allow coloring text in a safe way, without using explicit styles. You can write this now:

 %(red)red text%, %(green)green text%, %(blue)blue text%, %(yellow)yellow text%, %(orange)orange text%, %(fuchsia)fuchsia text% 

Displays:

red text, green text, blue text, yellow text, orange text, fuchsia text

Paragraphs

Paragraphs must be separated by at least one blank line. One single carriage return will generate a line-break.

Paragraphs are left-aligned by default. You must use explicit notation if you want them to be right or center-aligned.


Regular left-aligned paragraph.
The first paragraph continues here, after a line break.

p. Another left-aligned paragraph, using explicit notation.

p>. This is a right-aligned paragraph.

p=. This is a centered paragraph.

Displays:

Regular left-aligned paragraph.
The first paragraph continues here, after a line break.

Another left-aligned paragraph, using explicit notation.

This is a right-aligned paragraph.

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.

Lists

Use an asterisk (*) for unordered lists. Add one asterisk per level:

* Level 1
** Level 2
*** Level 3
* Back to level 1

Output:

Ordered lists work similarly, but using the number sign (#) instead of an asterisk:

# Level 1
## Level 2
### Level 3
# Back to level 1

Output:

  1. Level 1
    1. Level 2
      1. Level 3
  2. Back to level 1

Table of content

{{toc}} => left aligned toc
{{>toc}} => right aligned toc

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

Horizontal Rulers (separators)

Horizontal rules are generated by putting three hypens on an empty line:

This is a separator.

---

Between two paragraphs.

output:

This is a separator.


Between two paragraphs.

Notice that the horizontal ruler will not be generated if the line with the hypens has any other characters, or if it's not preceded and succeded with blank lines.

Tables

Tables have the following format:

|_. Table header |_. Another header |
| Table cell | More cells       |

Displays:

Table headerAnother header
Table cellMore cells

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.