Project

General

Profile

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
3
{{>TOC}}
4
5
h2. Links
6
7 6 Jean-Philippe Lang
h3. Redmine links
8
9 1 Jean-Philippe Lang
Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.
10
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
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
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
25
26
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
27
28 32 Jean-Philippe Lang
Links to others resources:
29 6 Jean-Philippe Lang
30
* Documents:
31
32
  * *!document#17* (link to document with id 17)
33
  * *!document:Greetings* (link to the document with title "Greetings")
34
  * *!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
* Versions:
38
39
  * *!version#3* (link to version with id 3)
40
  * *!version:1.0.0* (link to version named "1.0.0")
41
  * *!version:"1.0 beta 2"*
42
43 44 Anh Tu Sam
* Projects:
44
45
  * *project#<id>* (link to project with <id>)
46
  * *!project:<identifier>*
47
  * *!project:<name>*
48
49 6 Jean-Philippe Lang
* Attachments:
50
  
51
  * *!attachment:file.zip* (link to the attachment of the current object named file.zip)
52
  * 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
56 39 Yuki Kita
  * *!source:some/file*           -- Link to the file located at /some/file in the project's repository
57
  * *!source:some/file@52*        -- Link to the file's revision 52
58
  * *!source:some/file#L120*      -- Link to line 120 of the file
59
  * *!source:some/file@52#L120*   -- Link to line 120 of the file's revision 52
60
  * *!source:"some file@52#L120"* -- Double quotes can be used when the URL contains spaces
61
  * *!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
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
66
67 42 Andrew Quach Huynh
h3. External links
68 5 Jean-Philippe Lang
69
HTTP URLs and email addresses are automatically turned into clickable links: 
70
71
<pre>
72
http://www.redmine.org, someone@foo.bar
73
</pre>
74
75
displays: http://www.redmine.org, someone@foo.bar
76
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
<pre>
80
"Redmine web site":http://www.redmine.org
81
</pre>
82
83 1 Jean-Philippe Lang
displays: "Redmine web site":http://www.redmine.org
84
85
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
91
<pre>
92
JPL(Jean-Philippe Lang)
93
</pre>
94
95
Display:
96
97
JPL(Jean-Philippe Lang)
98
99 1 Jean-Philippe Lang
h3. Font style
100
101
<pre><code>* *bold*
102
* _italic_
103 19 Pavel Schichko
* *_bold italic_*
104 1 Jean-Philippe Lang
* +underline+
105
* -strike-through-
106 45 Ian Epperson
* Plain ^superscript^
107
* Plain ~subscript~
108 1 Jean-Philippe Lang
</code></pre>
109
110
Display:
111
112
 * *bold*
113
 * _italic_
114 19 Pavel Schichko
 * *_bold italic_*
115 1 Jean-Philippe Lang
 * +underline+
116
 * -strike-through-
117 45 Ian Epperson
 * Plain ^superscript^
118
 * Plain ~subscript~
119 1 Jean-Philippe Lang
120
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
* *&#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
h3. Headings
129
130
<pre><code>h1. Heading
131
h2. Subheading
132
h3. Subheading
133
</code></pre>
134
135
h3. Paragraphs
136
137
<pre><code>p>. right aligned
138
p=. centered
139 2 Jean-Philippe Lang
</code></pre>
140 1 Jean-Philippe Lang
141
p=. This is centered paragraph.
142 36 ha thach
143
h3. Predefined
144
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
149 37 ha thach
<pre> *Your text won't become bold* </pre>
150 36 ha thach
151 1 Jean-Philippe Lang
h3. Blockquotes
152
153
Start the paragraph with *bq.*
154
155
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
156
To go live, all you need to add is a database and a web server.
157
</code></pre>
158
159
Display:
160
161
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
162
To go live, all you need to add is a database and a web server.
163
164 28 Jean-Philippe Lang
h3. Unordered lists
165
166
<pre>
167
* Item 1
168
* Item 2
169 29 Eric Gallimore
** Item 21
170
** Item 22
171 28 Jean-Philippe Lang
* Item 3
172
</pre>
173
174
displays:
175 1 Jean-Philippe Lang
176 28 Jean-Philippe Lang
* Item 1
177
* Item 2
178 29 Eric Gallimore
** Item 21
179
** Item 22
180 28 Jean-Philippe Lang
* Item 3
181
182 1 Jean-Philippe Lang
h3. Ordered lists
183
184 28 Jean-Philippe Lang
<pre>
185
# Item 1
186
# Item 2
187
# Item 3
188 29 Eric Gallimore
## Item 3.1
189
## Item 3.2
190 28 Jean-Philippe Lang
</pre>
191 1 Jean-Philippe Lang
192
displays:
193 28 Jean-Philippe Lang
194
# Item 1
195
# Item 2
196
# Item 3
197 29 Eric Gallimore
## Item 3.1
198
## Item 3.2
199 28 Jean-Philippe Lang
200 20 Kirill Ponomarev
h3. Tables
201
202
<pre>
203 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
204
|\3=.IT|
205
|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
210
Display:
211
212 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
213
|\3=.IT|
214
|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
220
<pre><code>{{toc}} => left aligned toc
221
{{>toc}} => right aligned toc
222
</code></pre>
223
224 7 Jean-Philippe Lang
h2. Macros
225
226
Redmine has the following builtin macros:
227
228
{{macro_list}}
229
230
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
235
You can highlight code in your wiki page using this syntax:
236
237
<pre><code><pre><code class="ruby">
238
  Place you code here.
239
</code></pre>
240 40 Mischa The Evil
</code></pre>
241 1 Jean-Philippe Lang
242
Example:
243
244
<pre><code class="ruby">
245
# The Greeter class
246
class Greeter
247
  def initialize(name)
248
    @name = name.capitalize
249
  end
250
 
251
  def salute
252
    puts "Hello #{@name}!"
253
  end
254
end
255 40 Mischa The Evil
</code></pre>