Project

General

Profile

RedmineTextFormatting » History » Version 60

Dieter Egert, 2011-06-17 17:51

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 51 Graham King
* *[[Guide|User manual]]* displays a link to the same page but with different text: [[Guide|User manual]]
19
* *[[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
* *[[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 51 Graham King
HTTP URLs and email addresses can also use different text than the link itself:
74 47 Ian Epperson
* *"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 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.
78
* *"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
79
* *"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
80
* *"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
81
82 1 Jean-Philippe Lang
h2. Text formatting
83 10 John Goerzen
84 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.
85 1 Jean-Philippe Lang
86 38 ha thach
h3. Acronym
87
88
<pre>
89
JPL(Jean-Philippe Lang)
90
</pre>
91
92
Display:
93
94
JPL(Jean-Philippe Lang)
95
96 1 Jean-Philippe Lang
h3. Font style
97
98
<pre><code>* *bold*
99
* _italic_
100 19 Pavel Schichko
* *_bold italic_*
101 1 Jean-Philippe Lang
* +underline+
102
* -strike-through-
103 45 Ian Epperson
* Plain ^superscript^
104
* Plain ~subscript~
105 1 Jean-Philippe Lang
</code></pre>
106
107
Display:
108
109
 * *bold*
110
 * _italic_
111 19 Pavel Schichko
 * *_bold italic_*
112 1 Jean-Philippe Lang
 * +underline+
113
 * -strike-through-
114 45 Ian Epperson
 * Plain ^superscript^
115
 * Plain ~subscript~
116 1 Jean-Philippe Lang
117
h3. Inline images
118 9 Jean-Philippe Lang
119 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
120
* *&#33;>image_url&#33;* right floating image
121 18 samir djouadi
122 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;*
123 1 Jean-Philippe Lang
124
h3. Headings
125
126
<pre><code>h1. Heading
127
h2. Subheading
128
h3. Subheading
129
</code></pre>
130
131
h3. Paragraphs
132
133 58 Dieter Egert
<pre><code>p. left aligned
134
135 60 Dieter Egert
  p(. left ident 1em
136 58 Dieter Egert
137 60 Dieter Egert
    p((. left ident 2em
138
    as well as for following lines
139 58 Dieter Egert
140 60 Dieter Egert
                                                                                   p>. right aligned
141 58 Dieter Egert
142 60 Dieter Egert
                                                                        p)))>. right ident 3em
143 58 Dieter Egert
144 60 Dieter Egert
                           p=. This is centered paragraph.
145 1 Jean-Philippe Lang
</code></pre>
146
147
h3. Predefined
148
149
To escape wiki syntax
150 58 Dieter Egert
<pre> <pre> *Your text won't become bold* </pre> </pre>
151 36 ha thach
Display:
152 37 ha thach
153 1 Jean-Philippe Lang
<pre> *Your text won't become bold* </pre>
154 38 ha thach
155
h3. Blockquotes
156 37 ha thach
157 60 Dieter Egert
Start the paragraph with *bq.*  or > (also stacked: >>)
158 1 Jean-Philippe Lang
159
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
160
To go live, all you need to add is a database and a web server.
161
</code></pre>
162
163
Display:
164
165
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
166
To go live, all you need to add is a database and a web server.
167
168 60 Dieter Egert
>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
169
To go live, all you need to add is a database and a web server. (starting with >>)
170
171 28 Jean-Philippe Lang
h3. Unordered lists
172
173
<pre>
174
* Item 1
175
* Item 2
176 29 Eric Gallimore
** Item 21
177
** Item 22
178 28 Jean-Philippe Lang
* Item 3
179
</pre>
180
181
displays:
182 1 Jean-Philippe Lang
183 28 Jean-Philippe Lang
* Item 1
184
* Item 2
185 29 Eric Gallimore
** Item 21
186 28 Jean-Philippe Lang
** Item 22
187
* Item 3
188 1 Jean-Philippe Lang
189
h3. Ordered lists
190
191 28 Jean-Philippe Lang
<pre>
192
# Item 1
193
# Item 2
194
# Item 3
195
## Item 3.1
196
## Item 3.2
197 1 Jean-Philippe Lang
</pre>
198 29 Eric Gallimore
199
displays:
200 1 Jean-Philippe Lang
201 20 Kirill Ponomarev
# Item 1
202
# Item 2
203
# Item 3
204 21 Andrew Chaika
## Item 3.1
205
## Item 3.2
206
207 1 Jean-Philippe Lang
h3. Tables
208
209
<pre>
210 58 Dieter Egert
|_.UserID|_.Name|_.Group|_. attribute list |
211 60 Dieter Egert
|\3=.IT               |<. align left|
212
|1|Artur Pirozhkov |/2.Users |>. align right|
213
|2|Vasya Rogov        |=. center |
214 58 Dieter Egert
|3|John Smith |Admin
215
               (root)|^. valign top |
216
|4|-          |Nobody
217
               (anonymous)|~. valign bottom|
218 20 Kirill Ponomarev
</pre>
219 21 Andrew Chaika
220 60 Dieter Egert
displays (all multiple spaces are replaced by 1 space):
221 1 Jean-Philippe Lang
222 58 Dieter Egert
|_.UserID|_.Name|_.Group|_. attribute list |
223 60 Dieter Egert
|\3=.IT                |<. align left|
224
|1|Artur Pirozhkov |/2.Users |>. align right|
225
|2|Vasya Rogov         |=. center |
226 58 Dieter Egert
|3|John Smith |Admin
227
               (root)|^. valign top |
228
|4|-          |Nobody
229
               (anonymous)|~. valign bottom|
230 1 Jean-Philippe Lang
231
h3. Table of content
232
233
<pre><code>{{toc}} => left aligned toc
234
{{>toc}} => right aligned toc
235
</code></pre>
236 7 Jean-Philippe Lang
237
h2. Macros
238
239
Redmine has the following builtin macros:
240
241
{{macro_list}}
242
243 1 Jean-Philippe Lang
244 4 Jean-Philippe Lang
h2. Code highlighting
245 51 Graham King
246 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.
247
248
You can highlight code in your wiki page using this syntax:
249
250 49 Dave Clements
<pre><code><pre><code class="ruby">
251 1 Jean-Philippe Lang
  Place your code here.
252 40 Mischa The Evil
</code></pre>
253 1 Jean-Philippe Lang
</code></pre>
254
255
Example:
256
257
<pre><code class="ruby">
258
# The Greeter class
259
class Greeter
260
  def initialize(name)
261
    @name = name.capitalize
262
  end
263
 
264
  def salute
265
    puts "Hello #{@name}!"
266
  end
267 40 Mischa The Evil
end
268 52 Vladimir Vasilkin
</code></pre>
269
270
271
h2. Translation
272
273
h3. Русский 
274
275 1 Jean-Philippe Lang
[[RedmineTextFormattingRus|Частичный перевод на русский]]