Mercurial > hg > soundsoftware-site

annotate .svn/pristine/ba/ba17318dbb463f926062c32d7de0e2c9351f38c4.svn-base @ 1295:622f24f53b42 redmine-2.3

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