RedmineTextFormatting » History » Version 12

John Goerzen, 2008-03-13 15:03

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