دليل الويكي

نظرة عامة

يرصد هذا الويكي من صفحة , تتكون كل صفحة من:

• A المسار.

• A العنوان.

• A المحتوى.

مسار فريد الصفحة، ويحدد URL للوصول إلى ذلك. على سبيل المثال، مع الصفحة /lang/open يتم الوصول مع المسار http://gambaswiki.org/wiki/lang/open URL.

يجب أن محتويات الصفحة اتبع بناء الجملة المذكورة في الفصل "بناء جملة يكي 'أدناه.

يتم استخدام العنوان لعرض رابط لصفحة، ولا يتبع بناء الجملة السابقة. يتم عرضه 'كما هو'.

عندما يكون هناك وصلة إلى صفحة غير موجودة ، والنص هو الطريق أو الرابط للصفحة، يتم عرضة بشكل مائل.

مسار الاتفاقيات

المسار الصفحة مجاني من الناحية النظرية، ولكن يجب أن تتبع هذه الاتفاقية:

• All language-related pages are put in /lang, for keywords and functions, and in /cat, for overviews.

• All components-related pages are put in /comp. The path of a المكوٍّن page is /comp/gb.xxx/class/symbol. The symbol begins with a dot if it is a class .

• All pages under /def path make the lexicon.

• Miscellaneous documents should be put under the /doc path.

How to edit an already existing page

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), 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.

How to create a new 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.

How to delete a page

Edit the page you want to delete, and remove both the title and the page contents.

How to translate a page in your language

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.

How to translate the wiki predefined strings

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 جامباس source archive, with the IDE and the database المكوٍّن. Its name is 'doc.cgi'. Just translate it like any other project.

Image pages

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].

Wiki Syntax

Here is a brief overview of the syntax you must use to write articles on this wiki.

Formatting characters

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

Titles, Paragraphs & Lines

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!

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>

Tables

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 ]]=	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	المُعامِلات الحسابية
[http://gambas.sourceforge.net|Gambas web site]	Link to any URL	Gambas web site
What is ASCII ?	Autolink	What is ?
What is \ASCII ?	How to disable Autolink	What is ASCII ?

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.

If 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... }=	إنظر أيضا 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 جامباس.
{tip A tip may help you. }=	A tip may help you.

• Have a line break (an empty line) before and after such boxes.

• Do not use line breaks inside of a seealso box

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 المكوٍّن.
@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.