| @@ -1,280 +1,281 | |||
|
|
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 | 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 | 9 | pre, code { font-size:120%; } |
|
|
10 | 10 | pre code { font-size:100%; } |
|
|
11 | 11 | pre { |
|
|
12 | 12 | margin: 1em 1em 1em 1.6em; |
|
|
13 | 13 | padding: 2px; |
|
|
14 | 14 | background-color: #fafafa; |
|
|
15 | 15 | border: 1px solid #dadada; |
|
|
16 | 16 | width:95%; |
|
|
17 | 17 | overflow-x: auto; |
|
|
18 | 18 | } |
|
|
19 | 19 | a.new { color: #b73535; } |
|
|
20 | 20 | |
|
|
21 | 21 | .syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 } |
|
|
22 | 22 | .syntaxhl .comment { color:#666; } |
|
|
23 | 23 | |
|
|
24 | 24 | .syntaxhl .class { color:#B06; font-weight:bold } |
|
|
25 | 25 | .syntaxhl .delimiter { color:black } |
|
|
26 | 26 | .syntaxhl .function { color:#06B; font-weight:bold } |
|
|
27 | 27 | |
|
|
28 | 28 | .syntaxhl .inline { background: #eee } |
|
|
29 | 29 | .syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 } |
|
|
30 | 30 | |
|
|
31 | 31 | .syntaxhl .instance-variable { color:#33B } |
|
|
32 | 32 | .syntaxhl .reserved { color:#080; font-weight:bold } |
|
|
33 | 33 | |
|
|
34 | 34 | .syntaxhl .string { background-color:#fff0f0; color: #D20; } |
|
|
35 | 35 | .syntaxhl .string .delimiter { color:#710 } |
|
|
36 | 36 | |
|
|
37 | 37 | </style> |
|
|
38 | 38 | </head> |
|
|
39 | 39 | |
|
|
40 | 40 | <body> |
|
|
41 | 41 | <h1><a name="1" class="wiki-page"></a>Wiki formatting</h1> |
|
|
42 | 42 | |
|
|
43 | 43 | <h2><a name="2" class="wiki-page"></a>Links</h2> |
|
|
44 | 44 | |
|
|
45 | 45 | <h3><a name="3" class="wiki-page"></a>Redmine links</h3> |
|
|
46 | 46 | |
|
|
47 | 47 | <p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p> |
|
|
48 | 48 | <ul> |
|
|
49 | 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> | |
|
|
50 | 51 | </ul> |
|
|
51 | 52 | |
|
|
52 | 53 | <p>Wiki links:</p> |
|
|
53 | 54 | |
|
|
54 | 55 | <ul> |
|
|
55 | 56 | <li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li> |
|
|
56 | 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> |
|
|
57 | 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> |
|
|
58 | 59 | </ul> |
|
|
59 | 60 | |
|
|
60 | 61 | <p>You can also link to pages of an other project wiki:</p> |
|
|
61 | 62 | |
|
|
62 | 63 | <ul> |
|
|
63 | 64 | <li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li> |
|
|
64 | 65 | <li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li> |
|
|
65 | 66 | </ul> |
|
|
66 | 67 | |
|
|
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> |
|
|
68 | 69 | |
|
|
69 | 70 | <p>Links to other resources:</p> |
|
|
70 | 71 | |
|
|
71 | 72 | <ul> |
|
|
72 | 73 | <li>Documents: |
|
|
73 | 74 | <ul> |
|
|
74 | 75 | <li><strong>document#17</strong> (link to document with id 17)</li> |
|
|
75 | 76 | <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li> |
|
|
76 | 77 | <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li> |
|
|
77 | 78 | <li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li> |
|
|
78 | 79 | </ul></li> |
|
|
79 | 80 | </ul> |
|
|
80 | 81 | |
|
|
81 | 82 | <ul> |
|
|
82 | 83 | <li>Versions: |
|
|
83 | 84 | <ul> |
|
|
84 | 85 | <li><strong>version#3</strong> (link to version with id 3)</li> |
|
|
85 | 86 | <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li> |
|
|
86 | 87 | <li><strong>version:"1.0 beta 2"</strong></li> |
|
|
87 | 88 | <li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li> |
|
|
88 | 89 | </ul></li> |
|
|
89 | 90 | </ul> |
|
|
90 | 91 | |
|
|
91 | 92 | <ul> |
|
|
92 | 93 | <li>Attachments: |
|
|
93 | 94 | <ul> |
|
|
94 | 95 | <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li> |
|
|
95 | 96 | <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> |
|
|
96 | 97 | </ul></li> |
|
|
97 | 98 | </ul> |
|
|
98 | 99 | |
|
|
99 | 100 | <ul> |
|
|
100 | 101 | <li>Changesets: |
|
|
101 | 102 | <ul> |
|
|
102 | 103 | <li><strong>r758</strong> (link to a changeset)</li> |
|
|
103 | 104 | <li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li> |
|
|
104 | 105 | <li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li> |
|
|
105 | 106 | <li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li> |
|
|
106 | 107 | <li><strong>sandbox:r758</strong> (link to a changeset of another project)</li> |
|
|
107 | 108 | <li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li> |
|
|
108 | 109 | </ul></li> |
|
|
109 | 110 | </ul> |
|
|
110 | 111 | |
|
|
111 | 112 | <ul> |
|
|
112 | 113 | <li>Repository files: |
|
|
113 | 114 | <ul> |
|
|
114 | 115 | <li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li> |
|
|
115 | 116 | <li><strong>source:some/file@52</strong> (link to the file's revision 52)</li> |
|
|
116 | 117 | <li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li> |
|
|
117 | 118 | <li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li> |
|
|
118 | 119 | <li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li> |
|
|
119 | 120 | <li><strong>export:some/file</strong> (force the download of the file)</li> |
|
|
120 | 121 | <li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li> |
|
|
121 | 122 | <li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li> |
|
|
122 | 123 | <li><strong>sandbox:export:some/file</strong> (force the download of the file)</li> |
|
|
123 | 124 | </ul></li> |
|
|
124 | 125 | </ul> |
|
|
125 | 126 | |
|
|
126 | 127 | <ul> |
|
|
127 | 128 | <li>Forum messages: |
|
|
128 | 129 | <ul> |
|
|
129 | 130 | <li><strong>message#1218</strong> (link to message with id 1218)</li> |
|
|
130 | 131 | </ul></li> |
|
|
131 | 132 | </ul> |
|
|
132 | 133 | |
|
|
133 | 134 | <ul> |
|
|
134 | 135 | <li>Projects: |
|
|
135 | 136 | <ul> |
|
|
136 | 137 | <li><strong>project#3</strong> (link to project with id 3)</li> |
|
|
137 | 138 | <li><strong>project:someproject</strong> (link to project named "someproject")</li> |
|
|
138 | 139 | </ul></li> |
|
|
139 | 140 | </ul> |
|
|
140 | 141 | |
|
|
141 | 142 | |
|
|
142 | 143 | <p>Escaping:</p> |
|
|
143 | 144 | |
|
|
144 | 145 | <ul> |
|
|
145 | 146 | <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li> |
|
|
146 | 147 | </ul> |
|
|
147 | 148 | |
|
|
148 | 149 | |
|
|
149 | 150 | <h3><a name="4" class="wiki-page"></a>External links</h3> |
|
|
150 | 151 | |
|
|
151 | 152 | <p>HTTP URLs and email addresses are automatically turned into clickable links:</p> |
|
|
152 | 153 | |
|
|
153 | 154 | <pre> |
|
|
154 | 155 | http://www.redmine.org, someone@foo.bar |
|
|
155 | 156 | </pre> |
|
|
156 | 157 | |
|
|
157 | 158 | <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> |
|
|
158 | 159 | |
|
|
159 | 160 | <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p> |
|
|
160 | 161 | |
|
|
161 | 162 | <pre> |
|
|
162 | 163 | "Redmine web site":http://www.redmine.org |
|
|
163 | 164 | </pre> |
|
|
164 | 165 | |
|
|
165 | 166 | <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p> |
|
|
166 | 167 | |
|
|
167 | 168 | |
|
|
168 | 169 | <h2><a name="5" class="wiki-page"></a>Text formatting</h2> |
|
|
169 | 170 | |
|
|
170 | 171 | |
|
|
171 | 172 | <p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://www.textism.com/tools/textile/">http://www.textism.com/tools/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> |
|
|
172 | 173 | |
|
|
173 | 174 | <h3><a name="6" class="wiki-page"></a>Font style</h3> |
|
|
174 | 175 | |
|
|
175 | 176 | <pre> |
|
|
176 | 177 | * *bold* |
|
|
177 | 178 | * _italic_ |
|
|
178 | 179 | * _*bold italic*_ |
|
|
179 | 180 | * +underline+ |
|
|
180 | 181 | * -strike-through- |
|
|
181 | 182 | </pre> |
|
|
182 | 183 | |
|
|
183 | 184 | <p>Display:</p> |
|
|
184 | 185 | |
|
|
185 | 186 | <ul> |
|
|
186 | 187 | <li><strong>bold</strong></li> |
|
|
187 | 188 | <li><em>italic</em></li> |
|
|
188 | 189 | <li><em>*bold italic*</em></li> |
|
|
189 | 190 | <li><ins>underline</ins></li> |
|
|
190 | 191 | <li><del>strike-through</del></li> |
|
|
191 | 192 | </ul> |
|
|
192 | 193 | |
|
|
193 | 194 | <h3><a name="7" class="wiki-page"></a>Inline images</h3> |
|
|
194 | 195 | |
|
|
195 | 196 | <ul> |
|
|
196 | 197 | <li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li> |
|
|
197 | 198 | <li><strong>!>image_url!</strong> right floating image</li> |
|
|
198 | 199 | <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> |
|
|
199 | 200 | </ul> |
|
|
200 | 201 | |
|
|
201 | 202 | <h3><a name="8" class="wiki-page"></a>Headings</h3> |
|
|
202 | 203 | |
|
|
203 | 204 | <pre> |
|
|
204 | 205 | h1. Heading |
|
|
205 | 206 | h2. Subheading |
|
|
206 | 207 | h3. Subsubheading |
|
|
207 | 208 | </pre> |
|
|
208 | 209 | |
|
|
209 | 210 | <p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p> |
|
|
210 | 211 | |
|
|
211 | 212 | |
|
|
212 | 213 | <h3><a name="9" class="wiki-page"></a>Paragraphs</h3> |
|
|
213 | 214 | |
|
|
214 | 215 | <pre> |
|
|
215 | 216 | p>. right aligned |
|
|
216 | 217 | p=. centered |
|
|
217 | 218 | </pre> |
|
|
218 | 219 | |
|
|
219 | 220 | <p style="text-align:center;">This is a centered paragraph.</p> |
|
|
220 | 221 | |
|
|
221 | 222 | |
|
|
222 | 223 | <h3><a name="10" class="wiki-page"></a>Blockquotes</h3> |
|
|
223 | 224 | |
|
|
224 | 225 | <p>Start the paragraph with <strong>bq.</strong></p> |
|
|
225 | 226 | |
|
|
226 | 227 | <pre> |
|
|
227 | 228 | bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern. |
|
|
228 | 229 | To go live, all you need to add is a database and a web server. |
|
|
229 | 230 | </pre> |
|
|
230 | 231 | |
|
|
231 | 232 | <p>Display:</p> |
|
|
232 | 233 | |
|
|
233 | 234 | <blockquote> |
|
|
234 | 235 | <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> |
|
|
235 | 236 | </blockquote> |
|
|
236 | 237 | |
|
|
237 | 238 | |
|
|
238 | 239 | <h3><a name="11" class="wiki-page"></a>Table of content</h3> |
|
|
239 | 240 | |
|
|
240 | 241 | <pre> |
|
|
241 | 242 | {{toc}} => left aligned toc |
|
|
242 | 243 | {{>toc}} => right aligned toc |
|
|
243 | 244 | </pre> |
|
|
244 | 245 | |
|
|
245 | 246 | <h2><a name="12" class="wiki-page"></a>Macros</h2> |
|
|
246 | 247 | |
|
|
247 | 248 | <p>Redmine has the following builtin macros:</p> |
|
|
248 | 249 | |
|
|
249 | 250 | <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> |
|
|
250 | 251 | |
|
|
251 | 252 | <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> |
|
|
252 | 253 | |
|
|
253 | 254 | |
|
|
254 | 255 | <h2><a name="13" class="wiki-page"></a>Code highlighting</h2> |
|
|
255 | 256 | |
|
|
256 | 257 | <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> |
|
|
257 | 258 | |
|
|
258 | 259 | <p>You can highlight code in your wiki page using this syntax:</p> |
|
|
259 | 260 | |
|
|
260 | 261 | <pre> |
|
|
261 | 262 | <pre><code class="ruby"> |
|
|
262 | 263 | Place you code here. |
|
|
263 | 264 | </code></pre> |
|
|
264 | 265 | </pre> |
|
|
265 | 266 | |
|
|
266 | 267 | <p>Example:</p> |
|
|
267 | 268 | |
|
|
268 | 269 | <pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span> |
|
|
269 | 270 | <span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span> |
|
|
270 | 271 | <span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name) |
|
|
271 | 272 | <span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize |
|
|
272 | 273 | <span class="line-numbers"> 5</span> <span class="reserved">end</span> |
|
|
273 | 274 | <span class="line-numbers"> 6</span> |
|
|
274 | 275 | <span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span> |
|
|
275 | 276 | <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> |
|
|
276 | 277 | <span class="line-numbers"> 9</span> <span class="reserved">end</span> |
|
|
277 | 278 | <span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code> |
|
|
278 | 279 | </pre> |
|
|
279 | 280 | </body> |
|
|
280 | 281 | </html> |
General Comments 0
You need to be logged in to leave comments.
Login now