RedmineTextFormattingMarkdown » History » Version 13

Hans Ginzel, 2016-02-04 20:03
Repositories

1 1 Hans Ginzel
h1. Markdown formatting
2 1 Hans Ginzel
3 1 Hans Ginzel
Below is copy of *Textile* formatting that needs to be updated to *Markdown* formatting. Please help.
4 9 Hans Ginzel
For *Markdown* formatting see #15520, #16373 and #21443.
5 1 Hans Ginzel
6 1 Hans Ginzel
{{>TOC}}
7 1 Hans Ginzel
8 1 Hans Ginzel
h2. Links
9 1 Hans Ginzel
10 1 Hans Ginzel
h3. Redmine links
11 1 Hans Ginzel
12 1 Hans Ginzel
Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere text formatting is used.
13 1 Hans Ginzel
14 1 Hans Ginzel
* Link to an issue: *!#124* (displays #124, link is striked-through if the issue is closed)
15 1 Hans Ginzel
* Link to an issue note: *!#124-6*, or *!#124!#note-6*
16 1 Hans Ginzel
* Link to a changeset: *!r758* (displays r758)
17 1 Hans Ginzel
* Link to a changeset with a non-numeric hash: *commit:c6f4d0fd* (displays c6f4d0fd).
18 1 Hans Ginzel
19 1 Hans Ginzel
Wiki links:
20 1 Hans Ginzel
21 1 Hans Ginzel
* *[[Guide]]* displays a link to the page named 'Guide': [[Guide]]
22 1 Hans Ginzel
* *[[Guide|User manual]]* displays a link to the same page but with different text: [[Guide|User manual]]
23 1 Hans Ginzel
* *[[Guide#User-guide|User guide]]* displays a link to the header on the same page with different text: [[Guide#User-guide|User guide]]
24 1 Hans Ginzel
25 1 Hans Ginzel
You can also link to pages of another project's wiki (using the project identifier):
26 1 Hans Ginzel
27 1 Hans Ginzel
* *[[sandbox:some page]]* displays a link to the page named 'Some page' of the Sandbox wiki
28 1 Hans Ginzel
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
29 1 Hans Ginzel
30 1 Hans Ginzel
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
31 1 Hans Ginzel
32 1 Hans Ginzel
Links to others resources:
33 1 Hans Ginzel
34 1 Hans Ginzel
* Documents:
35 1 Hans Ginzel
36 1 Hans Ginzel
  * *!document#17* (link to document with id 17)
37 1 Hans Ginzel
  * *!document:Greetings* (link to the document with title "Greetings")
38 1 Hans Ginzel
  * *!document:"Some document"* (double quotes can be used when document title contains spaces)
39 1 Hans Ginzel
  * *!sandbox:document:"Some document"* (link to a document with title "Some document" in project identifier "sandbox")
40 1 Hans Ginzel
41 12 pierre pignede
* Files:
42 12 pierre pignede
43 12 pierre pignede
  * *file#17* (link to files with id 17)
44 12 pierre pignede
45 1 Hans Ginzel
* Versions:
46 1 Hans Ginzel
47 1 Hans Ginzel
  * *!version#3* (link to version with id 3)
48 1 Hans Ginzel
  * *!version:1.0.0* (link to version named "1.0.0")
49 1 Hans Ginzel
  * *!version:"1.0 beta 2"* (double quotes can be used when version name contains spaces)
50 1 Hans Ginzel
  * *!sandbox:version:1.0.0* (link to version "1.0.0" in the project identifier "sandbox")
51 1 Hans Ginzel
52 1 Hans Ginzel
* Attachments:
53 1 Hans Ginzel
  
54 1 Hans Ginzel
  * *!attachment:file.zip* (link to the attachment of the current object named file.zip)
55 1 Hans Ginzel
  * *!attachment:"file.zip"* (double quotes can be used when the filename contains non word characters)
56 1 Hans Ginzel
  * 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)
57 1 Hans Ginzel
58 1 Hans Ginzel
* Changesets:
59 1 Hans Ginzel
60 1 Hans Ginzel
  * *!r758* (link to a changeset)
61 1 Hans Ginzel
  * *!commit:c6f4d0fd* (link to a changeset with a non-numeric hash)
62 1 Hans Ginzel
  * *!svn1|r758* (link to a changeset of a specific repository, for projects with multiple repositories)
63 1 Hans Ginzel
  * *!commit:hg|c6f4d0fd* (link to a changeset with a non-numeric hash of a specific repository)
64 1 Hans Ginzel
  * *!sandbox:r758* (link to a changeset of another project)
65 1 Hans Ginzel
  * *!sandbox:commit:c6f4d0fd* (link to a changeset with a non-numeric hash of another project identifier)
66 1 Hans Ginzel
67 1 Hans Ginzel
* Repository files:
68 1 Hans Ginzel
69 1 Hans Ginzel
  * *!source:some/file*           -- Link to the file located at /some/file in the project's repository
70 1 Hans Ginzel
  * *!source:some/file@52*        -- Link to the file's revision 52
71 1 Hans Ginzel
  * *!source:some/file#L120*      -- Link to line 120 of the file
72 1 Hans Ginzel
  * *!source:some/file@52#L120*   -- Link to line 120 of the file's revision 52
73 1 Hans Ginzel
  * *!source:"some file@52#L120"* -- Double quotes can be used when the URL contains spaces  
74 1 Hans Ginzel
  * *!source:repo_identifier|some/file* -- Link to a file in a repository other than the project default repository. 
75 1 Hans Ginzel
  * *!source:"repo_identifier|some file"* -- Link to a file in a repository other than the project default repository, with spaces in the path. 
76 1 Hans Ginzel
  * *!export:some/file*           -- Force the download of the file
77 13 Hans Ginzel
78 13 Hans Ginzel
* Repositories: (*Wanted*, #123)
79 13 Hans Ginzel
80 13 Hans Ginzel
  * *repository:* -- Link to the project default repository. 
81 13 Hans Ginzel
  * *repository:repo_identifier* -- Link to a repository other than the project default repository. 
82 13 Hans Ginzel
  * *sandbox:repository:* -- Link to the another project default repository. 
83 13 Hans Ginzel
  * *sandbox:repository:repo_identifier* -- Link to a repository other than the other project default repository. 
84 13 Hans Ginzel
85 1 Hans Ginzel
 
86 1 Hans Ginzel
* Forums:
87 1 Hans Ginzel
88 1 Hans Ginzel
  * *!forum#2* (link to forum with id 2)
89 1 Hans Ginzel
  * *!forum:Discussion* (link to forum with name "Discussion")
90 1 Hans Ginzel
  * *!forum:"Help and more"* (double quotes can be used when forum name contains spaces)
91 1 Hans Ginzel
92 1 Hans Ginzel
* Forum messages:
93 1 Hans Ginzel
94 1 Hans Ginzel
  * *!message#1218* (link to message with id 1218)
95 1 Hans Ginzel
96 1 Hans Ginzel
* News items
97 1 Hans Ginzel
98 1 Hans Ginzel
  * *!news#1* (link to news item with id 1)
99 1 Hans Ginzel
  * *!news:Greetings* (link to news item with name "Greetings")
100 1 Hans Ginzel
  * *!news:"eCookbook first release !"* (double quotes can be used when news item name contains spaces)
101 1 Hans Ginzel
102 1 Hans Ginzel
* Projects:
103 1 Hans Ginzel
104 1 Hans Ginzel
  * *!project#3* (link to project with id 3)
105 1 Hans Ginzel
  * *!project:someproject* (link to project with name "someproject")
106 1 Hans Ginzel
  * *!project:"Multiple words project"* (double quotes can be used when project name contains spaces)
107 1 Hans Ginzel
108 1 Hans Ginzel
Escaping:
109 1 Hans Ginzel
110 1 Hans Ginzel
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
111 1 Hans Ginzel
112 1 Hans Ginzel
h3. External links
113 1 Hans Ginzel
114 1 Hans Ginzel
HTTP URLs are automatically turned into clickable links: 
115 1 Hans Ginzel
* *http://www.redmine.org* -- External link to the redmine website: http://www.redmine.org
116 1 Hans Ginzel
* *someone@foo.bar* -- Link to an email address: someone@foo.bar
117 1 Hans Ginzel
118 1 Hans Ginzel
HTTP URLs can also use different text than the link itself:
119 2 Hans Ginzel
* *[Redmine web site](http://www.redmine.org)* -- External link with different text: "Redmine web site":http://www.redmine.org
120 2 Hans Ginzel
* *[![Redmine web site](http://www.redmine.org/attachments/7069/Redmine_logo.png)](http://www.redmine.org)* -- External image with a title that links to an URL: 
121 1 Hans Ginzel
122 1 Hans Ginzel
p=. !http://www.redmine.org/attachments/7069/Redmine_logo.png(Redmine web site)!:http://www.redmine.org
123 1 Hans Ginzel
124 1 Hans Ginzel
h3. Email addresses
125 1 Hans Ginzel
126 1 Hans Ginzel
Email addresses are automatically turned into clickable links:
127 1 Hans Ginzel
128 3 Hans Ginzel
* *[Email someone](mailto:someone@foo.bar)* -- Email link with different text: "Email someone":mailto:someone@foo.bar
129 1 Hans Ginzel
130 1 Hans Ginzel
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.
131 3 Hans Ginzel
* *[Email webmaster and admin](mailto:webmaster@foo.bar?cc=admin@foo.bar)* -- Email to webmaster, CC admin:  "Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar
132 3 Hans Ginzel
* *[Email someone for help](mailto:someone@foo.bar?subject=Website%20Help)* -- Email link with the subject "Website Help": "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help
133 3 Hans Ginzel
* *[Email someone for help](mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20)* -- Email link with the subject "Website Help" and a default body: "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20
134 1 Hans Ginzel
135 1 Hans Ginzel
h2. Text formatting
136 1 Hans Ginzel
137 4 Hans Ginzel
For things such as headlines, bold, tables, lists, Redmine supports "Markdown syntax":http://en.wikipedia.org/wiki/Markdown.  See http://daringfireball.net/projects/markdown/syntax, http://agea.github.io/tutorial.md/, http://stackoverflow.com/editing-help 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 "Pandoc":http://pandoc.org. The "Redcarpet formatter":https://github.com/alminium/redmine_redcarpet_formatter is used.
138 1 Hans Ginzel
139 1 Hans Ginzel
h3. Acronym
140 4 Hans Ginzel
141 4 Hans Ginzel
?? in Markdown
142 1 Hans Ginzel
143 1 Hans Ginzel
<pre>
144 1 Hans Ginzel
JPL(Jean-Philippe Lang)
145 1 Hans Ginzel
</pre>
146 1 Hans Ginzel
147 1 Hans Ginzel
Display:
148 1 Hans Ginzel
149 1 Hans Ginzel
JPL(Jean-Philippe Lang)
150 1 Hans Ginzel
151 1 Hans Ginzel
h3. Font style
152 1 Hans Ginzel
153 5 Hans Ginzel
<pre><code>* **bold** __bold__
154 5 Hans Ginzel
* *italic* _italic_
155 5 Hans Ginzel
* ***bold italic*** ___bold italic___
156 5 Hans Ginzel
* <ins>underline</ins>
157 5 Hans Ginzel
* <del>strike through</del>
158 5 Hans Ginzel
* Plain <sup>superscript</sup>
159 5 Hans Ginzel
* Plain <sub>subscript</sub>
160 5 Hans Ginzel
* `inline monospace`
161 5 Hans Ginzel
* normal **bold** _italic_ normal;E=mc<sup>2</sup>
162 1 Hans Ginzel
* <notextile>normal<notextile></notextile>*bold*<notextile></notextile>_italic_<notextile></notextile>normal;E=mc<notextile></notextile>^2^</notextile>
163 1 Hans Ginzel
* <notextile>Escaping: <notextile>*bold* _italic_ @inlinemono@</notextile> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Alternative using HTML-codes: &#42;bold&#42; &#95;italic&#95; &#64;inlinemono&#64;</notextile>
164 1 Hans Ginzel
* <notextile><pre>*some lines*      some "link":http://www.redmine.org</pre></notextile>
165 1 Hans Ginzel
* <notextile><pre><notextile></notextile>*some lines*      some "link":http://www.redmine.org</pre></notextile>
166 1 Hans Ginzel
</code></pre>
167 1 Hans Ginzel
168 1 Hans Ginzel
Display:
169 1 Hans Ginzel
170 5 Hans Ginzel
 * *bold* *bold*
171 5 Hans Ginzel
 * _italic_ _italic_
172 5 Hans Ginzel
 * *_bold italic_* *_bold italic_*
173 1 Hans Ginzel
 * +underline+
174 1 Hans Ginzel
 * -strike-through-
175 1 Hans Ginzel
 * Plain ^superscript^
176 1 Hans Ginzel
 * Plain ~subscript~
177 1 Hans Ginzel
 * @inline monospace@
178 1 Hans Ginzel
 * normal *bold* _italic_ normal;E=mc ^2^
179 1 Hans Ginzel
 * normal<notextile></notextile>*bold*<notextile></notextile>_italic_<notextile></notextile>normal;E=mc<notextile></notextile>^2^
180 1 Hans Ginzel
 * Escaping: <notextile>*bold* _italic_ @inlinemono@</notextile> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Alternative using HTML-codes: &#42;bold&#42; &#95;italic&#95; &#64;inlinemono&#64;
181 1 Hans Ginzel
 * <pre>*some lines*      some "link":http://www.redmine.org</pre>
182 1 Hans Ginzel
 * <pre><notextile></notextile>*some lines*      some "link":http://www.redmine.org</pre>
183 1 Hans Ginzel
184 1 Hans Ginzel
h3. Colour
185 1 Hans Ginzel
186 1 Hans Ginzel
<pre><code><notextile>* %{color:red}red% %{color:green}green% %{color:yellow}yellow% %{color:#82B6E1}blue'ish%
187 1 Hans Ginzel
* %{color:red}red%<notextile></notextile>%{color:green}green%<notextile></notextile>%{color:yellow}yellow%<notextile></notextile>%{color:#82B6E1}blue'ish%
188 1 Hans Ginzel
* %{background:lightgreen}Lightgreen Background% %{background:yellow}Yellow Background%
189 1 Hans Ginzel
* %{background:lightgreen}Lightgreen Background%<notextile></notextile>%{background:yellow}Yellow Background%
190 1 Hans Ginzel
</notextile></code></pre>
191 1 Hans Ginzel
192 1 Hans Ginzel
Display:
193 1 Hans Ginzel
194 1 Hans Ginzel
 * %{color:red}red% %{color:green}green% %{color:yellow}yellow% %{color:#82B6E1}blue'ish%
195 1 Hans Ginzel
 * %{color:red}red%<notextile></notextile>%{color:green}green%<notextile></notextile>%{color:yellow}yellow%<notextile></notextile>%{color:#82B6E1}blue'ish%
196 1 Hans Ginzel
 * %{background:lightgreen}Lightgreen Background% %{background:yellow}Yellow Background%
197 1 Hans Ginzel
 * %{background:lightgreen}Lightgreen Background%<notextile></notextile>%{background:yellow}Yellow Background%
198 1 Hans Ginzel
199 1 Hans Ginzel
h3. Inline images
200 1 Hans Ginzel
201 6 Hans Ginzel
* *![](image_url)* displays an image located at image_url (textile syntax)
202 6 Hans Ginzel
* *![](image_url)* right floating image, see http://stackoverflow.com/questions/255170/markdown-and-image-alignment
203 6 Hans Ginzel
* *![Image title](image_url)* displays an image with an alt/title attribute
204 1 Hans Ginzel
* *&#33;image_url&#33;:URL* displays an image located at image_url with link URL added
205 1 Hans Ginzel
206 1 Hans Ginzel
If you have an image attached to your wiki page, it can be displayed inline using its filename: *&#33;attached_image.png&#33;*
207 1 Hans Ginzel
208 1 Hans Ginzel
You can also apply a CSS style to the image in the same ways as styling SPANs. The code *&#33;{width: 100%}attached_image.png&#33;* will make the image adjusts to the parent's width.
209 1 Hans Ginzel
210 1 Hans Ginzel
h3. Headings
211 1 Hans Ginzel
212 7 Hans Ginzel
<pre><code># Heading
213 1 Hans Ginzel
214 7 Hans Ginzel
## Subheading
215 1 Hans Ginzel
216 7 Hans Ginzel
### Subheading
217 7 Hans Ginzel
218 7 Hans Ginzel
or
219 7 Hans Ginzel
220 7 Hans Ginzel
Heading
221 7 Hans Ginzel
=======
222 7 Hans Ginzel
223 7 Hans Ginzel
Subheading
224 7 Hans Ginzel
----------
225 1 Hans Ginzel
</code></pre>
226 1 Hans Ginzel
227 1 Hans Ginzel
Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.
228 1 Hans Ginzel
229 1 Hans Ginzel
h3. Paragraphs
230 1 Hans Ginzel
231 1 Hans Ginzel
<pre><code>p. left aligned
232 1 Hans Ginzel
233 1 Hans Ginzel
  p(. left ident 1em
234 1 Hans Ginzel
235 1 Hans Ginzel
    p((. left ident 2em
236 1 Hans Ginzel
    as well as for following lines
237 1 Hans Ginzel
238 1 Hans Ginzel
                                                                                   p>. right aligned
239 1 Hans Ginzel
240 1 Hans Ginzel
                                                                        p)))>. right ident 3em
241 1 Hans Ginzel
242 1 Hans Ginzel
                           p=. This is centered paragraph.
243 1 Hans Ginzel
</code></pre>
244 1 Hans Ginzel
245 1 Hans Ginzel
h3. Horizontal rule 
246 1 Hans Ginzel
247 1 Hans Ginzel
@----@
248 1 Hans Ginzel
Display: 
249 1 Hans Ginzel
250 1 Hans Ginzel
----
251 1 Hans Ginzel
252 1 Hans Ginzel
253 1 Hans Ginzel
h3. Predefined
254 1 Hans Ginzel
255 1 Hans Ginzel
To escape wiki syntax
256 1 Hans Ginzel
<pre> <pre> *Your text won't become bold* </pre> </pre>
257 1 Hans Ginzel
Display:
258 1 Hans Ginzel
259 1 Hans Ginzel
<pre> *Your text won't become bold* </pre>
260 1 Hans Ginzel
261 1 Hans Ginzel
h3. Blockquotes
262 1 Hans Ginzel
263 1 Hans Ginzel
Start the paragraph with *bq.*:
264 1 Hans Ginzel
265 1 Hans Ginzel
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
266 1 Hans Ginzel
To go live, all you need to add is a database and a web server.
267 1 Hans Ginzel
</code></pre>
268 1 Hans Ginzel
269 1 Hans Ginzel
Displays:
270 1 Hans Ginzel
271 1 Hans Ginzel
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
272 1 Hans Ginzel
To go live, all you need to add is a database and a web server.
273 1 Hans Ginzel
274 1 Hans Ginzel
You can also use > at the beginning of each line and stack them for nested quotes:
275 1 Hans Ginzel
276 1 Hans Ginzel
<pre>
277 1 Hans Ginzel
>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
278 1 Hans Ginzel
>> To go live, all you need to add is a database and a web server.
279 1 Hans Ginzel
> Great!
280 1 Hans Ginzel
</pre>
281 1 Hans Ginzel
282 1 Hans Ginzel
Displays:
283 1 Hans Ginzel
284 1 Hans Ginzel
>>  Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
285 1 Hans Ginzel
>>  To go live, all you need to add is a database and a web server.
286 1 Hans Ginzel
> Great!
287 1 Hans Ginzel
288 1 Hans Ginzel
h3. Unordered lists
289 1 Hans Ginzel
290 1 Hans Ginzel
<pre>
291 1 Hans Ginzel
* Item 1
292 1 Hans Ginzel
* Item 2
293 8 Hans Ginzel
  * Item 21 (two spaces indentation)
294 8 Hans Ginzel
  * Item 22
295 1 Hans Ginzel
* Item 3
296 1 Hans Ginzel
</pre>
297 1 Hans Ginzel
298 1 Hans Ginzel
displays:
299 1 Hans Ginzel
300 1 Hans Ginzel
* Item 1
301 1 Hans Ginzel
* Item 2
302 1 Hans Ginzel
** Item 21
303 1 Hans Ginzel
** Item 22
304 1 Hans Ginzel
* Item 3
305 1 Hans Ginzel
306 1 Hans Ginzel
h3. Ordered lists
307 1 Hans Ginzel
308 1 Hans Ginzel
<pre>
309 1 Hans Ginzel
# Item 1
310 1 Hans Ginzel
# Item 2
311 1 Hans Ginzel
# Item 3
312 10 Hans Ginzel
  # Item 3.1 (two spaces)
313 10 Hans Ginzel
  # Item 3.2
314 1 Hans Ginzel
</pre>
315 1 Hans Ginzel
316 1 Hans Ginzel
displays:
317 1 Hans Ginzel
318 1 Hans Ginzel
# Item 1
319 1 Hans Ginzel
# Item 2
320 1 Hans Ginzel
# Item 3
321 1 Hans Ginzel
## Item 3.1
322 1 Hans Ginzel
## Item 3.2
323 1 Hans Ginzel
324 1 Hans Ginzel
h3. Tables
325 1 Hans Ginzel
326 1 Hans Ginzel
<pre>
327 1 Hans Ginzel
|_.UserID      |_.Name          |_.Group     |_. attribute list   |
328 1 Hans Ginzel
|Starting with | a              |   simple   |row                 |
329 1 Hans Ginzel
|\3=.IT                                      |<. align left       |
330 1 Hans Ginzel
|1             |Artur Pirozhkov |/2.Users    |>. align right      |
331 1 Hans Ginzel
|2             |Vasya Rogov     |=. center   |
332 1 Hans Ginzel
|3             |John Smith      |Admin
333 1 Hans Ginzel
                                 (root)      |^. valign top       |
334 1 Hans Ginzel
|4             |-               |Nobody
335 1 Hans Ginzel
                                 (anonymous) |~. valign bottom    |
336 1 Hans Ginzel
</pre>
337 1 Hans Ginzel
338 1 Hans Ginzel
displays (all multiple spaces are replaced by 1 space):
339 1 Hans Ginzel
340 1 Hans Ginzel
|_.UserID      |_.Name          |_.Group     |_. attribute list   |
341 1 Hans Ginzel
|Starting with | a              |   simple   |row                 |
342 1 Hans Ginzel
|\3=.IT                                      |<. align left       |
343 1 Hans Ginzel
|1             |Artur Pirozhkov |/2.Users    |>. align right      |
344 1 Hans Ginzel
|2             |Vasya Rogov     |=. center   |
345 1 Hans Ginzel
|3             |John Smith      |Admin
346 1 Hans Ginzel
                                 (root)      |^. valign top       |
347 1 Hans Ginzel
|4             |-               |Nobody
348 1 Hans Ginzel
                                 (anonymous) |~. valign bottom    |
349 1 Hans Ginzel
350 1 Hans Ginzel
If you want to include pipe characters inside your table (e.g. for Wiki links), you need to prevent textile from interpreting them:
351 1 Hans Ginzel
352 1 Hans Ginzel
|_.Input |_. Output|
353 1 Hans Ginzel
|*<notextile><notextile>|</notextile></notextile>*|<notextile>|</notextile>|
354 1 Hans Ginzel
355 1 Hans Ginzel
h3. Table of content
356 1 Hans Ginzel
357 1 Hans Ginzel
<pre><code>{{toc}} => left aligned toc
358 1 Hans Ginzel
{{>toc}} => right aligned toc
359 1 Hans Ginzel
</code></pre>
360 1 Hans Ginzel
361 1 Hans Ginzel
Please keep in mind, that the toc-tag needs an empty line above and underneath it and no other text before and after it.
362 1 Hans Ginzel
363 1 Hans Ginzel
Example:
364 1 Hans Ginzel
365 1 Hans Ginzel
<pre><code>
366 1 Hans Ginzel
h1. headLineOne
367 1 Hans Ginzel
368 1 Hans Ginzel
h2. something
369 1 Hans Ginzel
370 1 Hans Ginzel
{{toc}}
371 1 Hans Ginzel
372 1 Hans Ginzel
h2. something more
373 1 Hans Ginzel
</code></pre>
374 1 Hans Ginzel
375 1 Hans Ginzel
h2. Macros
376 1 Hans Ginzel
377 1 Hans Ginzel
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 [[RedmineMacros]]. Redmine also includes a few builtin macros:
378 1 Hans Ginzel
379 1 Hans Ginzel
{{macro_list}}
380 1 Hans Ginzel
381 11 Hans Ginzel
h2.
382 11 Hans Ginzel
 Code highlighting
383 1 Hans Ginzel
384 11 Hans Ginzel
Code highlighting relies on "CodeRay":http://coderay.rubychan.de/, a 
385 11 Hans Ginzel
fast syntax highlighting library written completely in Ruby. It 
386 11 Hans Ginzel
currently supports C, C++, CSS, Delphi, Diff, Groovy, HTML, Java, 
387 11 Hans Ginzel
Javascript, JSON, Nitro-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, 
388 11 Hans Ginzel
XML and YAML code.
389 1 Hans Ginzel
390 1 Hans Ginzel
You can highlight code in your wiki page using this syntax:
391 1 Hans Ginzel
392 11 Hans Ginzel
<pre><code>``` ruby
393 11 Hans Ginzel
Place your code here.
394 11 Hans Ginzel
```</code></pre>
395 1 Hans Ginzel
396 1 Hans Ginzel
Example:
397 1 Hans Ginzel
398 1 Hans Ginzel
<pre><code class="ruby">
399 1 Hans Ginzel
# The Greeter class
400 1 Hans Ginzel
class Greeter
401 1 Hans Ginzel
  def initialize(name)
402 1 Hans Ginzel
    @name = name.capitalize
403 1 Hans Ginzel
  end
404 1 Hans Ginzel
 
405 1 Hans Ginzel
  def salute
406 1 Hans Ginzel
    puts "Hello #{@name}!"
407 1 Hans Ginzel
  end
408 1 Hans Ginzel
end
409 1 Hans Ginzel
</code></pre>
410 1 Hans Ginzel
411 1 Hans Ginzel
h2. Textile formatting
412 1 Hans Ginzel
413 1 Hans Ginzel
Redmine supports textile formatting. For details see "Textile syntax":http://en.wikipedia.org/wiki/Textile_%28markup_language%29
414 1 Hans Ginzel
415 1 Hans Ginzel
Additional supported textiles:
416 1 Hans Ginzel
* *<notextile>%</notextile>{background:lightgreen}Green Background%* displays %{background:lightgreen}Green Background%
417 1 Hans Ginzel
418 1 Hans Ginzel
h2. Translation
419 1 Hans Ginzel
420 1 Hans Ginzel
Note that the following translations may not be up to date. Please refer to the original english documentation if needed.
421 1 Hans Ginzel
422 1 Hans Ginzel
* [[BrRedmineWikiFormatting|Português Brasileiro]]
423 1 Hans Ginzel
* [[RusRedmineTextFormatting|Русский]]
424 1 Hans Ginzel
* [[FrRedmineWikiFormatting|French]]
425 1 Hans Ginzel
* [[KoreanWikiFormatting|Korean]]
426 1 Hans Ginzel
* [[TurkishWikiFormatting|Türkçe]]
427 1 Hans Ginzel
* [[TraditionalChineseWikiFormatting|繁體中文]]
428 1 Hans Ginzel
* [[SimplifiedChineseWikiFormatting|简体中文]]