RedmineTextFormatting » History » Version 40

Mischa The Evil, 2010-08-30 20:15
Fixed order of closing pre- and code -tags.

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