Redmine

<h1><a name="1" class="wiki-page"></a>Wiki formatting (Markdown)</h1>

        <h3><a name="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>

            <li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" 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 note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>

        <p>Wiki links:</p>

            <li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" 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: <a href="#" class="wiki-page">Guide</a></li>

            <li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>

        <p>You can also link to pages of an other project wiki:</p>

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

        <p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>

        <p>Links to other resources:</p>

            <li>Documents:

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

            <li>Versions:

                    <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>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>

            <li>Attachments:

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

            <li>Changesets:

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

             <li>Repository files:

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

            <li>Forums:

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

            <li>Forum messages:

                    <li><strong>message#1218</strong> (link to message with id 1218)</li>

            <li>Projects:

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

            <li>News:

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

        <p>Escaping:</p>

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

        <h3><a name="4" class="wiki-page"></a>External links</h3>

        <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>

        <p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="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 markdown syntax:</p>

        <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>

    <h2><a name="5" class="wiki-page"></a>Text formatting</h2>

    <p>For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax.  See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</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><a name="6" class="wiki-page"></a>Font style</h3>

* **bold**

* *Italic*

* ***bold italic***

* ~~strike-through~~

        <p>Display:</p>

            <li><strong>bold</strong></li>

            <li><em>italic</em></li>

            <li><em><strong>bold italic</strong></em></li>

            <li><del>strike-through</del></li>

        <h3><a name="7" class="wiki-page"></a>Inline images</h3>

            <li><strong>![](image_url)</strong> displays an image located at image_url (markdown syntax)</li>

            <li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>![](attached_image)</strong></li>

        <h3><a name="8" class="wiki-page"></a>Headings</h3>

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

        <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>

        <p>Start the paragraph with <strong>&gt;</strong></p>

        <p>Display:</p>

        <h3><a name="11" class="wiki-page"></a>Table of content</h3>

{{toc}} => left aligned toc

{{>toc}} => right aligned toc

        <h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>

    <h2><a name="12" class="wiki-page"></a>Macros</h2>

    <p>Redmine has the following builtin macros:</p>

      <dd><p>Sample macro.</p></dd>

      <dd><p>Displays a list of all available macros, including description if available.</p></dd>

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

      <dd><p>Include a wiki page. Example:</p>

      <p>or to include a page of a specific project wiki:</p>

      <dd><p>Inserts of collapsed block of text. Example:</p>

      <pre><code>{{collapse(View details...)

This is a block of text that is collapsed by default.

It can be expanded by clicking a link.

      <dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>

    <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>

    <p>Default code highlightment relies on <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, a fast syntax highlighting library written completely in Ruby. It currently supports c, clojure, cpp (c++, cplusplus), css, delphi (pascal), diff (patch), erb (eruby, rhtml), go, groovy, haml, html (xhtml), java, javascript (ecmascript, ecma_script, java_script, js), json, lua, php, python, ruby (irb), sass, sql, taskpaper, text (plain, plaintext), xml and yaml (yml) languages, where the names inside parentheses are aliases.</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>

    <p>Example:</p>

<h1>Wiki Syntax Quick Reference (Markdown)</h1>

<tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>

<tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>

<tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>

<tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>

<tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>~~~<br />&nbsp;lines<br />&nbsp;of code<br />~~~</td><td>

 lines

 of code

<tr><th colspan="3">Lists</th></tr>

<tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />&nbsp;&nbsp;* Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>

<tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br />&nbsp;&nbsp;&nbsp;1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>

<tr><th colspan="3">Headings</th></tr>

<tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>

<tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>

<tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>

<tr><th colspan="3">Links</th></tr>

<tr><th colspan="3">Redmine links</th></tr>

<tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>

<tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>

<tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>

<tr><th colspan="3">Inline images</th></tr>

<tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>![](<em>image_url</em>)</td><td></td></tr>

<tr><th></th><td>![](<em>attached_image</em>)</td><td></td></tr>

<p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>