RedmineTextFormatting » History » Version 46

Ian Epperson, 2010-12-03 02:48
Changed the term - the user is unlikely to know about Textile and the concept isn't introduced prior to this mention.

1 1 Jean-Philippe Lang
h1. Wiki 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 1 Jean-Philippe Lang
Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki 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 16 Jean-Philippe Lang
* Link to a changeset with a non-numeric hash: *commit:c6f4d0fd* (displays c6f4d0fd).  Added in r1236.
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 1 Jean-Philippe Lang
* *[[Guide|User manual]]* displays a link to the same page but with a different text: [[Guide|User manual]]
19 22 Kirill Ponomarev
* *[[Guide#User-guide|User guide]]* displays a link to the header on the same page with a different text: [[Guide#User-guide|User guide]]
20 1 Jean-Philippe Lang
21 1 Jean-Philippe Lang
You can also link to pages of an other project 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 6 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 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)
53 1 Jean-Philippe Lang
54 14 Jean-Philippe Lang
* Repository files
55 14 Jean-Philippe Lang
56 39 Yuki Kita
  * *!source:some/file*           -- Link to the file located at /some/file in the project's repository
57 39 Yuki Kita
  * *!source:some/file@52*        -- Link to the file's revision 52
58 39 Yuki Kita
  * *!source:some/file#L120*      -- Link to line 120 of the file
59 39 Yuki Kita
  * *!source:some/file@52#L120*   -- Link to line 120 of the file's revision 52
60 39 Yuki Kita
  * *!source:"some file@52#L120"* -- Double quotes can be used when the URL contains spaces
61 39 Yuki Kita
  * *!export:some/file*           -- Force the download of the file
62 14 Jean-Philippe Lang
63 32 Jean-Philippe Lang
Escaping:
64 6 Jean-Philippe Lang
65 6 Jean-Philippe Lang
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
66 6 Jean-Philippe Lang
67 42 Andrew Quach Huynh
h3. External links
68 5 Jean-Philippe Lang
69 5 Jean-Philippe Lang
HTTP URLs and email addresses are automatically turned into clickable links: 
70 5 Jean-Philippe Lang
71 5 Jean-Philippe Lang
<pre>
72 5 Jean-Philippe Lang
http://www.redmine.org, someone@foo.bar
73 5 Jean-Philippe Lang
</pre>
74 5 Jean-Philippe Lang
75 5 Jean-Philippe Lang
displays: http://www.redmine.org, someone@foo.bar
76 5 Jean-Philippe Lang
77 46 Ian Epperson
If you want to display a specific text instead of the URL, you can use the following syntax:
78 5 Jean-Philippe Lang
79 5 Jean-Philippe Lang
<pre>
80 5 Jean-Philippe Lang
"Redmine web site":http://www.redmine.org
81 5 Jean-Philippe Lang
</pre>
82 5 Jean-Philippe Lang
83 1 Jean-Philippe Lang
displays: "Redmine web site":http://www.redmine.org
84 1 Jean-Philippe Lang
85 1 Jean-Philippe Lang
h2. Text formatting
86 10 John Goerzen
87 27 Jean-Philippe Lang
For things such as headlines, bold, tables, lists, Redmine supports Textile syntax.  See http://www.textism.com/tools/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.
88 1 Jean-Philippe Lang
89 38 ha thach
h3. Acronym
90 38 ha thach
91 38 ha thach
<pre>
92 38 ha thach
JPL(Jean-Philippe Lang)
93 38 ha thach
</pre>
94 38 ha thach
95 38 ha thach
Display:
96 38 ha thach
97 38 ha thach
JPL(Jean-Philippe Lang)
98 38 ha thach
99 1 Jean-Philippe Lang
h3. Font style
100 1 Jean-Philippe Lang
101 1 Jean-Philippe Lang
<pre><code>* *bold*
102 1 Jean-Philippe Lang
* _italic_
103 19 Pavel Schichko
* *_bold italic_*
104 1 Jean-Philippe Lang
* +underline+
105 1 Jean-Philippe Lang
* -strike-through-
106 45 Ian Epperson
* Plain ^superscript^
107 45 Ian Epperson
* Plain ~subscript~
108 1 Jean-Philippe Lang
</code></pre>
109 1 Jean-Philippe Lang
110 1 Jean-Philippe Lang
Display:
111 1 Jean-Philippe Lang
112 1 Jean-Philippe Lang
 * *bold*
113 1 Jean-Philippe Lang
 * _italic_
114 19 Pavel Schichko
 * *_bold italic_*
115 1 Jean-Philippe Lang
 * +underline+
116 1 Jean-Philippe Lang
 * -strike-through-
117 45 Ian Epperson
 * Plain ^superscript^
118 45 Ian Epperson
 * Plain ~subscript~
119 1 Jean-Philippe Lang
120 1 Jean-Philippe Lang
h3. Inline images
121 9 Jean-Philippe Lang
122 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
123 1 Jean-Philippe Lang
* *&#33;>image_url&#33;* right floating image
124 15 Jean-Philippe Lang
* *&#33;{width:300px}image_url&#33;* sets the width of the image
125 18 samir djouadi
126 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;*
127 1 Jean-Philippe Lang
128 1 Jean-Philippe Lang
h3. Headings
129 1 Jean-Philippe Lang
130 1 Jean-Philippe Lang
<pre><code>h1. Heading
131 1 Jean-Philippe Lang
h2. Subheading
132 1 Jean-Philippe Lang
h3. Subheading
133 1 Jean-Philippe Lang
</code></pre>
134 1 Jean-Philippe Lang
135 1 Jean-Philippe Lang
h3. Paragraphs
136 1 Jean-Philippe Lang
137 1 Jean-Philippe Lang
<pre><code>p>. right aligned
138 1 Jean-Philippe Lang
p=. centered
139 2 Jean-Philippe Lang
</code></pre>
140 1 Jean-Philippe Lang
141 1 Jean-Philippe Lang
p=. This is centered paragraph.
142 36 ha thach
143 36 ha thach
h3. Predefined
144 36 ha thach
145 37 ha thach
To escape wiki syntax
146 1 Jean-Philippe Lang
<pre> <pre> *Your text won't become bold* </pre> </pre>
147 38 ha thach
Display:
148 38 ha thach
149 37 ha thach
<pre> *Your text won't become bold* </pre>
150 36 ha thach
151 1 Jean-Philippe Lang
h3. Blockquotes
152 1 Jean-Philippe Lang
153 1 Jean-Philippe Lang
Start the paragraph with *bq.*
154 1 Jean-Philippe Lang
155 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.
156 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
157 1 Jean-Philippe Lang
</code></pre>
158 1 Jean-Philippe Lang
159 1 Jean-Philippe Lang
Display:
160 1 Jean-Philippe Lang
161 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
162 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
163 1 Jean-Philippe Lang
164 28 Jean-Philippe Lang
h3. Unordered lists
165 28 Jean-Philippe Lang
166 28 Jean-Philippe Lang
<pre>
167 28 Jean-Philippe Lang
* Item 1
168 28 Jean-Philippe Lang
* Item 2
169 29 Eric Gallimore
** Item 21
170 29 Eric Gallimore
** Item 22
171 28 Jean-Philippe Lang
* Item 3
172 28 Jean-Philippe Lang
</pre>
173 28 Jean-Philippe Lang
174 28 Jean-Philippe Lang
displays:
175 1 Jean-Philippe Lang
176 28 Jean-Philippe Lang
* Item 1
177 28 Jean-Philippe Lang
* Item 2
178 29 Eric Gallimore
** Item 21
179 29 Eric Gallimore
** Item 22
180 28 Jean-Philippe Lang
* Item 3
181 28 Jean-Philippe Lang
182 1 Jean-Philippe Lang
h3. Ordered lists
183 1 Jean-Philippe Lang
184 28 Jean-Philippe Lang
<pre>
185 28 Jean-Philippe Lang
# Item 1
186 28 Jean-Philippe Lang
# Item 2
187 28 Jean-Philippe Lang
# Item 3
188 29 Eric Gallimore
## Item 3.1
189 29 Eric Gallimore
## Item 3.2
190 28 Jean-Philippe Lang
</pre>
191 1 Jean-Philippe Lang
192 1 Jean-Philippe Lang
displays:
193 28 Jean-Philippe Lang
194 28 Jean-Philippe Lang
# Item 1
195 28 Jean-Philippe Lang
# Item 2
196 28 Jean-Philippe Lang
# Item 3
197 29 Eric Gallimore
## Item 3.1
198 29 Eric Gallimore
## Item 3.2
199 28 Jean-Philippe Lang
200 20 Kirill Ponomarev
h3. Tables
201 20 Kirill Ponomarev
202 20 Kirill Ponomarev
<pre>
203 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
204 21 Andrew Chaika
|\3=.IT|
205 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
206 20 Kirill Ponomarev
|2|Vasya Rogov|
207 21 Andrew Chaika
|3|John Smith|Admin|
208 1 Jean-Philippe Lang
</pre>
209 1 Jean-Philippe Lang
210 1 Jean-Philippe Lang
Display:
211 1 Jean-Philippe Lang
212 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
213 21 Andrew Chaika
|\3=.IT|
214 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
215 20 Kirill Ponomarev
|2|Vasya Rogov|
216 21 Andrew Chaika
|3|John Smith|Admin|
217 20 Kirill Ponomarev
218 1 Jean-Philippe Lang
h3. Table of content
219 1 Jean-Philippe Lang
220 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
221 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
222 1 Jean-Philippe Lang
</code></pre>
223 1 Jean-Philippe Lang
224 7 Jean-Philippe Lang
h2. Macros
225 7 Jean-Philippe Lang
226 7 Jean-Philippe Lang
Redmine has the following builtin macros:
227 7 Jean-Philippe Lang
228 7 Jean-Philippe Lang
{{macro_list}}
229 7 Jean-Philippe Lang
230 7 Jean-Philippe Lang
231 1 Jean-Philippe Lang
h2. Code highlighting
232 4 Jean-Philippe Lang
233 1 Jean-Philippe Lang
Code highlightment relies on "CodeRay":http://coderay.rubychan.de/, a fast syntax highlighting library written completely in Ruby. It currently supports c, html, javascript, rhtml, ruby, scheme, xml languages.
234 1 Jean-Philippe Lang
235 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
236 1 Jean-Philippe Lang
237 1 Jean-Philippe Lang
<pre><code><pre><code class="ruby">
238 1 Jean-Philippe Lang
  Place you code here.
239 1 Jean-Philippe Lang
</code></pre>
240 40 Mischa The Evil
</code></pre>
241 1 Jean-Philippe Lang
242 1 Jean-Philippe Lang
Example:
243 1 Jean-Philippe Lang
244 1 Jean-Philippe Lang
<pre><code class="ruby">
245 1 Jean-Philippe Lang
# The Greeter class
246 1 Jean-Philippe Lang
class Greeter
247 1 Jean-Philippe Lang
  def initialize(name)
248 1 Jean-Philippe Lang
    @name = name.capitalize
249 1 Jean-Philippe Lang
  end
250 1 Jean-Philippe Lang
 
251 1 Jean-Philippe Lang
  def salute
252 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
253 1 Jean-Philippe Lang
  end
254 1 Jean-Philippe Lang
end
255 40 Mischa The Evil
</code></pre>