RedmineTextFormatting » History » Version 69

Mikail Borovinskih, 2011-12-22 08:35
External image linke to wiki page of redmine

1 68 Jean-Philippe Lang
h1. Text 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 68 Jean-Philippe Lang
Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere text 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 68 Jean-Philippe Lang
* Link to a changeset with a non-numeric hash: *commit:c6f4d0fd* (displays c6f4d0fd).
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 1 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 68 Jean-Philippe Lang
  * *!attachment:"file.zip"* (double quotes can be used when the filename contains non word characters)
53 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)
54 1 Jean-Philippe Lang
55 14 Jean-Philippe Lang
* Repository files
56 14 Jean-Philippe Lang
57 39 Yuki Kita
  * *!source:some/file*           -- Link to the file located at /some/file in the project's repository
58 39 Yuki Kita
  * *!source:some/file@52*        -- Link to the file's revision 52
59 39 Yuki Kita
  * *!source:some/file#L120*      -- Link to line 120 of the file
60 39 Yuki Kita
  * *!source:some/file@52#L120*   -- Link to line 120 of the file's revision 52
61 39 Yuki Kita
  * *!source:"some file@52#L120"* -- Double quotes can be used when the URL contains spaces
62 39 Yuki Kita
  * *!export:some/file*           -- Force the download of the file
63 14 Jean-Philippe Lang
64 32 Jean-Philippe Lang
Escaping:
65 6 Jean-Philippe Lang
66 6 Jean-Philippe Lang
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
67 6 Jean-Philippe Lang
68 42 Andrew Quach Huynh
h3. External links
69 5 Jean-Philippe Lang
70 5 Jean-Philippe Lang
HTTP URLs and email addresses are automatically turned into clickable links: 
71 47 Ian Epperson
* *http&#58;//www.redmine.org* -- External link to the redmine website: http://www.redmine.org
72 47 Ian Epperson
* *someone&#64;foo.bar* -- Link to an email address: someone@foo.bar
73 5 Jean-Philippe Lang
74 51 Graham King
HTTP URLs and email addresses can also use different text than the link itself:
75 47 Ian Epperson
* *"Redmine web site"&#58;http&#58;//www.redmine.org* -- External link with different text: "Redmine web site":http://www.redmine.org
76 69 Mikail Borovinskih
* *!http://upload.wikimedia.org/wikipedia/commons/thumb/3/3f/Redmine_logo.svg/200px-Redmine_logo.svg.png!:http://en.wikipedia.org/wiki/Redmine* -- External image linke to wiki page of redmine: !http://upload.wikimedia.org/wikipedia/commons/thumb/3/3f/Redmine_logo.svg/200px-Redmine_logo.svg.png!:http://en.wikipedia.org/wiki/Redmine
77 47 Ian Epperson
* *"Email someone"&#58;mailto&#58;someone&#64;foo.bar* -- Email link with different text: "Email someone":mailto:someone@foo.bar
78 1 Jean-Philippe Lang
79 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.
80 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
81 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
82 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
83 48 Ian Epperson
84 1 Jean-Philippe Lang
h2. Text formatting
85 10 John Goerzen
86 67 Jean-Philippe Lang
For things such as headlines, bold, tables, lists, Redmine supports "Textile syntax":http://en.wikipedia.org/wiki/Textile_%28markup_language%29.  See http://redcloth.org/hobix.com/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.
87 1 Jean-Philippe Lang
88 38 ha thach
h3. Acronym
89 38 ha thach
90 38 ha thach
<pre>
91 38 ha thach
JPL(Jean-Philippe Lang)
92 38 ha thach
</pre>
93 38 ha thach
94 38 ha thach
Display:
95 38 ha thach
96 38 ha thach
JPL(Jean-Philippe Lang)
97 38 ha thach
98 1 Jean-Philippe Lang
h3. Font style
99 1 Jean-Philippe Lang
100 1 Jean-Philippe Lang
<pre><code>* *bold*
101 1 Jean-Philippe Lang
* _italic_
102 19 Pavel Schichko
* *_bold italic_*
103 1 Jean-Philippe Lang
* +underline+
104 1 Jean-Philippe Lang
* -strike-through-
105 45 Ian Epperson
* Plain ^superscript^
106 45 Ian Epperson
* Plain ~subscript~
107 63 Colin Sullivan
* @inline monospace@
108 1 Jean-Philippe Lang
</code></pre>
109 1 Jean-Philippe Lang
110 1 Jean-Philippe Lang
Display:
111 1 Jean-Philippe Lang
112 1 Jean-Philippe Lang
 * *bold*
113 1 Jean-Philippe Lang
 * _italic_
114 19 Pavel Schichko
 * *_bold italic_*
115 1 Jean-Philippe Lang
 * +underline+
116 1 Jean-Philippe Lang
 * -strike-through-
117 45 Ian Epperson
 * Plain ^superscript^
118 45 Ian Epperson
 * Plain ~subscript~
119 63 Colin Sullivan
 * @inline monospace@
120 1 Jean-Philippe Lang
121 1 Jean-Philippe Lang
h3. Inline images
122 9 Jean-Philippe Lang
123 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
124 1 Jean-Philippe Lang
* *&#33;>image_url&#33;* right floating image
125 66 Jean-Philippe Lang
* *&#33;image_url(Image title)&#33;* displays an image with an alt/title attribute
126 18 samir djouadi
127 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;*
128 1 Jean-Philippe Lang
129 1 Jean-Philippe Lang
h3. Headings
130 1 Jean-Philippe Lang
131 1 Jean-Philippe Lang
<pre><code>h1. Heading
132 66 Jean-Philippe Lang
133 1 Jean-Philippe Lang
h2. Subheading
134 66 Jean-Philippe Lang
135 1 Jean-Philippe Lang
h3. Subheading
136 1 Jean-Philippe Lang
</code></pre>
137 1 Jean-Philippe Lang
138 1 Jean-Philippe Lang
h3. Paragraphs
139 1 Jean-Philippe Lang
140 58 Dieter Egert
<pre><code>p. left aligned
141 58 Dieter Egert
142 60 Dieter Egert
  p(. left ident 1em
143 58 Dieter Egert
144 60 Dieter Egert
    p((. left ident 2em
145 60 Dieter Egert
    as well as for following lines
146 58 Dieter Egert
147 60 Dieter Egert
                                                                                   p>. right aligned
148 58 Dieter Egert
149 60 Dieter Egert
                                                                        p)))>. right ident 3em
150 58 Dieter Egert
151 60 Dieter Egert
                           p=. This is centered paragraph.
152 1 Jean-Philippe Lang
</code></pre>
153 1 Jean-Philippe Lang
154 1 Jean-Philippe Lang
h3. Predefined
155 1 Jean-Philippe Lang
156 1 Jean-Philippe Lang
To escape wiki syntax
157 58 Dieter Egert
<pre> <pre> *Your text won't become bold* </pre> </pre>
158 36 ha thach
Display:
159 37 ha thach
160 1 Jean-Philippe Lang
<pre> *Your text won't become bold* </pre>
161 38 ha thach
162 38 ha thach
h3. Blockquotes
163 37 ha thach
164 60 Dieter Egert
Start the paragraph with *bq.*  or > (also stacked: >>)
165 1 Jean-Philippe Lang
166 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.
167 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
168 1 Jean-Philippe Lang
</code></pre>
169 1 Jean-Philippe Lang
170 1 Jean-Philippe Lang
Display:
171 1 Jean-Philippe Lang
172 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
173 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
174 1 Jean-Philippe Lang
175 60 Dieter Egert
>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
176 60 Dieter Egert
To go live, all you need to add is a database and a web server. (starting with >>)
177 60 Dieter Egert
178 28 Jean-Philippe Lang
h3. Unordered lists
179 28 Jean-Philippe Lang
180 28 Jean-Philippe Lang
<pre>
181 28 Jean-Philippe Lang
* Item 1
182 28 Jean-Philippe Lang
* Item 2
183 29 Eric Gallimore
** Item 21
184 29 Eric Gallimore
** Item 22
185 28 Jean-Philippe Lang
* Item 3
186 28 Jean-Philippe Lang
</pre>
187 28 Jean-Philippe Lang
188 28 Jean-Philippe Lang
displays:
189 1 Jean-Philippe Lang
190 28 Jean-Philippe Lang
* Item 1
191 28 Jean-Philippe Lang
* Item 2
192 29 Eric Gallimore
** Item 21
193 28 Jean-Philippe Lang
** Item 22
194 28 Jean-Philippe Lang
* Item 3
195 1 Jean-Philippe Lang
196 1 Jean-Philippe Lang
h3. Ordered lists
197 1 Jean-Philippe Lang
198 28 Jean-Philippe Lang
<pre>
199 28 Jean-Philippe Lang
# Item 1
200 28 Jean-Philippe Lang
# Item 2
201 28 Jean-Philippe Lang
# Item 3
202 28 Jean-Philippe Lang
## Item 3.1
203 28 Jean-Philippe Lang
## Item 3.2
204 1 Jean-Philippe Lang
</pre>
205 29 Eric Gallimore
206 29 Eric Gallimore
displays:
207 1 Jean-Philippe Lang
208 20 Kirill Ponomarev
# Item 1
209 20 Kirill Ponomarev
# Item 2
210 20 Kirill Ponomarev
# Item 3
211 21 Andrew Chaika
## Item 3.1
212 21 Andrew Chaika
## Item 3.2
213 21 Andrew Chaika
214 1 Jean-Philippe Lang
h3. Tables
215 1 Jean-Philippe Lang
216 1 Jean-Philippe Lang
<pre>
217 58 Dieter Egert
|_.UserID|_.Name|_.Group|_. attribute list |
218 60 Dieter Egert
|\3=.IT               |<. align left|
219 60 Dieter Egert
|1|Artur Pirozhkov |/2.Users |>. align right|
220 60 Dieter Egert
|2|Vasya Rogov        |=. center |
221 58 Dieter Egert
|3|John Smith |Admin
222 58 Dieter Egert
               (root)|^. valign top |
223 58 Dieter Egert
|4|-          |Nobody
224 58 Dieter Egert
               (anonymous)|~. valign bottom|
225 20 Kirill Ponomarev
</pre>
226 21 Andrew Chaika
227 60 Dieter Egert
displays (all multiple spaces are replaced by 1 space):
228 1 Jean-Philippe Lang
229 58 Dieter Egert
|_.UserID|_.Name|_.Group|_. attribute list |
230 60 Dieter Egert
|\3=.IT                |<. align left|
231 60 Dieter Egert
|1|Artur Pirozhkov |/2.Users |>. align right|
232 60 Dieter Egert
|2|Vasya Rogov         |=. center |
233 58 Dieter Egert
|3|John Smith |Admin
234 58 Dieter Egert
               (root)|^. valign top |
235 58 Dieter Egert
|4|-          |Nobody
236 58 Dieter Egert
               (anonymous)|~. valign bottom|
237 1 Jean-Philippe Lang
238 1 Jean-Philippe Lang
h3. Table of content
239 1 Jean-Philippe Lang
240 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
241 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
242 1 Jean-Philippe Lang
</code></pre>
243 7 Jean-Philippe Lang
244 7 Jean-Philippe Lang
h2. Macros
245 7 Jean-Philippe Lang
246 7 Jean-Philippe Lang
Redmine has the following builtin macros:
247 7 Jean-Philippe Lang
248 7 Jean-Philippe Lang
{{macro_list}}
249 7 Jean-Philippe Lang
250 1 Jean-Philippe Lang
251 4 Jean-Philippe Lang
h2. Code highlighting
252 51 Graham King
253 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.
254 1 Jean-Philippe Lang
255 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
256 1 Jean-Philippe Lang
257 49 Dave Clements
<pre><code><pre><code class="ruby">
258 1 Jean-Philippe Lang
  Place your code here.
259 40 Mischa The Evil
</code></pre>
260 1 Jean-Philippe Lang
</code></pre>
261 1 Jean-Philippe Lang
262 1 Jean-Philippe Lang
Example:
263 1 Jean-Philippe Lang
264 1 Jean-Philippe Lang
<pre><code class="ruby">
265 1 Jean-Philippe Lang
# The Greeter class
266 1 Jean-Philippe Lang
class Greeter
267 1 Jean-Philippe Lang
  def initialize(name)
268 1 Jean-Philippe Lang
    @name = name.capitalize
269 1 Jean-Philippe Lang
  end
270 1 Jean-Philippe Lang
 
271 1 Jean-Philippe Lang
  def salute
272 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
273 1 Jean-Philippe Lang
  end
274 40 Mischa The Evil
end
275 52 Vladimir Vasilkin
</code></pre>
276 52 Vladimir Vasilkin
277 52 Vladimir Vasilkin
278 52 Vladimir Vasilkin
h2. Translation
279 52 Vladimir Vasilkin
280 52 Vladimir Vasilkin
h3. Русский 
281 52 Vladimir Vasilkin
282 65 Lucy Yevseyeva
[[RusRedmineTextFormatting|Перевод на русский]]