RedmineTextFormatting » History » Version 30

Jiří Křivánek, 2010-02-03 13:42
I needed to create a ling from the comment of the issue assigned to one project to the wiki of other project. I discovered that this is easily possible but not documented here. So added it...

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 30 Jiří Křivánek
* *[[prjid:Guide]]* displays a link to the page named 'Guide' but located in a Wiki of other project (with ID prjid): [[Guide]]
19 1 Jean-Philippe Lang
* *[[Guide|User manual]]* displays a link to the same page but with a different text: [[Guide|User manual]]
20 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]]
21 1 Jean-Philippe Lang
22 1 Jean-Philippe Lang
You can also link to pages of an other project wiki:
23 3 Jean-Philippe Lang
24 1 Jean-Philippe Lang
* *[[sandbox:some page]]* displays a link to the page named 'Some page' of the Sandbox wiki
25 1 Jean-Philippe Lang
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
26 1 Jean-Philippe Lang
27 1 Jean-Philippe Lang
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
28 1 Jean-Philippe Lang
29 14 Jean-Philippe Lang
Links to others resources (0.7):
30 6 Jean-Philippe Lang
31 6 Jean-Philippe Lang
* Documents:
32 6 Jean-Philippe Lang
33 6 Jean-Philippe Lang
  * *!document#17* (link to document with id 17)
34 6 Jean-Philippe Lang
  * *!document:Greetings* (link to the document with title "Greetings")
35 6 Jean-Philippe Lang
  * *!document:"Some document"* (double quotes can be used when document title contains spaces)
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 15 Jean-Philippe Lang
  * *!source:some/file*          -- Link to the file located at /some/file in the project's repository
51 15 Jean-Philippe Lang
  * *!source:some/file@52*       -- Link to the file's revision 52
52 15 Jean-Philippe Lang
  * *!source:some/file#L120*     -- Link to line 120 of the file
53 15 Jean-Philippe Lang
  * *!source:some/file@52#L120*  -- Link to line 120 of the file's revision 52
54 15 Jean-Philippe Lang
  * *!export:some/file*          -- Force the download of the file
55 14 Jean-Philippe Lang
56 14 Jean-Philippe Lang
Escaping (0.7):
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 1 Jean-Philippe Lang
h3. Font style
83 1 Jean-Philippe Lang
84 1 Jean-Philippe Lang
<pre><code>* *bold*
85 1 Jean-Philippe Lang
* _italic_
86 19 Pavel Schichko
* *_bold italic_*
87 1 Jean-Philippe Lang
* +underline+
88 1 Jean-Philippe Lang
* -strike-through-
89 1 Jean-Philippe Lang
</code></pre>
90 1 Jean-Philippe Lang
91 1 Jean-Philippe Lang
Display:
92 1 Jean-Philippe Lang
93 1 Jean-Philippe Lang
 * *bold*
94 1 Jean-Philippe Lang
 * _italic_
95 19 Pavel Schichko
 * *_bold italic_*
96 1 Jean-Philippe Lang
 * +underline+
97 1 Jean-Philippe Lang
 * -strike-through-
98 1 Jean-Philippe Lang
99 1 Jean-Philippe Lang
h3. Inline images
100 9 Jean-Philippe Lang
101 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
102 1 Jean-Philippe Lang
* *&#33;>image_url&#33;* right floating image
103 15 Jean-Philippe Lang
* *&#33;{width:300px}image_url&#33;* sets the width of the image
104 18 samir djouadi
105 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;*
106 1 Jean-Philippe Lang
107 1 Jean-Philippe Lang
h3. Headings
108 1 Jean-Philippe Lang
109 1 Jean-Philippe Lang
<pre><code>h1. Heading
110 1 Jean-Philippe Lang
h2. Subheading
111 1 Jean-Philippe Lang
h3. Subheading
112 1 Jean-Philippe Lang
</code></pre>
113 1 Jean-Philippe Lang
114 1 Jean-Philippe Lang
h3. Paragraphs
115 1 Jean-Philippe Lang
116 1 Jean-Philippe Lang
<pre><code>p>. right aligned
117 1 Jean-Philippe Lang
p=. centered
118 1 Jean-Philippe Lang
</code></pre>
119 2 Jean-Philippe Lang
120 1 Jean-Philippe Lang
p=. This is centered paragraph.
121 1 Jean-Philippe Lang
122 1 Jean-Philippe Lang
h3. Blockquotes
123 1 Jean-Philippe Lang
124 1 Jean-Philippe Lang
Start the paragraph with *bq.*
125 1 Jean-Philippe Lang
126 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.
127 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
128 1 Jean-Philippe Lang
</code></pre>
129 1 Jean-Philippe Lang
130 1 Jean-Philippe Lang
Display:
131 1 Jean-Philippe Lang
132 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
133 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
134 1 Jean-Philippe Lang
135 28 Jean-Philippe Lang
h3. Unordered lists
136 28 Jean-Philippe Lang
137 28 Jean-Philippe Lang
<pre>
138 28 Jean-Philippe Lang
* Item 1
139 28 Jean-Philippe Lang
* Item 2
140 29 Eric Gallimore
** Item 21
141 29 Eric Gallimore
** Item 22
142 28 Jean-Philippe Lang
* Item 3
143 28 Jean-Philippe Lang
</pre>
144 28 Jean-Philippe Lang
145 28 Jean-Philippe Lang
displays:
146 1 Jean-Philippe Lang
147 28 Jean-Philippe Lang
* Item 1
148 28 Jean-Philippe Lang
* Item 2
149 29 Eric Gallimore
** Item 21
150 29 Eric Gallimore
** Item 22
151 28 Jean-Philippe Lang
* Item 3
152 28 Jean-Philippe Lang
153 1 Jean-Philippe Lang
h3. Ordered lists
154 1 Jean-Philippe Lang
155 28 Jean-Philippe Lang
<pre>
156 28 Jean-Philippe Lang
# Item 1
157 28 Jean-Philippe Lang
# Item 2
158 28 Jean-Philippe Lang
# Item 3
159 29 Eric Gallimore
## Item 3.1
160 29 Eric Gallimore
## Item 3.2
161 28 Jean-Philippe Lang
</pre>
162 1 Jean-Philippe Lang
163 1 Jean-Philippe Lang
displays:
164 28 Jean-Philippe Lang
165 28 Jean-Philippe Lang
# Item 1
166 28 Jean-Philippe Lang
# Item 2
167 28 Jean-Philippe Lang
# Item 3
168 29 Eric Gallimore
## Item 3.1
169 29 Eric Gallimore
## Item 3.2
170 28 Jean-Philippe Lang
171 20 Kirill Ponomarev
h3. Tables
172 20 Kirill Ponomarev
173 20 Kirill Ponomarev
<pre>
174 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
175 21 Andrew Chaika
|\3=.IT|
176 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
177 20 Kirill Ponomarev
|2|Vasya Rogov|
178 21 Andrew Chaika
|3|John Smith|Admin|
179 1 Jean-Philippe Lang
</pre>
180 1 Jean-Philippe Lang
181 1 Jean-Philippe Lang
Display:
182 1 Jean-Philippe Lang
183 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
184 21 Andrew Chaika
|\3=.IT|
185 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
186 20 Kirill Ponomarev
|2|Vasya Rogov|
187 21 Andrew Chaika
|3|John Smith|Admin|
188 20 Kirill Ponomarev
189 1 Jean-Philippe Lang
h3. Table of content
190 1 Jean-Philippe Lang
191 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
192 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
193 1 Jean-Philippe Lang
</code></pre>
194 1 Jean-Philippe Lang
195 7 Jean-Philippe Lang
h2. Macros
196 7 Jean-Philippe Lang
197 7 Jean-Philippe Lang
Redmine has the following builtin macros:
198 7 Jean-Philippe Lang
199 7 Jean-Philippe Lang
{{macro_list}}
200 7 Jean-Philippe Lang
201 7 Jean-Philippe Lang
202 1 Jean-Philippe Lang
h2. Code highlighting
203 4 Jean-Philippe Lang
204 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.
205 1 Jean-Philippe Lang
206 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
207 1 Jean-Philippe Lang
208 1 Jean-Philippe Lang
<pre><code><pre><code class="ruby">
209 1 Jean-Philippe Lang
  Place you code here.
210 1 Jean-Philippe Lang
</code></pre>
211 1 Jean-Philippe Lang
</pre></code>
212 1 Jean-Philippe Lang
213 1 Jean-Philippe Lang
Example:
214 1 Jean-Philippe Lang
215 1 Jean-Philippe Lang
<pre><code class="ruby">
216 1 Jean-Philippe Lang
# The Greeter class
217 1 Jean-Philippe Lang
class Greeter
218 1 Jean-Philippe Lang
  def initialize(name)
219 1 Jean-Philippe Lang
    @name = name.capitalize
220 1 Jean-Philippe Lang
  end
221 1 Jean-Philippe Lang
 
222 1 Jean-Philippe Lang
  def salute
223 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
224 1 Jean-Philippe Lang
  end
225 1 Jean-Philippe Lang
end
226 1 Jean-Philippe Lang
</pre></code>