wiki_syntax_detailed_textile.html

Hiroo Hayashi, 2016-07-23 17:44

Download (23 KB)

 
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 #e2e2e2;
16
        width: auto;
17
        overflow-x: auto;
18
        overflow-y: hidden;
19
    }
20
    a.new { color: #b73535; }
21

22
    .syntaxhl .class { color:#258; font-weight:bold }
23
    .syntaxhl .comment  { color:#385; }
24
    .syntaxhl .delimiter { color:black }
25
    .syntaxhl .function { color:#06B; font-weight:bold }
26
    .syntaxhl .inline { background-color: hsla(0,0%,0%,0.07); color: black }
27
    .syntaxhl .inline-delimiter { font-weight: bold; color: #666 }
28
    .syntaxhl .instance-variable { color:#33B }
29
    .syntaxhl .keyword { color:#939; font-weight:bold }
30
    .syntaxhl .string .content { color: #46a }
31
    .syntaxhl .string .delimiter { color:#46a }
32
</style>
33
</head>
34

    
35
<!-- 
36
Don't edit this file directly.
37
Update the wiki page <http://www.redmine.org/projects/redmine/wiki/RedmineTextFormattingTextile> first.  Then merge the change to this file.
38
See <http://www.redmine.org/issues/23413> for more details.
39
-->
40
<body>
41
<h1 >Textile formatting</h1>
42

    
43

    
44
        <p>Below is <strong>Textile</strong> formatting. For <strong>Markdown</strong> formatting see <a href="/projects/redmine/wiki/RedmineTextFormattingMarkdown" class="wiki-page">RedmineTextFormattingMarkdown</a>.<br />For limitations of current Textile support see <a href="/issues/6269" class="issue tracker-2 status-1 priority-4 priority-default" title="RedCloth 4 support (New)">#6269</a>, <a href="/issues/10078" class="issue tracker-2 status-1 priority-4 priority-default" title="Definition List support (New)">#10078</a> (Definition Lists).</p>
45

    
46

    
47

    
48
<h2 >Links</h2>
49

    
50

    
51
<h3 >Redmine links</h3>
52

    
53

    
54
        <p><p>Redmine allows hyperlinking between resources (wiki pages, issues, documents...) from anywhere text formatting is used.</p>
55

    
56

    
57
        <p>Wiki links:</p>
58

    
59

    
60
        <ul>
61
        <li><strong>&#91;&#91;Guide&#93;&#93;</strong> displays a link to the page named 'Guide': <a href="/projects/redmine/wiki/Guide" class="wiki-page">Guide</a></li>
62
                <li><strong>&#91;&#91;Guide#further-reading&#93;&#93;</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="/projects/redmine/wiki/Guide#further-reading" class="wiki-page">Guide</a></li>
63
                <li><strong>&#91;&#91;Guide|User manual&#93;&#93;</strong> displays a link to the same page but with different text: <a href="/projects/redmine/wiki/Guide" class="wiki-page">User manual</a></li>
64
                <li><strong>&#91;&#91;Guide#User-guide|User guide&#93;&#93;</strong> displays a link to the header on the same page with different text: <a href="/projects/redmine/wiki/Guide#User-guide" class="wiki-page">User guide</a></li>
65
        </ul>
66

    
67

    
68
        <p>You can also link to pages of another project's wiki (using the project identifier):</p>
69

    
70

    
71
        <ul>
72
        <li><strong>&#91;&#91;sandbox:some page&#93;&#93;</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
73
                <li><strong>&#91;&#91;sandbox:&#93;&#93;</strong> displays a link to the Sandbox wiki main page</li>
74
        </ul>
75

    
76

    
77
        <p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="/projects/redmine/wiki/Nonexistent_page?parent=RedmineTextFormattingRedmineLinks" class="wiki-page new">Nonexistent page</a>.</p>
78

    
79

    
80
        <p>Links to other resources:</p>
81

    
82

    
83
        <ul>
84
        <li>Issues:
85

    
86
        <ul>
87
        <li><strong>#124</strong> (link to an issue: displays <a href="/issues/124" class="issue tracker-1 status-5 priority-4 priority-default closed" title="bulk edit doesn&#x27;t change the category or fixed version properties (Closed)">#124</a>, link is striked-through if the issue is closed)</li>
88
                <li><strong>#124-6</strong>, or <strong>#124#note-6</strong> (link to an issue note: displays <a href="/issues/124#note-6" class="issue tracker-1 status-5 priority-4 priority-default closed" title="bulk edit doesn&#x27;t change the category or fixed version properties (Closed)">#124-6</a>, or <a href="/issues/124#note-6" class="issue tracker-1 status-5 priority-4 priority-default closed" title="bulk edit doesn&#x27;t change the category or fixed version properties (Closed)">#124#note-6</a>)</li>
89
        </ul></li>
90
        </ul>
91

    
92

    
93
        <ul>
94
        <li>Documents:
95

    
96
        <ul>
97
        <li><strong>document#17</strong> (link to document with id 17)</li>
98
                <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
99
                <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
100
                <li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in project identifier "sandbox")</li>
101
        </ul></li>
102
        </ul>
103

    
104

    
105
        <ul>
106
        <li>Versions:
107

    
108
        <ul>
109
        <li><strong>version#3</strong> (link to version with id 3)</li>
110
                <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
111
                <li><strong>version:"1.0 beta 2"</strong> (double quotes can be used when version name contains spaces)</li>
112
                <li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project identifier "sandbox")</li>
113
        </ul></li>
114
        </ul>
115

    
116

    
117
        <ul>
118
        <li>Attachments:
119

    
120
        <ul>
121
        <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
122
                <li><strong>attachment:"file name.zip"</strong> (double quotes can be used when the filename contains non word characters)</li>
123
                <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>
124
        </ul></li>
125
        </ul>
126

    
127

    
128
        <ul>
129
        <li>Changesets:
130

    
131
        <ul>
132
        <li><strong>r758</strong> (link to a changeset, displays <a href="/projects/redmine/repository/revisions/758" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>
133
                <li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
134
                <li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
135
                <li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
136
                <li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
137
                <li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project identifier)</li>
138
        </ul></li>
139
        </ul>
140

    
141

    
142
        <ul>
143
        <li>Repository files:
144

    
145
        <ul>
146
        <li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
147
                <li><strong>source:"some file"</strong> (link to the file with non word characters in the path)</li>
148
                <li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
149
                <li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
150
                <li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
151
                <li><strong>source:repo_identifier|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
152
                <li><strong>sandbox:source:some/file</strong> (link to the file in the project identifier "sandbox")</li>
153
                <li><strong>export:some/file</strong> (force the download of the file)</li>
154
        </ul></li>
155
        </ul>
156

    
157

    
158
        <ul>
159
        <li>Forums:
160

    
161
        <ul>
162
        <li><strong>forum#2</strong> (link to forum with id 2)</li>
163
                <li><strong>forum:Discussion</strong> (link to forum with name "Discussion")</li>
164
                <li><strong>forum:"Help and more"</strong> (double quotes can be used when forum name contains spaces)</li>
165
        </ul></li>
166
        </ul>
167

    
168

    
169
        <ul>
170
        <li>Forum messages:
171

    
172
        <ul>
173
        <li><strong>message#1218</strong> (link to message with id 1218)</li>
174
        </ul></li>
175
        </ul>
176

    
177

    
178
        <ul>
179
        <li>News items
180

    
181
        <ul>
182
        <li><strong>news#1</strong> (link to news item with id 1)</li>
183
                <li><strong>news:Greetings</strong> (link to news item with name "Greetings")</li>
184
                <li><strong>news:"eCookbook first release !"</strong> (double quotes can be used when news item name contains spaces)</li>
185
        </ul></li>
186
        </ul>
187

    
188

    
189
        <ul>
190
        <li>Projects:
191

    
192
        <ul>
193
        <li><strong>project#3</strong> (link to project with id 3)</li>
194
                <li><strong>project:someproject</strong> (link to project with name "someproject")</li>
195
                <li><strong>project:"Multiple words project"</strong> (double quotes can be used when project name contains spaces)</li>
196
        </ul></li>
197
        </ul>
198

    
199

    
200
        <p>Escaping:</p>
201

    
202

    
203
        <ul>
204
        <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
205
        </ul></p>
206

    
207

    
208
<h3 >External links</h3>
209

    
210

    
211
HTTP URLs are automatically turned into clickable links: 
212
        <ul>
213
        <li><strong>http&#58;//www.redmine.org</strong> -- External link to the redmine website: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a></li>
214
        </ul>
215

    
216

    
217
HTTP URLs can also use different text than the link itself:
218
        <ul>
219
        <li><strong>"Redmine web site"&#58;http&#58;//www.redmine.org</strong> -- External link with different text: <a href="http://www.redmine.org" class="external">Redmine web site</a></li>
220
                <li><strong>!http://www.redmine.org/attachments/7069/Redmine_logo.png(Redmine web site)!:http://www.redmine.org</strong> -- External image with a title that links to an URL:</li>
221
        </ul>
222

    
223

    
224
        <p style="text-align:center;"><a href="http://www.redmine.org"><img src="http://www.redmine.org/attachments/7069/Redmine_logo.png" title="Redmine web site" alt="Redmine web site" /></a></p>
225

    
226

    
227
<h3 >Email addresses</h3>
228

    
229

    
230
        <p>Email addresses are automatically turned into clickable links:</p>
231

    
232

    
233
        <ul>
234
        <li><strong>someone&#64;foo.bar</strong> -- Link to an email address: <a class="email" href="mailto:someone@foo.bar">someone@foo.bar</a></li>
235
                <li><strong>"Email someone"&#58;mailto&#58;someone&#64;foo.bar</strong> -- Email link with different text: <a href="mailto:someone@foo.bar">Email someone</a></li>
236
        </ul>
237

    
238

    
239
More complex email instructions can be added to an email link.  A default subject, default body and CC information can be defined.  Note that spaces in any of these fields need to be replaced with the code %20.
240
        <ul>
241
        <li><strong>"Email webmaster and admin"&#58;mailto&#58;webmaster&#64;foo.bar?cc=admin&#64;foo.bar</strong> -- Email to webmaster, CC admin:  <a href="mailto:webmaster@foo.bar?cc=admin@foo.bar">Email webmaster and admin</a></li>
242
                <li><strong>"Email someone for help"&#58;mailto&#58;someone&#64;foo.bar?subject=Website%20Help</strong> -- Email link with the subject "Website Help": <a href="mailto:someone@foo.bar?subject=Website%20Help">Email someone for help</a></li>
243
                <li><strong>"Email someone for help"&#58;mailto&#58;someone&#64;foo.bar?subject=Website%20Help&#38;body=My%20problem%20is%20</strong> -- Email link with the subject "Website Help" and a default body: <a href="mailto:someone@foo.bar?subject=Website%20Help&#38;body=My%20problem%20is%20">Email someone for help</a></li>
244
        </ul>
245

    
246

    
247
<h2 >Text formatting</h2>
248

    
249

    
250
        <p>For things such as headlines, bold, tables, lists, Redmine supports <a href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29" class="external">Textile syntax</a>.  See <a class="external" href="http://redcloth.org/hobix.com/textile/">http://redcloth.org/hobix.com/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>
251

    
252

    
253
<h3 >Acronym</h3>
254

    
255

    
256
<pre>
257
JPL(Jean-Philippe Lang)
258
</pre>
259

    
260
        <p>displays:</p>
261

    
262

    
263
        <p><abbr title="Jean-Philippe Lang">JPL</abbr></p>
264

    
265

    
266
<h3 >Font style</h3>
267

    
268

    
269
<pre><code>* *bold*
270
* _italic_
271
* *_bold italic_*
272
* +underline+
273
* -strike-through-
274
* Plain ^superscript^
275
* Plain ~subscript~
276
* @inline monospace@
277
* normal *bold* _italic_ normal;E=mc ^2^
278
* normal&lt;notextile&gt;&lt;/notextile&gt;*bold*&lt;notextile&gt;&lt;/notextile&gt;_italic_&lt;notextile&gt;&lt;/notextile&gt;normal;E=mc&lt;notextile&gt;&lt;/notextile&gt;^2^
279
* Escaping: &lt;notextile&gt;*bold* _italic_ @inlinemono@&lt;/notextile&gt; &amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; Alternative using HTML-codes: &amp;#42;bold&amp;#42; &amp;#95;italic&amp;#95; &amp;#64;inlinemono&amp;#64;
280
* &lt;pre&gt;*some lines*      some "link":http://www.redmine.org&lt;/pre&gt;
281
* &lt;pre&gt;&lt;notextile&gt;&lt;/notextile&gt;*some lines*      some "link":http://www.redmine.org&lt;/pre&gt;<br /></code></pre>
282

    
283
        <p>displays:</p>
284

    
285

    
286
        <ul>
287
        <li><strong>bold</strong></li>
288
                <li><em>italic</em></li>
289
                <li><strong><em>bold italic</em></strong></li>
290
                <li><ins>underline</ins></li>
291
                <li><del>strike-through</del></li>
292
                <li>Plain <sup>superscript</sup></li>
293
                <li>Plain <sub>subscript</sub></li>
294
                <li><code>inline monospace</code></li>
295
                <li>normal <strong>bold</strong> <em>italic</em> normal;E=mc <sup>2</sup></li>
296
                <li>normal<strong>bold</strong><em>italic</em>normal;E=mc<sup>2</sup></li>
297
                <li>Escaping: *bold* _italic_ @inlinemono@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Alternative using HTML-codes: &#42;bold&#42; &#95;italic&#95; &#64;inlinemono&#64;</li>
298
                <li><pre>*some lines*      some "link":http://www.redmine.org</pre></li>
299
                <li><pre><strong>some lines</strong>      some <a href="http://www.redmine.org" class="external">link</a></pre></li>
300
        </ul>
301

    
302

    
303
<h3 >Color</h3>
304

    
305

    
306
<pre><code>* %{color:red}red% %{color:green}green% %{color:yellow}yellow% %{color:#82B6E1}blue'ish%
307
* %{color:red}red%&lt;notextile&gt;&lt;/notextile&gt;%{color:green}green%&lt;notextile&gt;&lt;/notextile&gt;%{color:yellow}yellow%&lt;notextile&gt;&lt;/notextile&gt;%{color:#82B6E1}blue'ish%
308
* %{background:lightgreen}Lightgreen Background% %{background:yellow}Yellow Background%
309
* %{background:lightgreen}Lightgreen Background%&lt;notextile&gt;&lt;/notextile&gt;%{background:yellow}Yellow Background%
310
</code></pre>
311

    
312
        <p>displays:</p>
313

    
314

    
315
        <ul>
316
        <li><span style="color:red;">red</span> <span style="color:green;">green</span> <span style="color:yellow;">yellow</span> <span style="color:#82B6E1;">blue'ish</span></li>
317
                <li><span style="color:red;">red</span><span style="color:green;">green</span><span style="color:yellow;">yellow</span><span style="color:#82B6E1;">blue'ish</span></li>
318
                <li><span style="background:lightgreen;">Lightgreen Background</span> <span style="background:yellow;">Yellow Background</span></li>
319
                <li><span style="background:lightgreen;">Lightgreen Background</span><span style="background:yellow;">Yellow Background</span></li>
320
        </ul>
321

    
322

    
323
<h3 >Inline images</h3>
324

    
325

    
326
        <ul>
327
        <li><strong>&#33;image_url&#33;</strong> displays an image located at image_url (textile syntax)</li>
328
                <li><strong>&#33;>image_url&#33;</strong> right floating image</li>
329
                <li><strong>&#33;image_url(Image title)&#33;</strong> displays an image with an alt/title attribute</li>
330
                <li><strong>&#33;image_url&#33;:URL</strong> displays an image located at image_url with link URL added</li>
331
        </ul>
332

    
333

    
334
        <p>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>&#33;attached_image.png&#33;</strong></p>
335

    
336

    
337
        <p>You can also apply a CSS style to the image in the same ways as styling SPANs. The code <strong>&#33;{width: 100%}attached_image.png&#33;</strong> will make the image adjusts to the parent's width.</p>
338

    
339

    
340
<h3 >Headings</h3>
341

    
342

    
343
<pre><code>h1. Heading
344

    
345
h2. Subheading
346

    
347
h3. Subheading
348
</code></pre>
349

    
350
        <p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
351

    
352

    
353
<h3 >Paragraphs</h3>
354

    
355

    
356
<pre><code>p. left aligned
357

    
358
p(. left ident 1em
359

    
360
p((. left ident 2em
361
as well as for following lines
362

    
363
p&gt;. right aligned
364

    
365
p)))&gt;. right ident 3em
366

    
367
p=. This is centered paragraph.
368
</code></pre>
369

    
370
        <p>displays;</p>
371

    
372

    
373
        <p>left aligned</p>
374

    
375

    
376
        <p style="padding-left:1em;">left ident 1em</p>
377

    
378

    
379
        <p style="padding-left:2em;">left ident 2em<br />as well as for following lines</p>
380

    
381

    
382
        <p style="text-align:right;">right aligned</p>
383

    
384

    
385
        <p style="padding-right:3em;text-align:right;">right ident 3em</p>
386

    
387

    
388
        <p style="text-align:center;">This is centered paragraph.</p>
389

    
390

    
391
<h3 >Horizontal rule</h3>
392

    
393

    
394
        <p><code>----</code></p>
395

    
396

    
397
        <p>displays:</p>
398

    
399

    
400
<hr />
401

    
402

    
403
<h3 >Preformatted Text</h3>
404

    
405

    
406
<pre> &lt;pre&gt;*Your text won't become bold*&lt;/pre&gt; </pre>
407

    
408
        <p>displays:</p>
409

    
410

    
411
<pre> *Your text won't become bold* </pre>
412

    
413
<h3 >Blockquotes</h3>
414

    
415

    
416
        <p>Start the paragraph with <strong>bq.</strong>:</p>
417

    
418

    
419
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
420
To go live, all you need to add is a database and a web server.
421
</code></pre>
422

    
423
        <p>displays:</p>
424

    
425

    
426
        <blockquote>
427
                <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>
428
        </blockquote>
429

    
430

    
431
        <p>You can also use > at the beginning of each line and stack them for nested quotes:</p>
432

    
433

    
434
<pre>
435
&gt;&gt; Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
436
&gt;&gt; To go live, all you need to add is a database and a web server.
437
&gt; Great!
438
</pre>
439

    
440
        <p>displays:</p>
441

    
442

    
443
<blockquote><blockquote>
444

    
445
        <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>
446

    
447

    
448
</blockquote>
449

    
450
        <p>Great!</p>
451

    
452

    
453
</blockquote>
454

    
455
<h3 >Unordered lists</h3>
456

    
457

    
458
<pre>
459
* Item 1
460
* Item 2
461
** Item 21
462
** Item 22
463
* Item 3
464
</pre>
465

    
466
        <p>displays:</p>
467

    
468

    
469
        <ul>
470
        <li>Item 1</li>
471
                <li>Item 2
472
        <ul>
473
        <li>Item 21</li>
474
                <li>Item 22</li>
475
        </ul>
476
        </li>
477
                <li>Item 3</li>
478
        </ul>
479

    
480

    
481
<h3 >Ordered lists</h3>
482

    
483

    
484
<pre>
485
# Item 1
486
# Item 2
487
# Item 3
488
## Item 3.1
489
## Item 3.2
490
</pre>
491

    
492
        <p>displays:</p>
493

    
494

    
495
        <ol>
496
        <li>Item 1</li>
497
                <li>Item 2</li>
498
                <li>Item 3
499
        <ol>
500
        <li>Item 3.1</li>
501
                <li>Item 3.2</li>
502
        </ol></li>
503
        </ol>
504

    
505

    
506
<h3 >Tables</h3>
507

    
508

    
509
<pre>
510
|_.UserID      |_.Name          |_.Group     |_. attribute list   |
511
|Starting with | a              |   simple   |row                 |
512
|\3=.IT                                      |&lt;. align left       |
513
|1             |Artur Pirozhkov |/2.Users    |&gt;. align right      |
514
|2             |Vasya Rogov     |=. center   |
515
|3             |John Smith      |Admin
516
                                 (root)      |^. valign top       |
517
|4             |-               |Nobody
518
                                 (anonymous) |~. valign bottom    |
519
</pre>
520

    
521
        <p>displays (all multiple spaces are replaced by 1 space):</p>
522

    
523

    
524
        <table>
525
                <tr>
526
                        <th>UserID      </th>
527
                        <th>Name          </th>
528
                        <th>Group     </th>
529
                        <th>attribute list   </th>
530
                </tr>
531
                <tr>
532
                        <td>Starting with </td>
533
                        <td> a              </td>
534
                        <td>   simple   </td>
535
                        <td>row                 </td>
536
                </tr>
537
                <tr>
538
                        <td style="text-align:center;" colspan="3">IT                                      </td>
539
                        <td style="text-align:left;">align left       </td>
540
                </tr>
541
                <tr>
542
                        <td>1             </td>
543
                        <td>Artur Pirozhkov </td>
544
                        <td rowspan="2">Users    </td>
545
                        <td style="text-align:right;">align right      </td>
546
                </tr>
547
                <tr>
548
                        <td>2             </td>
549
                        <td>Vasya Rogov     </td>
550
                        <td style="text-align:center;">center   </td>
551
                </tr>
552
                <tr>
553
                        <td>3             </td>
554
                        <td>John Smith      </td>
555
                        <td>Admin<br />                                 (root)      </td>
556
                        <td style="vertical-align:top;">valign top       </td>
557
                </tr>
558
                <tr>
559
                        <td>4             </td>
560
                        <td>-               </td>
561
                        <td>Nobody<br />                                 (anonymous) </td>
562
                        <td style="vertical-align:bottom;">valign bottom    </td>
563
                </tr>
564
        </table>
565

    
566

    
567

    
568

    
569
        <p>If you want to include pipe characters inside your table (e.g. for Wiki links), you need to prevent textile from interpreting them:</p>
570

    
571

    
572
        <table>
573
                <tr>
574
                        <th>Input </th>
575
                        <th>Output</th>
576
                </tr>
577
                <tr>
578
                        <td><strong>&lt;notextile&gt;|&lt;/notextile&gt;</strong></td>
579
                        <td>|</td>
580
                </tr>
581
        </table>
582

    
583

    
584

    
585

    
586
<h3 >Table of content</h3>
587

    
588

    
589
<pre><code>{{toc}} =&gt; left aligned toc
590
{{&gt;toc}} =&gt; right aligned toc
591
</code></pre>
592

    
593
        <p>Please keep in mind, that the toc-tag needs an empty line above and underneath it and no other text before and after it.</p>
594

    
595

    
596
        <p>Example:</p>
597

    
598

    
599
<pre><code>
600
h1. headLineOne
601

    
602
h2. something
603

    
604
{{toc}}
605

    
606
h2. something more
607
</code></pre>
608

    
609
<h2 >Macros</h2>
610

    
611

    
612
        <p>Redmine includes a macros system that lets you add custom functions to insert dynamic content in formatted text. You can learn about writing your own macros in <a href="/projects/redmine/wiki/RedmineMacros" class="wiki-page">RedmineMacros</a>. Redmine also includes a few builtin macros:</p>
613

    
614

    
615
        <p><dl><dt><code>hello_world</code></dt><dd><p>Sample macro.</p></dd><dt><code>macro_list</code></dt><dd><p>Displays a list of all available macros, including description if available.</p></dd><dt><code>child_pages</code></dt><dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
616

    
617

    
618
        <pre><code>!{{child_pages}} -- can be used from a wiki page only
619
!{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd><dt><code>include</code></dt><dd><p>Include a wiki page. Example:</p>
620

    
621

    
622
        <pre><code>!{{include(Foo)}}</code></pre>
623

    
624

    
625
        <p>or to include a page of a specific project wiki:</p>
626

    
627

    
628
        <pre><code>!{{include(projectname:Foo)}}</code></pre></dd><dt><code>collapse</code></dt><dd><p>Inserts of collapsed block of text. Example:</p>
629

    
630

    
631
        <pre><code>{{collapse(View details...)
632
This is a block of text that is collapsed by default.
633
It can be expanded by clicking a link.
634
}}</code></pre></dd><dt><code>thumbnail</code></dt><dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
635

    
636

    
637
<pre>{{thumbnail(image.png)}}
638
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd><dt><code>sample_macro</code></dt><dd><p>Sample macro</p></dd></dl></p>
639

    
640

    
641
<h2 >Code highlighting</h2>
642

    
643

    
644
        <p>Code highlighting 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, C++, CSS, Delphi, Diff, Groovy, HTML, Java, Javascript, JSON, Nitro-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, XML and YAML code.</p>
645

    
646

    
647
        <p>You can highlight code in your wiki page using this syntax:</p>
648

    
649

    
650
<pre><code>&lt;pre&gt;&lt;code class="ruby"&gt;
651
  Place your code here.
652
&lt;/code&gt;&lt;/pre&gt;
653
</code></pre>
654

    
655
        <p>Example:</p>
656

    
657

    
658
<pre><code class="ruby syntaxhl"><span class="CodeRay"><span class="comment"># The Greeter class</span>
659
<span class="keyword">class</span> <span class="class">Greeter</span>
660
  <span class="keyword">def</span> <span class="function">initialize</span>(name)
661
    <span class="instance-variable">@name</span> = name.capitalize
662
  <span class="keyword">end</span>
663

    
664
  <span class="keyword">def</span> <span class="function">salute</span>
665
    puts <span class="string"><span class="delimiter">&quot;</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">&quot;</span></span> 
666
  <span class="keyword">end</span>
667
<span class="keyword">end</span>
668
</span></code></pre>
669
</body>
670
</html>