<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"><htmlxmlns="http://www.w3.org/1999/xhtml"xml:lang="en"><head><title>RedmineWikiFormatting</title><metahttp-equiv="content-type"content="text/html; charset=utf-8"/><linkrel="stylesheet"type="text/css"href="../wiki_syntax_detailed.css"/></head><body><h1><aname="1"class="wiki-page"></a>Wiki formatting</h1><ulclass='toc'><li><ahref='#2'>Links</a></li><ul><li><ahref='#3'>Redmine links</a></li><li><ahref='#4'>External links</a></li></ul><li><ahref='#5'>Text formatting</a></li><ul><li><ahref='#6'>Font style</a></li><li><ahref='#7'>Inline images</a></li><li><ahref='#8'>Headings</a></li><li><ahref='#9'>Paragraphs</a></li><li><ahref='#10'>Blockquotes</a></li><li><ahref='#11'>Table of content</a></li><li><ahref='#14'>Horizontal Rule</a></li></ul><li><ahref='#12'>Macros</a></li><li><ahref='#13'>Code highlighting</a></li></ul><h2><aname="2"class="wiki-page"></a>Links</h2><h3><aname="3"class="wiki-page"></a>Redmine links</h3><p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p><ul><li>Link to an issue: <strong>#124</strong> (displays <del><ahref="#"class="issue"title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li><li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <ahref="#"class="issue"title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li><li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li><li>Link to an issue note within the same issue: <strong>#note-6</strong></li></ul><p>Wiki links:</p><ul><li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <ahref="#"class="wiki-page">Guide</a></li><li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <ahref="#"class="wiki-page">Guide</a></li><li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <ahref="#"class="wiki-page">#further-reading</a></li><li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <ahref="#"class="wiki-page">User manual</a></li></ul><p>You can also link to pages of an other project wiki:</p><ul><li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li><li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li></ul><p>Wiki links are displayed in red if the page doesn't exist yet, eg: <ahref="#"class="wiki-page new">Nonexistent page</a>.</p><p>Links to other resources:</p><ul><li>Documents:
<ul><li><strong>document#17</strong> (link to document with id 17)</li><li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li><li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li><li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li></ul></li></ul><ul><li>Versions:
<ul><li><strong>version#3</strong> (link to version with id 3)</li><li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li><li><strong>version:"1.0 beta 2"</strong></li><li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li></ul></li></ul><ul><li>Attachments:
<ul><li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li><li>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)</li></ul></li></ul><ul><li>Changesets:
<ul><li><strong>r758</strong> (link to a changeset)</li><li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li><li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li><li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li><li><strong>sandbox:r758</strong> (link to a changeset of another project)</li><li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li></ul></li></ul><ul><li>Repository files:
<ul><li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li><li><strong>source:some/file@52</strong> (link to the file's revision 52)</li><li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li><li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li><li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li><li><strong>export:some/file</strong> (force the download of the file)</li><li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li><li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li><li><strong>sandbox:export:some/file</strong> (force the download of the file)</li></ul></li></ul><ul><li>Forums:
<ul><li><strong>forum#1</strong> (link to forum with id 1</li><li><strong>forum:Support</strong> (link to forum named Support)</li><li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li></ul></li></ul><ul><li>Forum messages:
<ul><li><strong>message#1218</strong> (link to message with id 1218)</li></ul></li></ul><ul><li>Projects:
<ul><li><strong>project#3</strong> (link to project with id 3)</li><li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li><li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li></ul></li></ul><ul><li>News:
<ul><li><strong>news#2</strong> (link to news item with id 2)</li><li><strong>news:Greetings</strong> (link to news item named "Greetings")</li><li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li></ul></li></ul><ul><li>Users:
<ul><li><strong>user#2</strong> (link to user with id 2)</li><li><strong>user:jsmith</strong> (Link to user with login jsmith)</li><li><strong>@jsmith</strong> (Link to user with login jsmith)</li></ul></li></ul><p>Escaping:</p><ul><li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li></ul><h3><aname="4"class="wiki-page"></a>External links</h3><p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p><pre>
http://www.redmine.org, someone@foo.bar
</pre><p>displays: <aclass="external"href="http://www.redmine.org">http://www.redmine.org</a>, <ahref="mailto:someone@foo.bar"class="email">someone@foo.bar</a></p><p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p><pre>
"Redmine web site":http://www.redmine.org
</pre><p>displays: <ahref="http://www.redmine.org"class="external">Redmine web site</a></p><h2><aname="5"class="wiki-page"></a>Text formatting</h2><p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <aclass="external"href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p><h3><aname="6"class="wiki-page"></a>Font style</h3><pre>
* *bold*
* _italic_
* _*bold italic*_
* +underline+
* -strike-through-
</pre><p>Display:</p><ul><li><strong>bold</strong></li><li><em>italic</em></li><li><em><strong>bold italic</strong></em></li><li><ins>underline</ins></li><li><del>strike-through</del></li></ul><h3><aname="7"class="wiki-page"></a>Inline images</h3><ul><li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li><li><strong>!>image_url!</strong> right floating image</li><li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li><li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v.</li><li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li></ul><h3><aname="8"class="wiki-page"></a>Headings</h3><pre>
h1. Heading
h2. Subheading
h3. Subsubheading
</pre><p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p><h3><aname="9"class="wiki-page"></a>Paragraphs</h3><pre>
p>. right aligned
p=. centered
</pre><pstyle="text-align:center;">This is a centered paragraph.</p><h3><aname="10"class="wiki-page"></a>Blockquotes</h3><p>Start the paragraph with <strong>bq.</strong></p><pre>
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.
</pre><p>Display:</p><blockquote><p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br/>To go live, all you need to add is a database and a web server.</p></blockquote><h3><aname="11"class="wiki-page"></a>Table of content</h3><pre>{{toc}} => left aligned toc
{{>toc}} => right aligned toc
</pre><h3><aname="14"class="wiki-page"></a>Horizontal Rule</h3><pre>
---
</pre><h2><aname="12"class="wiki-page"></a>Macros</h2><p>Redmine has the following builtin macros:</p><p><dl><dt><code>hello_world</code></dt><dd><p>Sample macro.</p></dd><dt><code>macro_list</code></dt><dd><p>Displays a list of all available macros, including description if available.</p></dd><dt><code>child_pages</code></dt><dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p><pre><code>{{child_pages}} -- can be used from a wiki page only
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd><dt><code>include</code></dt><dd><p>Include a wiki page. Example:</p><pre><code>{{include(Foo)}}</code></pre><p>or to include a page of a specific project wiki:</p><pre><code>{{include(projectname:Foo)}}</code></pre></dd><dt><code>collapse</code></dt><dd><p>Inserts of collapsed block of text. Example:</p><pre><code>{{collapse(Viewdetails...)Thisisablockoftextthatiscollapsedbydefault.Itcanbeexpandedbyclickingalink.}}</code></pre></dd><dt><code>thumbnail</code></dt><dd><p>Displays a clickable thumbnail of an attached image. Examples:</p><pre>{{thumbnail(image.png)}}{{thumbnail(image.png,size=300,title=Thumbnail)}}</pre></dd><dt><code>issue</code></dt><dd><p>Inserts a link to an issue with flexible text. Examples:</p><pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
{{issue(123,project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
{{issue(123,tracker=false)}} -- #123: Enhance macro capabilities
{{issue(123,subject=false,project=true)}} -- Andromeda - Issue #123</pre></dd></dl></p><h2><aname="13"class="wiki-page"></a>Code highlighting</h2><p>Default code highlightment relies on <ahref="http://rouge.jneen.net/"class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <ahref="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages"class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p><p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p><pre><pre><code class="ruby">
Place your code here.
</code></pre></pre><p>Example:</p><pre><codeclass="ruby syntaxhl"><spanclass="c1"># The Greeter class</span><spanclass="k">class</span><spanclass="nc">Greeter</span><spanclass="k">def</span><spanclass="nf">initialize</span><spanclass="p">(</span><spanclass="nb">name</span><spanclass="p">)</span><spanclass="vi">@name</span><spanclass="o">=</span><spanclass="nb">name</span><spanclass="p">.</span><spanclass="nf">capitalize</span><spanclass="k">end</span><spanclass="k">def</span><spanclass="nf">salute</span><spanclass="nb">puts</span><spanclass="s2">"Hello </span><spanclass="si">#{</span><spanclass="vi">@name</span><spanclass="si">}</span><spanclass="s2">!"</span><spanclass="k">end</span><spanclass="k">end</span></code></pre></body></html>