##// END OF EJS Templates
jro_apps » redmine
RSS
add English markdown wiki syntax help (#16373)...
Toshi MARUYAMA -
r13807:a5b40dc4a738
parent child
Show More
Side by Side Unified
Context file:
r13807:a5b40dc4a738 Loading diff...:
Show file before | Show file after | Hide comments
@@ -0,0 +1,329
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 #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 (Markdown)</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 resources (issues, changesets, 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 an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
51 </ul>
52
53 <p>Wiki links:</p>
54
55 <ul>
56 <li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
57 <li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
58 <li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
59 </ul>
60
61 <p>You can also link to pages of an other project wiki:</p>
62
63 <ul>
64 <li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
65 <li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
66 </ul>
67
68 <p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
69
70 <p>Links to other resources:</p>
71
72 <ul>
73 <li>Documents:
74 <ul>
75 <li><strong>document#17</strong> (link to document with id 17)</li>
76 <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
77 <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
78 <li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
79 </ul>
80 </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>
91 </li>
92 </ul>
93
94 <ul>
95 <li>Attachments:
96 <ul>
97 <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
98 <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>
99 </ul>
100 </li>
101 </ul>
102
103 <ul>
104 <li>Changesets:
105 <ul>
106 <li><strong>r758</strong> (link to a changeset)</li>
107 <li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
108 <li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
109 <li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
110 <li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
111 <li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
112 </ul>
113 </li>
114 </ul>
115
116 <ul>
117 <li>Repository files:
118 <ul>
119 <li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
120 <li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
121 <li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
122 <li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
123 <li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
124 <li><strong>export:some/file</strong> (force the download of the file)</li>
125 <li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
126 <li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
127 <li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
128 </ul>
129 </li>
130 </ul>
131
132 <ul>
133 <li>Forums:
134 <ul>
135 <li><strong>forum#1</strong> (link to forum with id 1</li>
136 <li><strong>forum:Support</strong> (link to forum named Support)</li>
137 <li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
138 </ul>
139 </li>
140 </ul>
141
142 <ul>
143 <li>Forum messages:
144 <ul>
145 <li><strong>message#1218</strong> (link to message with id 1218)</li>
146 </ul>
147 </li>
148 </ul>
149
150 <ul>
151 <li>Projects:
152 <ul>
153 <li><strong>project#3</strong> (link to project with id 3)</li>
154 <li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
155 <li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
156 </ul>
157 </li>
158 </ul>
159
160 <ul>
161 <li>News:
162 <ul>
163 <li><strong>news#2</strong> (link to news item with id 2)</li>
164 <li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
165 <li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
166 </ul>
167 </li>
168 </ul>
169
170 <p>Escaping:</p>
171
172 <ul>
173 <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
174 </ul>
175
176
177 <h3><a name="4" class="wiki-page"></a>External links</h3>
178
179 <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
180
181 <pre>
182 http://www.redmine.org, someone@foo.bar
183 </pre>
184
185 <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>
186
187 <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
188
189 <pre>
190 [Redmine web site](http://www.redmine.org)
191 </pre>
192
193 <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
194
195
196 <h2><a name="5" class="wiki-page"></a>Text formatting</h2>
197
198
199 <p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
200
201 <h3><a name="6" class="wiki-page"></a>Font style</h3>
202
203 <pre>
204 * **bold**
205 * *Italic*
206 * ***bold italic***
207 * ~~strike-through~~
208 </pre>
209
210 <p>Display:</p>
211
212 <ul>
213 <li><strong>bold</strong></li>
214 <li><em>italic</em></li>
215 <li><em><strong>bold italic</strong></em></li>
216 <li><del>strike-through</del></li>
217 </ul>
218
219 <h3><a name="7" class="wiki-page"></a>Inline images</h3>
220
221 <ul>
222 <li><strong>![](image_url)</strong> displays an image located at image_url (textile syntax)</li>
223 <li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>![](attached_image)</strong></li>
224 </ul>
225
226 <h3><a name="8" class="wiki-page"></a>Headings</h3>
227
228 <pre>
229 # Heading
230 ## Subheading
231 ### Subsubheading
232 </pre>
233
234 <p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
235
236
237 <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
238
239 <p>Start the paragraph with <strong>&gt;</strong></p>
240
241 <pre>
242 &gt; Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
243 To go live, all you need to add is a database and a web server.
244 </pre>
245
246 <p>Display:</p>
247
248 <blockquote>
249 <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>
250 </blockquote>
251
252
253 <h3><a name="11" class="wiki-page"></a>Table of content</h3>
254
255 <pre>
256 {{toc}} =&gt; left aligned toc
257 {{&gt;toc}} =&gt; right aligned toc
258 </pre>
259
260 <h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
261
262 <pre>
263 ---
264 </pre>
265
266 <h2><a name="12" class="wiki-page"></a>Macros</h2>
267
268 <p>Redmine has the following builtin macros:</p>
269
270 <p>
271 <dl>
272 <dt><code>hello_world</code></dt>
273 <dd><p>Sample macro.</p></dd>
274
275 <dt><code>macro_list</code></dt>
276 <dd><p>Displays a list of all available macros, including description if available.</p></dd>
277
278 <dt><code>child_pages</code></dt>
279 <dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
280 <pre><code>{{child_pages}} -- can be used from a wiki page only
281 {{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
282
283 <dt><code>include</code></dt>
284 <dd><p>Include a wiki page. Example:</p>
285 <pre><code>{{include(Foo)}}</code></pre>
286 <p>or to include a page of a specific project wiki:</p>
287 <pre><code>{{include(projectname:Foo)}}</code></pre></dd>
288
289 <dt><code>collapse</code></dt>
290 <dd><p>Inserts of collapsed block of text. Example:</p>
291 <pre><code>{{collapse(View details...)
292 This is a block of text that is collapsed by default.
293 It can be expanded by clicking a link.
294 }}</code></pre></dd>
295
296 <dt><code>thumbnail</code></dt>
297 <dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
298 <pre>{{thumbnail(image.png)}}
299 {{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
300 </dl>
301 </p>
302
303 <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
304
305 <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>
306
307 <p>You can highlight code in your wiki page using this syntax:</p>
308
309 <pre>
310 ~~~ ruby
311 Place your code here.
312 ~~~
313 </pre>
314
315 <p>Example:</p>
316
317 <pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
318 <span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
319 <span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
320 <span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
321 <span class="line-numbers"> 5</span> <span class="reserved">end</span>
322 <span class="line-numbers"> 6</span>
323 <span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
324 <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>
325 <span class="line-numbers"> 9</span> <span class="reserved">end</span>
326 <span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
327 </pre>
328 </body>
329 </html>
Show file before | Show file after | Hide comments
@@ -0,0 +1,82
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <meta http-equiv="Content-Style-Type" content="text/css" />
6 <title>Wiki formatting</title>
7 <style type="text/css">
8 h1 { font-family: Verdana, sans-serif; font-size: 14px; text-align: center; color: #444; }
9 body { font-family: Verdana, sans-serif; font-size: 12px; color: #444; }
10 table th { padding-top: 1em; }
11 table td { vertical-align: top; background-color: #f5f5f5; height: 2em; vertical-align: middle;}
12 table td code { font-size: 1.2em; }
13 table td h1 { font-size: 1.8em; text-align: left; }
14 table td h2 { font-size: 1.4em; text-align: left; }
15 table td h3 { font-size: 1.2em; text-align: left; }
16
17 table.sample { border-collapse: collapse; border-spacing: 0; margin: 4px; }
18 table.sample th, table.sample td { border: solid 1px #bbb; padding: 4px; height: 1em; }
19 </style>
20 </head>
21 <body>
22
23 <h1>Wiki Syntax Quick Reference (Markdown)</h1>
24
25 <table style="width:100%">
26 <tr><th colspan="3">Font Styles</th></tr>
27 <tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td style="width:50%;">**Strong**</td><td style="width:50%;"><strong>Strong</strong></td></tr>
28 <tr><th><img src="../../images/jstoolbar/bt_em.png" style="border: 1px solid #bbb;" alt="Italic" /></th><td>*Italic*</td><td><em>Italic</em></td></tr>
29 <tr><th><img src="../../images/jstoolbar/bt_del.png" style="border: 1px solid #bbb;" alt="Deleted" /></th><td>~~Deleted~~</td><td><del>Deleted</del></td></tr>
30 <tr><th><img src="../../images/jstoolbar/bt_code.png" style="border: 1px solid #bbb;" alt="Inline Code" /></th><td>`Inline Code`</td><td><code>Inline Code</code></td></tr>
31 <tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>~~~<br />&nbsp;lines<br />&nbsp;of code<br />~~~</td><td>
32 <pre>
33 lines
34 of code
35 </pre>
36 </td></tr>
37
38 <tr><th colspan="3">Lists</th></tr>
39 <tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />&nbsp;&nbsp;* Sub<br />* Item 2</td><td><ul><li>Item 1<ul><li>Sub</li></ul></li><li>Item 2</li></ul></td></tr>
40 <tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td>1. Item 1<br />&nbsp;&nbsp;&nbsp;1. Sub<br />2. Item 2</td><td><ol><li>Item 1<ol><li>Sub</li></ol></li><li>Item 2</li></ol></td></tr>
41
42 <tr><th colspan="3">Headings</th></tr>
43 <tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td># Title 1</td><td><h1>Title 1</h1></td></tr>
44 <tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>## Title 2</td><td><h2>Title 2</h2></td></tr>
45 <tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>### Title 3</td><td><h3>Title 3</h3></td></tr>
46
47 <tr><th colspan="3">Links</th></tr>
48 <tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
49 <tr><th></th><td>[Foo](http://foo.bar)</td><td><a href="#">Foo</a></td></tr>
50
51 <tr><th colspan="3">Redmine links</th></tr>
52 <tr><th><img src="../../images/jstoolbar/bt_link.png" style="border: 1px solid #bbb;" alt="Link to a Wiki page" /></th><td>[[Wiki page]]</td><td><a href="#">Wiki page</a></td></tr>
53 <tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
54 <tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
55 <tr><th></th><td>commit:f30e13e43</td><td><a href="#">f30e13e4</a></td></tr>
56 <tr><th></th><td>source:some/file</td><td><a href="#">source:some/file</a></td></tr>
57
58 <tr><th colspan="3">Inline images</th></tr>
59 <tr><th><img src="../../images/jstoolbar/bt_img.png" style="border: 1px solid #bbb;" alt="Image" /></th><td>![](<em>image_url</em>)</td><td></td></tr>
60 <tr><th></th><td>![](<em>attached_image</em>)</td><td></td></tr>
61
62 <tr><th colspan="3">Tables</th></tr>
63 <tr>
64 <th></th>
65 <td>| A | B | C |<br />|---|---|---|<br />| A | B | C |<br />| D | E | F |</td>
66 <td>
67 <table class="sample">
68 <tbody>
69 <th>A</th><th>B</th><th>C</th>
70 <tr><td>A</td><td>B</td><td>C</td></tr>
71 <tr><td>D</td><td>E</td><td>F</td></tr>
72 </tbody>
73 </table>
74 </td>
75 </tr>
76
77 </table>
78
79 <p><a href="wiki_syntax_detailed_markdown.html" onclick="window.open('wiki_syntax_detailed_markdown.html', '', ''); return false;">More Information</a></p>
80
81 </body>
82 </html>
General Comments 0
You need to be logged in to leave comments. Login now