RedmineTextFormatting » History » Version 46
« Previous -
Version 46/127
(diff) -
Next » -
Current version
Ian Epperson, 2010-12-03 02:48
Changed the term - the user is unlikely to know about Textile and the concept isn't introduced prior to this mention.
Wiki formatting¶
Links¶
Redmine links¶
Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.
- Link to an issue: #124 (displays #124, link is striked-through if the issue is closed)
- Link to a changeset: r758 (displays r758)
- Link to a changeset with a non-numeric hash: commit:c6f4d0fd (displays c6f4d0fd). Added in r1236.
Wiki links:
- [[Guide]] displays a link to the page named 'Guide': Guide
- [[Guide|User manual]] displays a link to the same page but with a different text: User manual
- [[Guide#User-guide|User guide]] displays a link to the header on the same page with a different text: User guide
You can also link to pages of an other project wiki:
- [[sandbox:some page]] displays a link to the page named 'Some page' of the Sandbox wiki
- [[sandbox:]] displays a link to the Sandbox wiki main page
Wiki links are displayed in red if the page doesn't exist yet, eg: Nonexistent page.
Links to others resources:
- Documents:
- document#17 (link to document with id 17)
- document:Greetings (link to the document with title "Greetings")
- document:"Some document" (double quotes can be used when document title contains spaces)
- document:some_project:"Some document" (link to a document in a different project)
- Versions:
- version#3 (link to version with id 3)
- version:1.0.0 (link to version named "1.0.0")
- version:"1.0 beta 2"
- Projects:
- project#<id> (link to project with <id>)
- project:<identifier>
- project:<name>
- Attachments:
- attachment:file.zip (link to the attachment of the current object named file.zip)
- 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)
- Repository files
- source:some/file -- Link to the file located at /some/file in the project's repository
- source:some/file@52 -- Link to the file's revision 52
- source:some/file#L120 -- Link to line 120 of the file
- source:some/file@52#L120 -- Link to line 120 of the file's revision 52
- source:"some file@52#L120" -- Double quotes can be used when the URL contains spaces
- export:some/file -- Force the download of the file
Escaping:
- You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
External links¶
HTTP URLs and email addresses are automatically turned into clickable links:
http://www.redmine.org, someone@foo.bar
displays: http://www.redmine.org, someone@foo.bar
If you want to display a specific text instead of the URL, you can use the following syntax:
"Redmine web site":http://www.redmine.org
displays: Redmine web site
Text formatting¶
For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See http://www.textism.com/tools/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.
Acronym¶
JPL(Jean-Philippe Lang)
Display:
JPL
Font style¶
* *bold*
* _italic_
* *_bold italic_*
* +underline+
* -strike-through-
* Plain ^superscript^
* Plain ~subscript~
Display:
- bold
- italic
- bold italic
- underline
strike-through- Plain superscript
- Plain subscript
Inline images¶
- !image_url! displays an image located at image_url (textile syntax)
- !>image_url! right floating image
- !{width:300px}image_url! sets the width of the image
If you have an image attached to your wiki page, it can be displayed inline using its filename: !attached_image.png!
Headings¶
h1. Heading
h2. Subheading
h3. Subheading
Paragraphs¶
p>. right aligned
p=. centered
This is centered paragraph.
Predefined¶
To escape wiki syntax
<pre> *Your text won't become bold* </pre>
Display:
*Your text won't become bold*
Blockquotes¶
Start the paragraph with bq.
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.
Display:
Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.
Unordered lists¶
* Item 1 * Item 2 ** Item 21 ** Item 22 * Item 3
displays:
- Item 1
- Item 2
- Item 21
- Item 22
- Item 3
Ordered lists¶
# Item 1 # Item 2 # Item 3 ## Item 3.1 ## Item 3.2
displays:
- Item 1
- Item 2
- Item 3
- Item 3.1
- Item 3.2
Tables¶
|_.UserID|_.Name|_.Group| |\3=.IT| |1|Artur Pirozhkov|/2.Users| |2|Vasya Rogov| |3|John Smith|Admin|
Display:
UserID | Name | Group |
---|---|---|
IT | ||
1 | Artur Pirozhkov | Users |
2 | Vasya Rogov | |
3 | John Smith | Admin |
Table of content¶
{{toc}} => left aligned toc
{{>toc}} => right aligned toc
Macros¶
Redmine has the following builtin macros:
hello_world
Sample macro.
macro_list
Displays a list of all available macros, including description if available.
child_pages
Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:
!{{child_pages}} -- can be used from a wiki page only !{{child_pages(depth=2)}} -- display 2 levels nesting only
include
Include a wiki page. Example:
!{{include(Foo)}}
or to include a page of a specific project wiki:
!{{include(projectname:Foo)}}
collapse
Inserts of collapsed block of text. Example:
{{collapse(View details...) This is a block of text that is collapsed by default. It can be expanded by clicking a link. }}
thumbnail
Displays a clickable thumbnail of an attached image. Examples:
{{thumbnail(image.png)}} {{thumbnail(image.png, size=300, title=Thumbnail)}}
sample_macro
Sample macro
Code highlighting¶
Code highlightment relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports c, html, javascript, rhtml, ruby, scheme, xml languages.
You can highlight code in your wiki page using this syntax:
<pre><code class="ruby">
Place you code here.
</code></pre>
Example:
# The Greeter class
class Greeter
def initialize(name)
@name = name.capitalize
end
def salute
puts "Hello #{@name}!"
end
end