Savane provides a markup language that enables you to format text you post in items or items comments. HTML is not allowed for security reasons.
Basic Text Tags
Basic Text Tags are available almost everywhere.
bold markup is:
italic markup is:
Urls are automatically made links, additionnaly you can give them a title:
Item references like tracker #nnn will be made links to, like in
this is recipe #119.
Both ways can be combined to refer to a tracker giving it a title, e.g.:
See [recipe#119 project setup] for a detailed discussion
Following is a list of item names that can be used this way:
- bug, for bug trackers;
- support or sr, for support requests;
- task, for tasks;
- recipe or rcp, for cookbook recipes (see the note above);
- file, for attached files;
Plural forms of the full keywords (except for support) can also be used.
Rich Text Tags
Rich Text Tags are available in comments.
Unnumbered list markup is:
* item 1 * item 2 ** item 2 subitem 1 ** item 2 subitem 2
Numbered list markup is:
0 item 1 0 item 2
Horizontal ruler markup is:
Verbatim markup (useful for code bits) is:
+verbatim+ The piece of code The piece of code, line 2 -verbatim-
Heading Text Tags are available in rare places like items original submission, news item content, project description and users resume.
First Level heading markup is:
= Title =
Second Level heading markup is:
== Subtitle ==
Third Level heading markup is:
=== Subsubtitle ===
Fourth Level heading markup is:
==== Subsubsubtitle ====
Special No Markup Tag
If for some reason, you want to completely deactivate the markup on a part of a text, you can always use:
+nomarkup+ Piece of text that will be printed unformatted -nomarkup-
This tag diverges from the verbatim tag in the sense that it will not cause the relevant text to be formatted as it would be in a text editor, a pure verbatim environment, but simply unformatted. As result, for example, text indentation would be ignored because HTML by default ignores it. So to copy/paste bits of code, software output, you are advised to always use the verbatim tag instead.