##// END OF EJS Templates
jro_apps » redmine
RSS
Documents Wiki page anchors (#1647)....
Jean-Philippe Lang -
r2013:1169ff05aff2
parent child
Show More
Side by Side Unified
Context file:
r2013:1169ff05aff2 Loading diff...:
Show file before | Show file after | Hide comments
@@ -18,132 +18,58 pre {
18 18 }
19 19 a.new { color: #b73535; }
20 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 21 .CodeRay .c { color:#666; }
27 22
28 .CodeRay .ch { color:#04D }
29 .CodeRay .ch .k { color:#04D }
30 .CodeRay .ch .dl { color:#039 }
31
32 23 .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 24 .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 25 .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 26
52 27 .CodeRay .il { background: #eee }
53 .CodeRay .il .il { background: #ddd }
54 .CodeRay .il .il .il { background: #ccc }
55 28 .CodeRay .il .idl { font-weight: bold; color: #888 }
56 29
57 .CodeRay .in { color:#B2B; font-weight:bold }
58 30 .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 31 .CodeRay .r { color:#080; font-weight:bold }
69 32
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 33 .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 34 .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 }
96 35 </style>
97 36 </head>
98 37
99 38 <body>
100 39 <h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
101 40
102
103
104 41 <h2><a name="2" class="wiki-page"></a>Links</h2>
105 42
106
107 43 <h3><a name="3" class="wiki-page"></a>Redmine links</h3>
108 44
109
110 45 <p>Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.</p>
111
112
113 46 <ul>
114 47 <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>
115 48 <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>
116 49 <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>
117 50 </ul>
118 51
119
120 52 <p>Wiki links:</p>
121 53
122
123 54 <ul>
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>
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>
55 <li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="Guide.html" class="wiki-page">Guide</a></li>
56 <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="Guide.html#further-reading" class="wiki-page">Guide</a></li>
57 <li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="Guide.html" class="wiki-page">User manual</a></li>
126 58 </ul>
127 59
128
129 60 <p>You can also link to pages of an other project wiki:</p>
130 61
131
132 62 <ul>
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>
134 <li><strong>&#91;&#91;sandbox:&#93;&#93;</strong> displays a link to the Sandbox wiki main page</li>
63 <li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
64 <li><strong>[[sandbox]]</strong> displays a link to the Sandbox wiki main page</li>
135 65 </ul>
136 66
137
138 67 <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>
139 68
140
141 69 <p>Links to others resources (0.7):</p>
142 70
143
144 71 <ul>
145 72 <li>Documents:
146
147 73 <ul>
148 74 <li><strong>document#17</strong> (link to document with id 17)</li>
149 75 <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
@@ -151,10 +77,8 a.new { color: #b73535; }
151 77 </ul></li>
152 78 </ul>
153 79
154
155 80 <ul>
156 81 <li>Versions:
157
158 82 <ul>
159 83 <li><strong>version#3</strong> (link to version with id 3)</li>
160 84 <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
@@ -162,36 +86,27 a.new { color: #b73535; }
162 86 </ul></li>
163 87 </ul>
164 88
165
166 89 <ul>
167 90 <li>Attachments:
168
169 91 <ul>
170 92 <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
171 93 <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>
172 94 </ul></li>
173 95 </ul>
174 96
175
176 97 <ul>
177 98 <li>Repository files
178
179 99 <ul>
180 100 <li><strong>source:some/file</strong> -- Link to the file located at /some/file in the project's repository</li>
181 101 <li><strong>source:some/file@52</strong> -- Link to the file's revision 52</li>
182
183 102 <li><strong>source:some/file#L120</strong> -- Link to line 120 of the file</li>
184 103 <li><strong>source:some/file@52#L120</strong> -- Link to line 120 of the file's revision 52</li>
185 104 <li><strong>export:some/file</strong> -- Force the download of the file</li>
186 105 </ul></li>
187
188 106 </ul>
189 107
190
191
192 108 <p>Escaping (0.7):</p>
193 109
194
195 110 <ul>
196 111 <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
197 112 </ul>
@@ -199,20 +114,16 a.new { color: #b73535; }
199 114
200 115 <h3><a name="4" class="wiki-page"></a>External links</h3>
201 116
202
203 117 <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
204 118
205
206 119 <pre>
207 120 http://www.redmine.org, someone@foo.bar
208 121 </pre>
209 122
210 123 <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>
211 124
212
213 125 <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
214 126
215
216 127 <pre>
217 128 "Redmine web site":http://www.redmine.org
218 129 </pre>
@@ -225,10 +136,8 http://www.redmine.org, someone@foo.bar
225 136
226 137 <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>
227 138
228
229 139 <h3><a name="6" class="wiki-page"></a>Font style</h3>
230 140
231
232 141 <pre>
233 142 * *bold*
234 143 * _italic_
@@ -239,7 +148,6 http://www.redmine.org, someone@foo.bar
239 148
240 149 <p>Display:</p>
241 150
242
243 151 <ul>
244 152 <li><strong>bold</strong></li>
245 153 <li><em>italic</em></li>
@@ -248,31 +156,29 http://www.redmine.org, someone@foo.bar
248 156 <li><del>strike-through</del></li>
249 157 </ul>
250 158
251
252 159 <h3><a name="7" class="wiki-page"></a>Inline images</h3>
253 160
254
255 161 <ul>
256 <li><strong>&#33;image_url&#33;</strong> displays an image located at image_url (textile syntax)</li>
257 <li><strong>&#33;>image_url&#33;</strong> right floating image</li>
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>
162 <li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
163 <li><strong>!>image_url!</strong> right floating image</li>
164 <li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
259 165 </ul>
260 166
261
262 167 <h3><a name="8" class="wiki-page"></a>Headings</h3>
263 168
264
265 169 <pre>
266 170 h1. Heading
267 171 h2. Subheading
268 h3. Subheading
172 h3. Subsubheading
269 173 </pre>
270 174
271 <h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
175 <p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
272 176
273 177
178 <h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
179
274 180 <pre>
275 p&gt;. right aligned
181 p>. right aligned
276 182 p=. centered
277 183 </pre>
278 184
@@ -281,10 +187,8 p=. centered
281 187
282 188 <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
283 189
284
285 190 <p>Start the paragraph with <strong>bq.</strong></p>
286 191
287
288 192 <pre>
289 193 bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
290 194 To go live, all you need to add is a database and a web server.
@@ -292,7 +196,6 To go live, all you need to add is a database and a web server.
292 196
293 197 <p>Display:</p>
294 198
295
296 199 <blockquote>
297 200 <p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
298 201 </blockquote>
@@ -300,33 +203,26 To go live, all you need to add is a database and a web server.
300 203
301 204 <h3><a name="11" class="wiki-page"></a>Table of content</h3>
302 205
303
304 206 <pre>
305 {{toc}} =&gt; left aligned toc
306 {{&gt;toc}} =&gt; right aligned toc
207 {{toc}} => left aligned toc
208 {{>toc}} => right aligned toc
307 209 </pre>
308 210
309 211 <h2><a name="12" class="wiki-page"></a>Macros</h2>
310 212
311
312 213 <p>Redmine has the following builtin macros:</p>
313 214
314
315 215 <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>
316 216
317
318 217 <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>
319 218
320 219
321 220 <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
322 221
323
324 222 <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>
325 223
326
327 224 <p>You can highlight code in your wiki page using this syntax:</p>
328 225
329
330 226 <pre>
331 227 &lt;pre&gt;&lt;code class="ruby"&gt;
332 228 Place you code here.
@@ -335,7 +231,6 To go live, all you need to add is a database and a web server.
335 231
336 232 <p>Example:</p>
337 233
338
339 234 <pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
340 235 <span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>
341 236 <span class="no"> 3</span> <span class="r">def</span> <span class="fu">initialize</span>(name)
General Comments 0
You need to be logged in to leave comments. Login now