public/help/wiki_syntax_detailed.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   3 <head>
   4 <title>RedmineWikiFormatting</title>
   5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   6 <style type="text/css">
   7     body { font:80% Verdana,Tahoma,Arial,sans-serif; }
   8     h1, h2, h3, h4 {  font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
   9     pre, code { font-size:120%; }
  10     pre code { font-size:100%; }
  11     pre {
  12         margin: 1em 1em 1em 1.6em;
  13         padding: 2px;
  14         background-color: #fafafa;
  15         border: 1px solid #dadada;
  16         width:95%;
  17         overflow-x: auto;
  18     }
  19     a.new { color: #b73535; }
  20
  21     .CodeRay .c  { color:#666; }
  22
  23     .CodeRay .cl { color:#B06; font-weight:bold }
  24     .CodeRay .dl { color:black }
  25     .CodeRay .fu { color:#06B; font-weight:bold }
  26
  27     .CodeRay .il { background: #eee }
  28     .CodeRay .il .idl { font-weight: bold; color: #888 }
  29
  30     .CodeRay .iv { color:#33B }
  31     .CodeRay .r  { color:#080; font-weight:bold }
  32
  33     .CodeRay .s  { background-color:#fff0f0 }
  34     .CodeRay .s  .dl { color:#710 }
  35 </style>
  36 </head>
  37
  38 <body>
  39 <h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
  40
  41     <h2><a name="2" class="wiki-page"></a>Links</h2>
  42
  43         <h3><a name="3" class="wiki-page"></a>Redmine links</h3>
  44
  45         <p>Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.</p>
  46         <ul>
  47             <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>
  48             <li>Link to a changeset: <strong>r758</strong> (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>
  49             <li>Link to a changeset with a non-numeric hash: <strong>commit:c6f4d0fd</strong> (displays c6f4d0fd).  Added in <a href="#" class="changeset" title="Merged Git support branch (r1200 to r1226).">r1236</a>.</li>
  50         </ul>
  51
  52         <p>Wiki links:</p>
  53
  54         <ul>
  55             <li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
  56             <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>
  57             <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>
  58         </ul>
  59
  60         <p>You can also link to pages of an other project wiki:</p>
  61
  62         <ul>
  63             <li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
  64             <li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
  65         </ul>
  66
  67         <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>
  68
  69         <p>Links to other resources:</p>
  70
  71         <ul>
  72             <li>Documents:
  73                 <ul>
  74                     <li><strong>document#17</strong> (link to document with id 17)</li>
  75                     <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
  76                     <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
  77                     <li><strong>document:some_project:"Some document"</strong> (link to a document with title "Some document" in other project "some_project")
  78                 </ul></li>
  79         </ul>
  80
  81         <ul>
  82             <li>Versions:
  83                 <ul>
  84                     <li><strong>version#3</strong> (link to version with id 3)</li>
  85                     <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
  86                     <li><strong>version:"1.0 beta 2"</strong></li>
  87                 </ul></li>
  88         </ul>
  89
  90         <ul>
  91             <li>Attachments:
  92                 <ul>
  93                     <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
  94                     <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>
  95                 </ul></li>
  96         </ul>
  97
  98         <ul>
  99              <li>Repository files:
 100                 <ul>
 101                     <li><strong>source:some/file</strong>           (link to the file located at /some/file in the project's repository)</li>
 102                     <li><strong>source:some/file@52</strong>        (link to the file's revision 52)</li>
 103                     <li><strong>source:some/file#L120</strong>      (link to line 120 of the file)</li>
 104                     <li><strong>source:some/file@52#L120</strong>   (link to line 120 of the file's revision 52)</li>
 105                     <li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
 106                     <li><strong>export:some/file</strong>           (force the download of the file)</li>
 107                 </ul></li>
 108         </ul>
 109
 110         <ul>
 111             <li>Forum messages:
 112                 <ul>
 113                     <li><strong>message#1218</strong> (link to message with id 1218)</li>
 114                 </ul></li>
 115         </ul>
 116
 117         <ul>
 118             <li>Projects:
 119                 <ul>
 120                     <li><strong>project#3</strong> (link to project with id 3)</li>
 121                     <li><strong>project:someproject</strong> (link to project named "someproject")</li>
 122                 </ul></li>
 123         </ul>
 124
 125
 126         <p>Escaping:</p>
 127
 128         <ul>
 129             <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
 130         </ul>
 131
 132
 133         <h3><a name="4" class="wiki-page"></a>External links</h3>
 134
 135         <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
 136
 137 <pre>
 138 http://www.redmine.org, someone@foo.bar
 139 </pre>
 140
 141         <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>
 142
 143         <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
 144
 145 <pre>
 146 "Redmine web site":http://www.redmine.org
 147 </pre>
 148
 149         <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
 150
 151
 152     <h2><a name="5" class="wiki-page"></a>Text formatting</h2>
 153
 154
 155     <p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax.  See <a class="external" href="http://www.textism.com/tools/textile/">http://www.textism.com/tools/textile/</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>
 156
 157         <h3><a name="6" class="wiki-page"></a>Font style</h3>
 158
 159 <pre>
 160 * *bold*
 161 * _italic_
 162 * _*bold italic*_
 163 * +underline+
 164 * -strike-through-
 165 </pre>
 166
 167         <p>Display:</p>
 168
 169         <ul>
 170             <li><strong>bold</strong></li>
 171             <li><em>italic</em></li>
 172             <li><em>*bold italic*</em></li>
 173             <li><ins>underline</ins></li>
 174             <li><del>strike-through</del></li>
 175         </ul>
 176
 177         <h3><a name="7" class="wiki-page"></a>Inline images</h3>
 178
 179         <ul>
 180             <li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
 181             <li><strong>!>image_url!</strong> right floating image</li>
 182             <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>
 183         </ul>
 184
 185         <h3><a name="8" class="wiki-page"></a>Headings</h3>
 186
 187 <pre>
 188 h1. Heading
 189 h2. Subheading
 190 h3. Subsubheading
 191 </pre>
 192
 193         <p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
 194
 195
 196         <h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
 197
 198 <pre>
 199 p>. right aligned
 200 p=. centered
 201 </pre>
 202
 203         <p style="text-align:center;">This is centered paragraph.</p>
 204
 205
 206         <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
 207
 208         <p>Start the paragraph with <strong>bq.</strong></p>
 209
 210 <pre>
 211 bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
 212 To go live, all you need to add is a database and a web server.
 213 </pre>
 214
 215         <p>Display:</p>
 216
 217         <blockquote>
 218                 <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>
 219         </blockquote>
 220
 221
 222         <h3><a name="11" class="wiki-page"></a>Table of content</h3>
 223
 224 <pre>
 225 {{toc}} => left aligned toc
 226 {{>toc}} => right aligned toc
 227 </pre>
 228
 229     <h2><a name="12" class="wiki-page"></a>Macros</h2>
 230
 231     <p>Redmine has the following builtin macros:</p>
 232
 233     <p><dl><dt><code>hello_world</code></dt><dd><p>Sample macro.</p></dd><dt><code>include</code></dt><dd><p>Include a wiki page. Example:</p>
 234
 235     <pre><code>{{include(Foo)}}</code></pre></dd><dt><code>macro_list</code></dt><dd><p>Displays a list of all available macros, including description if available.</p></dd></dl></p>
 236
 237
 238     <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
 239
 240     <p>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, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.</p>
 241
 242     <p>You can highlight code in your wiki page using this syntax:</p>
 243
 244 <pre>
 245 &lt;pre&gt;&lt;code class="ruby"&gt;
 246   Place you code here.
 247 &lt;/code&gt;&lt;/pre&gt;
 248 </pre>
 249
 250     <p>Example:</p>
 251
 252 <pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
 253 <span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>
 254 <span class="no"> 3</span>   <span class="r">def</span> <span class="fu">initialize</span>(name)
 255 <span class="no"> 4</span>     <span class="iv">@name</span> = name.capitalize
 256 <span class="no"> 5</span>   <span class="r">end</span>
 257 <span class="no"> 6</span>
 258 <span class="no"> 7</span>   <span class="r">def</span> <span class="fu">salute</span>
 259 <span class="no"> 8</span>     puts <span class="s"><span class="dl">"</span><span class="k">Hello </span><span class="il"><span class="idl">#{</span><span class="iv">@name</span><span class="idl">}</span></span><span class="k">!</span><span class="dl">"</span></span>
 260 <span class="no"> 9</span>   <span class="r">end</span>
 261 <span class="no"><strong>10</strong></span> <span class="r">end</span>
 262 </code>
 263 </pre>
 264 </body>
 265 </html>