Manuel du wiki
Vue d'ensemble
Ce wiki est constitué de
pages, chaque page étant constituée de :
-
Un chemin.
-
Un titre.
-
Un contenu.
Le chemin identifie la page de manière unique, et définit l'URL pour y accéder. Par exemple, une page constitué par le chemin
/lang/open est accessible via l'URL
http://gambaswiki.org/wiki/lang/open.
Même si la documentation Gambas est organisée en arborescence, il n'y a pas de bouton "Niveau supérieur" dans tous les documents. Pour remonter d'un niveau, utilisez la barre d'adresse de votre navigateur, et effacez le tout dernier mot. Par exemple, à partir de la page http://gambaswiki.org/wiki/lang/open= aller à la page
http://gambaswiki.org/wiki/lang
Le contenu de la page doit suivre la syntaxe décrite dans le chapitre 'Syntaxe du Wiki' ci-dessous.
Le titre est employé pour afficher le lien à une page, et ne suit pas la syntaxe précédente. Il est affiché 'tel quel'.
Quand il y a un lien vers une page n'existant pas, le texte du lien indique le chemin de cette page affiché en italique.
Conventions de nommage d'un chemin
Le chemin d'une page est en théorie libre, mais doit suivre les conventions suivantes:
-
Pour toutes les pages relatives au langage, les mots clefs et les fonctions sont mis dans
/lang, et les vues d'ensemble dans /cat.
-
Toutes les pages relatives aux composants sont mises dans
/comp. Le chemin de la page du composant est /comp/gb.xxx/classe/symbole. Le symbole commence par un point si c'est l'évènement d'une classe.
-
Toutes les pages dans le chemin
/def font parties du lexique.
-
Les documents divers doivent être mis dans le chemin
/doc.
Comment éditer une page existante
Cliquez sur le lien 'Éditer' au sommet de la page.
Une boîte de dialogue apparaît, vous devez y entrer votre identifiant et votre mot de passe.
Cette boîte de dialogue n’apparaît qu’une fois par session.
Vous pouvez ensuite éditer la page et son titre en suivant la 'Syntaxe du wiki'. Ne changez pas le titre des pages des classes, méthodes, évènements ou constantes, car elles sont générées automatiquement.
Il peut être utile de sauvegarder le contenu original de la fenêtre d'édition dans votre éditeur habituel, par exemple gedit (ou Notepad) par copier/coller.
Une fois éditée, cliquez sur le bouton 'Enregistrer' pour mettre à jour la page.
Comment créer une nouvelle page
Entrez l'URL d'une nouvelle page dans votre navigateur internet. Le wiki vous informera que la page n'existe pas, et vous affichera le lien 'Créer' au sommet de la page.
Cliquez sur le lien 'Créer'.
Comment effacer une page
Éditez la page que vous voulez effacer, puis enlevez le titre et le contenu de la page.
Comment traduire une page dans votre langue
Éditez seulement la page, mais vérifiez bien que la page est dans la bonne langue, en observant le petit drapeau au sommet en haut à gauche.
S'il n'y a pas de drapeau représentant votre langue, dites-le-moi. Je l'ajouterai.
Traduisez seulement le titre et le contenu des pages. Ne jamais traduire le lien et le nom des pages!
Comment traduire les chaînes de caractères prédéfinies du wiki
Les chaînes de caractères prédéfinies du wiki, c.a.d. tout ce qui n'est pas le titre ou le contenu d'une page, est situé dans le script du projet de traduction
CGI qui gère ce wiki.
Les sources de ce projet sont situées dans l'archive source de Gambas, avec l'IDE et le composant de bases de données. Son nom est '
doc.cgi'. Traduisez-le simplement comme avec un autre projet, et envoyez moi la traduction.
Les images
Vous avez la possibilité de poster des images sur le wiki. Une image est une page dans laquelle le dernier élément du chemin, c.a.d. le nom du chemin, commence par deux points.
Par exemple,
/control/:combobox est une image représentant le contrôle combo-box.
Pour insérer une image dans une page normale, utilisez simplement le lien :
[/control/:combobox].
Liens symboliques
Une page dont le titre débute par le caractère '
@' n'est en réalité qu'un lien vers une autre page.
Le chemin de la page liée est indiqué juste après le caractère '
@'.
Par exemple, la page
Déclaration de méthode est en réalité un lien vers la page
Déclaration de méthode page, et le titre de
/cat/methoddecl page est
@/lang/methoddecl.
Syntaxe du wiki
Voici une brève description de la syntaxe utilisée pour écrire sur ce wiki.
Caractères de formatage
|
Syntaxe
|
Description
|
Résultat
|
|---|
**Gras**
|
Met le texte en gras.
|
Gras
|
/*Italique*/
|
Met le texte en italique.
|
Italique
|
=*Machine à écrire*=
|
Utilise une fonte non proportionnelle.
|
Machine à écrire
|
_*Souligné*_
|
Souligne le texte.
|
Souligné
|
Si un caractère précède un espace, celui-ci ne peut être un caractère de début de formatage. Et si un caractère suit un espace, celui-ci ne peut pas être un caractère de fin de formatage.
/ *Gambas* =Already= _Means_ BASIC! /
affiche
/ Gambas Already Means BASIC! /
et non
*Gambas Already Means BASIC!
Les balises
html sont préservées, elles ne sont pas interprétées par le wiki.
|
Si vous tapez...
|
Vous aurez...
|
|---|
M<sup>rs</sup> <font color="red">Pierce</font>
|
Mrs Pierce
|
Si vous voulez utiliser normalement un caractère spécial, ou si vous ne voulez pas insérer de balises
html, faites-les précéder par le caractère d'échappement backslash
'\'.
|
Si vous tapez...
|
Vous aurez...
|
|---|
\**Gras*\*
|
*Gras*
|
Ne faites pas \<\<cela>>!
|
Ne faites pas <<cela>>!
|
Titres, Paragraphes et Lignes
Pour sauter une ligne lors du résultat final, c.-à-d. démarrer un nouveau paragraphe, vous devez insérer une ligne vierge.
Exemple
|
Si vous tapez...
|
Vous aurez...
|
|---|
Gambas Already
Means BASIC!
|
Gambas Already Means BASIC!
|
Gambas Already
Means BASIC!
|
Gambas Already
Means BASIC!
|
Si vous finissez une ligne avec le caractère de soulignement
'_', alors
un saut de ligne est inséré.
Exemple
|
Si vous tapez...
|
Vous aurez...
|
|---|
Gambas Already_
Means BASIC!
|
Gambas Already
Means BASIC!
|
Vous ne pouvez utiliser les caractères spéciaux suivants qu'au début d'une ligne.
|
Syntaxe
|
Description
|
Résultat
|
|---|
+Titre
|
Affiche un grand titre.
|
Titre
|
++Titre
|
Affiche un plus petit titre.
|
Titre
|
+++Titre
|
Et ainsi de suite...
|
Titre
|
++++Titre
|
|
Titre
|
|
--
|
Ligne horizontale
|
|
==
<u>Ceci est un texte *verbatim* </u>
|
Texte verbatim. Notez que les balises html sont désormais interprétées.
|
<u>Ceci est un texte *verbatim*</u>
|
Tableaux
Vous ne pouvez utiliser les caractères spéciaux suivants qu'au début d'une ligne.
|
Syntaxe
|
Description
|
|---|
[[=
|
Commencent un tableau.
|
]]
|
Finissent un tableau.
|
][=
|
Séparent deux lignes.
|
-
|
Sépare deux colonnes.
|
La première ligne est toujours l'en-tête. Si la première ligne est vide, alors aucun en-tête n'est affiché.
Exemple
|
Si vous tapez...
|
Vous aurez...
|
Si vous tapez...
|
Vous aurez...
|
|---|
[[
Premier en-tête
-
Second en-tête
-
Troisième en-tête
][
1
-
2
-
3
][
4
-
5
-
6
]]=
|
|
Premier en-tête
|
Second en-tête
|
Troisième en-tête
|
|---|
|
1
|
2
|
3
|
|
4
|
5
|
6
|
|
[[
][
1
-
2
-
3
][
4
-
5
-
6
]]=
|
|
Liens
Le wiki dispose d'une fonction de lien automatique. La seule possibilité de la désactiver est d'utiliser le caractère spécial d'échappement backslash.
|
Syntaxe
|
Description
|
Résultat
|
|---|
[/lang/arithop]
|
Lien vers un sujet
|
Opérateurs arithmétiques
|
[http://gambas.sourceforge.net|Site web de Gambas]
|
Lien vers une URL
|
Site web de Gambas
|
Qu'est-ce que l'ASCII ?
|
Lien automatique
|
Qu'est-ce que l'ASCII ?
|
Qu'est-ce que l'\ASCII ?
|
Comment désactiver un lien automatique
|
Qu'est-ce que l'ASCII ?
|
Si le titre d'une page commence par le caractère
'@', alors celui-ci sera considéré comme un lien symbolique vers une page existante dont le chemin est donné par le reste du titre. Éditez cette
page pour comprendre.
Sections Spéciales
Une section commence au début d'une ligne par le caractère
'{', et finit par une ligne commençant par le caractère
'}'.
Les sections peuvent être imbriquées.
|
Si vous tapez...
|
Vous aurez...
|
Notes
|
|---|
{syntax
Ceci est la syntaxe d'une fonction
}=
|
Ceci est la syntaxe d'une fonction
|
|
{example
Exemple
}=
|
Exemples
|
|
{seealso
Voir aussi ces fonctions...
}=
|
Voir aussi
Voir aussi ces fonctions...
|
|
{box
Juste une boîte
}=
|
Juste une boîte
|
Dans cette boîte tous les caractères spéciaux comme /_ etc sont interprétés.
|
{code
Pour les exemples de code
}=
|
Pour les exemples de code
|
Dans cette boîte tous les caractères spéciaux comme /_ etc sont affichés, mais pas interprétés.
|
{warning
Attention!
}=
|
Attention!
|
|
{info
Notez ce point.
}=
|
Notez ce point.
|
|
{vb
Visual Basic ne fonctionne pas comme Gambas.
}=
|
Visual Basic ne fonctionne pas comme Gambas.
|
|
{tip
Un conseil pourrait vous aider.
}=
|
Un conseil pourrait vous aider.
|
|
{only 2.0
Contenus qui ne seront affichés que sur les pages Gambas 2.
}=
|
|
|
{only 3.0
Contenus qui ne seront affichés que sur les pages Gambas 3.
}=
|
Contenus qui ne seront affichés que sur les pages Gambas 3.
|
|
Prenez garde aux points suivants :
-
Insérez un saut de ligne (une ligne blanche) avant et après de telles sections.
-
N'utilisez pas de sauts de ligne à l'intérieur d'une section seealso.
-
Dans la section {syntax...}, ajoutez le mot-clé
no-title si vous voulez éviter l'affichage du titre de la page avant la section.
Commandes Spéciales
Une commande spéciale est une ligne commençant par le caractère
'@'.
|
Commandes Spéciales
|
Description
|
|---|
@components
|
Insère une liste de tous les composants.
|
@classes
|
Insère une liste de toutes les classes du composant en cours d'édition.
|
@symbols
|
Insère une liste de tous les symboles de la classe en cours d'édition.
|
@index /root/index/path
|
Crée un index de toutes les pages situées à la racine du chemin. Seulement le premier niveau de pages est indexé.
|
@title-index
|
Crée un index de tous les titres inclus dans la page. Les titres à l’intérieur des sections ou des tables sont ignorés. Notez que ce mot clé doit être inséré avant tout titre, habituellement au sommet de la page.
|
@since 3.5
|
Insère une section pour avertir l'utilisateur que cette fonctionnalité existe depuis une version spécifique de Gambas (ici : 3.5).
|