Revision 912:5e80956cc792 public/help
| 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 <a href="#" class="changeset">c6f4d0fd</a>).</li> |
|
| 50 |
<li>Link to a changeset of another project: <strong>sandbox:r758</strong> (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">sandbox:r758</a>)</li> |
|
| 51 |
<li>Link to a changeset with a non-numeric hash: <strong>sandbox:c6f4d0fd</strong> (displays <a href="#" class="changeset">sandbox:c6f4d0fd</a>).</li> |
|
| 52 |
</ul> |
|
| 53 |
|
|
| 54 |
<p>Wiki links:</p> |
|
| 55 |
|
|
| 56 |
<ul> |
|
| 57 |
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li> |
|
| 58 |
<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> |
|
| 59 |
<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> |
|
| 60 |
</ul> |
|
| 61 |
|
|
| 62 |
<p>You can also link to pages of an other project wiki:</p> |
|
| 63 |
|
|
| 64 |
<ul> |
|
| 65 |
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li> |
|
| 66 |
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li> |
|
| 67 |
</ul> |
|
| 68 |
|
|
| 69 |
<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> |
|
| 70 |
|
|
| 71 |
<p>Links to other resources:</p> |
|
| 72 |
|
|
| 73 |
<ul> |
|
| 74 |
<li>Documents: |
|
| 75 |
<ul> |
|
| 76 |
<li><strong>document#17</strong> (link to document with id 17)</li> |
|
| 77 |
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li> |
|
| 78 |
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li> |
|
| 79 |
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li> |
|
| 80 |
</ul></li> |
|
| 81 |
</ul> |
|
| 82 |
|
|
| 83 |
<ul> |
|
| 84 |
<li>Versions: |
|
| 85 |
<ul> |
|
| 86 |
<li><strong>version#3</strong> (link to version with id 3)</li> |
|
| 87 |
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li> |
|
| 88 |
<li><strong>version:"1.0 beta 2"</strong></li> |
|
| 89 |
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li> |
|
| 90 |
</ul></li> |
|
| 91 |
</ul> |
|
| 92 |
|
|
| 93 |
<ul> |
|
| 94 |
<li>Attachments: |
|
| 95 |
<ul> |
|
| 96 |
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li> |
|
| 97 |
<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> |
|
| 98 |
</ul></li> |
|
| 99 |
</ul> |
|
| 100 |
|
|
| 101 |
<ul> |
|
| 102 |
<li>Repository files: |
|
| 103 |
<ul> |
|
| 104 |
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li> |
|
| 105 |
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li> |
|
| 106 |
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li> |
|
| 107 |
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li> |
|
| 108 |
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li> |
|
| 109 |
<li><strong>export:some/file</strong> (force the download of the file)</li> |
|
| 110 |
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li> |
|
| 111 |
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li> |
|
| 112 |
</ul></li> |
|
| 113 |
</ul> |
|
| 114 |
|
|
| 115 |
<ul> |
|
| 116 |
<li>Forum messages: |
|
| 117 |
<ul> |
|
| 118 |
<li><strong>message#1218</strong> (link to message with id 1218)</li> |
|
| 119 |
</ul></li> |
|
| 120 |
</ul> |
|
| 121 |
|
|
| 122 |
<ul> |
|
| 123 |
<li>Projects: |
|
| 124 |
<ul> |
|
| 125 |
<li><strong>project#3</strong> (link to project with id 3)</li> |
|
| 126 |
<li><strong>project:someproject</strong> (link to project named "someproject")</li> |
|
| 127 |
</ul></li> |
|
| 128 |
</ul> |
|
| 129 |
|
|
| 130 |
|
|
| 131 |
<p>Escaping:</p> |
|
| 132 |
|
|
| 133 |
<ul> |
|
| 134 |
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li> |
|
| 135 |
</ul> |
|
| 136 |
|
|
| 137 |
|
|
| 138 |
<h3><a name="4" class="wiki-page"></a>External links</h3> |
|
| 139 |
|
|
| 140 |
<p>HTTP URLs and email addresses are automatically turned into clickable links:</p> |
|
| 141 |
|
|
| 142 |
<pre> |
|
| 143 |
http://www.redmine.org, someone@foo.bar |
|
| 144 |
</pre> |
|
| 145 |
|
|
| 146 |
<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> |
|
| 147 |
|
|
| 148 |
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p> |
|
| 149 |
|
|
| 150 |
<pre> |
|
| 151 |
"Redmine web site":http://www.redmine.org |
|
| 152 |
</pre> |
|
| 153 |
|
|
| 154 |
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p> |
|
| 155 |
|
|
| 156 |
|
|
| 157 |
<h2><a name="5" class="wiki-page"></a>Text formatting</h2> |
|
| 158 |
|
|
| 159 |
|
|
| 160 |
<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> |
|
| 161 |
|
|
| 162 |
<h3><a name="6" class="wiki-page"></a>Font style</h3> |
|
| 163 |
|
|
| 164 |
<pre> |
|
| 165 |
* *bold* |
|
| 166 |
* _italic_ |
|
| 167 |
* _*bold italic*_ |
|
| 168 |
* +underline+ |
|
| 169 |
* -strike-through- |
|
| 170 |
</pre> |
|
| 171 |
|
|
| 172 |
<p>Display:</p> |
|
| 173 |
|
|
| 174 |
<ul> |
|
| 175 |
<li><strong>bold</strong></li> |
|
| 176 |
<li><em>italic</em></li> |
|
| 177 |
<li><em>*bold italic*</em></li> |
|
| 178 |
<li><ins>underline</ins></li> |
|
| 179 |
<li><del>strike-through</del></li> |
|
| 180 |
</ul> |
|
| 181 |
|
|
| 182 |
<h3><a name="7" class="wiki-page"></a>Inline images</h3> |
|
| 183 |
|
|
| 184 |
<ul> |
|
| 185 |
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li> |
|
| 186 |
<li><strong>!>image_url!</strong> right floating image</li> |
|
| 187 |
<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> |
|
| 188 |
</ul> |
|
| 189 |
|
|
| 190 |
<h3><a name="8" class="wiki-page"></a>Headings</h3> |
|
| 191 |
|
|
| 192 |
<pre> |
|
| 193 |
h1. Heading |
|
| 194 |
h2. Subheading |
|
| 195 |
h3. Subsubheading |
|
| 196 |
</pre> |
|
| 197 |
|
|
| 198 |
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p> |
|
| 199 |
|
|
| 200 |
|
|
| 201 |
|
|
| 202 |
|
|
| 203 |
<h3><a name="9" class="wiki-page"></a>Bullets and Numbering</h3> |
|
| 204 |
|
|
| 205 |
<pre> |
|
| 206 |
* First Level Bullet |
|
| 207 |
** Second Level Bullet |
|
| 208 |
** Another Second Level Bullet |
|
| 209 |
*** Third Level Bullet |
|
| 210 |
** Back to 2nd Level Bullet |
|
| 211 |
* Back to 1st Level Bullet |
|
| 212 |
</pre> |
|
| 213 |
|
|
| 214 |
<ul> |
|
| 215 |
<li>First Level Bullet</li> |
|
| 216 |
<ul> |
|
| 217 |
<li>Second Level Bullet</li> |
|
| 218 |
<li>Another Second Level Bullet</li> |
|
| 219 |
<ul> |
|
| 220 |
<li>Third Level Bullet</li> |
|
| 221 |
</ul> |
|
| 222 |
<li>Back to 2nd Level Bullet</li> |
|
| 223 |
</ul> |
|
| 224 |
|
|
| 225 |
<li>Back to 1st Level Bullet</li> |
|
| 226 |
</ul> |
|
| 227 |
|
|
| 228 |
<pre> |
|
| 229 |
# First Level Numbering |
|
| 230 |
## Second Level Numbering |
|
| 231 |
## Another Second Level Numbering |
|
| 232 |
### Third Level Numbering |
|
| 233 |
## Back to 2nd Level Numbering |
|
| 234 |
# Back to 1st Level Numbering |
|
| 235 |
</pre> |
|
| 236 |
|
|
| 237 |
<ol> |
|
| 238 |
<li>First Level Numbering</li> |
|
| 239 |
<ol> |
|
| 240 |
<li>Second Level Numbering</li> |
|
| 241 |
<li>Another Second Level Numbering</li> |
|
| 242 |
<ol> |
|
| 243 |
<li>Third Level Numbering</li> |
|
| 244 |
</ol> |
|
| 245 |
<li>Back to 2nd Level Numbering</li> |
|
| 246 |
</ol> |
|
| 247 |
<li>Back to 1st Level Numbering</li> |
|
| 248 |
</ol> |
|
| 249 |
|
|
| 250 |
<pre> |
|
| 251 |
# First Level Numbering |
|
| 252 |
#* Bullet inside numbering environment |
|
| 253 |
#* Another Bullet inside numbering environment |
|
| 254 |
# Back to 1st Level Numbering |
|
| 255 |
</pre> |
|
| 256 |
|
|
| 257 |
<ol> |
|
| 258 |
<li>First Level Numbering</li> |
|
| 259 |
<ul> |
|
| 260 |
<li>Bullet inside numbering environment</li> |
|
| 261 |
<li>Another Bullet inside numbering environment</li> |
|
| 262 |
</ul> |
|
| 263 |
|
|
| 264 |
<li>Back to 1st Level Numbering</li> |
|
| 265 |
</ol> |
|
| 266 |
|
|
| 267 |
|
|
| 268 |
|
|
| 269 |
|
|
| 270 |
|
|
| 271 |
|
|
| 272 |
|
|
| 273 |
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3> |
|
| 274 |
|
|
| 275 |
<pre> |
|
| 276 |
p>. right aligned |
|
| 277 |
p=. centered |
|
| 278 |
</pre> |
|
| 279 |
|
|
| 280 |
<p style="text-align:center;">This is a centered paragraph.</p> |
|
| 281 |
|
|
| 282 |
|
|
| 283 |
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3> |
|
| 284 |
|
|
| 285 |
<p>Start the paragraph with <strong>bq.</strong></p> |
|
| 286 |
|
|
| 287 |
<pre> |
|
| 288 |
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern. |
|
| 289 |
To go live, all you need to add is a database and a web server. |
|
| 290 |
</pre> |
|
| 291 |
|
|
| 292 |
<p>Display:</p> |
|
| 293 |
|
|
| 294 |
<blockquote> |
|
| 295 |
<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> |
|
| 296 |
</blockquote> |
|
| 297 |
|
|
| 298 |
|
|
| 299 |
<h3><a name="11" class="wiki-page"></a>Table of content</h3> |
|
| 300 |
|
|
| 301 |
<pre> |
|
| 302 |
{{toc}} => left aligned toc
|
|
| 303 |
{{>toc}} => right aligned toc
|
|
| 304 |
</pre> |
|
| 305 |
|
|
| 306 |
<h2><a name="12" class="wiki-page"></a>Macros</h2> |
|
| 307 |
|
|
| 308 |
<p>Redmine has the following builtin macros:</p> |
|
| 309 |
|
|
| 310 |
<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> |
|
| 311 |
|
|
| 312 |
<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>
|
|
| 313 |
|
|
| 314 |
|
|
| 315 |
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2> |
|
| 316 |
|
|
| 317 |
<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> |
|
| 318 |
|
|
| 319 |
<p>You can highlight code in your wiki page using this syntax:</p> |
|
| 320 |
|
|
| 321 |
<pre> |
|
| 322 |
<pre><code class="ruby"> |
|
| 323 |
Place you code here. |
|
| 324 |
</code></pre> |
|
| 325 |
</pre> |
|
| 326 |
|
|
| 327 |
<p>Example:</p> |
|
| 328 |
|
|
| 329 |
<pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span> |
|
| 330 |
<span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span> |
|
| 331 |
<span class="no"> 3</span> <span class="r">def</span> <span class="fu">initialize</span>(name) |
|
| 332 |
<span class="no"> 4</span> <span class="iv">@name</span> = name.capitalize |
|
| 333 |
<span class="no"> 5</span> <span class="r">end</span> |
|
| 334 |
<span class="no"> 6</span> |
|
| 335 |
<span class="no"> 7</span> <span class="r">def</span> <span class="fu">salute</span> |
|
| 336 |
<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>
|
|
| 337 |
<span class="no"> 9</span> <span class="r">end</span> |
|
| 338 |
<span class="no"><strong>10</strong></span> <span class="r">end</span> |
|
| 339 |
</code> |
|
| 340 |
</pre> |
|
| 341 |
</body> |
|
| 342 |
</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 |
.syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
|
|
| 22 |
.syntaxhl .comment { color:#666; }
|
|
| 23 |
|
|
| 24 |
.syntaxhl .class { color:#B06; font-weight:bold }
|
|
| 25 |
.syntaxhl .delimiter { color:black }
|
|
| 26 |
.syntaxhl .function { color:#06B; font-weight:bold }
|
|
| 27 |
|
|
| 28 |
.syntaxhl .inline { background: #eee }
|
|
| 29 |
.syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
|
|
| 30 |
|
|
| 31 |
.syntaxhl .instance-variable { color:#33B }
|
|
| 32 |
.syntaxhl .reserved { color:#080; font-weight:bold }
|
|
| 33 |
|
|
| 34 |
.syntaxhl .string { background-color:#fff0f0; color: #D20; }
|
|
| 35 |
.syntaxhl .string .delimiter { color:#710 }
|
|
| 36 |
|
|
| 37 |
</style> |
|
| 38 |
</head> |
|
| 39 |
|
|
| 40 |
<body> |
|
| 41 |
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1> |
|
| 42 |
|
|
| 43 |
<h2><a name="2" class="wiki-page"></a>Links</h2> |
|
| 44 |
|
|
| 45 |
<h3><a name="3" class="wiki-page"></a>Redmine links</h3> |
|
| 46 |
|
|
| 47 |
<p>Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.</p> |
|
| 48 |
<ul> |
|
| 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> |
|
| 50 |
<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> |
|
| 51 |
<li>Link to a changeset with a non-numeric hash: <strong>commit:c6f4d0fd</strong> (displays <a href="#" class="changeset">c6f4d0fd</a>).</li> |
|
| 52 |
<li>Link to a changeset of another project: <strong>sandbox:r758</strong> (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">sandbox:r758</a>)</li> |
|
| 53 |
<li>Link to a changeset with a non-numeric hash: <strong>sandbox:c6f4d0fd</strong> (displays <a href="#" class="changeset">sandbox:c6f4d0fd</a>).</li> |
|
| 54 |
</ul> |
|
| 55 |
|
|
| 56 |
<p>Wiki links:</p> |
|
| 57 |
|
|
| 58 |
<ul> |
|
| 59 |
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li> |
|
| 60 |
<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> |
|
| 61 |
<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> |
|
| 62 |
</ul> |
|
| 63 |
|
|
| 64 |
<p>You can also link to pages of an other project wiki:</p> |
|
| 65 |
|
|
| 66 |
<ul> |
|
| 67 |
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li> |
|
| 68 |
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li> |
|
| 69 |
</ul> |
|
| 70 |
|
|
| 71 |
<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> |
|
| 72 |
|
|
| 73 |
<p>Links to other resources:</p> |
|
| 74 |
|
|
| 75 |
<ul> |
|
| 76 |
<li>Documents: |
|
| 77 |
<ul> |
|
| 78 |
<li><strong>document#17</strong> (link to document with id 17)</li> |
|
| 79 |
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li> |
|
| 80 |
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li> |
|
| 81 |
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li> |
|
| 82 |
</ul></li> |
|
| 83 |
</ul> |
|
| 84 |
|
|
| 85 |
<ul> |
|
| 86 |
<li>Versions: |
|
| 87 |
<ul> |
|
| 88 |
<li><strong>version#3</strong> (link to version with id 3)</li> |
|
| 89 |
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li> |
|
| 90 |
<li><strong>version:"1.0 beta 2"</strong></li> |
|
| 91 |
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li> |
|
| 92 |
</ul></li> |
|
| 93 |
</ul> |
|
| 94 |
|
|
| 95 |
<ul> |
|
| 96 |
<li>Attachments: |
|
| 97 |
<ul> |
|
| 98 |
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li> |
|
| 99 |
<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> |
|
| 100 |
</ul></li> |
|
| 101 |
</ul> |
|
| 102 |
|
|
| 103 |
<ul> |
|
| 104 |
<li>Repository files: |
|
| 105 |
<ul> |
|
| 106 |
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li> |
|
| 107 |
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li> |
|
| 108 |
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li> |
|
| 109 |
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li> |
|
| 110 |
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li> |
|
| 111 |
<li><strong>export:some/file</strong> (force the download of the file)</li> |
|
| 112 |
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li> |
|
| 113 |
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li> |
|
| 114 |
</ul></li> |
|
| 115 |
</ul> |
|
| 116 |
|
|
| 117 |
<ul> |
|
| 118 |
<li>Forum messages: |
|
| 119 |
<ul> |
|
| 120 |
<li><strong>message#1218</strong> (link to message with id 1218)</li> |
|
| 121 |
</ul></li> |
|
| 122 |
</ul> |
|
| 123 |
|
|
| 124 |
<ul> |
|
| 125 |
<li>Projects: |
|
| 126 |
<ul> |
|
| 127 |
<li><strong>project#3</strong> (link to project with id 3)</li> |
|
| 128 |
<li><strong>project:someproject</strong> (link to project named "someproject")</li> |
|
| 129 |
</ul></li> |
|
| 130 |
</ul> |
|
| 131 |
|
|
| 132 |
|
|
| 133 |
<p>Escaping:</p> |
|
| 134 |
|
|
| 135 |
<ul> |
|
| 136 |
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li> |
|
| 137 |
</ul> |
|
| 138 |
|
|
| 139 |
|
|
| 140 |
<h3><a name="4" class="wiki-page"></a>External links</h3> |
|
| 141 |
|
|
| 142 |
<p>HTTP URLs and email addresses are automatically turned into clickable links:</p> |
|
| 143 |
|
|
| 144 |
<pre> |
|
| 145 |
http://www.redmine.org, someone@foo.bar |
|
| 146 |
</pre> |
|
| 147 |
|
|
| 148 |
<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> |
|
| 149 |
|
|
| 150 |
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p> |
|
| 151 |
|
|
| 152 |
<pre> |
|
| 153 |
"Redmine web site":http://www.redmine.org |
|
| 154 |
</pre> |
|
| 155 |
|
|
| 156 |
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p> |
|
| 157 |
|
|
| 158 |
|
|
| 159 |
<h2><a name="5" class="wiki-page"></a>Text formatting</h2> |
|
| 160 |
|
|
| 161 |
|
|
| 162 |
<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> |
|
| 163 |
|
|
| 164 |
<h3><a name="6" class="wiki-page"></a>Font style</h3> |
|
| 165 |
|
|
| 166 |
<pre> |
|
| 167 |
* *bold* |
|
| 168 |
* _italic_ |
|
| 169 |
* _*bold italic*_ |
|
| 170 |
* +underline+ |
|
| 171 |
* -strike-through- |
|
| 172 |
</pre> |
|
| 173 |
|
|
| 174 |
<p>Display:</p> |
|
| 175 |
|
|
| 176 |
<ul> |
|
| 177 |
<li><strong>bold</strong></li> |
|
| 178 |
<li><em>italic</em></li> |
|
| 179 |
<li><em>*bold italic*</em></li> |
|
| 180 |
<li><ins>underline</ins></li> |
|
| 181 |
<li><del>strike-through</del></li> |
|
| 182 |
</ul> |
|
| 183 |
|
|
| 184 |
<h3><a name="7" class="wiki-page"></a>Inline images</h3> |
|
| 185 |
|
|
| 186 |
<ul> |
|
| 187 |
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li> |
|
| 188 |
<li><strong>!>image_url!</strong> right floating image</li> |
|
| 189 |
<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> |
|
| 190 |
</ul> |
|
| 191 |
|
|
| 192 |
<h3><a name="8" class="wiki-page"></a>Headings</h3> |
|
| 193 |
|
|
| 194 |
<pre> |
|
| 195 |
h1. Heading |
|
| 196 |
h2. Subheading |
|
| 197 |
h3. Subsubheading |
|
| 198 |
</pre> |
|
| 199 |
|
|
| 200 |
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p> |
|
| 201 |
|
|
| 202 |
|
|
| 203 |
|
|
| 204 |
|
|
| 205 |
<h3><a name="9" class="wiki-page"></a>Bullets and Numbering</h3> |
|
| 206 |
|
|
| 207 |
<pre> |
|
| 208 |
* First Level Bullet |
|
| 209 |
** Second Level Bullet |
|
| 210 |
** Another Second Level Bullet |
|
| 211 |
*** Third Level Bullet |
|
| 212 |
** Back to 2nd Level Bullet |
|
| 213 |
* Back to 1st Level Bullet |
|
| 214 |
</pre> |
|
| 215 |
|
|
| 216 |
<ul> |
|
| 217 |
<li>First Level Bullet</li> |
|
| 218 |
<ul> |
|
| 219 |
<li>Second Level Bullet</li> |
|
| 220 |
<li>Another Second Level Bullet</li> |
|
| 221 |
<ul> |
|
| 222 |
<li>Third Level Bullet</li> |
|
| 223 |
</ul> |
|
| 224 |
<li>Back to 2nd Level Bullet</li> |
|
| 225 |
</ul> |
|
| 226 |
|
|
| 227 |
<li>Back to 1st Level Bullet</li> |
|
| 228 |
</ul> |
|
| 229 |
|
|
| 230 |
<pre> |
|
| 231 |
# First Level Numbering |
|
| 232 |
## Second Level Numbering |
|
| 233 |
## Another Second Level Numbering |
|
| 234 |
### Third Level Numbering |
|
| 235 |
## Back to 2nd Level Numbering |
|
| 236 |
# Back to 1st Level Numbering |
|
| 237 |
</pre> |
|
| 238 |
|
|
| 239 |
<ol> |
|
| 240 |
<li>First Level Numbering</li> |
|
| 241 |
<ol> |
|
| 242 |
<li>Second Level Numbering</li> |
|
| 243 |
<li>Another Second Level Numbering</li> |
|
| 244 |
<ol> |
|
| 245 |
<li>Third Level Numbering</li> |
|
| 246 |
</ol> |
|
| 247 |
<li>Back to 2nd Level Numbering</li> |
|
| 248 |
</ol> |
|
| 249 |
<li>Back to 1st Level Numbering</li> |
|
| 250 |
</ol> |
|
| 251 |
|
|
| 252 |
<pre> |
|
| 253 |
# First Level Numbering |
|
| 254 |
#* Bullet inside numbering environment |
|
| 255 |
#* Another Bullet inside numbering environment |
|
| 256 |
# Back to 1st Level Numbering |
|
| 257 |
</pre> |
|
| 258 |
|
|
| 259 |
<ol> |
|
| 260 |
<li>First Level Numbering</li> |
|
| 261 |
<ul> |
|
| 262 |
<li>Bullet inside numbering environment</li> |
|
| 263 |
<li>Another Bullet inside numbering environment</li> |
|
| 264 |
</ul> |
|
| 265 |
|
|
| 266 |
<li>Back to 1st Level Numbering</li> |
|
| 267 |
</ol> |
|
| 268 |
|
|
| 269 |
|
|
| 270 |
|
|
| 271 |
|
|
| 272 |
|
|
| 273 |
|
|
| 274 |
|
|
| 275 |
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3> |
|
| 276 |
|
|
| 277 |
<pre> |
|
| 278 |
p>. right aligned |
|
| 279 |
p=. centered |
|
| 280 |
</pre> |
|
| 281 |
|
|
| 282 |
<p style="text-align:center;">This is a centered paragraph.</p> |
|
| 283 |
|
|
| 284 |
|
|
| 285 |
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3> |
|
| 286 |
|
|
| 287 |
<p>Start the paragraph with <strong>bq.</strong></p> |
|
| 288 |
|
|
| 289 |
<pre> |
|
| 290 |
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern. |
|
| 291 |
To go live, all you need to add is a database and a web server. |
|
| 292 |
</pre> |
|
| 293 |
|
|
| 294 |
<p>Display:</p> |
|
| 295 |
|
|
| 296 |
<blockquote> |
|
| 297 |
<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> |
|
| 298 |
</blockquote> |
|
| 299 |
|
|
| 300 |
|
|
| 301 |
<h3><a name="11" class="wiki-page"></a>Table of content</h3> |
|
| 302 |
|
|
| 303 |
<pre> |
|
| 304 |
{{toc}} => left aligned toc
|
|
| 305 |
{{>toc}} => right aligned toc
|
|
| 306 |
</pre> |
|
| 307 |
|
|
| 308 |
<h2><a name="12" class="wiki-page"></a>Macros</h2> |
|
| 309 |
|
|
| 310 |
<p>Redmine has the following builtin macros:</p> |
|
| 311 |
|
|
| 312 |
<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> |
|
| 313 |
|
|
| 314 |
<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>
|
|
| 315 |
|
|
| 316 |
|
|
| 317 |
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2> |
|
| 318 |
|
|
| 319 |
<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> |
|
| 320 |
|
|
| 321 |
<p>You can highlight code in your wiki page using this syntax:</p> |
|
| 322 |
|
|
| 323 |
<pre> |
|
| 324 |
<pre><code class="ruby"> |
|
| 325 |
Place you code here. |
|
| 326 |
</code></pre> |
|
| 327 |
</pre> |
|
| 328 |
|
|
| 329 |
<p>Example:</p> |
|
| 330 |
|
|
| 331 |
<pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span> |
|
| 332 |
<span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span> |
|
| 333 |
<span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name) |
|
| 334 |
<span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize |
|
| 335 |
<span class="line-numbers"> 5</span> <span class="reserved">end</span> |
|
| 336 |
<span class="line-numbers"> 6</span> |
|
| 337 |
<span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span> |
|
| 338 |
<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>
|
|
| 339 |
<span class="line-numbers"> 9</span> <span class="reserved">end</span> |
|
| 340 |
<span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code> |
|
| 341 |
</pre> |
|
| 342 |
</body> |
|
| 343 |
</html> |
|
Also available in: Unified diff