Syntaxe


Dans cette section nous expliciterons les diverses syntaxes utilisées pour rédiger des documentations sur le site postgis.fr.

 Table des matières

Insérer du code dans une documentation
Listes de fonctions
Type de donnée

Insérer du code dans une documentation

Afin d'inserer du code dans une documentation, il existe deu xsyntaxe différentes, suivant les cas. Si votre code doit être inclus dans une ligne, vous utiliserez la syntaxe suivante :

<code>mon code</code>
. Si votre code doit être considéré comme un bloc à part entière, vous utiliserea alors la syntaxe suivante :
<div class="code"> le code en question </div>
haut de la page | table des matières

Listes de fonctions

Lorsque vous souhaitez lister un ensemble de fonctions dans une documentation vous devez utiliser la syntaxe suivante :

<dl>
<dt><span class="term"> nom de la fonction : </span></dt>
<dd>

description
</dd>
<dt><span class="term"> nom d'une autre fonction : </span></dt>
<dd>

une autre description
</dd>
[...]
</dl>

haut de la page | table des matières

Type de donnée

Lorsque vous parlez d'un type de données cartographiques dans une documentation sur le site postgis.fr, ce dernier doit être contenu dans le balisage utilisé pour insérer du code dans une documentation, comme décrit ici.

Par exemple pour parler d'un objet de type POINT, vous utiliserez la syntaxe suivante :

<code>POINT</code>
haut de la page | table des matières