##// END OF EJS Templates
jro_apps » redmine
RSS
Added links to repository files in wiki syntax help....
Jean-Philippe Lang -
r1272:5f78b8a9a0f3
parent child
Show More
Side by Side Unified
Context file:
r1272:5f78b8a9a0f3 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,65 +1,66
1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 3 <head>
4 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 5 <meta http-equiv="Content-Style-Type" content="text/css" />
6 6 <title>Wiki formatting</title>
7 7 <style type="text/css">
8 8 h1 { font-family: Verdana, sans-serif; font-size: 14px; text-align: center; color: #444; }
9 9 body { font-family: Verdana, sans-serif; font-size: 12px; color: #444; }
10 10 table th { padding-top: 1em; }
11 11 table td { vertical-align: top; background-color: #f5f5f5; height: 2em; vertical-align: middle;}
12 12 table td code { font-size: 1.2em; }
13 13 table td h1 { font-size: 1.8em; text-align: left; }
14 14 table td h2 { font-size: 1.4em; text-align: left; }
15 15 table td h3 { font-size: 1.2em; text-align: left; }
16 16
17 17 </style>
18 18 </head>
19 19 <body>
20 20
21 21 <h1>Wiki Syntax Quick Reference</h1>
22 22
23 23 <table width="100%">
24 24 <tr><th colspan="3">Font Styles</th></tr>
25 25 <tr><th><img src="../../images/jstoolbar/bt_strong.png" style="border: 1px solid #bbb;" alt="Strong" /></th><td width="50%">*Strong*</td><td width="50%"><strong>Strong</strong></td></tr>
26 26 <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>
27 27 <tr><th><img src="../../images/jstoolbar/bt_ins.png" style="border: 1px solid #bbb;" alt="Underline" /></th><td>+Underline+</td><td><ins>Underline</ins></td></tr>
28 28 <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>
29 29 <tr><th></th><td>??Quote??</td><td><cite>Quote</cite></td></tr>
30 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 31 <tr><th><img src="../../images/jstoolbar/bt_pre.png" style="border: 1px solid #bbb;" alt="Preformatted text" /></th><td>&lt;pre><br />&nbsp;lines<br />&nbsp;of code<br />&lt;/pre></td><td>
32 32 <pre>
33 33 lines
34 34 of code
35 35 </pre>
36 36 </td></tr>
37 37
38 38 <tr><th colspan="3">Lists</th></tr>
39 39 <tr><th><img src="../../images/jstoolbar/bt_ul.png" style="border: 1px solid #bbb;" alt="Unordered list" /></th><td>* Item 1<br />* Item 2</td><td><ul><li>Item 1</li><li>Item 2</li></ul></td></tr>
40 40 <tr><th><img src="../../images/jstoolbar/bt_ol.png" style="border: 1px solid #bbb;" alt="Ordered list" /></th><td># Item 1<br /># Item 2</td><td><ol><li>Item 1</li><li>Item 2</li></ol></td></tr>
41 41
42 42 <tr><th colspan="3">Headings</th></tr>
43 43 <tr><th><img src="../../images/jstoolbar/bt_h1.png" style="border: 1px solid #bbb;" alt="Heading 1" /></th><td>h1. Title 1</td><td><h1>Title 1</h1></td></tr>
44 44 <tr><th><img src="../../images/jstoolbar/bt_h2.png" style="border: 1px solid #bbb;" alt="Heading 2" /></th><td>h2. Title 2</td><td><h2>Title 2</h2></td></tr>
45 45 <tr><th><img src="../../images/jstoolbar/bt_h3.png" style="border: 1px solid #bbb;" alt="Heading 3" /></th><td>h3. Title 3</td><td><h3>Title 3</h3></td></tr>
46 46
47 47 <tr><th colspan="3">Links</th></tr>
48 48 <tr><th></th><td>http://foo.bar</td><td><a href="#">http://foo.bar</a></td></tr>
49 49 <tr><th></th><td>"Foo":http://foo.bar</td><td><a href="#">Foo</a></td></tr>
50 50
51 51 <tr><th colspan="3">Redmine links</th></tr>
52 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 53 <tr><th></th><td>Issue #12</td><td>Issue <a href="#">#12</a></td></tr>
54 54 <tr><th></th><td>Revision r43</td><td>Revision <a href="#">r43</a></td></tr>
55 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>
56 57
57 58 <tr><th colspan="3">Inline images</th></tr>
58 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>
59 60 <tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
60 61 </table>
61 62
62 63 <p><a href="wiki_syntax_detailed.html" onclick="window.open('wiki_syntax_detailed.html', '', ''); return false;">More Information</a></p>
63 64
64 65 </body>
65 66 </html>
Show file before | Show file after | Hide comments
@@ -1,241 +1,352
1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2 2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
3 3 <head>
4 4 <title>RedmineWikiFormatting</title>
5 5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6 <style>
6 <style type="text/css">
7 7 body { font:80% Verdana,Tahoma,Arial,sans-serif; }
8 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 .af { color:#00C }
22 .CodeRay .an { color:#007 }
23 .CodeRay .av { color:#700 }
24 .CodeRay .aw { color:#C00 }
25 .CodeRay .bi { color:#509; font-weight:bold }
26 .CodeRay .c { color:#666; }
27
28 .CodeRay .ch { color:#04D }
29 .CodeRay .ch .k { color:#04D }
30 .CodeRay .ch .dl { color:#039 }
31
32 .CodeRay .cl { color:#B06; font-weight:bold }
33 .CodeRay .co { color:#036; font-weight:bold }
34 .CodeRay .cr { color:#0A0 }
35 .CodeRay .cv { color:#369 }
36 .CodeRay .df { color:#099; font-weight:bold }
37 .CodeRay .di { color:#088; font-weight:bold }
38 .CodeRay .dl { color:black }
39 .CodeRay .do { color:#970 }
40 .CodeRay .ds { color:#D42; font-weight:bold }
41 .CodeRay .e { color:#666; font-weight:bold }
42 .CodeRay .en { color:#800; font-weight:bold }
43 .CodeRay .er { color:#F00; background-color:#FAA }
44 .CodeRay .ex { color:#F00; font-weight:bold }
45 .CodeRay .fl { color:#60E; font-weight:bold }
46 .CodeRay .fu { color:#06B; font-weight:bold }
47 .CodeRay .gv { color:#d70; font-weight:bold }
48 .CodeRay .hx { color:#058; font-weight:bold }
49 .CodeRay .i { color:#00D; font-weight:bold }
50 .CodeRay .ic { color:#B44; font-weight:bold }
51
52 .CodeRay .il { background: #eee }
53 .CodeRay .il .il { background: #ddd }
54 .CodeRay .il .il .il { background: #ccc }
55 .CodeRay .il .idl { font-weight: bold; color: #888 }
56
57 .CodeRay .in { color:#B2B; font-weight:bold }
58 .CodeRay .iv { color:#33B }
59 .CodeRay .la { color:#970; font-weight:bold }
60 .CodeRay .lv { color:#963 }
61 .CodeRay .oc { color:#40E; font-weight:bold }
62 .CodeRay .of { color:#000; font-weight:bold }
63 .CodeRay .op { }
64 .CodeRay .pc { color:#038; font-weight:bold }
65 .CodeRay .pd { color:#369; font-weight:bold }
66 .CodeRay .pp { color:#579 }
67 .CodeRay .pt { color:#339; font-weight:bold }
68 .CodeRay .r { color:#080; font-weight:bold }
69
70 .CodeRay .rx { background-color:#fff0ff }
71 .CodeRay .rx .k { color:#808 }
72 .CodeRay .rx .dl { color:#404 }
73 .CodeRay .rx .mod { color:#C2C }
74 .CodeRay .rx .fu { color:#404; font-weight: bold }
75
76 .CodeRay .s { background-color:#fff0f0 }
77 .CodeRay .s .s { background-color:#ffe0e0 }
78 .CodeRay .s .s .s { background-color:#ffd0d0 }
79 .CodeRay .s .k { color:#D20 }
80 .CodeRay .s .dl { color:#710 }
81
82 .CodeRay .sh { background-color:#f0fff0 }
83 .CodeRay .sh .k { color:#2B2 }
84 .CodeRay .sh .dl { color:#161 }
85
86 .CodeRay .sy { color:#A60 }
87 .CodeRay .sy .k { color:#A60 }
88 .CodeRay .sy .dl { color:#630 }
89
90 .CodeRay .ta { color:#070 }
91 .CodeRay .tf { color:#070; font-weight:bold }
92 .CodeRay .ts { color:#D70; font-weight:bold }
93 .CodeRay .ty { color:#339; font-weight:bold }
94 .CodeRay .v { color:#036 }
95 .CodeRay .xt { color:#444 }
9 96 </style>
10 97 </head>
98
11 99 <body>
12 100 <h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
13 101
14 102
15 103
16 104 <h2><a name="2" class="wiki-page"></a>Links</h2>
17 105
18 106
19 107 <h3><a name="3" class="wiki-page"></a>Redmine links</h3>
20 108
21 109
22 110 <p>Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.</p>
23 111
24 112
25 113 <ul>
26 114 <li>Link to an issue: <strong>#124</strong> (displays <del><a href="/issues/show/124" 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>
27 115 <li>Link to a changeset: <strong>r758</strong> (displays <a href="/repositories/revision/1?rev=758" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>
28 116 <li>Link to a changeset with a non-numeric hash: <strong>commit:"c6f4d0fd"</strong> (displays c6f4d0fd). Added in <a href="/repositories/revision/1?rev=1236" class="changeset" title="Merged Git support branch (r1200 to r1226).">r1236</a>.</li>
29 117 </ul>
30 118
31 119
32 120 <p>Wiki links:</p>
33 121
34 122
35 123 <ul>
36 124 <li><strong>&#91;&#91;Guide&#93;&#93;</strong> displays a link to the page named 'Guide': <a href="Guide.html" class="wiki-page">Guide</a></li>
37 125 <li><strong>&#91;&#91;Guide|User manual&#93;&#93;</strong> displays a link to the same page but with a different text: <a href="Guide.html" class="wiki-page">User manual</a></li>
38 126 </ul>
39 127
40 128
41 129 <p>You can also link to pages of an other project wiki:</p>
42 130
43 131
44 132 <ul>
45 133 <li><strong>&#91;&#91;sandbox:some page&#93;&#93;</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
46 134 <li><strong>&#91;&#91;sandbox:&#93;&#93;</strong> displays a link to the Sandbox wiki main page</li>
47 135 </ul>
48 136
49 137
50 138 <p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="Nonexistent_page.html" class="wiki-page new">Nonexistent page</a>.</p>
51 139
52 140
53 <p>Links to others resources (0.6.devel.1064 and above):</p>
141 <p>Links to others resources (0.7):</p>
54 142
55 143
56 144 <ul>
57 145 <li>Documents:
58 146
59 147 <ul>
60 148 <li><strong>document#17</strong> (link to document with id 17)</li>
61 149 <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
62 150 <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
63 151 </ul></li>
64 152 </ul>
65 153
66 154
67 155 <ul>
68 156 <li>Versions:
69 157
70 158 <ul>
71 159 <li><strong>version#3</strong> (link to version with id 3)</li>
72 160 <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
73 161 <li><strong>version:"1.0 beta 2"</strong></li>
74 162 </ul></li>
75 163 </ul>
76 164
77 165
78 166 <ul>
79 167 <li>Attachments:
80 168
81 169 <ul>
82 170 <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
83 171 <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>
84 172 </ul></li>
85 173 </ul>
86 174
87 175
88 <p>Escaping (0.6.devel.1064 and above):</p>
176 <ul>
177 <li>Repository files
178
179 <ul>
180 <li><strong>source:some/file</strong> -- Link to the file located at /some/file in the project's repository</li>
181 <li><strong>source:some/file@52</strong> -- Link to the file's revision 52</li>
182
183 <li><strong>source:some/file#L120</strong> -- Link to line 120 of the file</li>
184 <li><strong>source:some/file@52#L120</strong> -- Link to line 120 of the file's revision 52</li>
185 <li><strong>export:some/file</strong> -- Force the download of the file</li>
186 </ul></li>
187
188 </ul>
189
190
191
192 <p>Escaping (0.7):</p>
89 193
90 194
91 195 <ul>
92 196 <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
93 197 </ul>
94 198
95 199
96 200 <h3><a name="4" class="wiki-page"></a>External links</h3>
97 201
98 202
99 203 <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
100 204
101 205
102 206 <pre>
103 207 http://www.redmine.org, someone@foo.bar
104 208 </pre>
105 209
106 210 <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>
107 211
108 212
109 213 <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
110 214
111 215
112 216 <pre>
113 217 "Redmine web site":http://www.redmine.org
114 218 </pre>
115 219
116 220 <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
117 221
118 222
119 223 <h2><a name="5" class="wiki-page"></a>Text formatting</h2>
120 224
121 225
122 226 <p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://hobix.com/textile/">http://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>
123 227
124 228
125 229 <h3><a name="6" class="wiki-page"></a>Font style</h3>
126 230
127 231
128 <pre><code>* *bold*
232 <pre>
233 * *bold*
129 234 * _italic_
130 235 * _*bold italic*_
131 236 * +underline+
132 237 * -strike-through-
133 &lt;/code></pre>
238 </pre>
134 239
135 240 <p>Display:</p>
136 241
137 242
138 243 <ul>
139 244 <li><strong>bold</strong></li>
140 245 <li><em>italic</em></li>
141 246 <li><em>*bold italic*</em></li>
142 247 <li><ins>underline</ins></li>
143 248 <li><del>strike-through</del></li>
144 249 </ul>
145 250
146 251
147 252 <h3><a name="7" class="wiki-page"></a>Inline images</h3>
148 253
149 254
150 255 <ul>
151 256 <li><strong>&#33;image_url&#33;</strong> displays an image located at image_url (textile syntax)</li>
152 257 <li><strong>&#33;>image_url&#33;</strong> right floating image</li>
153 258 <li>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></li>
154 259 </ul>
155 260
156 261
157 262 <h3><a name="8" class="wiki-page"></a>Headings</h3>
158 263
159 264
160 <pre><code>h1. Heading
265 <pre>
266 h1. Heading
161 267 h2. Subheading
162 268 h3. Subheading
163 &lt;/code></pre>
269 </pre>
164 270
165 271 <h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
166 272
167 273
168 <pre><code>p&gt;. right aligned
274 <pre>
275 p&gt;. right aligned
169 276 p=. centered
170 &lt;/code></pre>
277 </pre>
171 278
172 279 <p style="text-align:center;">This is centered paragraph.</p>
173 280
174 281
175 282 <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
176 283
177 284
178 285 <p>Start the paragraph with <strong>bq.</strong></p>
179 286
180 287
181 <pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
288 <pre>
289 bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
182 290 To go live, all you need to add is a database and a web server.
183 &lt;/code></pre>
291 </pre>
184 292
185 293 <p>Display:</p>
186 294
187 295
188 296 <blockquote>
189 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>
190 298 </blockquote>
191 299
192 300
193 301 <h3><a name="11" class="wiki-page"></a>Table of content</h3>
194 302
195 303
196 <pre><code>{{toc}} =&gt; left aligned toc
304 <pre>
305 {{toc}} =&gt; left aligned toc
197 306 {{&gt;toc}} =&gt; right aligned toc
198 &lt;/code></pre>
307 </pre>
199 308
200 309 <h2><a name="12" class="wiki-page"></a>Macros</h2>
201 310
202 311
203 312 <p>Redmine has the following builtin macros:</p>
204 313
205 314
206 315 <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>
207 316
208 317
209 318 <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>
210 319
211 320
212 321 <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
213 322
214 323
215 324 <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, html, javascript, rhtml, ruby, scheme, xml languages.</p>
216 325
217 326
218 327 <p>You can highlight code in your wiki page using this syntax:</p>
219 328
220 329
221 <pre><code>&lt;pre&gt;&lt;code class="ruby"&gt;
330 <pre>
331 &lt;pre&gt;&lt;code class="ruby"&gt;
222 332 Place you code here.
223 333 &lt;/code&gt;&lt;/pre&gt;
224 </pre>&lt;/code>
334 </pre>
225 335
226 336 <p>Example:</p>
227 337
228 338
229 339 <pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
230 340 <span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>
231 341 <span class="no"> 3</span> <span class="r">def</span> <span class="fu">initialize</span>(name)
232 342 <span class="no"> 4</span> <span class="iv">@name</span> = name.capitalize
233 343 <span class="no"> 5</span> <span class="r">end</span>
234 344 <span class="no"> 6</span>
235 345 <span class="no"> 7</span> <span class="r">def</span> <span class="fu">salute</span>
236 346 <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>
237 347 <span class="no"> 9</span> <span class="r">end</span>
238 348 <span class="no"><strong>10</strong></span> <span class="r">end</span>
239 </pre>&lt;/code>
349 </code>
350 </pre>
240 351 </body>
241 352 </html>
General Comments 0
You need to be logged in to leave comments. Login now