RedmineTextFormatting » History » Version 120

Toshi MARUYAMA, 2015-11-02 13:03
rollback to previous version (#20987)

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