| BBCode Manual |
|
Below is a complete manual on how to use our BBCode to add formating and images to your blogs, forum posts and so on around Coder Profile.
|
| Definitions |
| BBCode |
|
BBCode is short for Bulletin Board Code.
BBCode was originally used on Bulletin Boards at which it would be used to format a users post without that person having to understand more complicated methods like HTML.
|
| Syntax |
|
This is the "format" of something, in the terms used below it is the correct format in which you enter some code being BBCode.
|
| Aliases |
|
Other BBCode that the same sort of formating is done with, but with a slight difference.
|
| { ....... } |
|
Used in the syntax of some code.
What goes between the curly braces is your text that you want to apply the bbcode tag on.
|
| Tags (opening and closing) |
|
A tag is all the content between two square braces i.e. [ + ].
An opening tag is the start tag for example [b] and the closing tag would be the tag [/b].
These 2 tags tell the interpreter when to start formatting and when to finish formatting the text between the tags.
|
| Parameters |
|
What options a BBCode tag can take. An example of a parameter is: [code title=""] where title is a parameter of the code tag. Parameters are always optional and there can be more than one parameter on a tag for example: [code language='c' title='hello world'] parameters must be wrapped inside single or double quotes.
|
|
| The BBCode Rules |
| Rule Number 1 |
|
All BBCode must be written in lowercase for it to be interpreted as BBCode
|
|
|
| Rule Number 2 |
While not recommended as risk of becoming broken over time as the BBCode system evolves, you may overlap different bb tags though.
NOT RECOMMENDED = [b]text here[u] text here [/b]text here[/u]
RECOMMENDED = [b]text here[/b][u][b] text here [/b][/u][u]text here[/u]
|
|
|
|
| The Available BBCode's |
|
Headings
|
|
Syntax: [h1] {text} [/h1]
|
|
|
Aliases: [h2] {text} [/h2], [h2] {text} [/h2]
|
|
|
|
|
Description: h1 is the largest heading, followed by h2 and then h3.
|
|
|
Quote
|
|
Syntax: [quote] {text} [/quote]
|
|
|
|
|
Parameters: title - contains the title of the quote
|
|
|
Description: Formats a quote in to a nice box that stands out from the rest of the text as a "quote".
Lines are wrapped and all bbcode and custom emoticons are interpreted.
|
|
|
Code
|
|
Syntax: [code] {text} [/code]
|
|
|
|
Parameters: title - contains the title of the code
language - if it is in the geshi syntax highlighting list of languages, then the code will be syntax highlighted for that language. Languages that can go in this attribute are: abap, actionscript, actionscript3, ada, apache, applescript, asp, asm, cadlisp, autoit, bnf, bash, basic4gl, blitzbasic, boo, c, csharp, cpp, cpp-qt, caddcl, ocaml, cil, c_mac, cobol, cfm, css, d, delphi, dos, dot, eiffel, fortran, freebasic, gml, genero, groovy, haskell, html4strict, ini, inno, io, java, java5, javascript, kixtart, latex, lisp, lotusformulas, lotusscript, lua, m68k, matlab, mirc, mpasm, mxml, mysql, nsis, objc, glsl, oobas, oracle8, plsql, pascal, perl, php, python, qbasic, ruby, rails, sas, scala, scheme, sdlbasic, smalltalk, sql, thinbasic, tcl, tsql, pascal, idl, verilog, vhdl, vb, vbnet, visualfoxpro, winbatch, xpp, xml, z80
|
|
|
Description: Formats code in to a nice box that stands out from the rest of the text as a "quote".
Lines are wrapped and bbcode and custom emoticons are NOT interpreted. Line numbers are also added to make referencing easier.
|
|
|
Emoticons
|
|
Syntax: [emo{emoticon number}]
|
|
|
|
|
Description: Will display an emoticon when that emoticons number is entered
|
|
|
Email Address
|
|
Syntax: [email] {email address} [/email]
|
|
|
|
|
Parameters: title - you can make some text of your choice link to the email address
subject - use a default subject for the email
|
|
|
Description: Will change the email address into a clickable link.
It will also automatically validate the email address to make sure it is of the correct format else it will not display the email address.
If the email address passes the formatting check, then it will encode the email address to prevent spam bots harvesting the address and sending spam to the address while appearing as normal on the page itself.
|
|
|
URL (Web Address) & Images
|
|
Syntax: [url] {url address} [/url]
|
|
|
|
Parameters: title - make the title a hyper link so when clicked, it goes to the url
type - when you specify that the URL is an image, it will be attempted to be downloaded and shown inline as a thumbnail. eg [url type='image']
|
|
|
Description: Will change the url address into a clickable link.
It will also scan a limited amount of url's to make sure the location it points to exists else it will display the link in a different color.
Long URLs will be trunacated but will still work when clicked to prevent display problems of long URLs.
|
|
|
Font
|
|
Syntax: [font]{text}[/font]
|
|
|
|
Parameters: bgcolor - set the background color (can be any HTML named literal such as red, green, blue, or a 6 digit hex such as #006699)
color - set the text color (can be any HTML named literal such as red, green, blue, or a 6 digit hex such as #006699)
size - set the size of the text in pixels from 8 to 30 pixels in size (just put in the number of pixels such as 20 would produce text 20 pixels in size)
|
|
|
Description: Will change the background color to a different color.
Some color names are: red, blue, black, silver, gray, white, maroon, purple, fuchsia, green, lime, olive, yellow, navy, teal, aqua, brown, pink and so on.
|
|
|
Bold
|
|
|
|
|
|
|
|
|
|
Description: Will make the text bold.
|
|
|
Underline
|
|
|
|
|
|
|
|
|
|
Description: Will underline the text.
|
|
|
Italic
|
|
|
|
|
|
|
|
|
|
Description: Will make the text italic.
|
|
|
List
|
|
Syntax: [list] {text} [/list]
|
|
|
Child Tags: [item]{text}{/item]
|
|
|
Parameters: type - the type of bullets you want to use: disk (default), decimal (same as number), number, circle, square
|
|
|
|
|
Description: Produces a HTML valid list. A valid BBCode list would be: [list][item]Book 1[/item][item]Book 2[/item][item]Book 3[/item][/list]
|
|
|
Position
|
|
Syntax: [position] {text} [/position]
|
|
|
|
|
Parameters: align - where you want to align the contents (left, right, center, justify) which includes the alignment of images
|
|
|
|
|
Description: Sets the position of it's contents and is only really of much use when you set its parameters.
|
|
|
Strike
|
|
Syntax: [strike] {text} [/strike]
|
|
|
|
|
|
|
|
|
Description: Strikes out it's content by putting a line through the middle of it.
|
|
|
| Last Note |
| Last Notes From Us | |
|
Do not be afraid to use the good old trial and error method of learning how to use our BBCode system here at Coder Profile.
You can not destroy our site through the use of incorrect BBCode and you will not interfere with the sites design.
The best way to learn is to try for your self.
Have fun formatting your text with Coder Profile's BBCode system ;-)
|
|
|
Kind Regards,
The Coder Profile Team
|
|
|
|
