Wiki Formatting

Links

OpenProject links

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

Wiki links:

You can also link to pages of an other project wiki:

Wiki links are displayed in red if the page doesn't exist yet, eg: Nonexistent page.

Links to other resources:

Escaping:

External links

HTTP URLs and email addresses are automatically turned into clickable links:

https://www.openproject.org, someone@foo.bar

displays: https://www.openproject.org, someone@foo.bar

If you want to display a specific text instead of the URL, you can use the standard textile syntax:

"OpenProject web site":https://www.openproject.org

displays: OpenProject web site

Text formatting

For things such as headlines, bold, tables, lists, OpenProject 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.

Font style

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

Display:

Inline images

Headings

h1. Heading
h2. Subheading
h3. Subsubheading

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

Paragraphs

p>. right aligned
p=. centered

This is a 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

Macros

OpenProject has the following builtin macros:

hello_world

Sample macro.

include

Include a wiki page. Example:

{{include(Foo)}}
macro_list

Displays a list of all available macros, including description if available.

Code highlighting

Code highlightment relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.

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

<pre><code class="ruby">
  Place you code here.
</code></pre>

Example:

 1 # The Greeter class
 2 class Greeter
 3   def initialize(name)
 4     @name = name.capitalize
 5   end
 6
 7   def salute
 8     puts "Hello #{@name}!"
 9   end
10 end