RedmineTextFormatting » History » Version 48

Ian Epperson, 2010-12-03 03:26
Added info on how to format complex email links

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 44 Anh Tu Sam
* Projects:
44 44 Anh Tu Sam
45 44 Anh Tu Sam
  * *project#<id>* (link to project with <id>)
46 44 Anh Tu Sam
  * *!project:<identifier>*
47 44 Anh Tu Sam
  * *!project:<name>*
48 44 Anh Tu Sam
49 6 Jean-Philippe Lang
* Attachments:
50 6 Jean-Philippe Lang
  
51 6 Jean-Philippe Lang
  * *!attachment:file.zip* (link to the attachment of the current object named file.zip)
52 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)
53 1 Jean-Philippe Lang
54 14 Jean-Philippe Lang
* Repository files
55 14 Jean-Philippe Lang
56 39 Yuki Kita
  * *!source:some/file*           -- Link to the file located at /some/file in the project's repository
57 39 Yuki Kita
  * *!source:some/file@52*        -- Link to the file's revision 52
58 39 Yuki Kita
  * *!source:some/file#L120*      -- Link to line 120 of the file
59 39 Yuki Kita
  * *!source:some/file@52#L120*   -- Link to line 120 of the file's revision 52
60 39 Yuki Kita
  * *!source:"some file@52#L120"* -- Double quotes can be used when the URL contains spaces
61 39 Yuki Kita
  * *!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 6 Jean-Philippe Lang
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
66 6 Jean-Philippe Lang
67 42 Andrew Quach Huynh
h3. External links
68 5 Jean-Philippe Lang
69 5 Jean-Philippe Lang
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 47 Ian Epperson
* *someone&#64;foo.bar* -- Link to an email address: someone@foo.bar
72 5 Jean-Philippe Lang
73 47 Ian Epperson
HTTP URLs an 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 47 Ian Epperson
* *"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 48 Ian Epperson
* *"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 48 Ian Epperson
* *"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 48 Ian Epperson
* *"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 48 Ian Epperson
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 38 ha thach
88 38 ha thach
<pre>
89 38 ha thach
JPL(Jean-Philippe Lang)
90 38 ha thach
</pre>
91 38 ha thach
92 38 ha thach
Display:
93 38 ha thach
94 38 ha thach
JPL(Jean-Philippe Lang)
95 38 ha thach
96 1 Jean-Philippe Lang
h3. Font style
97 1 Jean-Philippe Lang
98 1 Jean-Philippe Lang
<pre><code>* *bold*
99 1 Jean-Philippe Lang
* _italic_
100 19 Pavel Schichko
* *_bold italic_*
101 1 Jean-Philippe Lang
* +underline+
102 1 Jean-Philippe Lang
* -strike-through-
103 45 Ian Epperson
* Plain ^superscript^
104 45 Ian Epperson
* Plain ~subscript~
105 1 Jean-Philippe Lang
</code></pre>
106 1 Jean-Philippe Lang
107 1 Jean-Philippe Lang
Display:
108 1 Jean-Philippe Lang
109 1 Jean-Philippe Lang
 * *bold*
110 1 Jean-Philippe Lang
 * _italic_
111 19 Pavel Schichko
 * *_bold italic_*
112 1 Jean-Philippe Lang
 * +underline+
113 1 Jean-Philippe Lang
 * -strike-through-
114 45 Ian Epperson
 * Plain ^superscript^
115 45 Ian Epperson
 * Plain ~subscript~
116 1 Jean-Philippe Lang
117 1 Jean-Philippe Lang
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 1 Jean-Philippe Lang
* *&#33;>image_url&#33;* right floating image
121 15 Jean-Philippe Lang
* *&#33;{width:300px}image_url&#33;* sets the width of the image
122 18 samir djouadi
123 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;*
124 1 Jean-Philippe Lang
125 1 Jean-Philippe Lang
h3. Headings
126 1 Jean-Philippe Lang
127 1 Jean-Philippe Lang
<pre><code>h1. Heading
128 1 Jean-Philippe Lang
h2. Subheading
129 1 Jean-Philippe Lang
h3. Subheading
130 1 Jean-Philippe Lang
</code></pre>
131 1 Jean-Philippe Lang
132 1 Jean-Philippe Lang
h3. Paragraphs
133 1 Jean-Philippe Lang
134 1 Jean-Philippe Lang
<pre><code>p>. right aligned
135 1 Jean-Philippe Lang
p=. centered
136 2 Jean-Philippe Lang
</code></pre>
137 1 Jean-Philippe Lang
138 1 Jean-Philippe Lang
p=. This is centered paragraph.
139 36 ha thach
140 36 ha thach
h3. Predefined
141 36 ha thach
142 37 ha thach
To escape wiki syntax
143 1 Jean-Philippe Lang
<pre> <pre> *Your text won't become bold* </pre> </pre>
144 38 ha thach
Display:
145 38 ha thach
146 37 ha thach
<pre> *Your text won't become bold* </pre>
147 36 ha thach
148 1 Jean-Philippe Lang
h3. Blockquotes
149 1 Jean-Philippe Lang
150 1 Jean-Philippe Lang
Start the paragraph with *bq.*
151 1 Jean-Philippe Lang
152 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.
153 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
154 1 Jean-Philippe Lang
</code></pre>
155 1 Jean-Philippe Lang
156 1 Jean-Philippe Lang
Display:
157 1 Jean-Philippe Lang
158 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
159 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
160 1 Jean-Philippe Lang
161 28 Jean-Philippe Lang
h3. Unordered lists
162 28 Jean-Philippe Lang
163 28 Jean-Philippe Lang
<pre>
164 28 Jean-Philippe Lang
* Item 1
165 28 Jean-Philippe Lang
* Item 2
166 29 Eric Gallimore
** Item 21
167 29 Eric Gallimore
** Item 22
168 28 Jean-Philippe Lang
* Item 3
169 28 Jean-Philippe Lang
</pre>
170 28 Jean-Philippe Lang
171 28 Jean-Philippe Lang
displays:
172 1 Jean-Philippe Lang
173 28 Jean-Philippe Lang
* Item 1
174 28 Jean-Philippe Lang
* Item 2
175 29 Eric Gallimore
** Item 21
176 29 Eric Gallimore
** Item 22
177 28 Jean-Philippe Lang
* Item 3
178 28 Jean-Philippe Lang
179 1 Jean-Philippe Lang
h3. Ordered lists
180 1 Jean-Philippe Lang
181 28 Jean-Philippe Lang
<pre>
182 28 Jean-Philippe Lang
# Item 1
183 28 Jean-Philippe Lang
# Item 2
184 28 Jean-Philippe Lang
# Item 3
185 29 Eric Gallimore
## Item 3.1
186 29 Eric Gallimore
## Item 3.2
187 28 Jean-Philippe Lang
</pre>
188 1 Jean-Philippe Lang
189 1 Jean-Philippe Lang
displays:
190 28 Jean-Philippe Lang
191 28 Jean-Philippe Lang
# Item 1
192 28 Jean-Philippe Lang
# Item 2
193 28 Jean-Philippe Lang
# Item 3
194 29 Eric Gallimore
## Item 3.1
195 29 Eric Gallimore
## Item 3.2
196 28 Jean-Philippe Lang
197 20 Kirill Ponomarev
h3. Tables
198 20 Kirill Ponomarev
199 20 Kirill Ponomarev
<pre>
200 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
201 21 Andrew Chaika
|\3=.IT|
202 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
203 20 Kirill Ponomarev
|2|Vasya Rogov|
204 21 Andrew Chaika
|3|John Smith|Admin|
205 1 Jean-Philippe Lang
</pre>
206 1 Jean-Philippe Lang
207 1 Jean-Philippe Lang
Display:
208 1 Jean-Philippe Lang
209 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
210 21 Andrew Chaika
|\3=.IT|
211 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
212 20 Kirill Ponomarev
|2|Vasya Rogov|
213 21 Andrew Chaika
|3|John Smith|Admin|
214 20 Kirill Ponomarev
215 1 Jean-Philippe Lang
h3. Table of content
216 1 Jean-Philippe Lang
217 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
218 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
219 1 Jean-Philippe Lang
</code></pre>
220 1 Jean-Philippe Lang
221 7 Jean-Philippe Lang
h2. Macros
222 7 Jean-Philippe Lang
223 7 Jean-Philippe Lang
Redmine has the following builtin macros:
224 7 Jean-Philippe Lang
225 7 Jean-Philippe Lang
{{macro_list}}
226 7 Jean-Philippe Lang
227 7 Jean-Philippe Lang
228 1 Jean-Philippe Lang
h2. Code highlighting
229 4 Jean-Philippe Lang
230 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.
231 1 Jean-Philippe Lang
232 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
233 1 Jean-Philippe Lang
234 1 Jean-Philippe Lang
<pre><code><pre><code class="ruby">
235 1 Jean-Philippe Lang
  Place you code here.
236 1 Jean-Philippe Lang
</code></pre>
237 40 Mischa The Evil
</code></pre>
238 1 Jean-Philippe Lang
239 1 Jean-Philippe Lang
Example:
240 1 Jean-Philippe Lang
241 1 Jean-Philippe Lang
<pre><code class="ruby">
242 1 Jean-Philippe Lang
# The Greeter class
243 1 Jean-Philippe Lang
class Greeter
244 1 Jean-Philippe Lang
  def initialize(name)
245 1 Jean-Philippe Lang
    @name = name.capitalize
246 1 Jean-Philippe Lang
  end
247 1 Jean-Philippe Lang
 
248 1 Jean-Philippe Lang
  def salute
249 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
250 1 Jean-Philippe Lang
  end
251 1 Jean-Philippe Lang
end
252 40 Mischa The Evil
</code></pre>