RedmineTextFormatting » History » Version 43

Markus Valle-Klann, 2010-09-27 14:16

1 1 Jean-Philippe Lang
h1. Wiki formatting
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
{{>TOC}}
4 1 Jean-Philippe Lang
5 1 Jean-Philippe Lang
h2. Links
6 1 Jean-Philippe Lang
7 6 Jean-Philippe Lang
h3. Redmine links
8 6 Jean-Philippe Lang
9 1 Jean-Philippe Lang
Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.
10 1 Jean-Philippe Lang
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 1 Jean-Philippe Lang
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 1 Jean-Philippe Lang
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
25 1 Jean-Philippe Lang
26 1 Jean-Philippe Lang
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
27 1 Jean-Philippe Lang
28 32 Jean-Philippe Lang
Links to others resources:
29 6 Jean-Philippe Lang
30 6 Jean-Philippe Lang
* Documents:
31 6 Jean-Philippe Lang
32 6 Jean-Philippe Lang
  * *!document#17* (link to document with id 17)
33 6 Jean-Philippe Lang
  * *!document:Greetings* (link to the document with title "Greetings")
34 6 Jean-Philippe Lang
  * *!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 6 Jean-Philippe Lang
* Versions:
38 6 Jean-Philippe Lang
39 6 Jean-Philippe Lang
  * *!version#3* (link to version with id 3)
40 6 Jean-Philippe Lang
  * *!version:1.0.0* (link to version named "1.0.0")
41 6 Jean-Philippe Lang
  * *!version:"1.0 beta 2"*
42 6 Jean-Philippe Lang
43 6 Jean-Philippe Lang
* Attachments:
44 6 Jean-Philippe Lang
  
45 6 Jean-Philippe Lang
  * *!attachment:file.zip* (link to the attachment of the current object named file.zip)
46 6 Jean-Philippe Lang
  * 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)
47 1 Jean-Philippe Lang
48 14 Jean-Philippe Lang
* Repository files
49 14 Jean-Philippe Lang
50 39 Yuki Kita
  * *!source:some/file*           -- Link to the file located at /some/file in the project's repository
51 39 Yuki Kita
  * *!source:some/file@52*        -- Link to the file's revision 52
52 39 Yuki Kita
  * *!source:some/file#L120*      -- Link to line 120 of the file
53 39 Yuki Kita
  * *!source:some/file@52#L120*   -- Link to line 120 of the file's revision 52
54 39 Yuki Kita
  * *!source:"some file@52#L120"* -- Double quotes can be used when the URL contains spaces
55 39 Yuki Kita
  * *!export:some/file*           -- Force the download of the file
56 14 Jean-Philippe Lang
57 32 Jean-Philippe Lang
Escaping:
58 6 Jean-Philippe Lang
59 6 Jean-Philippe Lang
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
60 6 Jean-Philippe Lang
61 42 Andrew Quach Huynh
h3. External links
62 5 Jean-Philippe Lang
63 5 Jean-Philippe Lang
HTTP URLs and email addresses are automatically turned into clickable links: 
64 5 Jean-Philippe Lang
65 5 Jean-Philippe Lang
<pre>
66 5 Jean-Philippe Lang
http://www.redmine.org, someone@foo.bar
67 5 Jean-Philippe Lang
</pre>
68 5 Jean-Philippe Lang
69 5 Jean-Philippe Lang
displays: http://www.redmine.org, someone@foo.bar
70 5 Jean-Philippe Lang
71 5 Jean-Philippe Lang
If you want to display a specific text instead of the URL, you can use the standard textile syntax:
72 5 Jean-Philippe Lang
73 5 Jean-Philippe Lang
<pre>
74 5 Jean-Philippe Lang
"Redmine web site":http://www.redmine.org
75 5 Jean-Philippe Lang
</pre>
76 5 Jean-Philippe Lang
77 1 Jean-Philippe Lang
displays: "Redmine web site":http://www.redmine.org
78 1 Jean-Philippe Lang
79 1 Jean-Philippe Lang
h2. Text formatting
80 10 John Goerzen
81 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.
82 1 Jean-Philippe Lang
83 38 ha thach
h3. Acronym
84 38 ha thach
85 38 ha thach
<pre>
86 38 ha thach
JPL(Jean-Philippe Lang)
87 38 ha thach
</pre>
88 38 ha thach
89 38 ha thach
Display:
90 38 ha thach
91 38 ha thach
JPL(Jean-Philippe Lang)
92 38 ha thach
93 1 Jean-Philippe Lang
h3. Font style
94 1 Jean-Philippe Lang
95 1 Jean-Philippe Lang
<pre><code>* *bold*
96 1 Jean-Philippe Lang
* _italic_
97 19 Pavel Schichko
* *_bold italic_*
98 1 Jean-Philippe Lang
* +underline+
99 1 Jean-Philippe Lang
* -strike-through-
100 1 Jean-Philippe Lang
</code></pre>
101 1 Jean-Philippe Lang
102 1 Jean-Philippe Lang
Display:
103 1 Jean-Philippe Lang
104 1 Jean-Philippe Lang
 * *bold*
105 1 Jean-Philippe Lang
 * _italic_
106 19 Pavel Schichko
 * *_bold italic_*
107 1 Jean-Philippe Lang
 * +underline+
108 1 Jean-Philippe Lang
 * -strike-through-
109 1 Jean-Philippe Lang
110 1 Jean-Philippe Lang
h3. Inline images
111 9 Jean-Philippe Lang
112 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
113 1 Jean-Philippe Lang
* *&#33;>image_url&#33;* right floating image
114 15 Jean-Philippe Lang
* *&#33;{width:300px}image_url&#33;* sets the width of the image
115 18 samir djouadi
116 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;*
117 1 Jean-Philippe Lang
118 1 Jean-Philippe Lang
h3. Headings
119 1 Jean-Philippe Lang
120 1 Jean-Philippe Lang
<pre><code>h1. Heading
121 1 Jean-Philippe Lang
h2. Subheading
122 1 Jean-Philippe Lang
h3. Subheading
123 1 Jean-Philippe Lang
</code></pre>
124 1 Jean-Philippe Lang
125 1 Jean-Philippe Lang
h3. Paragraphs
126 1 Jean-Philippe Lang
127 1 Jean-Philippe Lang
<pre><code>p>. right aligned
128 1 Jean-Philippe Lang
p=. centered
129 2 Jean-Philippe Lang
</code></pre>
130 1 Jean-Philippe Lang
131 1 Jean-Philippe Lang
p=. This is centered paragraph.
132 36 ha thach
133 36 ha thach
h3. Predefined
134 36 ha thach
135 37 ha thach
To escape wiki syntax
136 1 Jean-Philippe Lang
<pre> <pre> *Your text won't become bold* </pre> </pre>
137 38 ha thach
Display:
138 38 ha thach
139 37 ha thach
<pre> *Your text won't become bold* </pre>
140 36 ha thach
141 1 Jean-Philippe Lang
h3. Blockquotes
142 1 Jean-Philippe Lang
143 1 Jean-Philippe Lang
Start the paragraph with *bq.*
144 1 Jean-Philippe Lang
145 1 Jean-Philippe Lang
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
146 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
147 1 Jean-Philippe Lang
</code></pre>
148 1 Jean-Philippe Lang
149 1 Jean-Philippe Lang
Display:
150 1 Jean-Philippe Lang
151 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
152 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
153 1 Jean-Philippe Lang
154 28 Jean-Philippe Lang
h3. Unordered lists
155 28 Jean-Philippe Lang
156 28 Jean-Philippe Lang
<pre>
157 28 Jean-Philippe Lang
* Item 1
158 28 Jean-Philippe Lang
* Item 2
159 29 Eric Gallimore
** Item 21
160 29 Eric Gallimore
** Item 22
161 28 Jean-Philippe Lang
* Item 3
162 28 Jean-Philippe Lang
</pre>
163 28 Jean-Philippe Lang
164 28 Jean-Philippe Lang
displays:
165 1 Jean-Philippe Lang
166 28 Jean-Philippe Lang
* Item 1
167 28 Jean-Philippe Lang
* Item 2
168 29 Eric Gallimore
** Item 21
169 29 Eric Gallimore
** Item 22
170 28 Jean-Philippe Lang
* Item 3
171 28 Jean-Philippe Lang
172 1 Jean-Philippe Lang
h3. Ordered lists
173 1 Jean-Philippe Lang
174 28 Jean-Philippe Lang
<pre>
175 28 Jean-Philippe Lang
# Item 1
176 28 Jean-Philippe Lang
# Item 2
177 28 Jean-Philippe Lang
# Item 3
178 29 Eric Gallimore
## Item 3.1
179 29 Eric Gallimore
## Item 3.2
180 28 Jean-Philippe Lang
</pre>
181 1 Jean-Philippe Lang
182 1 Jean-Philippe Lang
displays:
183 28 Jean-Philippe Lang
184 28 Jean-Philippe Lang
# Item 1
185 28 Jean-Philippe Lang
# Item 2
186 28 Jean-Philippe Lang
# Item 3
187 29 Eric Gallimore
## Item 3.1
188 29 Eric Gallimore
## Item 3.2
189 28 Jean-Philippe Lang
190 20 Kirill Ponomarev
h3. Tables
191 20 Kirill Ponomarev
192 20 Kirill Ponomarev
<pre>
193 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
194 21 Andrew Chaika
|\3=.IT|
195 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
196 20 Kirill Ponomarev
|2|Vasya Rogov|
197 21 Andrew Chaika
|3|John Smith|Admin|
198 1 Jean-Philippe Lang
</pre>
199 1 Jean-Philippe Lang
200 1 Jean-Philippe Lang
Display:
201 1 Jean-Philippe Lang
202 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
203 21 Andrew Chaika
|\3=.IT|
204 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
205 20 Kirill Ponomarev
|2|Vasya Rogov|
206 21 Andrew Chaika
|3|John Smith|Admin|
207 20 Kirill Ponomarev
208 1 Jean-Philippe Lang
h3. Table of content
209 1 Jean-Philippe Lang
210 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
211 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
212 1 Jean-Philippe Lang
</code></pre>
213 1 Jean-Philippe Lang
214 7 Jean-Philippe Lang
h2. Macros
215 7 Jean-Philippe Lang
216 7 Jean-Philippe Lang
Redmine has the following builtin macros:
217 7 Jean-Philippe Lang
218 7 Jean-Philippe Lang
{{macro_list}}
219 7 Jean-Philippe Lang
220 7 Jean-Philippe Lang
221 1 Jean-Philippe Lang
h2. Code highlighting
222 4 Jean-Philippe Lang
223 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.
224 1 Jean-Philippe Lang
225 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
226 1 Jean-Philippe Lang
227 1 Jean-Philippe Lang
<pre><code><pre><code class="ruby">
228 1 Jean-Philippe Lang
  Place you code here.
229 1 Jean-Philippe Lang
</code></pre>
230 40 Mischa The Evil
</code></pre>
231 1 Jean-Philippe Lang
232 1 Jean-Philippe Lang
Example:
233 1 Jean-Philippe Lang
234 1 Jean-Philippe Lang
<pre><code class="ruby">
235 1 Jean-Philippe Lang
# The Greeter class
236 1 Jean-Philippe Lang
class Greeter
237 1 Jean-Philippe Lang
  def initialize(name)
238 1 Jean-Philippe Lang
    @name = name.capitalize
239 1 Jean-Philippe Lang
  end
240 1 Jean-Philippe Lang
 
241 1 Jean-Philippe Lang
  def salute
242 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
243 1 Jean-Philippe Lang
  end
244 1 Jean-Philippe Lang
end
245 40 Mischa The Evil
</code></pre>