Project

General

Profile

RedmineTextFormatting » History » Version 35

ha thach, 2010-04-30 15:03
move Sidebar to RedmineWikis

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
h3. Font style
82
83
<pre><code>* *bold*
84
* _italic_
85 19 Pavel Schichko
* *_bold italic_*
86 1 Jean-Philippe Lang
* +underline+
87
* -strike-through-
88
</code></pre>
89
90
Display:
91
92
 * *bold*
93
 * _italic_
94 19 Pavel Schichko
 * *_bold italic_*
95 1 Jean-Philippe Lang
 * +underline+
96
 * -strike-through-
97
98
h3. Inline images
99 9 Jean-Philippe Lang
100 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
101
* *&#33;>image_url&#33;* right floating image
102 15 Jean-Philippe Lang
* *&#33;{width:300px}image_url&#33;* sets the width of the image
103 18 samir djouadi
104 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;*
105 1 Jean-Philippe Lang
106
h3. Headings
107
108
<pre><code>h1. Heading
109
h2. Subheading
110
h3. Subheading
111
</code></pre>
112
113
h3. Paragraphs
114
115
<pre><code>p>. right aligned
116
p=. centered
117
</code></pre>
118 2 Jean-Philippe Lang
119 1 Jean-Philippe Lang
p=. This is centered paragraph.
120
121
h3. Blockquotes
122
123
Start the paragraph with *bq.*
124
125
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
126
To go live, all you need to add is a database and a web server.
127
</code></pre>
128
129
Display:
130
131
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
132
To go live, all you need to add is a database and a web server.
133
134 28 Jean-Philippe Lang
h3. Unordered lists
135
136
<pre>
137
* Item 1
138
* Item 2
139 29 Eric Gallimore
** Item 21
140
** Item 22
141 28 Jean-Philippe Lang
* Item 3
142
</pre>
143
144
displays:
145 1 Jean-Philippe Lang
146 28 Jean-Philippe Lang
* Item 1
147
* Item 2
148 29 Eric Gallimore
** Item 21
149
** Item 22
150 28 Jean-Philippe Lang
* Item 3
151
152 1 Jean-Philippe Lang
h3. Ordered lists
153
154 28 Jean-Philippe Lang
<pre>
155
# Item 1
156
# Item 2
157
# Item 3
158 29 Eric Gallimore
## Item 3.1
159
## Item 3.2
160 28 Jean-Philippe Lang
</pre>
161 1 Jean-Philippe Lang
162
displays:
163 28 Jean-Philippe Lang
164
# Item 1
165
# Item 2
166
# Item 3
167 29 Eric Gallimore
## Item 3.1
168
## Item 3.2
169 28 Jean-Philippe Lang
170 20 Kirill Ponomarev
h3. Tables
171
172
<pre>
173 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
174
|\3=.IT|
175
|1|Artur Pirozhkov|/2.Users|
176 20 Kirill Ponomarev
|2|Vasya Rogov|
177 21 Andrew Chaika
|3|John Smith|Admin|
178 1 Jean-Philippe Lang
</pre>
179
180
Display:
181
182 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
183
|\3=.IT|
184
|1|Artur Pirozhkov|/2.Users|
185 20 Kirill Ponomarev
|2|Vasya Rogov|
186 21 Andrew Chaika
|3|John Smith|Admin|
187 20 Kirill Ponomarev
188 1 Jean-Philippe Lang
h3. Table of content
189
190
<pre><code>{{toc}} => left aligned toc
191
{{>toc}} => right aligned toc
192
</code></pre>
193
194 7 Jean-Philippe Lang
h2. Macros
195
196
Redmine has the following builtin macros:
197
198
{{macro_list}}
199
200
201 1 Jean-Philippe Lang
h2. Code highlighting
202 4 Jean-Philippe Lang
203 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.
204
205
You can highlight code in your wiki page using this syntax:
206
207
<pre><code><pre><code class="ruby">
208
  Place you code here.
209
</code></pre>
210
</pre></code>
211
212
Example:
213
214
<pre><code class="ruby">
215
# The Greeter class
216
class Greeter
217
  def initialize(name)
218
    @name = name.capitalize
219
  end
220
 
221
  def salute
222
    puts "Hello #{@name}!"
223
  end
224
end
225
</pre></code>