Project

General

Profile

RedmineTextFormatting » History » Version 38

ha thach, 2010-05-17 09:42
add Acronym

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