Wiki Manual
Přehled
Tato wiki je vyrobena ze
stránek, přičemž každá obsahuje:
- Cestu.
- Název (titulek).
- Obsah.
Cesta jednoznačně identifikuje stránku, a definuje URL přístup.
Například, stránka s
/lang/open je cesta přístupná z
http://gambasdoc.org/help/lang/open URL.
I když je,
Gambas dokumentace řazena stromově, nejsou v dokumentaci žádné "Level Up" tlačítka. Chcete-li jít ještě o úroveň výš, použijte adresního řádku prohlížeče a odstraňte poslední slovo. Například ze strany
http://gambasdoc.org/help/lang/open jdi na stránku
http://gambasdoc.org/help/lang
Obsah stránky musí odpovídat syntaxi popsane ve 'Wiki syntaxe', která je popsaná níže.
Název se používá pro zobrazování odkaz na stránku, a neřídí se předchozí syntaxi.
Je zobrazen tak 'jak je'.
Když tam je odkaz na neexistující stránku, tak odkaz je cesta na stránku, zobrazený
kurzívou.
Konvence cesty
Cesta stránky je teoreticky volná, ale musí být řízena podle této konvence:
- Všechny jazykově-související stránky jsou uváděny v /lang, klíčová slova a funkce, a /cat, pro přehled.
- Všechny komponenty-související stránky jsou umístěny do /comp. Cesta komponenty je stránka /comp/gb.xxx/class/symbol. Symbol začíná tečkou, je-li třída událost.
- Všechny stránky v rámci /def tvoří cestu lexikonu.
- Jiné dokumenty by měly být vloženy pod cesta /doc.
Jak upravit již existující stránky
Klikněte na odkaz '
Edit' v horní části stránky.
Zobrazí se dialogové okno, kde musíte zadat přihlašovací jméno a heslo.
Toto dialogové okno se zobrazí pouze jednou pro každou relaci.
Potom můžete editovat stránku a její název podle 'Wiki syntaxe'.
Neměňte název (titulek) v
třídách,
metodách,
událostech nebo na konstantních stránkách, protože jsou automaticky generovány.
Může být užitečné ukládat původní obsah editačního okna do obvyklého editoru, např. gedit (nebo Poznámkový blok), a pak obsah vyjmout a vložit.
Jakmile jste doupravovaly, klikněte na tlačítko '
Save' pro aktualizaci stránky.
Jak vytvořit novou stránku
Vložte nové URL stránky v prohlížeči. Wiki Vám řekne, že stránka neexistuje, a zobrazí odkaz '
Create' v horní části stránky.
Klikněte na odkaz '
Create'.
Jak odstranit stránku
Upravte stránku, kterou chcete odstranit, a klikněte na tlačítko 'Delete'.
Jak přeložit stránku do vašeho jazyku
Stačí editovat stránku, ale zkontrolujte, že si právě prohlížíte stránku ve správném jazyce, při pohledu na malou vlajku v levé horní části stránky.
Není-li zde vlajka, která představuje Váš jazyk, tak mi řekněte. Bude přidána.
 |
Překládejte pouze názvy (titulky) a obsahy stránek. Nepřekládejte odkazy a jména stránek!
|
Jak přeložit předdefinované wiki řetezce
Předdefinované wiki řetězce, tj. vše, co není název nebo obsah stránky, je umístěno v CGI skriptu projektu, který spravuje tuto wiki.
Zdroj tohoto projektu se nachází v zdroj archivu
Gambasu, s IDE a databází
Komponenty. Jeho jméno je '
doc.cgi'. Jen přeložte jako každý jiný projekt, a pošlete mi překlad.
Obrázek na stránce
Můžete nahrávat obrázky do wiki. Obraz je stránka, jejíž poslední cesta prveku, tj. název cesty, začíná dvojtečkou.
Například,
/control/:combobox je obrazek, který představuje kontrolu combo-boxu.
Chcete-li vložit obrázek do normální stránku, stačí vytvořit odkaz:
[/control/:combobox].
Symbolické odkazy
Stránky, jejichž názvy začínají s '
@' znaku jsou vlastně jen odkaz na jinou stránku.
Cesta z odkazované stránky je určena právě po znaku '
@'.
Například,
/cat/methoddecl je vlastně odkaz na stránku
/lang/methoddecl,
a název stránky
/cat/methoddecl je
@/lang/methoddecl.
Wiki syntaxe
Zde je stručný přehled syntaxe který je nutné použít k psaní článků na této wiki.
Formátování znaků
|
Syntaxe
|
Popis
|
Výsledek
|
|
*Bold*
|
Vloží text tučně.
|
Bold
|
|
/Italic/
|
Vloží text kurzívou.
|
Italic
|
|
=TypeWriter=
|
Použití jiné než proporcionální písmo.
|
TypeWriter
|
|
_Underline_
|
Podtrhne text.
|
Underline
|
 |
Pokud znak předchází mezeře, nemůže být začínajícím formátovácím znakem.
A pokud znak následuje mezeru, nemůže to být poslední znak.
/ *Gambas* =Already= _Means_ BASIC! /
vytiskne
/ Gambas Already Means BASIC! /
a ne
Gambas Already Means BASIC!
|
 |
HTML značky jsou zachovány, nejsou vykládány wiki.
|
Pokud napíšete...
|
Tak dostanete...
|
|
M<sup>rs</sup> <font color="red">Pierce</font>
|
Mrs Pierce
|
|
 |
Pokud chcete použít speciální znak normálně, nebo chcete-li
vložit HTML značky, vložte před ně znak zpětného lomítka '\'.
|
Pokud napíšete...
|
Tak dostanete...
|
|
\*Bold\*
|
*Bold*
|
|
Nedělejte \<\<toto>>!
|
Nedělejte <<toto>>!
|
|
Tituly, Odstavce & Linky
Ke skoku na poslední výsledek, tj. začít nový odstavec, musíte vložit prázdný řádek.
Příklad
|
Pokud napíšete...
|
Tak dostanete...
|
Gambas Already
Means BASIC!
|
Gambas Already Means BASIC!
|
Gambas Already
Means BASIC!
|
Gambas Already
Means BASIC!
|
Pokud skončíte řádek s podtržítkem, pak se vloží konec řádku.
Příklad
|
Pokud napíšete...
|
Tak dostanete...
|
Gambas Already_
Means BASIC!
|
Gambas Already
Means BASIC!
|
 |
Můžete použít následující speciální znaky pouze na začátku řádku.
|
|
Syntaxe
|
Popis
|
Výsledek
|
+Title
|
Zobrazuje velký titulek.
|
Title
|
++Title
|
Zobrazí menší titulek.
|
Title
|
+++Title
|
A tak dále...
|
Title
|
++++Title
|
|
Title
|
|
--
|
Vodorovná čára
|
|
==
<u>This is *verbatim* text</u>
==
|
Doslovný text. Všimněte si, že HTML příkazy jsou nyní interpretovány.
|
|
Tabulky
Můžete použít následující speciální znaky pouze na začátku řádku.
|
Syntaxe
|
Popis
|
|
[[
|
Začátek tabulky.
|
|
]]
|
Konec tabulky.
|
|
][
|
Oddělení dvou řádků.
|
|
-
|
Oddělení dvou sloupců.
|
První řádek je vždy záhlaví (hlavička). Pokud první řádek je prázdný, pak žádná hlavička není vytištěna.
Příklad
|
Pokud napíšete...
|
Tak dostanete...
|
Pokud napíšete...
|
Tak dostanete...
|
[[
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
]]
|
|
Odkazy
Tato wiki má funkci AutoLink (automatické odkazy). Jediný způsob, jak ji zakázat je zpětným lomítkem!
|
Syntaxe
|
popis
|
Výsledek
|
|
[/lang/arithop]
|
Odkaz na téma
|
Aritmetické operátory
|
|
[http://gambas.sourceforge.net|Gambas web site]
|
Odkaz na jakoukoliv URL
|
Gambas web site
|
|
What is ASCII ?
|
Automatický odkaz
|
What is ASCII ?
|
|
What is \ASCII ?
|
Jak vypnout automatické odkazy
|
What is ASCII ?
|
 |
Pokud název stránky (titulek) začíná znakem '@', pak je považován za symbolický odkaz na skutečnou stránku, jejíž cesta je zadaná zbytkem názvu (titulku).
Uprav tuto stránku pro pochopení.
|
Speciální sekce
Sekce je uvozována řádkem začínajícím na
'{' a zakončována
'}' na samostatném řádku.
Sekce mohou být vnořené.
|
Pokud napíšete...
|
Tak dostanete...
|
Berte na vědomí
|
{syntax
To je syntaxe funkcí
}
|
To je syntaxe funkcí
|
|
{example
Příklad
}
|
Example
|
|
{seealso
Viz také tyto funkce...
}
|
See also
Viz také tyto funkce...
|
|
{box
Jen box
}
|
Jen box
|
V tomto boxu jsou všechny speciální znaky jako / _ atd interpretovány
|
{code
for code examples
}
|
|
V tomto boxu jsou všechny speciální znaky jako / _ atd zobrazeny ale neinterpretovány
|
{warning
Upozornění!
}
|
 |
Upozornění!
|
|
|
{info
Všimněte si, tohoto bodu.
}
|
 |
Všimněte si, tohoto bodu.
|
|
|
{vb
Visual Basic nefunguje jako Gambas.
}
|
 |
Visual Basic nefunguje jako Gambas.
|
|
|
{tip
Tip vám může pomoci.
}
|
 |
Tip vám může pomoci.
|
|
|
{only 2.0
Obsah, který bude zobrazen pouze v Gambas 2 stránkách.
}
|
|
|
{only 3.0
Obsah, který bude zobrazen pouze v Gambas 3 stránkách.
}
|
Obsah, který bude zobrazen pouze v Gambas 3 stránkách.
|
|
 |
Dejte si pozor na následující body:
- Používejte prázdné řádky před a za každým boxem.
- Nepoužívejte odřádkování uvnitř boxu.
- Blok {syntax...} defaultně vždy zobrazuje titulek stránky (což je obvykle název dokumentované funkce, či instrukce). Pokud ho použijete několikrát na jedné stránce, tak možná nebudete chtít zobrazovat titulek pokaždé, pak možná bude potřeba použít atribut no-title, který zabrání vytisknutí titulek před blok.
|
Speciální příkazy
Speciální příkaz je řádek začínající znakem
'@'.
|
Speciální příkaz
|
Popis
|
|
@components
|
Vloží seznam všech komponent.
|
|
@classes
|
Vloží seznam všech tříd aktuální komponenty.
|
|
@symbols
|
Vloží seznam všech symbolů současné třídy.
|
|
@index /root/index/path
|
Vytvoří index všech stránek zadané kořenové cesty. Pouze první stupeň stránek je indexován.
|
|
@title-index
|
Vytvoří index všech titulků zahrnutých na stránce. Titulky uvnitř sekce nebo tabulek jsou ignorovány. Všimněte si, že toto slovo musí být vloženo před titulek, obvykle v horní části stránky.
|