There are several HTML (HyperTextMarkupLanguage) tags that are allowed within a WikiPage. Feel free to practice them in the PlayGround.
Bold
Make things bold like this: <b>bold</b>
Italic
Make things italic like this: <i>italic</i>
Underline
Things can be underlined like this: <u>underlined</u>
Headings
There are 3 heading sizes available (such as the heading above). They are: <h1>heading1</h1>, <h2>heading2</h2>, <h3>heading</h3>
Text Control
The size of text can be made bigger or smaller using: <big>bigger</big>, <small>smaller</small>
Text can also be centered using: <center>This will be centered.</center>
Skipping a line in the text inserts double line break. If a single break is required, you can use this: <br>
A normal break can be forced using this: <p>
Lists
Both ordered and unordered lists are possible. Example:
- One
- Two
- sub-one
- Three
The code looks like this for the ordered list:
<ol>
<li>One</li>
<li>Two</li>
<ol>
<li>sub-one</li>
</ol>
<li>Three</li>
</ol>
And like this for the unordered one:
<ul>
<li>One</li>
<li>Two</li>
<ul>
<li>sub-one</li>
</ul>
<li>Three</li>
</ul>
Horizontal Line
A horizontal line can be created in two ways. One is to use the tag: <hr>
The other is to start a line with at least 4 dashes. These dashes must be at the very start of the line, like this
----
The result is this:
See? A nice line! And to insert a blank line (or even just to skip a line), you can use <br>
Other
There are some other rules that are imporant to know about. If you need to insert text that you don't want to be interpreted by the formatting engine (such as source code) just make sure the very first character in each line is an =.
=<b>This</b> will not <i>b</i> [parsed] by the [[WikiEngine]].
=if( this->code() == 42 )
= printf( "Yay!\n" );
Results in:
<b>This</b> will not <i>be</i> [parsed] by the [[WikiEngine]].
if( this->code() == 42 )
printf( "Yay!\n" );
One other formatting trick is the use of 3 single quote characters. When displayed, they are simply removed, however this is done after all other processing and so they can be used to prevent the engine from matching certain patterns. This was used to show the example tags above and get the engine to not process them.
This <b>"executes the bold tag"</b>, but this <'''b>shows it instead<'''/b>.
Results in:
This "executes the bold tag", but this <b>shows it instead</b>.
Comments
It is possible to put comments into pages using the <comment> tag. When rendered, it converts them to an HTML comment. Use like this:
<comment>This is a comment and does not appear on the final output page.</comment>
Linking
There are several forms of linking within the Wiki. Normal URLs (such as http://www.bebits.com) can be done like this: [[http://www.bebits.com]]
Links can also be given another name using this technique: [[http://www.bebits.com another name]]
E-Mail addresses can be linked to in the same way (both named (Yay!) and unnamed (bebits@bebits.com)) like this: [[bebits@bebits.com Yay!]], [[bebits@bebits.com]]
A shortcut to the BeBits search feature is available using 3 square brackets. "Find BeOS SSH clients on BeBits." Is done like this: "Find BeOS [[[SSH]]] clients on [[BeBits]]."
Finally (and probably most importantly), other WikiPages can be linked to like this: [[WikiPage]]
Note: A WikiPage has a name called a WikiName and it must be in a certain format. If the name does not match that format, it will not be linked. For example, this is not a proper WikiName and will not link: [[Notawikiname]]
A link to a page can be Page just like external links using the form of: [[WikiPage Another name goes here]] (But appears to be broken at the moment)
Images
Even images can be inserted into a WikiPage. For example:
Using code like this: [[image:http://www.bebits.com/gfx/balogo.gif BeBits!]]
The named part of the code above (in this example the text "BeBits!") is optional and used as the image's ALT attribute.
IndexPage | TableOfContents
