Project

General

Profile

RedmineTextFormatting » History » Version 7

Jean-Philippe Lang, 2008-02-16 16:38
builtin macros

1 1 Jean-Philippe Lang
h1. Wiki formatting
2
3
{{>TOC}}
4
5
Redmine supports "Textile":http://hobix.com/textile/ syntax for wikis and almost anything that has a text description (issues, news, messages, changesets...).
6
7
h2. Links
8
9 6 Jean-Philippe Lang
h3. Redmine links
10
11 1 Jean-Philippe Lang
Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.
12
13 6 Jean-Philippe Lang
* Link to an issue: *#1*
14
* Link to a changeset: *!r758* (displays r758)
15 1 Jean-Philippe Lang
16 6 Jean-Philippe Lang
Wiki links:
17 1 Jean-Philippe Lang
18 3 Jean-Philippe Lang
* *[[Guide]]* displays a link to the page named 'Guide': [[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
21
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
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
25
26
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
27
28 6 Jean-Philippe Lang
Links to others resources (0.6.devel.1064 and above):
29
30
* Documents:
31
32
  * *!document#17* (link to document with id 17)
33
  * *!document:Greetings* (link to the document with title "Greetings")
34
  * *!document:"Some document"* (double quotes can be used when document title contains spaces)
35
36
* Versions:
37
38
  * *!version#3* (link to version with id 3)
39
  * *!version:1.0.0* (link to version named "1.0.0")
40
  * *!version:"1.0 beta 2"*
41
42
* Attachments:
43
  
44
  * *!attachment:file.zip* (link to the attachment of the current object named file.zip)
45
  * 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
47
Escaping (0.6.devel.1064 and above):
48
49
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
50
51
h3. External links
52 5 Jean-Philippe Lang
53
HTTP URLs and email addresses are automatically turned into clickable links: 
54
55
<pre>
56
http://www.redmine.org, someone@foo.bar
57
</pre>
58
59
displays: http://www.redmine.org, someone@foo.bar
60
61
If you want to display a specific text instead of the URL, you can use the standard textile syntax:
62
63
<pre>
64
"Redmine web site":http://www.redmine.org
65
</pre>
66
67 1 Jean-Philippe Lang
displays: "Redmine web site":http://www.redmine.org
68
69
h2. Text formatting
70
71
h3. Font style
72
73
<pre><code>* *bold*
74
* _italic_
75
* _*bold italic*_
76
* +underline+
77
* -strike-through-
78
</code></pre>
79
80
Display:
81
82
 * *bold*
83
 * _italic_
84
 * _*bold italic*_
85
 * +underline+
86
 * -strike-through-
87
88
h2. Inline images
89
90
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
91
* *&#33;>image_url&#33;* right floating image
92
* If you have an image attached to your wiki page, it can be displayed inline using its filename: *&#33;attached_image.png&#33;*
93
94
95
h3. Headings
96
97
<pre><code>h1. Heading
98
h2. Subheading
99
h3. Subheading
100
</code></pre>
101
102
h3. Paragraphs
103
104
<pre><code>p>. right aligned
105
p=. centered
106
</code></pre>
107 2 Jean-Philippe Lang
108 1 Jean-Philippe Lang
p=. This is centered paragraph.
109
110
h3. Blockquotes
111
112
Start the paragraph with *bq.*
113
114
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
115
To go live, all you need to add is a database and a web server.
116
</code></pre>
117
118
Display:
119
120
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
121
To go live, all you need to add is a database and a web server.
122
123
h3. Table of content
124
125
<pre><code>{{toc}} => left aligned toc
126
{{>toc}} => right aligned toc
127
</code></pre>
128
129 7 Jean-Philippe Lang
h2. Macros
130
131
Redmine has the following builtin macros:
132
133
{{macro_list}}
134
135
136 1 Jean-Philippe Lang
h2. Code highlighting
137 4 Jean-Philippe Lang
138 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.
139
140
You can highlight code in your wiki page using this syntax:
141
142
<pre><code><pre><code class="ruby">
143
  Place you code here.
144
</code></pre>
145
</pre></code>
146
147
Example:
148
149
<pre><code class="ruby">
150
# The Greeter class
151
class Greeter
152
  def initialize(name)
153
    @name = name.capitalize
154
  end
155
 
156
  def salute
157
    puts "Hello #{@name}!"
158
  end
159
end
160
</pre></code>