RedmineTextFormatting » History » Version 33

ha thach, 2010-04-30 14:32
create Sidebar instruction

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 1 Jean-Philippe Lang
h3. Blockquotes
122 1 Jean-Philippe Lang
123 1 Jean-Philippe Lang
Start the paragraph with *bq.*
124 1 Jean-Philippe Lang
125 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.
126 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
127 1 Jean-Philippe Lang
</code></pre>
128 1 Jean-Philippe Lang
129 1 Jean-Philippe Lang
Display:
130 1 Jean-Philippe Lang
131 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
132 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
133 1 Jean-Philippe Lang
134 28 Jean-Philippe Lang
h3. Unordered lists
135 28 Jean-Philippe Lang
136 28 Jean-Philippe Lang
<pre>
137 28 Jean-Philippe Lang
* Item 1
138 28 Jean-Philippe Lang
* Item 2
139 29 Eric Gallimore
** Item 21
140 29 Eric Gallimore
** Item 22
141 28 Jean-Philippe Lang
* Item 3
142 28 Jean-Philippe Lang
</pre>
143 28 Jean-Philippe Lang
144 28 Jean-Philippe Lang
displays:
145 1 Jean-Philippe Lang
146 28 Jean-Philippe Lang
* Item 1
147 28 Jean-Philippe Lang
* Item 2
148 29 Eric Gallimore
** Item 21
149 29 Eric Gallimore
** Item 22
150 28 Jean-Philippe Lang
* Item 3
151 28 Jean-Philippe Lang
152 1 Jean-Philippe Lang
h3. Ordered lists
153 1 Jean-Philippe Lang
154 28 Jean-Philippe Lang
<pre>
155 28 Jean-Philippe Lang
# Item 1
156 28 Jean-Philippe Lang
# Item 2
157 28 Jean-Philippe Lang
# Item 3
158 29 Eric Gallimore
## Item 3.1
159 29 Eric Gallimore
## Item 3.2
160 28 Jean-Philippe Lang
</pre>
161 1 Jean-Philippe Lang
162 1 Jean-Philippe Lang
displays:
163 28 Jean-Philippe Lang
164 28 Jean-Philippe Lang
# Item 1
165 28 Jean-Philippe Lang
# Item 2
166 28 Jean-Philippe Lang
# Item 3
167 29 Eric Gallimore
## Item 3.1
168 29 Eric Gallimore
## Item 3.2
169 28 Jean-Philippe Lang
170 33 ha thach
h3. Sidebar
171 33 ha thach
172 33 ha thach
If you create the page named Sidebar, it will appear on the side bar of every wiki pages in the project
173 33 ha thach
174 20 Kirill Ponomarev
h3. Tables
175 20 Kirill Ponomarev
176 20 Kirill Ponomarev
<pre>
177 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
178 21 Andrew Chaika
|\3=.IT|
179 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
180 20 Kirill Ponomarev
|2|Vasya Rogov|
181 21 Andrew Chaika
|3|John Smith|Admin|
182 1 Jean-Philippe Lang
</pre>
183 1 Jean-Philippe Lang
184 1 Jean-Philippe Lang
Display:
185 1 Jean-Philippe Lang
186 21 Andrew Chaika
|_.UserID|_.Name|_.Group|
187 21 Andrew Chaika
|\3=.IT|
188 21 Andrew Chaika
|1|Artur Pirozhkov|/2.Users|
189 20 Kirill Ponomarev
|2|Vasya Rogov|
190 21 Andrew Chaika
|3|John Smith|Admin|
191 20 Kirill Ponomarev
192 1 Jean-Philippe Lang
h3. Table of content
193 1 Jean-Philippe Lang
194 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
195 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
196 1 Jean-Philippe Lang
</code></pre>
197 1 Jean-Philippe Lang
198 7 Jean-Philippe Lang
h2. Macros
199 7 Jean-Philippe Lang
200 7 Jean-Philippe Lang
Redmine has the following builtin macros:
201 7 Jean-Philippe Lang
202 7 Jean-Philippe Lang
{{macro_list}}
203 7 Jean-Philippe Lang
204 7 Jean-Philippe Lang
205 1 Jean-Philippe Lang
h2. Code highlighting
206 4 Jean-Philippe Lang
207 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.
208 1 Jean-Philippe Lang
209 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
210 1 Jean-Philippe Lang
211 1 Jean-Philippe Lang
<pre><code><pre><code class="ruby">
212 1 Jean-Philippe Lang
  Place you code here.
213 1 Jean-Philippe Lang
</code></pre>
214 1 Jean-Philippe Lang
</pre></code>
215 1 Jean-Philippe Lang
216 1 Jean-Philippe Lang
Example:
217 1 Jean-Philippe Lang
218 1 Jean-Philippe Lang
<pre><code class="ruby">
219 1 Jean-Philippe Lang
# The Greeter class
220 1 Jean-Philippe Lang
class Greeter
221 1 Jean-Philippe Lang
  def initialize(name)
222 1 Jean-Philippe Lang
    @name = name.capitalize
223 1 Jean-Philippe Lang
  end
224 1 Jean-Philippe Lang
 
225 1 Jean-Philippe Lang
  def salute
226 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
227 1 Jean-Philippe Lang
  end
228 1 Jean-Philippe Lang
end
229 1 Jean-Philippe Lang
</pre></code>