Gentoo Forums
Gentoo Forums
Gentoo Forums
Quick Search:  
BBCode Guide
Introduction
What is BBCode?

Text Formatting
How to create bold, italic and underlined text
How to change the text colour or size
Can I combine formatting tags?

Quoting and outputting fixed-width text
Quoting text in replies
Outputting code or fixed width data

Generating lists
Creating an Un-ordered list
Creating an Ordered list

Creating Links
Linking to another site
Linking within the forums
Linking to Gentoo pages

Other matters
Can I add my own tags?

 

Introduction
What is BBCode?
BBCode is a special implementation of HTML. Whether you can actually use BBCode in your posts on the forum is determined by the administrator. In addition, you can disable BBCode on a per post basis via the posting form. BBCode itself is similar in style to HTML: tags are enclosed in square braces [ and ] rather than < and > and it offers greater control over what and how something is displayed. Depending on the template you are using you may find adding BBCode to your posts is made much easier through a clickable interface above the message area on the posting form. Even with this you may find the following guide useful.
Back to top

Text Formatting
How to create bold, italic and underlined text
BBCode includes tags to allow you to quickly change the basic style of your text. This is achieved in the following ways:
  • To make a piece of text bold enclose it in [b][/b], eg.

    [b]Hello[/b]

    will become Hello
  • For underlining use [u][/u], for example:

    [u]Good Morning[/u]

    becomes Good Morning
  • To italicise text use [i][/i], eg.

    This is [i]Great![/i]

    would give This is Great!

Back to top
How to change the text colour or size
To alter the color or size of your text the following tags can be used. Keep in mind that how the output appears will depend on the viewers browser and system:
  • Changing the colour of text is achieved by wrapping it in [color=][/color]. You can specify either a recognised colour name (eg. red, blue, yellow, etc.) or the hexadecimal triplet alternative, eg. #FFFFFF, #000000. For example, to create red text you could use:

    [color=red]Hello![/color]

    or

    [color=#FF0000]Hello![/color]

    will both output Hello!
  • Changing the text size is achieved in a similar way using [size=][/size]. This tag is dependent on the template you are using but the recommended format is a numerical value representing the text size in pixels, starting at 1 (so tiny you will not see it) through to 29 (very large). For example:

    [size=9]SMALL[/size]

    will generally be SMALL

    whereas:

    [size=24]HUGE![/size]

    will be HUGE!

Back to top
Can I combine formatting tags?
Yes, of course you can; for example to get someones attention you may write:

[size=18][color=red][b]LOOK AT ME![/b][/color][/size]

this would output LOOK AT ME!

We don't recommend you output lots of text that looks like this, though! Remember that it is up to you, the poster, to ensure that tags are closed correctly. For example, the following is incorrect:

[b][u]This is wrong[/b][/u]
Back to top

Quoting and outputting fixed-width text
Quoting text in replies
There are two ways you can quote text: with a reference or without.
  • When you utilise the Quote function to reply to a post on the board you should notice that the post text is added to the message window enclosed in a [quote=""][/quote] block. This method allows you to quote with a reference to a person or whatever else you choose to put. For example, to quote a piece of text Mr. Blobby wrote, you would enter:

    [quote="Mr. Blobby"]The text Mr. Blobby wrote would go here[/quote]

    The resulting output will automatically add: Mr. Blobby wrote: before the actual text. Remember that you must include the quotation marks "" around the name you are quoting -- they are not optional.
  • The second method allows you to blindly quote something. To utilise this enclose the text in [quote][/quote] tags. When you view the message it will simply show: Quote: before the text itself.

Back to top
Outputting code or fixed width data
If you want to output a piece of code or in fact anything that requires a fixed width with a Courier-type font, you should enclose the text in [code][/code] tags, eg.

[code]echo "This is some code";[/code]

All formatting used within [code][/code] tags is retained when you later view it.
Back to top

Generating lists
Creating an Un-ordered list
BBCode supports two types of lists, unordered and ordered. They are essentially the same as their HTML equivalents. An unordered list ouputs each item in your list sequentially one after the other indenting each with a bullet character. To create an unordered list you use [list][/list] and define each item within the list using [*]. For example, to list your favorite colours you could use:

[list]
[*]Red
[*]Blue
[*]Yellow
[/list]

This would generate the following list:
  • Red
  • Blue
  • Yellow

Back to top
Creating an Ordered list
The second type of list, an ordered list gives you control over what is output before each item. To create an ordered list you use [list=1][/list] to create a numbered list or alternatively [list=a][/list] for an alphabetical list. As with the unordered list items are specified using [*]. For example:

[list=1]
[*]Go to the shops
[*]Buy a new computer
[*]Swear at computer when it crashes
[/list]

will generate the following:
  1. Go to the shops
  2. Buy a new computer
  3. Swear at computer when it crashes
Whereas for an alphabetical list you would use:

[list=a]
[*]The first possible answer
[*]The second possible answer
[*]The third possible answer
[/list]

giving
  1. The first possible answer
  2. The second possible answer
  3. The third possible answer

Back to top

Creating Links
Linking to another site
phpBB BBCode supports a number of ways of creating URIs, Uniform Resource Indicators better known as URLs.
  • The first of these uses the [url=][/url] tag; whatever you type after the = sign will cause the contents of that tag to act as a URL. For example, to link to phpBB.com you could use:

    [url=http://www.phpbb.com/]Visit phpBB![/url]

    This would generate the following link, Visit phpBB! You will notice the link opens in a new window so the user can continue browsing the forums if they wish.
  • If you want the URL itself displayed as the link you can do this by simply using:

    [url]http://www.phpbb.com/[/url]

    This would generate the following link: http://www.phpbb.com/
  • Additionally phpBB features something called Magic Linkswhich will turn any syntatically correct URL into a link without you needing to specify any tags or even the leading http://. For example typing www.phpbb.com into your message will automatically lead to www.phpbb.com being output when you view the message.
  • The same thing applies equally to email addresses; you can either specify an address explicitly, like:

    [email]no.one@domain.adr[/email]

    which will output no.one@domain.adr or you can just type no.one@domain.adr into your message and it will be automatically converted when you view.
As with all the BBCode tags you can wrap URLs around any of the other tags such as [img][/img] (see next entry), [b][/b], etc. As with the formatting tags it is up to you to ensure the correct open and close order is following. For example:

[url=http://www.phpbb.com/][img]http://www.phpbb.com/images/phplogo.gif[/url][/img]

is not correct which may lead to your post being deleted so take care.
Back to top
Linking within the forums
You can link to certain posts, topic or profiles.
  • You can use the [post=][/post] tag for directly linking to a post; adding the post id after the = sign will cause the contents of that tag to act as a link to that post. For example:

    [post=1901]guidelines[/post]

    This would generate the following link: guidelines
  • If you don't use the = sign the text "post post_id" is used as the link text:

    [post]1901[/post]

    This would generate the following link: post 1901
  • You can use the [topic=][/topic] tag for directly linking to a topic; adding the topic id after the = sign will cause the contents of that tag to act as a link to that topic. For example:

    [topic=525]guidelines[/topic]

    This would generate the following link: guidelines
  • If you don't use the = sign the text "topic topic_id" is used as the link text:

    [topic]525[/topic]

    This would generate the following link: topic 525
  • You can use the [profile=][/profile] tag for directly linking to a user's profile; adding the user id after the = sign will cause the contents of that tag to act as a link to that profile. For example:

    [profile=30593]tomk's profile[/profile]

    This would generate the following link: tomk's profile
  • If you don't use the = sign the text "user user_id" is used as the link text:

    [profile]30593[/profile]

    This would generate the following link: user 30593

Back to top
Linking to Gentoo pages
You can link to certain Gentoo pages: bugzilla, Gentoo Linux Security Announcements, Gentoo Weekly Newsletters and Gentoo Linux Enhancement Proposals.
  • You can use the [bug=][/bug] tag for directly linking to a bug in Gentoo's bugzilla; adding the bug id after the = sign will cause the contents of that tag to act as a link to that bug. For example:

    [bug=100001]Larry the Cow has suffered an udder amputation[/bug]

    This would generate the following link: Larry the Cow has suffered an udder amputation
  • If you don't use the = sign the text "bug bug_id" is used as the link text:

    [bug]100001[/bug]

    This would generate the following link: bug 100001
  • You can use the [glsa=][/glsa] tag for directly linking to a GLSA; adding the GLSA id after the = sign will cause the contents of that tag to act as a link to that GLSA. For example:

    [glsa=200509-06]Squid: Denial of Service vulnerabilities[/glsa]

    This would generate the following link: Squid: Denial of Service vulnerabilities
  • If you don't use the = sign the text "GLSA GLSA_id" is used as the link text:

    [glsa]200509-06[/glsa]

    This would generate the following link: GLSA 200509-06
  • You can use the [gwn=][/gwn] tag for directly linking to an issue of the GWN; adding the GWN id after the = sign will cause the contents of that tag to act as a link to that GWN. For example:

    [gwn=20050905]Gentoo Weekly Newsletter: September 5th, 2005[/gwn]

    This would generate the following link: Gentoo Weekly Newsletter: September 5th, 2005
  • If you don't use the = sign the text "GWN GWN_id" is used as the link text:

    [gwn]20050905[/gwn]

    This would generate the following link: GWN 20050905
  • You can use the [glep=][/glep] tag for directly linking to a GLEP; adding the GLEP id after the = sign will cause the contents of that tag to act as a link to that GLEP. For example:

    [glep=0040]Standardizing "arch" keywording across all archs.[/glep]

    This would generate the following link: Standardizing "arch" keywording across all archs.
  • If you don't use the = sign the text "GLEP GLEP_id" is used as the link text:

    [glep]0040[/glep]

    This would generate the following link: GLEP 0040

Back to top

Other matters
Can I add my own tags?
No, I am afraid not directly in phpBB 2.0. We are looking at offering customisable BBCode tags for the next major version.
Back to top

All times are GMT

Jump to: