RedmineTextFormatting » History » Version 58
Dieter Egert, 2011-06-17 17:35
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://www.redmine.org* -- External link to the redmine website: http://www.redmine.org |
71 | 47 | Ian Epperson | * *someone@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":http://www.redmine.org* -- External link with different text: "Redmine web site":http://www.redmine.org |
75 | 47 | Ian Epperson | * *"Email someone":mailto:someone@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":mailto:webmaster@foo.bar?cc=admin@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":mailto:someone@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":mailto:someone@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 | 1 | Jean-Philippe Lang | </code></pre> |
106 | 1 | Jean-Philippe Lang | |
107 | 1 | Jean-Philippe Lang | Display: |
108 | 1 | Jean-Philippe Lang | |
109 | 1 | Jean-Philippe Lang | * *bold* |
110 | 1 | Jean-Philippe Lang | * _italic_ |
111 | 19 | Pavel Schichko | * *_bold italic_* |
112 | 1 | Jean-Philippe Lang | * +underline+ |
113 | 1 | Jean-Philippe Lang | * -strike-through- |
114 | 45 | Ian Epperson | * Plain ^superscript^ |
115 | 45 | Ian Epperson | * Plain ~subscript~ |
116 | 1 | Jean-Philippe Lang | |
117 | 1 | Jean-Philippe Lang | h3. Inline images |
118 | 9 | Jean-Philippe Lang | |
119 | 1 | Jean-Philippe Lang | * *!image_url!* displays an image located at image_url (textile syntax) |
120 | 1 | Jean-Philippe Lang | * *!>image_url!* right floating image |
121 | 18 | samir djouadi | |
122 | 15 | Jean-Philippe Lang | If you have an image attached to your wiki page, it can be displayed inline using its filename: *!attached_image.png!* |
123 | 1 | Jean-Philippe Lang | |
124 | 1 | Jean-Philippe Lang | h3. Headings |
125 | 1 | Jean-Philippe Lang | |
126 | 1 | Jean-Philippe Lang | <pre><code>h1. Heading |
127 | 1 | Jean-Philippe Lang | h2. Subheading |
128 | 1 | Jean-Philippe Lang | h3. Subheading |
129 | 1 | Jean-Philippe Lang | </code></pre> |
130 | 1 | Jean-Philippe Lang | |
131 | 1 | Jean-Philippe Lang | h3. Paragraphs |
132 | 1 | Jean-Philippe Lang | |
133 | 58 | Dieter Egert | <pre><code>p. left aligned |
134 | 58 | Dieter Egert | |
135 | 58 | Dieter Egert | p(. left ident 1em |
136 | 58 | Dieter Egert | |
137 | 58 | Dieter Egert | p((. left ident 2em |
138 | 58 | Dieter Egert | as well as for following lines |
139 | 58 | Dieter Egert | |
140 | 58 | Dieter Egert | p>. right aligned |
141 | 58 | Dieter Egert | |
142 | 58 | Dieter Egert | p)))>. right ident 3em |
143 | 58 | Dieter Egert | |
144 | 58 | Dieter Egert | p=. This is centered paragraph. |
145 | 1 | Jean-Philippe Lang | </code></pre> |
146 | 1 | Jean-Philippe Lang | |
147 | 58 | Dieter Egert | p. left aligned |
148 | 58 | Dieter Egert | |
149 | 58 | Dieter Egert | p(. left ident 1em |
150 | 58 | Dieter Egert | |
151 | 58 | Dieter Egert | p((. left ident 2em |
152 | 58 | Dieter Egert | as well as for following lines |
153 | 58 | Dieter Egert | |
154 | 58 | Dieter Egert | p>. right aligned |
155 | 58 | Dieter Egert | |
156 | 58 | Dieter Egert | p)))>. right ident 3em |
157 | 58 | Dieter Egert | |
158 | 1 | Jean-Philippe Lang | p=. This is centered paragraph. |
159 | 1 | Jean-Philippe Lang | |
160 | 58 | Dieter Egert | |
161 | 36 | ha thach | h3. Predefined |
162 | 36 | ha thach | |
163 | 37 | ha thach | To escape wiki syntax |
164 | 1 | Jean-Philippe Lang | <pre> <pre> *Your text won't become bold* </pre> </pre> |
165 | 38 | ha thach | Display: |
166 | 38 | ha thach | |
167 | 37 | ha thach | <pre> *Your text won't become bold* </pre> |
168 | 36 | ha thach | |
169 | 1 | Jean-Philippe Lang | h3. Blockquotes |
170 | 1 | Jean-Philippe Lang | |
171 | 1 | Jean-Philippe Lang | Start the paragraph with *bq.* |
172 | 1 | Jean-Philippe Lang | |
173 | 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. |
174 | 1 | Jean-Philippe Lang | To go live, all you need to add is a database and a web server. |
175 | 1 | Jean-Philippe Lang | </code></pre> |
176 | 1 | Jean-Philippe Lang | |
177 | 1 | Jean-Philippe Lang | Display: |
178 | 1 | Jean-Philippe Lang | |
179 | 1 | Jean-Philippe Lang | bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern. |
180 | 1 | Jean-Philippe Lang | To go live, all you need to add is a database and a web server. |
181 | 1 | Jean-Philippe Lang | |
182 | 28 | Jean-Philippe Lang | h3. Unordered lists |
183 | 28 | Jean-Philippe Lang | |
184 | 28 | Jean-Philippe Lang | <pre> |
185 | 28 | Jean-Philippe Lang | * Item 1 |
186 | 28 | Jean-Philippe Lang | * Item 2 |
187 | 29 | Eric Gallimore | ** Item 21 |
188 | 29 | Eric Gallimore | ** Item 22 |
189 | 28 | Jean-Philippe Lang | * Item 3 |
190 | 28 | Jean-Philippe Lang | </pre> |
191 | 28 | Jean-Philippe Lang | |
192 | 28 | Jean-Philippe Lang | displays: |
193 | 1 | Jean-Philippe Lang | |
194 | 28 | Jean-Philippe Lang | * Item 1 |
195 | 28 | Jean-Philippe Lang | * Item 2 |
196 | 29 | Eric Gallimore | ** Item 21 |
197 | 28 | Jean-Philippe Lang | ** Item 22 |
198 | 28 | Jean-Philippe Lang | * Item 3 |
199 | 28 | Jean-Philippe Lang | |
200 | 28 | Jean-Philippe Lang | h3. Ordered lists |
201 | 28 | Jean-Philippe Lang | |
202 | 28 | Jean-Philippe Lang | <pre> |
203 | 28 | Jean-Philippe Lang | # Item 1 |
204 | 28 | Jean-Philippe Lang | # Item 2 |
205 | 29 | Eric Gallimore | # Item 3 |
206 | 29 | Eric Gallimore | ## Item 3.1 |
207 | 28 | Jean-Philippe Lang | ## Item 3.2 |
208 | 20 | Kirill Ponomarev | </pre> |
209 | 20 | Kirill Ponomarev | |
210 | 20 | Kirill Ponomarev | displays: |
211 | 21 | Andrew Chaika | |
212 | 21 | Andrew Chaika | # Item 1 |
213 | 21 | Andrew Chaika | # Item 2 |
214 | 1 | Jean-Philippe Lang | # Item 3 |
215 | 1 | Jean-Philippe Lang | ## Item 3.1 |
216 | 1 | Jean-Philippe Lang | ## Item 3.2 |
217 | 1 | Jean-Philippe Lang | |
218 | 1 | Jean-Philippe Lang | h3. Tables |
219 | 1 | Jean-Philippe Lang | |
220 | 1 | Jean-Philippe Lang | <pre> |
221 | 58 | Dieter Egert | |_.UserID|_.Name|_.Group|_. attribute list | |
222 | 58 | Dieter Egert | |\3=.IT |<. align left| |
223 | 58 | Dieter Egert | |1|Artur Pirozhkov|/2.Users|>. align right| |
224 | 58 | Dieter Egert | |2|Vasya Rogov|=. center | |
225 | 58 | Dieter Egert | |3|John Smith |Admin |
226 | 58 | Dieter Egert | (root)|^. valign top | |
227 | 58 | Dieter Egert | |4|- |Nobody |
228 | 58 | Dieter Egert | (anonymous)|~. valign bottom| |
229 | 20 | Kirill Ponomarev | </pre> |
230 | 21 | Andrew Chaika | |
231 | 1 | Jean-Philippe Lang | Display: |
232 | 1 | Jean-Philippe Lang | |
233 | 58 | Dieter Egert | |_.UserID|_.Name|_.Group|_. attribute list | |
234 | 58 | Dieter Egert | |\3=.IT |<. align left| |
235 | 58 | Dieter Egert | |1|Artur Pirozhkov|/2.Users|>. align right| |
236 | 58 | Dieter Egert | |2|Vasya Rogov|=. center | |
237 | 58 | Dieter Egert | |3|John Smith |Admin |
238 | 58 | Dieter Egert | (root)|^. valign top | |
239 | 58 | Dieter Egert | |4|- |Nobody |
240 | 58 | Dieter Egert | (anonymous)|~. valign bottom| |
241 | 1 | Jean-Philippe Lang | |
242 | 1 | Jean-Philippe Lang | h3. Table of content |
243 | 1 | Jean-Philippe Lang | |
244 | 1 | Jean-Philippe Lang | <pre><code>{{toc}} => left aligned toc |
245 | 1 | Jean-Philippe Lang | {{>toc}} => right aligned toc |
246 | 1 | Jean-Philippe Lang | </code></pre> |
247 | 7 | Jean-Philippe Lang | |
248 | 7 | Jean-Philippe Lang | h2. Macros |
249 | 7 | Jean-Philippe Lang | |
250 | 7 | Jean-Philippe Lang | Redmine has the following builtin macros: |
251 | 7 | Jean-Philippe Lang | |
252 | 7 | Jean-Philippe Lang | {{macro_list}} |
253 | 7 | Jean-Philippe Lang | |
254 | 1 | Jean-Philippe Lang | |
255 | 4 | Jean-Philippe Lang | h2. Code highlighting |
256 | 51 | Graham King | |
257 | 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. |
258 | 1 | Jean-Philippe Lang | |
259 | 1 | Jean-Philippe Lang | You can highlight code in your wiki page using this syntax: |
260 | 1 | Jean-Philippe Lang | |
261 | 49 | Dave Clements | <pre><code><pre><code class="ruby"> |
262 | 1 | Jean-Philippe Lang | Place your code here. |
263 | 40 | Mischa The Evil | </code></pre> |
264 | 1 | Jean-Philippe Lang | </code></pre> |
265 | 1 | Jean-Philippe Lang | |
266 | 1 | Jean-Philippe Lang | Example: |
267 | 1 | Jean-Philippe Lang | |
268 | 1 | Jean-Philippe Lang | <pre><code class="ruby"> |
269 | 1 | Jean-Philippe Lang | # The Greeter class |
270 | 1 | Jean-Philippe Lang | class Greeter |
271 | 1 | Jean-Philippe Lang | def initialize(name) |
272 | 1 | Jean-Philippe Lang | @name = name.capitalize |
273 | 1 | Jean-Philippe Lang | end |
274 | 1 | Jean-Philippe Lang | |
275 | 1 | Jean-Philippe Lang | def salute |
276 | 1 | Jean-Philippe Lang | puts "Hello #{@name}!" |
277 | 1 | Jean-Philippe Lang | end |
278 | 40 | Mischa The Evil | end |
279 | 52 | Vladimir Vasilkin | </code></pre> |
280 | 52 | Vladimir Vasilkin | |
281 | 52 | Vladimir Vasilkin | |
282 | 52 | Vladimir Vasilkin | h2. Translation |
283 | 52 | Vladimir Vasilkin | |
284 | 52 | Vladimir Vasilkin | h3. Русский |
285 | 52 | Vladimir Vasilkin | |
286 | 1 | Jean-Philippe Lang | [[RedmineTextFormattingRus|Частичный перевод на русский]] |