RedmineTextFormatting » History » Version 79

Mike Bison, 2012-09-03 20:55

1 68 Jean-Philippe Lang
h1. Text formatting
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
{{>TOC}}
4 1 Jean-Philippe Lang
5 1 Jean-Philippe Lang
h2. Links
6 1 Jean-Philippe Lang
7 6 Jean-Philippe Lang
h3. Redmine links
8 6 Jean-Philippe Lang
9 68 Jean-Philippe Lang
Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere text formatting is used.
10 1 Jean-Philippe Lang
11 8 Jean-Philippe Lang
* Link to an issue: *!#124* (displays #124, link is striked-through if the issue is closed)
12 6 Jean-Philippe Lang
* Link to a changeset: *!r758* (displays r758)
13 68 Jean-Philippe Lang
* Link to a changeset with a non-numeric hash: *commit:c6f4d0fd* (displays c6f4d0fd).
14 1 Jean-Philippe Lang
15 6 Jean-Philippe Lang
Wiki links:
16 1 Jean-Philippe Lang
17 3 Jean-Philippe Lang
* *[[Guide]]* displays a link to the page named 'Guide': [[Guide]]
18 51 Graham King
* *[[Guide|User manual]]* displays a link to the same page but with different text: [[Guide|User manual]]
19 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]]
20 1 Jean-Philippe Lang
21 51 Graham King
You can also link to pages of another project's wiki:
22 3 Jean-Philippe Lang
23 1 Jean-Philippe Lang
* *[[sandbox:some page]]* displays a link to the page named 'Some page' of the Sandbox wiki
24 1 Jean-Philippe Lang
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
25 1 Jean-Philippe Lang
26 1 Jean-Philippe Lang
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
27 1 Jean-Philippe Lang
28 32 Jean-Philippe Lang
Links to others resources:
29 6 Jean-Philippe Lang
30 6 Jean-Philippe Lang
* Documents:
31 6 Jean-Philippe Lang
32 6 Jean-Philippe Lang
  * *!document#17* (link to document with id 17)
33 6 Jean-Philippe Lang
  * *!document:Greetings* (link to the document with title "Greetings")
34 6 Jean-Philippe Lang
  * *!document:"Some document"* (double quotes can be used when document title contains spaces)
35 43 Markus Valle-Klann
  * *!document:some_project:"Some document"* (link to a document in a different project)
36 6 Jean-Philippe Lang
37 6 Jean-Philippe Lang
* Versions:
38 6 Jean-Philippe Lang
39 6 Jean-Philippe Lang
  * *!version#3* (link to version with id 3)
40 6 Jean-Philippe Lang
  * *!version:1.0.0* (link to version named "1.0.0")
41 6 Jean-Philippe Lang
  * *!version:"1.0 beta 2"*
42 6 Jean-Philippe Lang
43 44 Anh Tu Sam
* Projects:
44 44 Anh Tu Sam
45 44 Anh Tu Sam
  * *project#<id>* (link to project with <id>)
46 44 Anh Tu Sam
  * *!project:<identifier>*
47 44 Anh Tu Sam
  * *!project:<name>*
48 44 Anh Tu Sam
49 1 Jean-Philippe Lang
* Attachments:
50 6 Jean-Philippe Lang
  
51 6 Jean-Philippe Lang
  * *!attachment:file.zip* (link to the attachment of the current object named file.zip)
52 68 Jean-Philippe Lang
  * *!attachment:"file.zip"* (double quotes can be used when the filename contains non word characters)
53 6 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)
54 1 Jean-Philippe Lang
55 14 Jean-Philippe Lang
* Repository files
56 14 Jean-Philippe Lang
57 39 Yuki Kita
  * *!source:some/file*           -- Link to the file located at /some/file in the project's repository
58 39 Yuki Kita
  * *!source:some/file@52*        -- Link to the file's revision 52
59 39 Yuki Kita
  * *!source:some/file#L120*      -- Link to line 120 of the file
60 39 Yuki Kita
  * *!source:some/file@52#L120*   -- Link to line 120 of the file's revision 52
61 77 Thomas Themel
  * *!source:"some file@52#L120"* -- Double quotes can be used when the URL contains spaces  
62 77 Thomas Themel
  * *!source:repo_identifier|some/file* -- Link to a file in a repository other than the project default repository. 
63 77 Thomas Themel
  * *!source:"repo_identifier|some file"* -- Link to a file in a repository other than the project default repository, with spaces in the path. 
64 1 Jean-Philippe Lang
  * *!export:some/file*           -- Force the download of the file
65 77 Thomas Themel
 
66 14 Jean-Philippe Lang
67 32 Jean-Philippe Lang
Escaping:
68 6 Jean-Philippe Lang
69 6 Jean-Philippe Lang
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
70 6 Jean-Philippe Lang
71 42 Andrew Quach Huynh
h3. External links
72 5 Jean-Philippe Lang
73 5 Jean-Philippe Lang
HTTP URLs and email addresses are automatically turned into clickable links: 
74 47 Ian Epperson
* *http&#58;//www.redmine.org* -- External link to the redmine website: http://www.redmine.org
75 47 Ian Epperson
* *someone&#64;foo.bar* -- Link to an email address: someone@foo.bar
76 5 Jean-Philippe Lang
77 51 Graham King
HTTP URLs and email addresses can also use different text than the link itself:
78 47 Ian Epperson
* *"Redmine web site"&#58;http&#58;//www.redmine.org* -- External link with different text: "Redmine web site":http://www.redmine.org
79 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: 
80 70 Jean-Philippe Lang
81 70 Jean-Philippe Lang
p=. !http://www.redmine.org/attachments/7069/Redmine_logo.png(Redmine web site)!:http://www.redmine.org
82 70 Jean-Philippe Lang
83 47 Ian Epperson
* *"Email someone"&#58;mailto&#58;someone&#64;foo.bar* -- Email link with different text: "Email someone":mailto:someone@foo.bar
84 1 Jean-Philippe Lang
85 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.
86 48 Ian Epperson
* *"Email webmaster and admin"&#58;mailto&#58;webmaster&#64;foo.bar?cc=admin&#64;foo.bar* -- Email to webmaster, CC admin:  "Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar
87 48 Ian Epperson
* *"Email someone for help"&#58;mailto&#58;someone&#64;foo.bar?subject=Website%20Help* -- Email link with the subject "Website Help": "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help
88 48 Ian Epperson
* *"Email someone for help"&#58;mailto&#58;someone&#64;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
89 48 Ian Epperson
90 1 Jean-Philippe Lang
h2. Text formatting
91 10 John Goerzen
92 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.
93 1 Jean-Philippe Lang
94 38 ha thach
h3. Acronym
95 38 ha thach
96 38 ha thach
<pre>
97 38 ha thach
JPL(Jean-Philippe Lang)
98 38 ha thach
</pre>
99 38 ha thach
100 38 ha thach
Display:
101 38 ha thach
102 38 ha thach
JPL(Jean-Philippe Lang)
103 38 ha thach
104 1 Jean-Philippe Lang
h3. Font style
105 1 Jean-Philippe Lang
106 1 Jean-Philippe Lang
<pre><code>* *bold*
107 1 Jean-Philippe Lang
* _italic_
108 19 Pavel Schichko
* *_bold italic_*
109 1 Jean-Philippe Lang
* +underline+
110 1 Jean-Philippe Lang
* -strike-through-
111 45 Ian Epperson
* Plain ^superscript^
112 45 Ian Epperson
* Plain ~subscript~
113 63 Colin Sullivan
* @inline monospace@
114 1 Jean-Philippe Lang
</code></pre>
115 1 Jean-Philippe Lang
116 1 Jean-Philippe Lang
Display:
117 1 Jean-Philippe Lang
118 1 Jean-Philippe Lang
 * *bold*
119 1 Jean-Philippe Lang
 * _italic_
120 19 Pavel Schichko
 * *_bold italic_*
121 1 Jean-Philippe Lang
 * +underline+
122 1 Jean-Philippe Lang
 * -strike-through-
123 45 Ian Epperson
 * Plain ^superscript^
124 45 Ian Epperson
 * Plain ~subscript~
125 63 Colin Sullivan
 * @inline monospace@
126 1 Jean-Philippe Lang
127 1 Jean-Philippe Lang
h3. Inline images
128 9 Jean-Philippe Lang
129 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
130 1 Jean-Philippe Lang
* *&#33;>image_url&#33;* right floating image
131 66 Jean-Philippe Lang
* *&#33;image_url(Image title)&#33;* displays an image with an alt/title attribute
132 73 Dieter Egert
* *&#33;image_url&#33;:URL* displays an image located at image_url with link URL added
133 18 samir djouadi
134 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;*
135 1 Jean-Philippe Lang
136 1 Jean-Philippe Lang
h3. Headings
137 1 Jean-Philippe Lang
138 1 Jean-Philippe Lang
<pre><code>h1. Heading
139 66 Jean-Philippe Lang
140 1 Jean-Philippe Lang
h2. Subheading
141 66 Jean-Philippe Lang
142 1 Jean-Philippe Lang
h3. Subheading
143 1 Jean-Philippe Lang
</code></pre>
144 1 Jean-Philippe Lang
145 1 Jean-Philippe Lang
h3. Paragraphs
146 1 Jean-Philippe Lang
147 58 Dieter Egert
<pre><code>p. left aligned
148 58 Dieter Egert
149 60 Dieter Egert
  p(. left ident 1em
150 58 Dieter Egert
151 60 Dieter Egert
    p((. left ident 2em
152 60 Dieter Egert
    as well as for following lines
153 58 Dieter Egert
154 60 Dieter Egert
                                                                                   p>. right aligned
155 58 Dieter Egert
156 60 Dieter Egert
                                                                        p)))>. right ident 3em
157 58 Dieter Egert
158 60 Dieter Egert
                           p=. This is centered paragraph.
159 1 Jean-Philippe Lang
</code></pre>
160 1 Jean-Philippe Lang
161 1 Jean-Philippe Lang
h3. Predefined
162 1 Jean-Philippe Lang
163 1 Jean-Philippe Lang
To escape wiki syntax
164 58 Dieter Egert
<pre> <pre> *Your text won't become bold* </pre> </pre>
165 36 ha thach
Display:
166 37 ha thach
167 1 Jean-Philippe Lang
<pre> *Your text won't become bold* </pre>
168 38 ha thach
169 38 ha thach
h3. Blockquotes
170 37 ha thach
171 60 Dieter Egert
Start the paragraph with *bq.*  or > (also stacked: >>)
172 1 Jean-Philippe Lang
173 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.
174 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
175 1 Jean-Philippe Lang
</code></pre>
176 1 Jean-Philippe Lang
177 1 Jean-Philippe Lang
Display:
178 1 Jean-Philippe Lang
179 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
180 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
181 1 Jean-Philippe Lang
182 60 Dieter Egert
>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
183 60 Dieter Egert
To go live, all you need to add is a database and a web server. (starting with >>)
184 60 Dieter Egert
185 28 Jean-Philippe Lang
h3. Unordered lists
186 28 Jean-Philippe Lang
187 28 Jean-Philippe Lang
<pre>
188 28 Jean-Philippe Lang
* Item 1
189 28 Jean-Philippe Lang
* Item 2
190 29 Eric Gallimore
** Item 21
191 29 Eric Gallimore
** Item 22
192 28 Jean-Philippe Lang
* Item 3
193 28 Jean-Philippe Lang
</pre>
194 28 Jean-Philippe Lang
195 28 Jean-Philippe Lang
displays:
196 1 Jean-Philippe Lang
197 28 Jean-Philippe Lang
* Item 1
198 28 Jean-Philippe Lang
* Item 2
199 29 Eric Gallimore
** Item 21
200 28 Jean-Philippe Lang
** Item 22
201 28 Jean-Philippe Lang
* Item 3
202 1 Jean-Philippe Lang
203 1 Jean-Philippe Lang
h3. Ordered lists
204 1 Jean-Philippe Lang
205 28 Jean-Philippe Lang
<pre>
206 28 Jean-Philippe Lang
# Item 1
207 28 Jean-Philippe Lang
# Item 2
208 28 Jean-Philippe Lang
# Item 3
209 28 Jean-Philippe Lang
## Item 3.1
210 28 Jean-Philippe Lang
## Item 3.2
211 1 Jean-Philippe Lang
</pre>
212 29 Eric Gallimore
213 29 Eric Gallimore
displays:
214 1 Jean-Philippe Lang
215 20 Kirill Ponomarev
# Item 1
216 20 Kirill Ponomarev
# Item 2
217 20 Kirill Ponomarev
# Item 3
218 21 Andrew Chaika
## Item 3.1
219 21 Andrew Chaika
## Item 3.2
220 21 Andrew Chaika
221 1 Jean-Philippe Lang
h3. Tables
222 1 Jean-Philippe Lang
223 1 Jean-Philippe Lang
<pre>
224 71 Dieter Egert
|_.UserID     |_.Name|_.Group|_. attribute list  |
225 72 Dieter Egert
|Starting with| a    |   simple|row |
226 60 Dieter Egert
|\3=.IT               |<. align left|
227 60 Dieter Egert
|1|Artur Pirozhkov |/2.Users |>. align right|
228 60 Dieter Egert
|2|Vasya Rogov        |=. center |
229 58 Dieter Egert
|3|John Smith |Admin
230 58 Dieter Egert
               (root)|^. valign top |
231 58 Dieter Egert
|4|-          |Nobody
232 58 Dieter Egert
               (anonymous)|~. valign bottom|
233 20 Kirill Ponomarev
</pre>
234 21 Andrew Chaika
235 1 Jean-Philippe Lang
displays (all multiple spaces are replaced by 1 space):
236 1 Jean-Philippe Lang
237 71 Dieter Egert
|_.UserID     |_.Name|_.Group|_. attribute list   |
238 72 Dieter Egert
|Starting with| a    |   simple|row |
239 60 Dieter Egert
|\3=.IT                |<. align left|
240 60 Dieter Egert
|1|Artur Pirozhkov |/2.Users |>. align right|
241 60 Dieter Egert
|2|Vasya Rogov         |=. center |
242 58 Dieter Egert
|3|John Smith |Admin
243 58 Dieter Egert
               (root)|^. valign top |
244 58 Dieter Egert
|4|-          |Nobody
245 58 Dieter Egert
               (anonymous)|~. valign bottom|
246 1 Jean-Philippe Lang
247 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:
248 78 Thomas Themel
249 78 Thomas Themel
|_.Input |_. Output|
250 78 Thomas Themel
|*<notextile><notextile>|</notextile></notextile>*|<notextile>|</notextile>|
251 78 Thomas Themel
252 1 Jean-Philippe Lang
h3. Table of content
253 1 Jean-Philippe Lang
254 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
255 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
256 1 Jean-Philippe Lang
</code></pre>
257 7 Jean-Philippe Lang
258 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.
259 79 Mike Bison
260 79 Mike Bison
Example:
261 79 Mike Bison
262 79 Mike Bison
<pre><code>
263 79 Mike Bison
h1. headLineOne
264 79 Mike Bison
265 79 Mike Bison
h2. something
266 79 Mike Bison
267 79 Mike Bison
{{toc}}
268 79 Mike Bison
269 79 Mike Bison
h2. something more
270 79 Mike Bison
</code></pre>
271 79 Mike Bison
272 7 Jean-Philippe Lang
h2. Macros
273 7 Jean-Philippe Lang
274 7 Jean-Philippe Lang
Redmine has the following builtin macros:
275 7 Jean-Philippe Lang
276 7 Jean-Philippe Lang
{{macro_list}}
277 7 Jean-Philippe Lang
278 1 Jean-Philippe Lang
279 4 Jean-Philippe Lang
h2. Code highlighting
280 51 Graham King
281 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.
282 1 Jean-Philippe Lang
283 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
284 1 Jean-Philippe Lang
285 49 Dave Clements
<pre><code><pre><code class="ruby">
286 1 Jean-Philippe Lang
  Place your code here.
287 40 Mischa The Evil
</code></pre>
288 1 Jean-Philippe Lang
</code></pre>
289 1 Jean-Philippe Lang
290 1 Jean-Philippe Lang
Example:
291 1 Jean-Philippe Lang
292 1 Jean-Philippe Lang
<pre><code class="ruby">
293 1 Jean-Philippe Lang
# The Greeter class
294 1 Jean-Philippe Lang
class Greeter
295 1 Jean-Philippe Lang
  def initialize(name)
296 1 Jean-Philippe Lang
    @name = name.capitalize
297 1 Jean-Philippe Lang
  end
298 1 Jean-Philippe Lang
 
299 1 Jean-Philippe Lang
  def salute
300 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
301 1 Jean-Philippe Lang
  end
302 40 Mischa The Evil
end
303 52 Vladimir Vasilkin
</code></pre>
304 52 Vladimir Vasilkin
305 52 Vladimir Vasilkin
h2. Translation
306 1 Jean-Philippe Lang
307 75 Caille Rotie
Note that the following translations may not be up to date. Please refer to the original english documentation if needed.
308 52 Vladimir Vasilkin
309 75 Caille Rotie
* [[RusRedmineTextFormatting|Перевод на русский]]
310 75 Caille Rotie
* [[FrRedmineWikiFormatting|French]]