Les informations suivantes vont vous permettre de bien comprendre la structure des diagrammes
de syntaxe.
- Lisez les diagrammes de syntaxe de gauche à droite et de haut en bas, en suivant le chemin représenté par la ligne. Les conventions suivantes sont utilisées :
- Le symbole >>--- marque le début d'un diagramme de syntaxe.
- Le symbole ---> indique que le diagramme de syntaxe continue à la
ligne suivante.
- Le symbole >--- indique qu'un diagramme de syntaxe a commencé à la ligne précédente.
- Le symbole --->< marque la fin d'un diagramme de syntaxe.
- Les élément obligatoires apparaissent sur la ligne horizontale (chemin principal).

>>-élément_obligatoire-----------------------------------------><
- Les éléments facultatifs apparaissent au-dessous du chemin principal.

>>-élément_obligatoire--+--------------------+-----------------><
'-élément_facultatif-'
- Lorsque vous pouvez faire un choix dans une liste de plus de deux éléments, ceux-ci apparaissent verticalement dans une pile.
Si le choix de l'un des éléments est obligatoire, un élément de la pile apparaît sur le chemin principal.

>>-élément_obligatoire--+-choix1_obligatoire-+-----------------><
'-choix2_obligatoire-'
Si le choix de l'un des éléments est facultatif, toute la pile apparaît au-dessous du chemin principal.

>>-élément_obligatoire--+-------------------+------------------><
+-choix1_facultatif-+
'-choix2_facultatif-'
Si l'un des éléments correspond à la valeur par défaut, il apparaît au-dessus du chemin principal, les autres
options s'affichant au-dessous.

.-choix_défaut------.
>>-élément_obligatoire--+-------------------+------------------><
+-choix_facultatif--+
'-choix2_facultatif-'
- Une flèche retournée vers la gauche, au-dessus de la ligne principale, indique un élément réitérable.

.--------------------.
V |
>>-élément_obligatoire----élément_réitérable-+-----------------><
Si la flèche de répétition contient une virgule, vous devez séparer les éléments répétés par une virgule.

.-,------------------.
V |
>>-élément_obligatoire----élément_réitérable-+-----------------><
- Un diagramme doit parfois être divisé en fragments. Le fragment de syntaxe est présenté dans la liste des
descriptions des options, mais le contenu du fragment doit être lu comme s'il figurait sur le
chemin principal du diagramme. Par exemple, la description du fragment |
Trace-options | apparaît sous Options de trace de la liste des descriptions des
options de la commande.
- Les variables apparaissent en minuscules et en italiques (par exemple,
nom-colonne).
Elles représentent des noms ou valeurs fournis par l'utilisateur.
- Séparez les mots clés et les paramètres par au moins un espace si aucune ponctuation
ne s'affiche dans le diagramme.
- Entrez des signes de ponctuation, des parenthèses, des opérateurs arithmétiques et d'autres symboles,
exactement comme ils apparaissent dans le diagramme.
- Les notes de bas de page se présentent sous la forme d'un numéro entre parenthèses. Par exemple : (1).