1.3. Headers, Bold & Bullets

Manula uses the popular Textile markdown language for formatting your manual topics.
Textile is much easier than HTML and quicker than WYSIWYG editors, though initially it may take some getting used to.

Here’s a quick introduction to creating headers, bold text and bullets using Textile.

(For a full guide on Textile, check the Formatting topics section.)

Headers

Creating headers is simple, just use the left most button on the toolbar (or even quicker, just type “h2. “) and add your header text. In your editor, it will look like this:

h2. My first header

*In Textile, white space is important! When creating headers, always have a blank line before and after the header line. Also, don’t forget to keep a space between the dot (.) and the header text.

Bold text

The next button on the toolbar (B) lets you turn selected text into bold text.
But again, typing is easier. Use stars (*) around a piece of text to make it bold:

*this is bold* becomes: this is bold

Bullets

Making bullets is as easy as starting a line with a star (*) or a dash (#) sign.
*’s for regular bullets, #’s for numbered bullets.

In the manual editor, write this:

* This is a regular bullet
* This is another one
* And this is the last

to generate bullets like this in your live manual:

• This is a regular bullet
• This is another one
• And this is the last

Similarly, writing this:

# This bullet is automatically numbered as nr 1
# The hash signs are automatically turned into 1's and 2's
# This will become bullet 3

will turn into:

1. This bullet is automatically numbered as nr 1
2. The hash signs are automatically turned into 1’s and 2’s
3. This will become bullet 3

*Again, white space is important, don’t forget to have a blank line before and after a bullet list and don’t forget the space after the * or # character.

Click here for the Manula website.

Powered by