wiki_syntax_detailed_markdown.html

Hiroo Hayashi, 2016-07-23 17:44

Download (27 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 (Markdown)</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/RedmineTextFormattingMarkdown> first.  Then merge the change to this file.
38
See <http://www.redmine.org/issues/23413> for more details.
39
-->
40
<body>
41
<h1 >Markdown formatting</h1>
42

    
43

    
44
        <p>Below is <strong>Markdown</strong> formatting. For <strong>Textile</strong> formatting see <a href="/projects/redmine/wiki/RedmineTextFormattingTextile" class="wiki-page">Textile formatting</a>.<br />Currently HTML tags are not allowed by default. See <a href="/issues/15520" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520</a> and <a href="/issues/20497" class="issue tracker-2 status-1 priority-4 priority-default" title="Markdown formatting supporting HTML (New)">#20497</a> for details.  For other limitations of the current <strong>Markdown</strong> formatting see <a href="/issues/16373" class="issue tracker-2 status-5 priority-4 priority-default closed" title="TextFormatting help for Markdown formatting (Closed)">#16373</a> and <a href="/issues/21443" class="issue tracker-2 status-1 priority-4 priority-default" title="Links to resources in Markdown (New)">#21443</a>.</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
        <p>HTTP URLs are automatically turned into clickable links:</p>
212

    
213

    
214
        <ul>
215
        <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>
216
        </ul>
217

    
218

    
219
        <p>HTTP URLs can also use different text than the link itself:</p>
220

    
221

    
222
        <ul>
223
        <li><strong>&#91;Redmine web site&#93;(http&#58;//www.redmine.org)</strong> -- External link with different text: <a href="http://www.redmine.org" class="external">Redmine web site</a></li>
224
                <li><strong>&#91;!&#91;Redmine web site&#93;(http&#58;//www.redmine.org/attachments/7069/Redmine_logo.png)&#93;(<a class="external" href="http://www.redmine.org">http://www.redmine.org</a>)</strong> -- External image with a title that links to an URL:</li>
225
        </ul>
226

    
227

    
228
        <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>
229

    
230

    
231
<h3 >Email addresses</h3>
232

    
233

    
234
        <p>Email addresses are automatically turned into clickable links:</p>
235

    
236

    
237
        <ul>
238
        <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>
239
                <li><strong>&#91;Email someone&#93;(mailto&#58;someone&#64;foo.bar)</strong> -- Email link with different text: <a href="mailto:someone@foo.bar">Email someone</a></li>
240
        </ul>
241

    
242

    
243
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.
244
        <ul>
245
        <li><strong>&#91;Email webmaster and admin&#93;(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>
246
                <li><strong>&#91;Email someone for help&#93;(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>
247
                <li><strong>&#91;Email someone for help&#93;(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>
248
        </ul>
249

    
250

    
251
<h2 >Text formatting</h2>
252

    
253

    
254
        <p>For things such as headlines, bold, tables, lists, Redmine supports <a href="http://en.wikipedia.org/wiki/Markdown" class="external">Markdown syntax</a>.  See <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a>, <a class="external" href="http://agea.github.io/tutorial.md/">http://agea.github.io/tutorial.md/</a>, <a class="external" href="http://stackoverflow.com/editing-help">http://stackoverflow.com/editing-help</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. For conversions see <a href="http://pandoc.org" class="external">Pandoc</a>. The <a href="https://github.com/alminium/redmine_redcarpet_formatter" class="external">Redcarpet formatter</a> is used.</p>
255

    
256

    
257
<h3 >Acronym</h3>
258

    
259

    
260
        <p>Not supported by Markdown</p>
261

    
262

    
263
<h3 >Font style</h3>
264

    
265

    
266
<pre><code>* **bold** __bold__
267
* *italic* _italic_
268
* ***bold italic*** ___bold italic___
269
* &lt;ins&gt;underline&lt;/ins&gt;
270
* &lt;del&gt;strike through&lt;/del&gt;
271
* Plain &lt;sup&gt;superscript&lt;/sup&gt;
272
* Plain &lt;sub&gt;subscript&lt;/sub&gt;
273
* `inline monospace`
274
* normal **bold** _italic_ normal;E=mc&lt;sup&gt;2&lt;/sup&gt;
275
* 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;sup&gt;2&lt;/sup&gt;
276
* Escaping: \*\*bold\*\* \_italic\_ \`inlinemono\`
277
* &lt;pre&gt;**some lines**      some [link](http://www.redmine.org)&lt;/pre&gt;
278
* &lt;pre&gt;\*\*some lines\*\*      some \[link](http\://www\.redmine\.org)&lt;/pre&gt;<br /></code></pre>
279

    
280
        <p>displays:</p>
281

    
282

    
283
        <ul>
284
        <li><strong>bold</strong> <strong>bold</strong></li>
285
                <li><em>italic</em> <em>italic</em></li>
286
                <li><strong><em>bold italic</em></strong> <strong><em>bold italic</em></strong></li>
287
                <li><ins>underline</ins></li>
288
                <li><del>strike-through</del></li>
289
                <li>Plain <sup>superscript</sup></li>
290
                <li>Plain <sub>subscript</sub></li>
291
                <li><code>inline monospace</code></li>
292
                <li>normal <strong>bold</strong> <em>italic</em> normal;E=mc<sup>2</sup></li>
293
                <li>normal<strong>bold</strong><em>italic</em>normal;E=mc<sup>2</sup></li>
294
                <li>Escaping: *bold* _italic_ `inlinemono` </li>
295
                <li><pre><strong>some lines</strong>      some <a href="http://www.redmine.org" class="external">link</a></pre></li>
296
                <li><pre>**some lines**      some [link](http://www.redmine.org)</pre></li>
297
        </ul>
298

    
299

    
300
        <p><b>Note:</b> HTML tags need to be allowed to use the HTML tags (&lt;ins&gt;, &lt;del&gt;, &lt;sup&gt;, &lt;sub&gt;).  See <a href="/issues/15520#note-16" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-16</a> and <a href="/issues/15520#note-17" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-17</a> for details.</p>
301

    
302

    
303
<h3 >Color</h3>
304

    
305

    
306
<pre><code>* &lt;span style="color:red"&gt;red&lt;/span&gt; &lt;span style="color:green"&gt;green&lt;/span&gt; &lt;span style="color:yellow"&gt;yellow&lt;/span&gt; &lt;span style="color:#82B6E1"&gt;blue'ish&lt;/span&gt;
307
* &lt;span style="color:red"&gt;red&lt;/span&gt;&lt;span style="color:green"&gt;green&lt;/span&gt;&lt;span style="color:yellow"&gt;yellow&lt;/span&gt;&lt;span style="color:#82B6E1"&gt;blue'ish&lt;/span&gt;
308
* &lt;span style="background-color:lightgreen"&gt;Lightgreen Background&lt;/span&gt; &lt;span style="background-color:yellow"&gt;Yellow Background&lt;/span&gt;
309
* &lt;span style="background-color:lightgreen"&gt;Lightgreen Background&lt;/span&gt;&lt;span style="background-color:yellow"&gt;Yellow Background&lt;/span&gt;
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
        <p><b>Note:</b> HTML tags need to be allowed to use the HTML tag (&lt;span&gt;).  See <a href="/issues/15520#note-16" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-16</a> and <a href="/issues/15520#note-17" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-17</a> for details.</p>
324

    
325

    
326
<h3 >Inline images</h3>
327

    
328

    
329
        <ul>
330
        <li><strong>![](image_url)</strong> displays an image located at image_url (textile syntax)</li>
331
                <li><strong>![alt text](image_url "optional title")</strong> displays an image with an alt/title attribute</li>
332
                <li><strong>[![](image_url)](URL)</strong> displays an image located at image_url with link URL added</li>
333
        </ul>
334

    
335

    
336
        <p>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>![](attached_image.png)</strong>.</p>
337

    
338

    
339
        <p>As of this writing, Markdown has no syntax for specifying the dimensions of an image; if this is important to you, you can use regular HTML &lt;img&gt; tags.</p>
340

    
341

    
342
        <ul>
343
        <li>&lt;img style="float:right" src="URL"/&gt;</li>
344
                <li>&lt;img style="width:100%" src="attached_image.png"/&gt;</li>
345
        </ul>
346

    
347

    
348
        <p><b>Note:</b> HTML tags need to be allowed to use the HTML tag (&lt;img&gt;).  See <a href="/issues/15520#note-16" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-16</a> and <a href="/issues/15520#note-17" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-17</a> for details.</p>
349

    
350

    
351
<h3 >Headings</h3>
352

    
353

    
354
<pre><code># Heading
355

    
356
## Subheading
357

    
358
### Subheading
359

    
360
or
361

    
362
Heading
363
=======
364

    
365
Subheading
366
----------
367
</code></pre>
368

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

    
371

    
372
<h3 >Paragraphs</h3>
373

    
374

    
375
        <p>Markdown does not support alignment of a paragraph.  Use &lt;div> tags if you need it.</p>
376

    
377

    
378
<pre><code>left aligned
379
&lt;div style="padding-left:1em;"&gt;
380
left ident 1em
381
&lt;/div&gt;
382

    
383
&lt;div style="padding-left:2em;"&gt;
384
left ident 2em
385
as well as for following lines
386
&lt;/div&gt;
387

    
388
&lt;div style="text-align:right;"&gt;
389
right aligned
390
&lt;/div&gt;
391

    
392
&lt;div style="padding-right:3em;text-align:right;"&gt;
393
right ident 3em
394
&lt;/div&gt;
395

    
396
&lt;div style="text-align:center;"&gt;
397
This is centered paragraph.
398
&lt;/div&gt;</code></pre>
399

    
400
        <p>displays;</p>
401

    
402

    
403
        <p>left aligned</p>
404

    
405

    
406
        <p style="padding-left:1em;">left ident 1em</p>
407

    
408

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

    
411

    
412
        <p style="text-align:right;">right aligned</p>
413

    
414

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

    
417

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

    
420

    
421
        <p><b>Note:</b> HTML tags need to be allowed to use the HTML tags (&lt;div&gt;).  See <a href="/issues/15520#note-16" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-16</a> and <a href="/issues/15520#note-17" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-17</a> for details.</p>
422

    
423

    
424
<h3 >Horizontal rule</h3>
425

    
426

    
427
        <p><code>----</code></p>
428

    
429

    
430
        <p>displays:</p>
431

    
432

    
433
<hr />
434

    
435

    
436
<h3 >Preformatted Text</h3>
437

    
438

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

    
441
        <p>displays:</p>
442

    
443

    
444
<pre>**Your text won't become bold**</pre>
445

    
446
<h3 >Blockquotes</h3>
447

    
448

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

    
451

    
452
<pre>
453
&gt;&gt; Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
454
&gt;&gt; To go live, all you need to add is a database and a web server.
455
&gt; Great!
456
</pre>
457

    
458
        <p>displays:</p>
459

    
460

    
461
<blockquote><blockquote>
462

    
463
        <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>
464

    
465

    
466
</blockquote>
467

    
468
        <p>Great!</p>
469

    
470

    
471
</blockquote>
472

    
473
<h3 >Unordered lists</h3>
474

    
475

    
476
        <p>Unordered lists use asterisks (<code>*</code>), pluses (<code>+</code>), and hyphens (<code>-</code>) as list markers</p>
477

    
478

    
479
<pre>
480
* Item 1
481
* Item 2
482
  * Item 21 (two spaces indentation)
483
  * Item 22
484
* Item 3
485
</pre>
486

    
487
        <p>displays:</p>
488

    
489

    
490
        <ul>
491
        <li>Item 1</li>
492
                <li>Item 2
493
        <ul>
494
        <li>Item 21</li>
495
                <li>Item 22</li>
496
        </ul>
497
        </li>
498
                <li>Item 3</li>
499
        </ul>
500

    
501

    
502
<h3 >Ordered lists</h3>
503

    
504

    
505
        <p>Ordered lists use numbers followed by periods.</p>
506

    
507

    
508
<pre>
509
1. Item 1
510
3. Item 2
511
2. Item 3
512
  1. Item 3.1 (two spaces)
513
  1. Item 3.2
514
</pre>
515

    
516
        <p>displays:</p>
517

    
518

    
519
        <ol>
520
        <li>Item 1</li>
521
                <li>Item 2</li>
522
                <li>Item 3
523
        <ol>
524
        <li>Item 3.1</li>
525
                <li>Item 3.2</li>
526
        </ol></li>
527
        </ol>
528

    
529

    
530
        <p>Note that the actual numbers you use to mark the list have no effect on the output.</p>
531

    
532

    
533
<h3 >Tables</h3>
534

    
535

    
536
        <p>Markdown does not have syntax for a table. Use an HTML table to write a table.</p>
537

    
538

    
539
<pre><code>&lt;table&gt;
540
  &lt;tr&gt;&lt;td style="text-align:center;"&gt;&lt;strong&gt;UserID&lt;/strong&gt;&lt;/td&gt;&lt;td style="text-align:center;"&gt;&lt;strong&gt;Name&lt;/strong&gt;&lt;/td&gt;&lt;td style="text-align:center;"&gt;&lt;strong&gt;Group&lt;/strong&gt;&lt;/td&gt;&lt;td style="text-align:center;"&gt;&lt;strong&gt;attribute list&lt;/strong&gt;&lt;/td&gt;&lt;/tr&gt;
541
  &lt;tr&gt;&lt;td&gt;Starting with&lt;/td&gt;&lt;td&gt;a&lt;/td&gt;&lt;td&gt;simple&lt;/td&gt;&lt;td&gt;row&lt;/td&gt;&lt;/tr&gt;
542
  &lt;tr&gt;&lt;td style="text-align:center;" colspan="3"&gt;IT&lt;/td&gt;&lt;td&gt;align left&lt;/td&gt;&lt;/tr&gt;
543
  &lt;tr&gt;&lt;td&gt;1&lt;/td&gt;&lt;td&gt;Artur Pirozhkov&lt;/td&gt;&lt;td rowspan="2"&gt;Users&lt;/td&gt;&lt;td style="text-align:right;"&gt;align right&lt;/td&gt;&lt;/tr&gt;
544
  &lt;tr&gt;&lt;td&gt;2&lt;/td&gt;&lt;td&gt;Vasya Rogov&lt;/td&gt;&lt;td style="text-align:center;"&gt;center&lt;/td&gt;&lt;/tr&gt;
545
  &lt;tr&gt;&lt;td rowspan="2"&gt;3&lt;/td&gt;&lt;td rowspan="2"&gt;John Smith&lt;/td&gt;&lt;td&gt;Admin&lt;/td&gt;&lt;td style="vertical-align:top;" rowspan="2"&gt;valign top&lt;/td&gt;&lt;/tr&gt;
546
  &lt;tr&gt;&lt;td&gt;(root)&lt;/td&gt;&lt;/tr&gt;
547
  &lt;tr&gt;&lt;td rowspan="2"&gt;4&lt;/td&gt;&lt;td rowspan="2"&gt;-&lt;/td&gt;&lt;td&gt;Nobody&lt;/td&gt;&lt;td style="vertical-align:bottom;" rowspan="2"&gt;valign bottom&lt;/td&gt;&lt;/tr&gt;
548
  &lt;tr&gt;&lt;td&gt;(anonymous)&lt;/td&gt;&lt;/tr&gt;
549
&lt;/table&gt;
550
</code></pre>
551

    
552
        <p>displays;</p>
553

    
554

    
555
        <table>
556
                <tr>
557
                        <td style="text-align:center;"><strong>UserID</strong>   </td>
558
                        <td style="text-align:center;"><strong>Name</strong>       </td>
559
                        <td style="text-align:center;"><strong>Group</strong>  </td>
560
                        <td style="text-align:center;"><strong>attribute list</strong> </td>
561
                </tr>
562
                <tr>
563
                        <td>Starting with </td>
564
                        <td> a              </td>
565
                        <td>   simple   </td>
566
                        <td>row                 </td>
567
                </tr>
568
                <tr>
569
                        <td style="text-align:center;" colspan="3">IT                                      </td>
570
                        <td style="text-align:left;">align left       </td>
571
                </tr>
572
                <tr>
573
                        <td>1             </td>
574
                        <td>Artur Pirozhkov </td>
575
                        <td rowspan="2">Users    </td>
576
                        <td style="text-align:right;">align right      </td>
577
                </tr>
578
                <tr>
579
                        <td>2             </td>
580
                        <td>Vasya Rogov     </td>
581
                        <td style="text-align:center;">center   </td>
582
                </tr>
583
                <tr>
584
                        <td>3             </td>
585
                        <td>John Smith      </td>
586
                        <td>Admin<br />                                 (root)      </td>
587
                        <td style="vertical-align:top;">valign top       </td>
588
                </tr>
589
                <tr>
590
                        <td>4             </td>
591
                        <td>-               </td>
592
                        <td>Nobody<br />                                 (anonymous) </td>
593
                        <td style="vertical-align:bottom;">valign bottom    </td>
594
                </tr>
595
        </table>
596

    
597

    
598

    
599

    
600
        <p><b>Note:</b> HTML tags need to be allowed to use the HTML tags (&lt;table&gt;, &lt;tr&gt;, &lt;td&gt;).  See <a href="/issues/15520#note-16" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-16</a> and <a href="/issues/15520#note-17" class="issue tracker-2 status-5 priority-4 priority-default closed" title="Markdown formatting (Closed)">#15520-17</a> for details.</p>
601

    
602

    
603
<h3 >Table of content</h3>
604

    
605

    
606
<pre><code>{{toc}} =&gt; left aligned toc
607
{{&gt;toc}} =&gt; right aligned toc
608
</code></pre>
609

    
610
        <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>
611

    
612

    
613
        <p>Example:</p>
614

    
615

    
616
<pre><code>h1. headLineOne
617

    
618
h2. something
619

    
620
{{toc}}
621

    
622
h2. something more
623
</code></pre>
624

    
625
<h2 >Macros</h2>
626

    
627

    
628
        <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>
629

    
630

    
631
        <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>
632

    
633

    
634
        <pre><code>!{{child_pages}} -- can be used from a wiki page only
635
!{{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>
636

    
637

    
638
        <pre><code>!{{include(Foo)}}</code></pre>
639

    
640

    
641
        <p>or to include a page of a specific project wiki:</p>
642

    
643

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

    
646

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

    
652

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

    
656

    
657
<h2 >Code highlighting</h2>
658

    
659

    
660
        <p>Code highlighting relies on <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, a <br />fast syntax highlighting library written completely in Ruby. It <br />currently supports C, C++, CSS, Delphi, Diff, Groovy, HTML, Java, <br />Javascript, JSON, Nitro-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, <br />XML and YAML code.</p>
661

    
662

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

    
665

    
666
<pre><code>``` ruby
667
Place your code here.
668
```</code></pre>
669

    
670
        <p>Example:</p>
671

    
672

    
673
<pre><code class="ruby syntaxhl"><span class="CodeRay"><span class="comment"># The Greeter class</span>
674
<span class="keyword">class</span> <span class="class">Greeter</span>
675
  <span class="keyword">def</span> <span class="function">initialize</span>(name)
676
    <span class="instance-variable">@name</span> = name.capitalize
677
  <span class="keyword">end</span>
678

    
679
  <span class="keyword">def</span> <span class="function">salute</span>
680
    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> 
681
  <span class="keyword">end</span>
682
<span class="keyword">end</span>
683
</span></code></pre>
684
</body>
685
</html>