RedmineTextFormatting » History » Version 3

« Previous - Version 3/126 (diff) - Next » - Current version
Jean-Philippe Lang, 2007-10-13 12:22


Wiki formatting

Redmine supports Textile syntax for wikis and almost anything that has a text description (issues, news, messages, changesets...).

Links

Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.

Links to issues and changesets

  • Link to an issue: #1
  • Link to a changeset: r5

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

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 an external URL

HTTP URLs and email addresses are automatically turned into clickable links: http://www.redmine.org,

Text formatting

Font style

* *bold*
* _italic_
* _*bold italic*_
* +underline+
* -strike-through-

Display:

  • bold
  • italic
  • bold italic
  • underline
  • strike-through

Inline images

  • !image_url! displays an image located at image_url (textile syntax)
  • !>image_url! right floating 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.

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.

Table of content

{{toc}} => left aligned toc
{{>toc}} => right aligned toc

Code highlighting

Code highlightment relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports c, html, 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

Redmine_logo.png (5.86 KB) Jean-Philippe Lang, 2012-01-22 12:11

1111.jpg (50.5 KB) Кирилл Ивашнев, 2018-05-18 21:14