Mercurial > hg > soundsoftware-site

annotate public/help/wiki_syntax_detailed.html @ 863:818ff422eece bug_168

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