Project

General

Profile

RedmineTextFormatting » History » Version 42

Andrew Quach Huynh, 2010-09-23 16:44

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