Mercurial > hg > soundsoftware-site

annotate public/help/zh/wiki_syntax_detailed.html @ 1628:9c5f8e24dadc live tip

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