APIdoc BBCode

Contents

• Introduction
• Text Formatting
  • Bold and Italic
  • Emphasis
  • Colour
  • Combining Formatting Tags
• Quoting Text
• Lists
  • Unordered Lists
  • Ordered Lists
• Links
• Images

Introduction

To style your comment posts you can use BBCode. BBCode is a markup language similar to HTML and is used on many web forums. Tags are enclosed in square brackets [ and ]. The following tags are available:

Text Formatting

Bold and Italic

Text can be made bold or italic:

• To make text bold, enclose it in [b][/b], e.g. [b]bold[/b] will become bold.
• To make text italic, enclose it in [i][/i], e.g. [i]italic[/i] will become italic.

Emphasis

Two kinds of emphasis can be used:

• To emphasise text, enclose it in [em][/em], e.g. [em]emphasis[/em] will become emphasis.
• To strongly emphasise text, enclose it in [strong][/strong], e.g. [strong]strong emphasis[/strong] will become strong emphasis.

Colour

To specify the colour of text, enclose it in [color=][/color] tag. You can specify the colour as a recognised colour name (one of aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow) or as an HTML hexadecimal RGB triplet (e.g. #ffffff or #000000). For example, to create red text, you can use

[color=red]red[/color]

or

[color=#ff0000]red[/color]

Both will produce red.

Combining Formatting Tags

Tags can be combined to produce different effects. For example, [b]bold, [i]italic and [color=blue]blue[/color][/i][/b] produces bold, italic and blue.

Make sure you close nested tags in the correct order. For example, the following is incorrect: [b][i]text[/b][/i].

Quoting Text

You can quote text in two ways. To quote with a reference to the author of the text, surround text in [quote=][/quote]. For example, [quote=David Wilson]Quoted text[/quote] will become

To quote without a reference, surround text in [quote][/quote]. For example, [quote]Quoted text[/quote] will become

Lists

As in HTML, two types of lists are supported, ordered and unordered.

Unordered Lists

Unordered lists can be defined using the [list] and [*] tags. For example:

[list]
[*]One
[*]Two
[*]Three
[/list]

produces

• One
• Two
• Three

Ordered Lists

Ordered lists can be defined similarly to unordered lists. Use [list=1][/list] to create a numbered list and [list=a][/list] to create an alphabetical list. For example:

[list=1]
[*]One
[*]Two
[*]Three
[/list]

produces

1. One
2. Two
3. Three

[list=a]
[*]One
[*]Two
[*]Three
[/list]

produces

1. One
2. Two
3. Three

Other ordering notations can also be specified:

[list=A][/list]	Upper-case latin (A, B, C, ...)
[list=i][/list]	Lower-case roman numerals (i, ii, iii, ...)
[list=I][/list]	Upper-case roman numerals (I, II, III, ...)
[list=g][/list]	Lower-case greek (α, β, γ, ...)

Links

To include a link, use the [url=][/url] tag. For example, [url=http://example.org]A Link[/url] generates A Link.

If you want the URL to be used as the link text, you can use the following form of the [url] tag: [url]http://example.org[/url]. This generates http://example.org.

To include a link to an email address, use the [email] tag. [email=mail@example.org]Email[/email] generates Email and [email]mail@example.org[/email] generates mail@example.org.

Images

You can place an image in a comment using the [img][/img] tag. For example, [img]http://example.org/image.png[/img].

By combining the [url] and [img] tags, you can create a link using an image. For example, [url=http://example.org][img]http://example.org/image.png[/img][/url].