Project

General

Profile

RedmineTextFormatting » History » Version 47

Ian Epperson, 2010-12-03 03:09
Cleaned up the external links section to match the others, and added how to use alt text with email links

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 47 Ian Epperson
* *http&#58;//www.redmine.org* -- External link to the redmine website: http://www.redmine.org
71
* *someone&#64;foo.bar* -- Link to an email address: someone@foo.bar
72 5 Jean-Philippe Lang
73 47 Ian Epperson
HTTP URLs an email addresses can also use different text than the link itself:
74
* *"Redmine web site"&#58;http&#58;//www.redmine.org* -- External link with different text: "Redmine web site":http://www.redmine.org
75
* *"Email someone"&#58;mailto&#58;someone&#64;foo.bar* -- Email link with different text: "Email someone":mailto:someone@foo.bar
76 1 Jean-Philippe Lang
77
h2. Text formatting
78 10 John Goerzen
79 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.
80 1 Jean-Philippe Lang
81 38 ha thach
h3. Acronym
82
83
<pre>
84
JPL(Jean-Philippe Lang)
85
</pre>
86
87
Display:
88
89
JPL(Jean-Philippe Lang)
90
91 1 Jean-Philippe Lang
h3. Font style
92
93
<pre><code>* *bold*
94
* _italic_
95 19 Pavel Schichko
* *_bold italic_*
96 1 Jean-Philippe Lang
* +underline+
97
* -strike-through-
98 45 Ian Epperson
* Plain ^superscript^
99
* Plain ~subscript~
100 1 Jean-Philippe Lang
</code></pre>
101
102
Display:
103
104
 * *bold*
105
 * _italic_
106 19 Pavel Schichko
 * *_bold italic_*
107 1 Jean-Philippe Lang
 * +underline+
108
 * -strike-through-
109 45 Ian Epperson
 * Plain ^superscript^
110
 * Plain ~subscript~
111 1 Jean-Philippe Lang
112
h3. Inline images
113 9 Jean-Philippe Lang
114 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
115
* *&#33;>image_url&#33;* right floating image
116 15 Jean-Philippe Lang
* *&#33;{width:300px}image_url&#33;* sets the width of the image
117 18 samir djouadi
118 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;*
119 1 Jean-Philippe Lang
120
h3. Headings
121
122
<pre><code>h1. Heading
123
h2. Subheading
124
h3. Subheading
125
</code></pre>
126
127
h3. Paragraphs
128
129
<pre><code>p>. right aligned
130
p=. centered
131 2 Jean-Philippe Lang
</code></pre>
132 1 Jean-Philippe Lang
133
p=. This is centered paragraph.
134 36 ha thach
135
h3. Predefined
136
137 37 ha thach
To escape wiki syntax
138 1 Jean-Philippe Lang
<pre> <pre> *Your text won't become bold* </pre> </pre>
139 38 ha thach
Display:
140
141 37 ha thach
<pre> *Your text won't become bold* </pre>
142 36 ha thach
143 1 Jean-Philippe Lang
h3. Blockquotes
144
145
Start the paragraph with *bq.*
146
147
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
148
To go live, all you need to add is a database and a web server.
149
</code></pre>
150
151
Display:
152
153
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
154
To go live, all you need to add is a database and a web server.
155
156 28 Jean-Philippe Lang
h3. Unordered lists
157
158
<pre>
159
* Item 1
160
* Item 2
161 29 Eric Gallimore
** Item 21
162
** Item 22
163 28 Jean-Philippe Lang
* Item 3
164
</pre>
165
166
displays:
167 1 Jean-Philippe Lang
168 28 Jean-Philippe Lang
* Item 1
169
* Item 2
170 29 Eric Gallimore
** Item 21
171
** Item 22
172 28 Jean-Philippe Lang
* Item 3
173
174 1 Jean-Philippe Lang
h3. Ordered lists
175
176 28 Jean-Philippe Lang
<pre>
177
# Item 1
178
# Item 2
179
# Item 3
180 29 Eric Gallimore
## Item 3.1
181
## Item 3.2
182 28 Jean-Philippe Lang
</pre>
183 1 Jean-Philippe Lang
184
displays:
185 28 Jean-Philippe Lang
186
# Item 1
187
# Item 2
188
# Item 3
189 29 Eric Gallimore
## Item 3.1
190
## Item 3.2
191 28 Jean-Philippe Lang
192 20 Kirill Ponomarev
h3. Tables
193
194
<pre>
195 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
196
|\3=.IT|
197
|1|Artur Pirozhkov|/2.Users|
198 20 Kirill Ponomarev
|2|Vasya Rogov|
199 21 Andrew Chaika
|3|John Smith|Admin|
200 1 Jean-Philippe Lang
</pre>
201
202
Display:
203
204 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
205
|\3=.IT|
206
|1|Artur Pirozhkov|/2.Users|
207 20 Kirill Ponomarev
|2|Vasya Rogov|
208 21 Andrew Chaika
|3|John Smith|Admin|
209 20 Kirill Ponomarev
210 1 Jean-Philippe Lang
h3. Table of content
211
212
<pre><code>{{toc}} => left aligned toc
213
{{>toc}} => right aligned toc
214
</code></pre>
215
216 7 Jean-Philippe Lang
h2. Macros
217
218
Redmine has the following builtin macros:
219
220
{{macro_list}}
221
222
223 1 Jean-Philippe Lang
h2. Code highlighting
224 4 Jean-Philippe Lang
225 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.
226
227
You can highlight code in your wiki page using this syntax:
228
229
<pre><code><pre><code class="ruby">
230
  Place you code here.
231
</code></pre>
232 40 Mischa The Evil
</code></pre>
233 1 Jean-Philippe Lang
234
Example:
235
236
<pre><code class="ruby">
237
# The Greeter class
238
class Greeter
239
  def initialize(name)
240
    @name = name.capitalize
241
  end
242
 
243
  def salute
244
    puts "Hello #{@name}!"
245
  end
246
end
247 40 Mischa The Evil
</code></pre>