Project

General

Profile

RedmineTextFormatting » History » Version 64

Lucy Yevseyeva, 2011-09-03 14:59

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