Mercurial > hg > soundsoftware-site

annotate .svn/pristine/7a/7afd9face81eb9278f77d90a9ccde1ba0d2fa278.svn-base @ 1519:afce8026aaeb redmine-2.4-integration

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