Project

General

Profile

RedmineTextFormatting » History » Version 13

John Goerzen, 2008-03-13 15:07

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