Génération doc
Cette action permet de lancer la "génération" de la documentation.
Elle réalise 2 fonctions principales:
- La première permet de réaliser une génération "ADOCUMENT".
Dans le cas d'une nouvelle documentation, cette fonction est utile pour créer un squelette de paragraphes de documentation pour un nouvel objet X3 (qu'il s'agisse d'une fonction ou d'une action ou de tout autre objet ...) Ce squelette est différent en fonction de chaque type d'objet concerné. Le but est de constituer un ensemble de paragraphes pré-déterminés que le générateur organise automatiquement selon le dictionnaire X3 de l'objet concerné.
Elle est utile également dans le cas d’une documentation déjà existante comportant déjà des paragraphes. Elle permet ainsi :
- de mettre à jour les champs suivants de chacun des paragraphes : Code activité et Code module.
- de créer automatiquement, le cas échéant, les paragraphes prédéterminés manquants.Seuls les ajouts automatiques de paragraphes prédéterminés sont pris en charge. Aucun paragraphe n’est supprimé automatiquement.
Une option de la génération "ADOCUMENT" permet de ne lancer cette génération que pour les documentations dèjà existantes dans la base. Les objets X3 ne possédant pas de documentation se sont pas traités dans ce cas.Pour plus d'information, se référer à la documentation annexe traitant des différents paragraphes de documentations.
- La deuxième fonction permet de réaliser une génération "document final".
Cette fonction a pour but de créer un fichier HTML final relatif à la documentation concernée et rassemblant l'ensemble des informations contenues dans les paragraphes. Le fichier est généré dans le répertoire spécifié par le paramètre DIRDOC - Répertoire doc finale (chapitre SUP, groupe DOC).
Une option permet de choisir entre une génération "Complète" et "Selon code activité".
La version "Complète" réalise une génération de toutes les documentations "Standard" (code activité < ‘X' et différent de ‘FAL’).
La version "Selon code activité" ne traitera que les documentations ayant des codes activités (du moment qu’ils sont différents de ‘FAL’) et dont le flag d'activité du code activité est : ACTIF. Cette génération est généralement utilisée pour traiter le cas de documentations "Spécifiques".
D'autres options sont aussi proposées afin :
- de générer uniquement les documentations validées.
- de générer ou pas les aides sur champs liées aux documentations traitées par la génération "HTML".
Paramètres de l'action
Les paramètres de l'action sont les suivants :
Paramètre | Intitulé | Type paramètre |
|---|---|---|
TYPDOC | Type document | Char |
FONCTION | Fonction | Char |
LANGUE | Langue | Char |
Gestion de l'écran
Fenêtre de sélection préliminaire
Champs
Les champs suivants sont présents dans cet onglet :
Sélections
| Si cette case est cochée, toutes les langues sont prises en compte pour l'opération. Si la case n'est pas cochée, on prendra, selon les cas :
|
| Permet de définir la langue de génération (quand la case permettant de générer dans toutes les langues n'est pas cochée). |
| Si cette case est cochée, tous les types de documentation sont pris en compte pour la génération. Il est à noter que, dans ce cas, on limite la génération aux documentations standard (seules les documentations de code inférieur à X sont prises en compte). |
| Permet de définir le type de documentation à prendre en compte dans le traitement (quand on n'a pas coché la case pour les prendre tous en compte). |
| Permet de donner une borne sur les codes à prendre en compte pour la génération de documentation. |
|
|
Génération ADOCUMENT
| Ce radio-bouton permet créer/mettre à jour le squelette de la documentation (hiérarchie des paragraphes) à partir des éléments techniques trouvés dans le dictionnaire des données. On peut choisir de reprendre uniquement les documentations existantes ou créer de nouvelles documentations si besoin. Les liens de documentation sont également pris en compte. Les paragraphes susceptibles d'être créés sont définis dans l'annexe technique correspondante. |
|
|
Génération document final
| Ce radio-bouton permet de générer la documentation finale à partir du contenu des paragraphes de documentation. Cette documentation est créée dans différents sous-répertoires du répertoire défini par le paramètre utilisateur DIRDOC. La génération "Complète" traite l'ensemble des documentations n'ayant pas de code activité mais aussi celles ayant des codes activités standards (code activité <'X'). Il faut utiliser la génération "Selon code activité" pour obtenir la génération des documentations des fonctions ayant des codes activités actifs (qu'ils soient standards ou spécifiques). |
| Permet de générer le document final uniquement pour les documentations validées. |
| Si cette case est cochée, sont traitées spécifiquement les aides sur champs relatives aux documentations sur fonction ou objet traitées par ailleurs. Pour savoir quelles sont les aides sur champ à traiter, explorez les écrans associés aux paragraphes de documentation correspondants. |
| Si cette case est cochée, on crée la documentation finale à partir du contenu des paragraphes de documentation. Cette documentation est créée dans le sous-répertoire FLD du répertoire défini par le paramètre utilisateur DIRDOC. |
| Permet de donner une borne sur les codes à prendre en compte pour la génération de documentation. |
|
|
|
|
Fermer