RedmineTextFormatting » History » Version 37

ha thach, 2010-05-11 05:12
modify predefined format

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