.. _d8.00.01-generation-auto:

Génération automatique
======================


Génération automatique du paragraphe syntaxe
--------------------------------------------

Le paragraphe *Syntaxe* des commandes des documents u4/u7 est généré automatiquement
à partir du catalogue de la commande.

Quand de nouveaux mots-clés sont ajoutés, il suffit de générer le nouveau paragraphe
et remplacer le précédent, en général, dans le fichier :file:`Syntaxe.rst`.

Pour cela, il suffit au développeur d'avoir construit une version de développement
avec le catalogue de commandes modifié et de lancer le cas-test vocab01c
en définissant la variable d'environnement CMD:

.. code-block:: shell

    make vocab01c CMD=FIN
    # ou
    ./waf test -n vocab01c CMD=FIN


Cette exécution produit le fichier :file:`vocab01c.mpi.release.output` dans un
répertoire temporaire (le nom complet est affiché dans le terminal).
Au milieu de ce fichier, on trouve les lignes à copier entre les lignes de
``+++++``.
Enregistrer ces lignes (sans les ``+++++``) dans le fichier :file:`Syntaxe.rst`.


Remarque
    On trouve dans certains documents des extraits de la syntaxe globale.

    Avant d'ajouter un tel extrait, il faut se demander si cela apporte quelque chose
    par rapport à cliquer sur *Syntaxe* dans le menu de gauche.
    Pour les mots-clés simples, il est inutile de rappeler la syntaxe du mot-clé.


Exemple:

.. code-block:: text

    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    Syntaxe
    =======

    .. code-block:: text

        FIN(
            ◇ RETASSAGE = / "OUI",
                          / "NON" (par défaut),
            ◇ INFO_RESU = / "OUI",
                          / "NON" (par défaut),
            ◇ PROC0 = / "OUI",
                      / "NON",
        )

        ◆ : obligatoire
        ◇ : optionnel
        ⟐ : présent par défaut
        & : ensemble
        / : un seul parmi
        | : plusieurs choix possibles

    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++