Project

General

Profile

RedmineTextFormatting » History » Version 18

samir djouadi, 2009-04-28 07:43

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 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
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 14 Jean-Philippe Lang
Links to others resources (0.7):
28 6 Jean-Philippe Lang
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 1 Jean-Philippe Lang
46 14 Jean-Philippe Lang
* Repository files
47
48 15 Jean-Philippe Lang
  * *!source:some/file*          -- Link to the file located at /some/file in the project's repository
49
  * *!source:some/file@52*       -- Link to the file's revision 52
50
  * *!source:some/file#L120*     -- Link to line 120 of the file
51
  * *!source:some/file@52#L120*  -- Link to line 120 of the file's revision 52
52
  * *!export:some/file*          -- Force the download of the file
53 14 Jean-Philippe Lang
54
Escaping (0.7):
55 6 Jean-Philippe Lang
56
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
57
58
h3. External links
59 5 Jean-Philippe Lang
60
HTTP URLs and email addresses are automatically turned into clickable links: 
61
62
<pre>
63
http://www.redmine.org, someone@foo.bar
64
</pre>
65
66
displays: http://www.redmine.org, someone@foo.bar
67
68
If you want to display a specific text instead of the URL, you can use the standard textile syntax:
69
70
<pre>
71
"Redmine web site":http://www.redmine.org
72
</pre>
73
74 1 Jean-Philippe Lang
displays: "Redmine web site":http://www.redmine.org
75
76
h2. Text formatting
77 10 John Goerzen
78
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.
79 1 Jean-Philippe Lang
80
h3. Font style
81
82
<pre><code>* *bold*
83
* _italic_
84
* _*bold italic*_
85
* +underline+
86
* -strike-through-
87
</code></pre>
88
89
Display:
90
91
 * *bold*
92
 * _italic_
93
 * _*bold italic*_
94
 * +underline+
95
 * -strike-through-
96
97
h3. Inline images
98 9 Jean-Philippe Lang
99 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
100
* *&#33;>image_url&#33;* right floating image
101 15 Jean-Philippe Lang
* *&#33;{width:300px}image_url&#33;* sets the width of the image
102 18 samir djouadi
103 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;*
104 1 Jean-Philippe Lang
105
h3. Headings
106
107
<pre><code>h1. Heading
108
h2. Subheading
109
h3. Subheading
110
</code></pre>
111
112
h3. Paragraphs
113
114
<pre><code>p>. right aligned
115
p=. centered
116
</code></pre>
117 2 Jean-Philippe Lang
118 1 Jean-Philippe Lang
p=. This is centered paragraph.
119
120
h3. Blockquotes
121
122
Start the paragraph with *bq.*
123
124
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
125
To go live, all you need to add is a database and a web server.
126
</code></pre>
127
128
Display:
129
130
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
131
To go live, all you need to add is a database and a web server.
132
133
h3. Table of content
134
135
<pre><code>{{toc}} => left aligned toc
136
{{>toc}} => right aligned toc
137
</code></pre>
138
139 7 Jean-Philippe Lang
h2. Macros
140
141
Redmine has the following builtin macros:
142
143
{{macro_list}}
144
145
146 1 Jean-Philippe Lang
h2. Code highlighting
147 4 Jean-Philippe Lang
148 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.
149
150
You can highlight code in your wiki page using this syntax:
151
152
<pre><code><pre><code class="ruby">
153
  Place you code here.
154
</code></pre>
155
</pre></code>
156
157
Example:
158
159
<pre><code class="ruby">
160
# The Greeter class
161
class Greeter
162
  def initialize(name)
163
    @name = name.capitalize
164
  end
165
 
166
  def salute
167
    puts "Hello #{@name}!"
168
  end
169
end
170
</pre></code>