Chaque étape de traitement proposée par un plugin Computree dispose d’une documentation associée. Cette documentation est de la responsabilité des développeurs de plugins, et est donc plus ou moins détaillée selon les cas.
Elle est accessible directement dans l’interface graphique de Computree, et est générée au format HTML à la première utilisation du logiciel (dans la langue active). Elle est proposée en Anglais, et optionnellement en français selon les plugins.
Comment accéder à la documentation des étapes ?
Dans le menu d’ajout des étapes
Un clic droit sur une étape permet d’ouvrir le menu contextuel.
Dans ce menu, cliquer sur Documentation de l’étape.
Cela permet d’accéder à la page de documentation de l’étape sélectionnée.
Directement dans la chaîne de traitement
Un clic droit sur une étape ajoutée permet d’ouvrir le menu contextuel.
Dans ce menu, cliquer sur Documentation de l’étape.
Cela permet d’accéder à la page de documentation de l’étape sélectionnée.
Dans le menu aide
Dans le menu Aide, cliquer sur Documentation des étapes.
Cela permet d’accéder à l’index de la documentation des étapes.
Ouverture externe du fichier index HTML
Il est également possible d’ouvrir directement les fichiers de documentation générés.
Pour cela, ouvrir le dossier Computree/doc_en (documentation en anglais) ou Computree/doc_fr (documentation en Français).
Puis ouvrir le fichier index.html dans un navigateur web.
Organisation de la documentation
Sur la partie gauche, un index des étapes organisé de la même façon que le menu des étapes permet de naviguer dans la documentation des étapes.
La documentation d’une étape inclus les sections suivantes :
- Titre de la page : nom de l’étape, tel qu’affiché dans le menu des étapes
- Plugin : nom du plugin proposant cette étape, avec un lien vers la page internet du plugin
- Nom de classe : nom de la classe (code source) correspondant à l’étape.
- Description : decription du fonctionnement général de l’étape
- Paramètres : paramètres de l’étape pouvant être modifiés par l’utilisateur lors de l’ajout de l’étape
- Données d’entrée : données nécessaires en entrée de l’étape
- Données de sortie : données produites en sortie de l’étape
- Détails : informations complémentaires sur le fonctionnement détaillé de l’étape ou les cas d’usage. Cette section n’est pas toujours présente, selon la complexité de l’étape, et le niveau de documentation proposé par le développeur du plugin.
Re-générer la documentation
En cas de problème il est possible de re-créer l’ensemble de la documentation.
Pour cela, dans le menu Aide, cliquer sur Recréer la documentation des étapes.
Cette génération est faite automatiquemet lors du premier lancement de Computree, dans la langue active.
Si la langue active est modifiée, la documentation dans la langue correspondante sera créée au prochain démarrage de Computree.