|
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
|
3 |
<head>
|
|
4 |
<title>RedmineWikiFormatting</title>
|
|
5 |
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
6 |
<style type="text/css">
|
|
7 |
body { font:80% Verdana,Tahoma,Arial,sans-serif; }
|
|
8 |
h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
|
|
9 |
pre, code { font-size:120%; }
|
|
10 |
pre code { font-size:100%; }
|
|
11 |
pre {
|
|
12 |
margin: 1em 1em 1em 1.6em;
|
|
13 |
padding: 2px;
|
|
14 |
background-color: #fafafa;
|
|
15 |
border: 1px solid #dadada;
|
|
16 |
width:95%;
|
|
17 |
overflow-x: auto;
|
|
18 |
}
|
|
19 |
a.new { color: #b73535; }
|
|
20 |
|
|
21 |
.syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
|
|
22 |
.syntaxhl .comment { color:#666; }
|
|
23 |
|
|
24 |
.syntaxhl .class { color:#B06; font-weight:bold }
|
|
25 |
.syntaxhl .delimiter { color:black }
|
|
26 |
.syntaxhl .function { color:#06B; font-weight:bold }
|
|
27 |
|
|
28 |
.syntaxhl .inline { background: #eee }
|
|
29 |
.syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
|
|
30 |
|
|
31 |
.syntaxhl .instance-variable { color:#33B }
|
|
32 |
.syntaxhl .reserved { color:#080; font-weight:bold }
|
|
33 |
|
|
34 |
.syntaxhl .string { background-color:#fff0f0; color: #D20; }
|
|
35 |
.syntaxhl .string .delimiter { color:#710 }
|
|
36 |
|
|
37 |
</style>
|
|
38 |
</head>
|
|
39 |
|
|
40 |
<body>
|
|
41 |
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
|
|
42 |
|
|
43 |
<h2><a name="2" class="wiki-page"></a>Links</h2>
|
|
44 |
|
|
45 |
<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
|
|
46 |
|
|
47 |
<p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
|
48 |
<ul>
|
|
49 |
<li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
|
|
50 |
<li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
|
51 |
</ul>
|
|
52 |
|
|
53 |
<p>Wiki links:</p>
|
|
54 |
|
|
55 |
<ul>
|
|
56 |
<li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
|
|
57 |
<li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
|
|
58 |
<li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
|
|
59 |
</ul>
|
|
60 |
|
|
61 |
<p>You can also link to pages of an other project wiki:</p>
|
|
62 |
|
|
63 |
<ul>
|
|
64 |
<li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
|
|
65 |
<li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
|
|
66 |
</ul>
|
|
67 |
|
|
68 |
<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
|
69 |
|
|
70 |
<p>Links to other resources:</p>
|
|
71 |
|
|
72 |
<ul>
|
|
73 |
<li>Documents:
|
|
74 |
<ul>
|
|
75 |
<li><strong>document#17</strong> (link to document with id 17)</li>
|
|
76 |
<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
|
|
77 |
<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
|
|
78 |
<li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
|
|
79 |
</ul></li>
|
|
80 |
</ul>
|
|
81 |
|
|
82 |
<ul>
|
|
83 |
<li>Versions:
|
|
84 |
<ul>
|
|
85 |
<li><strong>version#3</strong> (link to version with id 3)</li>
|
|
86 |
<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
|
|
87 |
<li><strong>version:"1.0 beta 2"</strong></li>
|
|
88 |
<li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
|
|
89 |
</ul></li>
|
|
90 |
</ul>
|
|
91 |
|
|
92 |
<ul>
|
|
93 |
<li>Attachments:
|
|
94 |
<ul>
|
|
95 |
<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
|
|
96 |
<li>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)</li>
|
|
97 |
</ul></li>
|
|
98 |
</ul>
|
|
99 |
|
|
100 |
<ul>
|
|
101 |
<li>Changesets:
|
|
102 |
<ul>
|
|
103 |
<li><strong>r758</strong> (link to a changeset)</li>
|
|
104 |
<li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
|
105 |
<li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
|
106 |
<li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
|
107 |
<li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
|
108 |
<li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
|
109 |
</ul></li>
|
|
110 |
</ul>
|
|
111 |
|
|
112 |
<ul>
|
|
113 |
<li>Repository files:
|
|
114 |
<ul>
|
|
115 |
<li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
|
|
116 |
<li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
|
|
117 |
<li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
|
|
118 |
<li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
|
|
119 |
<li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
|
|
120 |
<li><strong>export:some/file</strong> (force the download of the file)</li>
|
|
121 |
<li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
|
122 |
<li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
|
|
123 |
<li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
|
|
124 |
</ul></li>
|
|
125 |
</ul>
|
|
126 |
|
|
127 |
<ul>
|
|
128 |
<li>Forums:
|
|
129 |
<ul>
|
|
130 |
<li><strong>forum#1</strong> (link to forum with id 1</li>
|
|
131 |
<li><strong>forum:Support</strong> (link to forum named Support)</li>
|
|
132 |
<li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
|
|
133 |
</ul></li>
|
|
134 |
</ul>
|
|
135 |
|
|
136 |
<ul>
|
|
137 |
<li>Forum messages:
|
|
138 |
<ul>
|
|
139 |
<li><strong>message#1218</strong> (link to message with id 1218)</li>
|
|
140 |
</ul></li>
|
|
141 |
</ul>
|
|
142 |
|
|
143 |
<ul>
|
|
144 |
<li>Projects:
|
|
145 |
<ul>
|
|
146 |
<li><strong>project#3</strong> (link to project with id 3)</li>
|
|
147 |
<li><strong>project:some-project</strong> (link to project with name or slug of "some-project")</li>
|
|
148 |
<li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
|
|
149 |
</ul></li>
|
|
150 |
</ul>
|
|
151 |
|
|
152 |
<ul>
|
|
153 |
<li>News:
|
|
154 |
<ul>
|
|
155 |
<li><strong>news#2</strong> (link to news item with id 2)</li>
|
|
156 |
<li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
|
|
157 |
<li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
|
|
158 |
</ul></li>
|
|
159 |
</ul>
|
|
160 |
|
|
161 |
<p>Escaping:</p>
|
|
162 |
|
|
163 |
<ul>
|
|
164 |
<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
|
|
165 |
</ul>
|
|
166 |
|
|
167 |
|
|
168 |
<h3><a name="4" class="wiki-page"></a>External links</h3>
|
|
169 |
|
|
170 |
<p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
|
|
171 |
|
|
172 |
<pre>
|
|
173 |
http://www.redmine.org, [email protected]
|
|
174 |
</pre>
|
|
175 |
|
|
176 |
<p>displays: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:[email protected]" class="email">[email protected]</a></p>
|
|
177 |
|
|
178 |
<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
|
|
179 |
|
|
180 |
<pre>
|
|
181 |
"Redmine web site":http://www.redmine.org
|
|
182 |
</pre>
|
|
183 |
|
|
184 |
<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
|
185 |
|
|
186 |
|
|
187 |
<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
|
|
188 |
|
|
189 |
|
|
190 |
<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
|
|
191 |
|
|
192 |
<h3><a name="6" class="wiki-page"></a>Font style</h3>
|
|
193 |
|
|
194 |
<pre>
|
|
195 |
* *bold*
|
|
196 |
* _italic_
|
|
197 |
* _*bold italic*_
|
|
198 |
* +underline+
|
|
199 |
* -strike-through-
|
|
200 |
</pre>
|
|
201 |
|
|
202 |
<p>Display:</p>
|
|
203 |
|
|
204 |
<ul>
|
|
205 |
<li><strong>bold</strong></li>
|
|
206 |
<li><em>italic</em></li>
|
|
207 |
<li><em><strong>bold italic</strong></em></li>
|
|
208 |
<li><ins>underline</ins></li>
|
|
209 |
<li><del>strike-through</del></li>
|
|
210 |
</ul>
|
|
211 |
|
|
212 |
<h3><a name="7" class="wiki-page"></a>Inline images</h3>
|
|
213 |
|
|
214 |
<ul>
|
|
215 |
<li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
|
|
216 |
<li><strong>!>image_url!</strong> right floating image</li>
|
|
217 |
<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
|
|
218 |
</ul>
|
|
219 |
|
|
220 |
<h3><a name="8" class="wiki-page"></a>Headings</h3>
|
|
221 |
|
|
222 |
<pre>
|
|
223 |
h1. Heading
|
|
224 |
h2. Subheading
|
|
225 |
h3. Subsubheading
|
|
226 |
</pre>
|
|
227 |
|
|
228 |
<p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
|
|
229 |
|
|
230 |
|
|
231 |
<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
|
|
232 |
|
|
233 |
<pre>
|
|
234 |
p>. right aligned
|
|
235 |
p=. centered
|
|
236 |
</pre>
|
|
237 |
|
|
238 |
<p style="text-align:center;">This is a centered paragraph.</p>
|
|
239 |
|
|
240 |
|
|
241 |
<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
|
|
242 |
|
|
243 |
<p>Start the paragraph with <strong>bq.</strong></p>
|
|
244 |
|
|
245 |
<pre>
|
|
246 |
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
|
247 |
To go live, all you need to add is a database and a web server.
|
|
248 |
</pre>
|
|
249 |
|
|
250 |
<p>Display:</p>
|
|
251 |
|
|
252 |
<blockquote>
|
|
253 |
<p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
|
|
254 |
</blockquote>
|
|
255 |
|
|
256 |
|
|
257 |
<h3><a name="11" class="wiki-page"></a>Table of content</h3>
|
|
258 |
|
|
259 |
<pre>
|
|
260 |
{{toc}} => left aligned toc
|
|
261 |
{{>toc}} => right aligned toc
|
|
262 |
</pre>
|
|
263 |
|
|
264 |
<h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
|
265 |
|
|
266 |
<pre>
|
|
267 |
---
|
|
268 |
</pre>
|
|
269 |
|
|
270 |
<h2><a name="12" class="wiki-page"></a>Macros</h2>
|
|
271 |
|
|
272 |
<p>Redmine has the following builtin macros:</p>
|
|
273 |
|
|
274 |
<p>
|
|
275 |
<dl>
|
|
276 |
<dt><code>hello_world</code></dt>
|
|
277 |
<dd><p>Sample macro.</p></dd>
|
|
278 |
|
|
279 |
<dt><code>macro_list</code></dt>
|
|
280 |
<dd><p>Displays a list of all available macros, including description if available.</p></dd>
|
|
281 |
|
|
282 |
<dt><code>child_pages</code></dt>
|
|
283 |
<dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
|
|
284 |
<pre><code>{{child_pages}} -- can be used from a wiki page only
|
|
285 |
{{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
|
|
286 |
|
|
287 |
<dt><code>include</code></dt>
|
|
288 |
<dd><p>Include a wiki page. Example:</p>
|
|
289 |
<pre><code>{{include(Foo)}}</code></pre>
|
|
290 |
<p>or to include a page of a specific project wiki:</p>
|
|
291 |
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
|
292 |
|
|
293 |
<dt><code>collapse</code></dt>
|
|
294 |
<dd><p>Inserts of collapsed block of text. Example:</p>
|
|
295 |
<pre><code>{{collapse(View details...)
|
|
296 |
This is a block of text that is collapsed by default.
|
|
297 |
It can be expanded by clicking a link.
|
|
298 |
}}</code></pre></dd>
|
|
299 |
|
|
300 |
<dt><code>thumbnail</code></dt>
|
|
301 |
<dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
|
|
302 |
<pre>{{thumbnail(image.png)}}
|
|
303 |
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
|
304 |
</dl>
|
|
305 |
</p>
|
|
306 |
|
|
307 |
<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
|
|
308 |
|
|
309 |
<p>Default code highlightment relies on <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, a fast syntax highlighting library written completely in Ruby. It currently supports c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.</p>
|
|
310 |
|
|
311 |
<p>You can highlight code in your wiki page using this syntax:</p>
|
|
312 |
|
|
313 |
<pre>
|
|
314 |
<pre><code class="ruby">
|
|
315 |
Place your code here.
|
|
316 |
</code></pre>
|
|
317 |
</pre>
|
|
318 |
|
|
319 |
<p>Example:</p>
|
|
320 |
|
|
321 |
<pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
|
|
322 |
<span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
|
|
323 |
<span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
|
|
324 |
<span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
|
|
325 |
<span class="line-numbers"> 5</span> <span class="reserved">end</span>
|
|
326 |
<span class="line-numbers"> 6</span>
|
|
327 |
<span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
|
|
328 |
<span class="line-numbers"> 8</span> puts <span class="string"><span class="delimiter">"</span><span class="content">Hello </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">!</span><span class="delimiter">"</span></span>
|
|
329 |
<span class="line-numbers"> 9</span> <span class="reserved">end</span>
|
|
330 |
<span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
|
|
331 |
</pre>
|
|
332 |
</body>
|
|
333 |
</html>
|
0 |
334 |
|
3.0-stable: copy Spanish wiki helps to Spanish Panama (#19489)