xmldocrenderimages()
xmldocrenderimages(module_name)
xmldocrenderimages(module_name, language)
xmldocrenderimages(module_name, language, force)
xmldocrenderimages(module_name, [], force)
xmldocrenderimages([], [], force)
| Paramètre | Description |
|---|---|
| module_name | une chaîne : nom du module (le module doit être chargé). Une valeur numérique vide [] sélectionne tous les modules qui ont des fichiers d'aide. |
| language | une chaîne : langue des fichiers d'aide, par exemple 'en_US' ou 'fr_FR'. Une valeur vide [] sélectionne toutes les langues disponibles. |
| force | un logique : à vrai, chaque image est générée à nouveau, même si elle est déjà à jour. Par défaut : faux. |
xmldocrenderimages exécute les exemples des fichiers d'aide qui déclarent une image avec example_item_img et generate="true", puis enregistre la figure obtenue à côté du fichier XML.
Une image est générée quand elle est absente, vide ou plus ancienne que son fichier XML. Utilisez force pour la générer à nouveau dans tous les cas.
Chaque exemple s'exécute dans un processus nelson-adv-cli séparé avec un délai maximal de 120 secondes, plusieurs en parallèle. Un exemple en échec est relancé jusqu'à cinq fois avant qu'une erreur soit levée.
Sans argument, les images de tous les modules sont générées pour toutes les langues disponibles. La fonction change la langue de la session pendant son travail et la rétablit à la fin.
xmldocrenderimages('graphics');
xmldocrenderimages([], [], true);
| Version | Description |
|---|---|
| 2.0.0 | version initiale |