redmine textile formatting

tricks

url=http://www.redmine.org/projects/redmine/wiki/RedmineTextFormatting


Email addresses
Email addresses are automatically turned into clickable links:

"Email someone":mailto:someone@foo.bar -- Email link with different text: Email someone
More complex email instructions can be added to an email link. A default subject, default body and CC information can be defined. Note that spaces in any of these fields need to be replaced with the code %20.
"Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar -- Email to webmaster, CC admin: Email webmaster and admin
"Email someone for help":mailto:someone@foo.bar?subject=Website%20Help -- Email link with the subject "Website Help": Email someone for help
"Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20 -- Email link with the subject "Website Help" and a default body: Email someone for help
Text formatting
For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See http://redcloth.org/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.

Acronym
JPL(Jean-Philippe Lang)
Display:

JPL

Font style
* *bold*
* _italic_
* *_bold italic_*
* +underline+
* -strike-through-
* Plain ^superscript^
* Plain ~subscript~
* @inline monospace@
Display:

bold
italic
bold italic
underline
strike-through
Plain superscript
Plain subscript
inline monospace
Inline images
!image_url! displays an image located at image_url (textile syntax)
!>image_url! right floating image
!image_url(Image title)! displays an image with an alt/title attribute
!image_url!:URL displays an image located at image_url with link URL added
If you have an image attached to your wiki page, it can be displayed inline using its filename: !attached_image.png!

You can also apply a CSS style to the image in the same ways as styling SPANs. The code !{width: 100%}attached_image.png! will make the image adjusts to the parent's width.

Headings
h1. Heading

h2. Subheading

h3. Subheading
Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.

Paragraphs
p. left aligned

  p(. left ident 1em

    p((. left ident 2em
    as well as for following lines

                                                                                   p>. right aligned

                                                                        p)))>. right ident 3em

                           p=. This is centered paragraph.
Horizontal rule
----
Display:

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.
Displays:

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.

You can also use > at the beginning of each line and stack them for nested quotes:

>> 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.
> Great!
Displays:

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.

Great!

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     |_. attribute list   |
|Starting with | a              |   simple   |row                 |
|\3=.IT                                      |<. align left       |
|1             |Artur Pirozhkov |/2.Users    |>. align right      |
|2             |Vasya Rogov     |=. center   |
|3             |John Smith      |Admin
                                 (root)      |^. valign top       |
|4             |-               |Nobody
                                 (anonymous) |~. valign bottom    |
displays (all multiple spaces are replaced by 1 space):

UserID	Name	Group	attribute list
Starting with	a	simple	row
IT	align left
1	Artur Pirozhkov	Users	align right
2	Vasya Rogov	center
3	John Smith	Admin
(root)	valign top
4	-	Nobody
(anonymous)	valign bottom
If you want to include pipe characters inside your table (e.g. for Wiki links), you need to prevent textile from interpreting them:

Input	Output
<notextile>|</notextile>	|
Table of content
{{toc}} => left aligned toc
{{>toc}} => right aligned toc
Please keep in mind, that the toc-tag needs an empty line above and underneath it and no other text before and after it.

Example:


h1. headLineOne

h2. something

{{toc}}

h2. something more
Macros
Redmine includes a macros system that lets you add custom functions to insert dynamic content in formatted text. You can learn about writing your own macros in RedmineMacros. Redmine alse includes a few 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 highlighting relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports C, C++, CSS, Delphi, Diff, Groovy, HTML, Java, Javascript, JSON, Nitro-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, XML and YAML code.

You can highlight code in your wiki page using this syntax:

<pre><code class="ruby">
  Place your code here.
</code></pre>
Example:

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!" 
  end
end
Textile formatting
Redmine supports textile formatting. For details see Textile syntax

Additional supported textiles:
%{background:lightgreen}Green Background% displays Green Background