Project

General

Profile

RedmineTextFormatting » History » Version 51

Graham King, 2011-01-25 19:41
Very minor grammar fixes and update Coderay capabilities.

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
<pre><code>p>. right aligned
134
p=. centered
135 2 Jean-Philippe Lang
</code></pre>
136 1 Jean-Philippe Lang
137
p=. This is centered paragraph.
138 36 ha thach
139
h3. Predefined
140
141 37 ha thach
To escape wiki syntax
142 1 Jean-Philippe Lang
<pre> <pre> *Your text won't become bold* </pre> </pre>
143 38 ha thach
Display:
144
145 37 ha thach
<pre> *Your text won't become bold* </pre>
146 36 ha thach
147 1 Jean-Philippe Lang
h3. Blockquotes
148
149
Start the paragraph with *bq.*
150
151
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
152
To go live, all you need to add is a database and a web server.
153
</code></pre>
154
155
Display:
156
157
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
158
To go live, all you need to add is a database and a web server.
159
160 28 Jean-Philippe Lang
h3. Unordered lists
161
162
<pre>
163
* Item 1
164
* Item 2
165 29 Eric Gallimore
** Item 21
166
** Item 22
167 28 Jean-Philippe Lang
* Item 3
168
</pre>
169
170
displays:
171 1 Jean-Philippe Lang
172 28 Jean-Philippe Lang
* Item 1
173
* Item 2
174 29 Eric Gallimore
** Item 21
175
** Item 22
176 28 Jean-Philippe Lang
* Item 3
177
178 1 Jean-Philippe Lang
h3. Ordered lists
179
180 28 Jean-Philippe Lang
<pre>
181
# Item 1
182
# Item 2
183
# Item 3
184 29 Eric Gallimore
## Item 3.1
185
## Item 3.2
186 28 Jean-Philippe Lang
</pre>
187 1 Jean-Philippe Lang
188
displays:
189 28 Jean-Philippe Lang
190
# Item 1
191
# Item 2
192
# Item 3
193 29 Eric Gallimore
## Item 3.1
194
## Item 3.2
195 28 Jean-Philippe Lang
196 20 Kirill Ponomarev
h3. Tables
197
198
<pre>
199 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
200
|\3=.IT|
201
|1|Artur Pirozhkov|/2.Users|
202 20 Kirill Ponomarev
|2|Vasya Rogov|
203 21 Andrew Chaika
|3|John Smith|Admin|
204 1 Jean-Philippe Lang
</pre>
205
206
Display:
207
208 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
209
|\3=.IT|
210
|1|Artur Pirozhkov|/2.Users|
211 20 Kirill Ponomarev
|2|Vasya Rogov|
212 21 Andrew Chaika
|3|John Smith|Admin|
213 20 Kirill Ponomarev
214 1 Jean-Philippe Lang
h3. Table of content
215
216
<pre><code>{{toc}} => left aligned toc
217
{{>toc}} => right aligned toc
218
</code></pre>
219
220 7 Jean-Philippe Lang
h2. Macros
221
222
Redmine has the following builtin macros:
223
224
{{macro_list}}
225
226
227 1 Jean-Philippe Lang
h2. Code highlighting
228 4 Jean-Philippe Lang
229 51 Graham King
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.
230 1 Jean-Philippe Lang
231
You can highlight code in your wiki page using this syntax:
232
233
<pre><code><pre><code class="ruby">
234 49 Dave Clements
  Place your code here.
235 1 Jean-Philippe Lang
</code></pre>
236 40 Mischa The Evil
</code></pre>
237 1 Jean-Philippe Lang
238
Example:
239
240
<pre><code class="ruby">
241
# The Greeter class
242
class Greeter
243
  def initialize(name)
244
    @name = name.capitalize
245
  end
246
 
247
  def salute
248
    puts "Hello #{@name}!"
249
  end
250
end
251 40 Mischa The Evil
</code></pre>