Wiki-Syntax

Kurzübersicht der Syntaxsprache zum schreiben der Wikiartikel.

Formatting characters

Syntax Beschreibung Ergebnis
**fett** formatiert fett. fett
/*kursiv*/ formatiert kursiv. kursiv
=*TypeWriter*= benutzt Unproportionalschrift. TypeWriter
_*unterstrichen*_ formatiert unterstrichen. unterstrichen

If a character precedes a space, it cannot be a beginning formatting character. And if a character follows a space, it cannot be an ending character.

/ *Gambas* =Already= _Means_ BASIC! /

prints
/ Gambas Already Means BASIC! /

and not
*Gambas Already Means BASIC!

The HTML markup are kept, they are not interpreted by the wiki.

If you type... You get...
M<sup>rs</sup> <font color="red">Pierce</font> Mrs Pierce

If you want to use a special character normally, or if you want to not insert HTML markups, preced them by the backslash escape character '\'.

If you type... You get...
\**Bold*\* *Bold*
Don't do \<\<that>>! Don't do <<that>>!

Titel, Absätze & Linien

To jump a line on the final result, i.e. to start a new paragraph, you must insert a blank line.

Example
If you type... You get...
Gambas Already
Means BASIC!
Gambas Already Means BASIC!
Gambas Already

Means BASIC!
Gambas Already

Means BASIC!

If you ends a line with an underscore, then a line break in inserted.

Example
If you type... You get...
Gambas Already_
Means BASIC!
Gambas Already
Means BASIC!

You can use the following special characters only at the beginning of a line.

Syntax Description Result
+Title
Displays a big title.

Title

++Title
Displays a smaller title.

Title

+++Title
And so on...

Title

++++Title
 
Title
-- Horizontal line
==

<u>This is *verbatim* text</u>

Verbatim text. Note that the HTML markup are interpreted.
<u>This is *verbatim* text</u>

Tabellen

You can use the following special characters only at the beginning of a line.

Syntax Description
[[= Begins a table.
]] Ends a table.
][= Separates two rows.
- Separates two columns.

The first row is always the headers. If the first row is void, then no header is printed.

Example
If you type... You get... If you type... You get...
[[
First header
-
Second header
-
Third header
][
1
-
2
-
3
][
4
-
5
-
6
]]=
First header Second header Third header
1 2 3
4 5 6
[[
][
1
-
2
-
3
][
4
-
5
-
6
]]=
1 2 3
4 5 6

Links

This wiki has a autolink feature. The only way to disable it is the backslash escape character!

Syntax Description Result
[/lang/arithop] Link to a topic Arithmetische Operatoren
[http://gambas.sourceforge.net|Gambas web site] Link to any URL Gambas web site
What is ASCII ? Autolink What is ASCII ?
What is \ASCII ? How to disable Autolink What is ASCII ?

If a page title begins with a '@' character, then it is considered as a symbolic link to the real page whose path is given by the rest of the title. Edit this page to understand.

Special Sections

A section starts with a line beginning with a '{' character, and ends with a line beginning with a '}' character.

Sections can be nested.

You type... You get...
{syntax
This is the syntax of a function
}=
This is the syntax of a function
{example
Example
}=

Examples

Example
{seealso
See also these functions...
}=

Siehe auch

See also these functions...
{box
Just a box
}=
Just a box
{warning
Warning!
}=
Warning!
{info
Note that point.
}=
Note that point.
{vb
Visual Basic does not work like Gambas.
}=
Visual Basic does not work like Gambas.
{tip
A tip may help you.
}=
A tip may help you.

Special Commands

A special command is a line beginning with a '@' character.

Special command Description
@components Inserts the list of all components.
@classes Inserts the list of all classes of the current component.
@symbols Inserts the list of all symbols of the current class.
@index /root/index/path Creates an index of all pages of the specified root path. Only the first level pages are indexed.
@version Inserts the current Gambas interpreter version installed on the wiki host system.