Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
About The Best Formula In The World
Architecture details
Benchmarks
Books
By Reference Argument Passing
Compatibility between versions
Creating And Using Libraries
Database Datatype Mapping
Database Request Quoting
Date & time management
Dates and calendars
DBus and Gambas
Differences Between Shell And Exec
Differences From Visual Basic
Distributions & Operating Systems
Drag & Drop
DrawingArea Internal Behaviour
External functions datatype mapping
Frequently Asked Questions
Gambas Farm Server Protocol
Gambas Mailing List Netiquette
Gambas Markdown Syntax
Gambas Naming Conventions
Gambas Object Model
Gambas Scripting
Gambas Server Pages
Gambas Unit Testing
Gambas Wiki Markup Syntax
Getting Started With Gambas
Hall Of Fame
Image Management In Gambas
Including Help Comments in Source Code
Interpreter limits
Introduction
Just In Time Compiler
Just In Time Compiler (old version)
License
Localisation and Internationalization
Mailing Lists & Forums
Naming Conventions
Network Programming
ODBC Component Documentation
PCRE Pattern Syntax
Porting from Gambas 2 to Gambas 3
Previous News
Project Directory Structure
Release Notes
Reporting a problem, a bug or a crash
Rich Text Syntax
Screenshots
Text highlighting definition file syntax
The Program has stopped unexpectedly by raising signal #11
Variable Naming Convention
WebPage Syntax
Web site home page
What Is Gambas?
Window & Form Management
Window Activation & Deactivation
Window Life Cycle
XML APIs
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

Gambas Wiki Markup Syntax

The Gambas Wiki markup syntax is the Gambas markdown syntax with a few custom tables and special commands added. So read the documentation of Gambas Markdown Syntax first.

Special tables

The wiki provides the following predefined class tables:

box

This is a text surrounded by a rounded box.

critical

This is a message with a critical error icon.

info

This is a message with an information icon.

warning

This is a message with a warning icon.

tip

This is a message with a tip icon.

vb

This is a message with a "Visual Basic" icon.

Use it when explaining a difference between Gambas and Visual Basic™.

Special commands

@{since <version>}

Insert a red box with the since <version> text inside. Use it when part of the documentation is meaningful only from a specific Gambas version.

For example, @{since 3.5} will gives you:

Since 3.5

@{classes}

Insert a list of all classes implemented by a component, with links pointing at the classes help pages.

Use it only in a component help page, i.e. whose path is /comp/<component>.

@{symbols}

Insert a list of all symbols implemented by a class, and a description of its special methods, with links pointing at the symbols help pages.

Use it only in a class help page, i.e. whose path is /comp/<component>/<class>.

@{syntax}

Insert the syntax of a specific symbol of a class.

Use it only in a symbol help page, i.e. whose path is /comp/<component>/<class>/<symbol>.

@{class}

The name of the current class.

Use it only in a class or symbol help page.