维基手册

概述

本wiki由一些 页面 组成，每一个页面包括：
  • 路径.

  • 标题.

  • 内容.

路径是页面的唯一标识，通过定义的URL进行访问。 例如，通过 URL 为 http://gambaswiki.org/wiki/lang/open 的地址，可以访问一个具有 /lang/open 路径的页面。

即使Gambas文档被排序成树状，在所有的文档中也不会有“上一级”按钮。通过删除浏览器地址栏最后单词可以返回上一级。例如从 http://gambaswiki.org/wiki/lang/open 页面到 http://gambaswiki.org/wiki/lang 页面。

页面的内容必须使用在接下来的'Wiki语法'部分中指定的语法来描述。

标题用于显示一个到该页面的链接，而且不遵守前面的语法。这意味着它会如实显示。

当一个超链接链接的页面不存在时，该超链接显示的文字是斜体的页面路径。

路径的约定

页面路径理论上可以自由指定，但是必须符合下面的约定：

  • 所有与语言相关的页面放置于 /lang,关键字和函数位于 /cat 概述。

  • 所有与组件相关的页面放置于 /comp ，组件（组件）页面的路径是 /comp/gb.xxx/class/symbol ，类（类）的事件（事件）用符号“.”做起始。

  • 名词解释位于 /def 。

  • 各种文档应该被放置在 /doc 。

如何编辑一个已经存在的页面

单击页面顶部的“编辑”链接。

在弹出的对话框中输入你的用户名和密码， 这个对话框在每次会话中只出现一次。

然后你能使用'Wiki语法'编辑标题和页面内容。 不要改变 类（类）, 方法（方法）, 事件（事件）的标题，以及自动生成的固定页面。

可以通过复制、粘贴将编辑窗口的原文放入通用编辑器（例如，gedit 或者 记事本）进行保存。

编辑结束，单击“保存”按钮更新页面。

如何创建一个新的页面

在浏览器中输入新页面的URL，Wiki会提示你该页面不存在， 并且在页面的顶部显示“创建”链接。

单击“创建”链接。

如何删除一个页面

编辑你想删除的页面，点击“删除”按钮。

如何将一个页面翻译成你的语言

要正确的编辑页面，通过查看页面左上角的小旗，来确定当前查看的页面选择的语言正确。

如果没有代表你的语言的旗帜，请告诉我，我会添加上去。

仅仅翻译页面的标题和内容， 不要翻译*超链接和页面的名字！

如何翻译wiki的预定义字符串

wiki的预定义字符串，即不是一个页面标题或内容的部分，位于管理该wiki的CGI脚本工程中。

工程的源代码位于Gambas源代码归档中，与IDE和数据库组件在一起。的来源，该项目位于Gambas来源封存，与IDE和数据库的组成部分。它的名字是'doc.cgi'。仅仅需要像翻译任何其他工程那样翻译它，并将翻译结果发送给我。

图像页面

你可以上传图片到wiki，一幅图像就是一个以图像名为路径结尾的页面，例如，路径名用“冒号”作为起始。

例如， /control/:combobox 是一个组合列表框控件的图像。

在一个普通页面中插入该图像，应正确设置超链接： [/control/:combobox] 。

符号链接

标题以'@'字符开头的页面事实上仅仅是到另一个页面的链接。 被链接的页面的路径就是'@'字符后面的内容。

例如，'方法声明 页面事实上是到 方法声明 页面的链接， 并且 /cat/methoddecl 页面的标题是 @/lang/methoddecl 。

Wiki语法

这是你在这个 wiki 中写文章必须遵守的语法的简要说明。

格式符

语法 说明 结果
**文本** 粗体文本 文本
/*文本*/ 斜体文本 文本
=*TypeWriter*= 使用非等宽字体 TypeWriter
_*文本*_ 下划线文本 文本

如果符号位于空格之前，它不能成为起始格式符。同样，如果符号位于空格之后，它也不能成为结束格式符。

/ *Gambas* =Already= _Means_ BASIC! /

输出
/ Gambas Already Means BASIC! /

而不是
*Gambas Already Means BASIC!

Wiki不解释html的格式控制符，它们被原样保留。

输入... 结果...
M<sup>rs</sup> <font color="red">Pierce</font> Mrs Pierce

如果你想将wiki格式控制符或者html格式控制符作为普通字符显示出来，可以在这些字符前面添加 '\' 符号来指定它们为普通字符。

输入... 结果...
\**Bold*\* *Bold*
Don't do \<\<that>>! Don't do <<that>>!

标题，段落和行

在一段内容结束的地方向下跳一行，例如，必须插入一个空行，以便开始一个新的段落。

示例
输入... 结果...
Gambas Already
Means BASIC! 		Gambas Already Means BASIC!
Gambas Already

Means BASIC! 		Gambas Already

Means BASIC!

如果你使用下线字符作为一行的结尾，那么，行在你放置下线字符的地方断开。

示例
输入... 结果...
Gambas Already_
Means BASIC! 		Gambas Already
Means BASIC!

下面的特殊字符仅仅能使用在行的起始位置。

语法 说明 结果
+Title
 大标题

Title

++Title
 小一点的标题

Title

+++Title
 依此类推...

Title

++++Title
  
Title
-- 水平线
==

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

 原文。注意，html标记会被解释。 
<u>This is *verbatim* text</u>

表格

你仅仅能在行的起始位置使用下面的特殊符号。

语法 说明
[[= 表格起始
]] 表格结束
][= 两行间的分隔
- 两列间的分隔

第一行始终作为表头，如果第一行是空的，将不显示表头。

示例
输入... 结果... 输入... 结果...
[[
 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

超链接

本wiki具有根据文本内容自动建立超链接的功能，你可以在文本前面添加“\”字符强行禁止其成为超链接！

语法 说明 结果
[/lang/arithop] 链接到主题 算术运算
[http://gambas.sourceforge.net|Gambas web site] 链接到URL Gambas web site
What is ASCII ? 自动链接 What is ASCII码 ?
What is \ASCII ? 禁止一个自动链接 What is ASCII ?

一个以='@'字符为标题起始的页面，被作为一个以标题其余部分为路径的页面的动态链接。 进入这个页面的编辑状态来了解这一点。

特殊区域

区域从以 '{' 字符起始的行开始，到以 '}' 字符为起始的行结束。

能够嵌入的区域

输入... 结果... 注意
{syntax
 一个函数的语法
}=
一个函数的语法
{example
 一个例子
}=

Examples

一个例子
{seealso
 参见相关内容...
}=

参见

参见相关内容...
{box
 一个方框
}=
一个方框
所有/ _等等这样的特殊字符都被解释
{code
 代码示例
}= 
代码示例
所有/ _这样的特殊字符都会显示，而不被解释
{warning
 警告！
}=
警告！
{info
 注意
}=
注意
{vb
 Visual Basic does not work like Gambas.
}=
Visual Basic does not work like Gambas.
{tip
 提示
}=
提示

当心下列几点：
  • 这样的方框之前和之后要有一个换行符（空行）。

  • seealso方框内请勿使用换行符

  • 在{syntax...}区域，可以在区域前添加=no-title=关键字来避免页面标题显示。

特殊命令

特殊命令行以 '@' 字符起始。

特殊命令 说明
@components 插入全部组件的列表
@classes 插入当前组件（组件）的全部类的列表
@symbols 插入当前类（类）的全部符号的列表。
@index /root/index/path 创建指定的根路径下全部第一级页面的索引。
@title-index 创建包含在页面内的所有标题的索引。区域或表格内的标题会被忽略。注意：该关键字必须被插入在任何标题之前，通常位于页面顶端。