Redmine text formatting cheat sheet
Redmine text formatting can not only be used in the wiki or the ticket system but also in other text
areas across your Redmine installation and Plugins.
Wiki markup
What you type
What you get
[[Wiki page name]]
Wiki page name
Re dmine links
Wiki page
Link to an anchor on a wiki [[Wiki page name#further reading]]
page (e.g. further reading)
Wiki page name
Display the link with a
different text
[[Wiki page name|User manual]]
User manual
Link to main page of an
other projects wiki (e.g.
sandbox)
[[sandbox:]]
Sandbox
Link to a new wiki page,
that does not yet exist.
Those links are displayed
red
[[New wiki page name]]
New wiki page name
Link to a project (e.g. with project#5
the project id 5)
Usage
Links
Project name
Link to a project name
(e.g. with the project
identifier common)
project:common
Project name
Link to an issue
Issue #22
Issue #22
Link to an issue note
#596-2, or
#596#note-2
#596-2
#596#note-2
Link to a forum message
e.g with the id 1390
message#1390
message#1390
http://alphanodes.com
[email protected]
http://alphanodes.com
[email protected]
External links
HTTP URLs and email
addresses are
automatically turned into
clickable links
Redmine services:http://alphanodes.com
Instead of the URL you
want to use a specific text
Redmine services
Links to other resources
Link to a revision
Revision r100
Revision r100
Link to a changeset of an
other project e.g.
common
common:r309
r309
Link to a commit
commit:f30e14d44
f30e14d44
Link to a changeset with a common:commit:fff9930r
non-numeric hash in an
other project e.g.
common
fff9930r
Link to a file
source:some/file
source:some/file
Link to attachments of
the current project or
issue (e.g. file.zip)
attachment:file.zip
file.zip
document#21
Dokument title
Links to documents
Link to a document with
the id 21
Link to document with the document:Welcome
title Welcome
Welcome
Link to a document with
spaces in title
document:Document title
Document title
Link do a document with
the title Greetings to
you in an other project
named Common
common:document:Greetings to you
Greetings to you
Link to version id 5
version#5
Version title
Link to version named
2.0.1
version:2.0.1
2.0.1
Link to Version with
spaces in title
version:2.0.1 beta 2
2.0.1 beta 2
Link to a version in an
other project named
Common
common:version:2.0.1
Version title
Links to versions
Links to repository files
Link to the file located
at /some/file in the
project's repository
source:some/file
source:some/file
Link to the file's revision
66
source:some/file@66
source:some/file@66
Link to line 102 of the file
source:some/file#L102
source:some/file#L102
Link to line 102 of the
file's revision 66
source:some/file@66L102
source:some/file@66L102
Force file download
export:some/file
export:some/file
Link to a file of a specific source:svn1|some/file
repository, for projects
with multiple repositories
source:svn1|some/file
Link to a file located at
/some/file in the
repository of an other
project e.g. common
common:source:some/file
common:source:some/file
Force file download in an
other project e.g.
common
common:export:some/file
common:export:some/file
Font styles
Text formatting
Bold
*bold*
bold
Italic
_italic_
italic
Bold and italic
_*bold italic*_
bold italic
Underline
+underline+
underline
Strike through
-strike-through-
strike through
Inline code
@Inline-Code@
Inline-Code
Quotation
??quotation??
quotation
Pre formatted code
<pre>
pre formatted code
</pre>
Pre formatted code
Coloured word
coloured %{color:red}word%
coloured word
Coloured text passage
p{color:green}. coloured paragraph
coloured paragraph
Headings
h1. Heading
Heading
Heading
Subheading
h2. Subheading
Subheading
Subsubheading
h3. Subsubheading
Subsubheading
Paragraphs, Blockquotes & more
Paragraph
p. This is a paragraph
Right aligned Paragraph
p>. This is a right aligned paragraph.
Centered Paragraph
p=. This is a centered paragraph.
Blockquotes
bq. Now start the blockquote.
Table of content left
aligned
{{toc}}
Right aligened table of
content
{{>toc}}
Horizontal rule
Text
--More text
This is a paragraph
This is a right aligned paragraph.
This is a centered paragraph.
Now start the blockquote.
Text
More text
Listings
Unordered list
* Element 1
* Element 2
Element 1
Element 2
Ordered list
# Element 1
# Element 2
1.
2.
Element 1
Element 2
Unordered sublist
* Topic 1
* Topic 2
** Subtopic 1
** Subtopic 2
*** More subtopics 1
*** More subtopics 2
* Topic 3
Topic 1
Topic 2
Subtopic 1
Subtopic 2
More subtopics 1
More subtopics 2
Topic 3
# Topic 1
# Topic 2
** Subtopic 1
** Subtopic 2
*** More subtopics
1.
2.
List combination
Image integration and customization
Integrate an attached
image into the wiki page
by using the image file
name
!attached_image_name.jpg!
Integrate an attached
image into the wiki by
using the image URL
!URL_to_attached_image!
Right floating image by
the usage of >
!>imagename.jpg!
Image with hover text
!imagename.jpg(hover text)!
Image with specific image
width
!{width: 150px}imagename.jpg!
Table integration and customization
Simple table
| Heading 1 | Heading 2 |
| row 1 col 1 | row 1 col 2 |
| row 2 col 1 | row 2 col 2 |
| row 3 col 1 | row 3 col 2 |
Table with 2 rows
combined
|Heading 1 | Heading 2 |
|/2. Cell spanning | 2 |
|2|
Table with 2 cells
combined
|Heading 1 | Heading 2 |
|\2. Cell spanning |
|2|2|
Background color for
table cells
|{background:#ddd}. Heading 1 | Heading 2 |
| row 1 col 1 | row 1 col 2 |
| row 2 col 1 |{background:#ddd}. row 2 col 2 |
| row 3 col 1 | row 3 col 2 |
Code highlighting
Highlight code in your wiki <pre><code class=ruby>
page using this syntax. It Place your code here.
currently supports c, cpp, </code></pre>
css, delphi, groovy, html,
java, javascript, json, php,
python, rhtml, ruby,
scheme, sql, xml and yaml
language
This cheat sheet is designed by AlphaNodes GmbH
Munich, Germany || http://alphanodes.com || Follow us @AlphaNodes
Topic 1
Topic 2
Subtopic 1
Subtopic 2
More subtopics
Images
Tables
Code
