This wiki is made of pages, each page being made of:
The page contents must follow the syntax described in the 'Wiki syntax' chapter below.
The title is used for displaying a link to a page, and does not follow the previous syntax. It is displayed 'as is'.
When there is a link on a non-existing page, the link text is the path of the page, displayed in italic.
The page path is theoretically free, but must follow this convention:
Click on the 'Edit' link on the top of the page.
A dialog box appears where you must enter your login and your password. This dialog box appears only once for each session.
Then you can edit the page and its title by following the 'Wiki syntax'. Don't change the title of class, method, event or constant pages, as they are automatically generated.
It may be useful to save the original content of the edit window into a usual editor, e.g. gedit (or Notepad) by cut and paste.
Once edited, click on the 'Save' button to update the page.
Enters a new page URL in your browser. The Wiki will tell you that the page does not exist, and will display a 'Create' link on top of the page.
Click on the 'Create' link.
Edit the page you want to delete, and remove both the title and the page contents.
Just edit the page, but check that you are currently viewing the page in the correct language, by looking at the little flag on the top-left of the page.
If there is no flag that represents your language, just tell me. I will add it.
![]() | Only translate page titles and contents. Do not translate link and page names! |
The wiki predefined strings, i.e. everything that is not a page title or a page content, is located in the translate CGI script project that manages this wiki.
The source of this project is located in the Gambas source archive, with the IDE and the database component. Its name is 'doc.cgi'. Just translate it like any other project.
You can upload images to the wiki. An image is a page whose last path element, i.e. the path name, begins with a colon.
For example, /control/:combobox is an image that represents a combo-box control.
To insert an image inside a normal page, just make a link: [/control/:combobox].
Here is a brief overview of the syntax you must use to write articles on this wiki.
Syntax | Description | Result |
---|---|---|
*Bold* | Put text in bold. | Bold |
/Italic/ | Put text in italic. | Italic |
=TypeWriter= | Use a non proportional font. | TypeWriter |
_Underline_ | Underlines text. | Underline |
![]() |
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 want to use a special character normally, or if you want to not
insert HTML markups, precede them by the backslash escape character '\'.
|
To jump a line on the final result, i.e. to start a new paragraph, you must insert a blank line.
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.
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. |
This is *verbatim* text |
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.
If you type... | You get... | If you type... | You get... | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
[[ First header - Second header - Third header ][ 1 - 2 - 3 ][ 4 - 5 - 6 ]] |
|
[[ ][ 1 - 2 - 3 ][ 4 - 5 - 6 ]] |
|
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 | Arithmetic Operators |
[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. |
A section starts with a line beginning with a '{' character, and ends with a line beginning with a '}' character.
Sections can be nested.
If you type... | You get... | ||
---|---|---|---|
{syntax This is the syntax of a function } |
Syntax
This is the syntax of a function
| ||
{example Example } |
Example
Example | ||
{seealso See also these functions... } |
See also See also these functions... | ||
{box Just a box } |
Just a box
| ||
{warning Warning! } |
| ||
{info Note that point. } |
| ||
{vb Visual Basic does not work like Gambas. } |
| ||
{tip A tip may help you. } |
|
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. |