RedmineTextFormatting » History » Version 65

Lucy Yevseyeva, 2011-09-04 16:39

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 51 Graham King
* *[[Guide|User manual]]* displays a link to the same page but with different text: [[Guide|User manual]]
19 51 Graham King
* *[[Guide#User-guide|User guide]]* displays a link to the header on the same page with different text: [[Guide#User-guide|User guide]]
20 1 Jean-Philippe Lang
21 51 Graham King
You can also link to pages of another project's 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 51 Graham King
HTTP URLs and 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 63 Colin Sullivan
* @inline monospace@
106 1 Jean-Philippe Lang
</code></pre>
107 1 Jean-Philippe Lang
108 1 Jean-Philippe Lang
Display:
109 1 Jean-Philippe Lang
110 1 Jean-Philippe Lang
 * *bold*
111 1 Jean-Philippe Lang
 * _italic_
112 19 Pavel Schichko
 * *_bold italic_*
113 1 Jean-Philippe Lang
 * +underline+
114 1 Jean-Philippe Lang
 * -strike-through-
115 45 Ian Epperson
 * Plain ^superscript^
116 45 Ian Epperson
 * Plain ~subscript~
117 63 Colin Sullivan
 * @inline monospace@
118 1 Jean-Philippe Lang
119 1 Jean-Philippe Lang
h3. Inline images
120 9 Jean-Philippe Lang
121 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
122 1 Jean-Philippe Lang
* *&#33;>image_url&#33;* right floating image
123 18 samir djouadi
124 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;*
125 1 Jean-Philippe Lang
126 1 Jean-Philippe Lang
h3. Headings
127 1 Jean-Philippe Lang
128 1 Jean-Philippe Lang
<pre><code>h1. Heading
129 1 Jean-Philippe Lang
h2. Subheading
130 1 Jean-Philippe Lang
h3. Subheading
131 1 Jean-Philippe Lang
</code></pre>
132 1 Jean-Philippe Lang
133 1 Jean-Philippe Lang
h3. Paragraphs
134 1 Jean-Philippe Lang
135 58 Dieter Egert
<pre><code>p. left aligned
136 58 Dieter Egert
137 60 Dieter Egert
  p(. left ident 1em
138 58 Dieter Egert
139 60 Dieter Egert
    p((. left ident 2em
140 60 Dieter Egert
    as well as for following lines
141 58 Dieter Egert
142 60 Dieter Egert
                                                                                   p>. right aligned
143 58 Dieter Egert
144 60 Dieter Egert
                                                                        p)))>. right ident 3em
145 58 Dieter Egert
146 60 Dieter Egert
                           p=. This is centered paragraph.
147 1 Jean-Philippe Lang
</code></pre>
148 1 Jean-Philippe Lang
149 1 Jean-Philippe Lang
h3. Predefined
150 1 Jean-Philippe Lang
151 1 Jean-Philippe Lang
To escape wiki syntax
152 58 Dieter Egert
<pre> <pre> *Your text won't become bold* </pre> </pre>
153 36 ha thach
Display:
154 37 ha thach
155 1 Jean-Philippe Lang
<pre> *Your text won't become bold* </pre>
156 38 ha thach
157 38 ha thach
h3. Blockquotes
158 37 ha thach
159 60 Dieter Egert
Start the paragraph with *bq.*  or > (also stacked: >>)
160 1 Jean-Philippe Lang
161 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.
162 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
163 1 Jean-Philippe Lang
</code></pre>
164 1 Jean-Philippe Lang
165 1 Jean-Philippe Lang
Display:
166 1 Jean-Philippe Lang
167 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
168 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
169 1 Jean-Philippe Lang
170 60 Dieter Egert
>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
171 60 Dieter Egert
To go live, all you need to add is a database and a web server. (starting with >>)
172 60 Dieter Egert
173 28 Jean-Philippe Lang
h3. Unordered lists
174 28 Jean-Philippe Lang
175 28 Jean-Philippe Lang
<pre>
176 28 Jean-Philippe Lang
* Item 1
177 28 Jean-Philippe Lang
* Item 2
178 29 Eric Gallimore
** Item 21
179 29 Eric Gallimore
** Item 22
180 28 Jean-Philippe Lang
* Item 3
181 28 Jean-Philippe Lang
</pre>
182 28 Jean-Philippe Lang
183 28 Jean-Philippe Lang
displays:
184 1 Jean-Philippe Lang
185 28 Jean-Philippe Lang
* Item 1
186 28 Jean-Philippe Lang
* Item 2
187 29 Eric Gallimore
** Item 21
188 28 Jean-Philippe Lang
** Item 22
189 28 Jean-Philippe Lang
* Item 3
190 1 Jean-Philippe Lang
191 1 Jean-Philippe Lang
h3. Ordered lists
192 1 Jean-Philippe Lang
193 28 Jean-Philippe Lang
<pre>
194 28 Jean-Philippe Lang
# Item 1
195 28 Jean-Philippe Lang
# Item 2
196 28 Jean-Philippe Lang
# Item 3
197 28 Jean-Philippe Lang
## Item 3.1
198 28 Jean-Philippe Lang
## Item 3.2
199 1 Jean-Philippe Lang
</pre>
200 29 Eric Gallimore
201 29 Eric Gallimore
displays:
202 1 Jean-Philippe Lang
203 20 Kirill Ponomarev
# Item 1
204 20 Kirill Ponomarev
# Item 2
205 20 Kirill Ponomarev
# Item 3
206 21 Andrew Chaika
## Item 3.1
207 21 Andrew Chaika
## Item 3.2
208 21 Andrew Chaika
209 1 Jean-Philippe Lang
h3. Tables
210 1 Jean-Philippe Lang
211 1 Jean-Philippe Lang
<pre>
212 58 Dieter Egert
|_.UserID|_.Name|_.Group|_. attribute list |
213 60 Dieter Egert
|\3=.IT               |<. align left|
214 60 Dieter Egert
|1|Artur Pirozhkov |/2.Users |>. align right|
215 60 Dieter Egert
|2|Vasya Rogov        |=. center |
216 58 Dieter Egert
|3|John Smith |Admin
217 58 Dieter Egert
               (root)|^. valign top |
218 58 Dieter Egert
|4|-          |Nobody
219 58 Dieter Egert
               (anonymous)|~. valign bottom|
220 20 Kirill Ponomarev
</pre>
221 21 Andrew Chaika
222 60 Dieter Egert
displays (all multiple spaces are replaced by 1 space):
223 1 Jean-Philippe Lang
224 58 Dieter Egert
|_.UserID|_.Name|_.Group|_. attribute list |
225 60 Dieter Egert
|\3=.IT                |<. align left|
226 60 Dieter Egert
|1|Artur Pirozhkov |/2.Users |>. align right|
227 60 Dieter Egert
|2|Vasya Rogov         |=. center |
228 58 Dieter Egert
|3|John Smith |Admin
229 58 Dieter Egert
               (root)|^. valign top |
230 58 Dieter Egert
|4|-          |Nobody
231 58 Dieter Egert
               (anonymous)|~. valign bottom|
232 1 Jean-Philippe Lang
233 1 Jean-Philippe Lang
h3. Table of content
234 1 Jean-Philippe Lang
235 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
236 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
237 1 Jean-Philippe Lang
</code></pre>
238 7 Jean-Philippe Lang
239 7 Jean-Philippe Lang
h2. Macros
240 7 Jean-Philippe Lang
241 7 Jean-Philippe Lang
Redmine has the following builtin macros:
242 7 Jean-Philippe Lang
243 7 Jean-Philippe Lang
{{macro_list}}
244 7 Jean-Philippe Lang
245 1 Jean-Philippe Lang
246 4 Jean-Philippe Lang
h2. Code highlighting
247 51 Graham King
248 1 Jean-Philippe Lang
Code highlighting relies on "CodeRay":http://coderay.rubychan.de/, a fast syntax highlighting library written completely in Ruby. It currently supports C, C++, CSS, Delphi, Diff, Groovy, HTML, Java, Javascript, JSON, Nitro-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, XML and YAML code.
249 1 Jean-Philippe Lang
250 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
251 1 Jean-Philippe Lang
252 49 Dave Clements
<pre><code><pre><code class="ruby">
253 1 Jean-Philippe Lang
  Place your code here.
254 40 Mischa The Evil
</code></pre>
255 1 Jean-Philippe Lang
</code></pre>
256 1 Jean-Philippe Lang
257 1 Jean-Philippe Lang
Example:
258 1 Jean-Philippe Lang
259 1 Jean-Philippe Lang
<pre><code class="ruby">
260 1 Jean-Philippe Lang
# The Greeter class
261 1 Jean-Philippe Lang
class Greeter
262 1 Jean-Philippe Lang
  def initialize(name)
263 1 Jean-Philippe Lang
    @name = name.capitalize
264 1 Jean-Philippe Lang
  end
265 1 Jean-Philippe Lang
 
266 1 Jean-Philippe Lang
  def salute
267 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
268 1 Jean-Philippe Lang
  end
269 40 Mischa The Evil
end
270 52 Vladimir Vasilkin
</code></pre>
271 52 Vladimir Vasilkin
272 52 Vladimir Vasilkin
273 52 Vladimir Vasilkin
h2. Translation
274 52 Vladimir Vasilkin
275 52 Vladimir Vasilkin
h3. Русский 
276 52 Vladimir Vasilkin
277 65 Lucy Yevseyeva
[[RusRedmineTextFormatting|Перевод на русский]]