Cette fonction permet de mettre à jour les documentations utilisateurs stockées dans la base de données du dossier courant, sous la forme de paragraphes normalisés, auxquels peuvent être adjoints des fichiers complémentaires tels que des images, des schémas.

Chaque documentation est définie par un type et un code qui la rattache au progiciel documenté. Selon le type de documentation, le code diffère. Une annexe détaille les types de documentations possibles et la façon dont le code est défini.

    Pré-requis

    SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre

    Gestion de l'écran

    Chaque fiche correspond à un paragraphe de la documentation. La clé d'une fiche est constituée du code langue, du type de documentation et du code, ainsi que d'un niveau et d'un sous-niveau qui permettent d'organiser des tables des matière intermédiaires dans la documentation.

    La liste de gauche contient 4 volets qui sont les suivants :

    • La liste normale et les derniers lus sont les listes habituelles
    • La liste hiérarchisée permet de visualiser les documentations liées au type de documentation courante et à la langue courante. Cette hiérarchie fait apparaître quand on la déplie pour une documentation donnée, d'abord les niveaux de documentation (qui correspondent à la table des matières située en tête de document), puis les sous-niveaux attachés à chaque documentation (sous-tables des matières).
    • La liste nommée Documentation courante permet de faire apparaître l'ensemble des paragraphes de la documentation correspondant à la fiche courante.

    Ecran de saisie

    Présentation

    Chaque paragraphe de documentation est saisi dans l'unique onglet de la fonction. On ny trouve à la fois des éléments de clé (langue, type, code, et imbrication des paragraphe), des informations définissant le style et la façon dont le paragraphe est généré, ainsi que le texte du paragraphe, s'il est nécessaire.

    La saisie d'un paragraphe se fait via un éditeur HTML, dont l'utilisation est détaillée dans une documentation annexe.

     

    Champs

    Les champs suivants sont présents dans cet onglet :

    Bloc numéro 1

    Cette zone fait référence à la table des langues, et définit la langue dans laquelle est écrite la documentation.

    Ce champ définit le type de la documentation. Chaque type est associé à un type d'éléments documentés (documentation fonctionnelle, décrivant une fiche du dictionnaire ou des valeurs de paramétrage, décrivant la structure du dictionnaire, diverses).

    Lorsqu'un type de documentation correspond à un code objet, une entrée Documentationest automatiquement créée dans la barre de menus de l'objet en question. On peut alors documenter les fiches saisies dans l'objet en question. C'est pourquoi l'aide fonctionnelle est codée AFC (code de l'objet Fonctions), l'aide sur paramètres généraux est codée ADP (code de l'objet Paramètres)...

    Les règles pour nommer les documentations sont définies dans une documentation annexe.

    • Code (champ COD)

    Ce champ définit le code de la documentation. Il correspond en principe au code de la fiche (fonction, paramètre...) que l'on documente. Les règles pour nommer les documentations sont définies dans une documentation annexe.

    • Niveau (champ LEV)

    Ce niveau établit une hiérarchie dans les paragraphes. Chaque premier paragraphe d'un niveau est présent dans la table des matières principale (sauf s'il est de type MIN).

    • Sous-niveau (champ SUBLEV)

    Ce sous-niveau établit une sous-hiérarchie dans les paragraphes. Dès lors qu'il y a plus d'un sous-niveau par niveau de documentation, une table des matières secondaire est établie dans le premier sous-paragraphe d'un niveau, faisant apparaître des liens vers les sous-paragraphes suivants (sauf si le sous-paragraphe est de type MIN).

    Caractéristiques

    Le code paragraphe détermine la façon dont est généré le paragraphe dans le document final. Ce peut être une simple recopie du texte, ou une génération plus sophistiquée dépendant du dictionnaire. Une documentation annexe détaille les codes paragraphes utilisables en fonction du type de documentation.

    Lorsqu'un code écran est saisi dans ce champ, un pictogramme présent sur le titre du paragraphe dans la documentation générée permet de déplier une section contenant la liste des champs de l'écran et l'aide sur champ associée. Il est conseillé d'utiliser alors un style de paragraphe égal à 4 (bandeau plein sur lequel le pictogramme de dépliage apparaît lisiblement).

    • Intitulé (champ TIT)

    Ce champ est le titre du paragraphe. S'il est vide, un titre par défaut est attribué en fonction du type de paragraphe (aussi bien en création qu'en modification).

    Dans le cas des paragraphes divers ne figurant pas dans les tables des matières (de type MIN), le fait de renseigner le titre avec le seul caractère " ! "désactive l'insertion d'un titre.

    Ce code activité, hérité du dictionnaire lors de la régénération, permet de faire notamment la distinction entre fiches standard et spécifiques, mais aussi de créer des documentations adaptées à des dossiers donnés en ne générant que les paragraphes et les documentations correspondant aux codes activité activés sur le dossier. Il est à noter que le code activité FAL (toujours faux) est pris en compte de façon particulière : un paragraphe marqué de ce code n'est jamais pris en compte par le traitement de génération, même si on demande une génération complète. Ceci permet de désactiver des paragraphes générés que l'on ne désire pas trouver dans une documentation.

    • Module (champ MODULE)

    Module d'appartenance du paragraphe de la documentation.

    • Style (champ STY)

    Le style fait référence à une valeur numérique correspondant à une balise "H1","H2,"H3"... selon le numéro choisi. Si ce champ est vide, par défaut, il est pris égal à 3. Pour des sous-paragraphes, il est conseillé d'utilisé 4, 5, ou 6, selon le niveau. Le titre 4 est présenté en bandeau : un pictogramme donnant accès aux aides sur champ y est visible si un écran est associé au paragraphe.

    • Priorité traduction (champ PRIO)

     

    • Groupe propriétaire (champ CREGRP)

    Ce champs permet d'afficher le Groupe créateur de la documentation concernée.

    Il n'est disponible que dans les environnements dans lesquels cette notion a été implémentée. Cela concerne les environnements dans lesquels le paramètre utilisateur GRPDEV existe.

    NOTE : Le groupe est affiché en Rouge lorsque le groupe de l'utilisateur diffère du groupe créateur trouvé dans la table AOBJGRPDEV

    • Validation (champ VLDDAT)

    Correspond à la date à laquelle la fiche a été considérée comme validée.

    • champ VLDFLG

    Cet indicateur signifie que la fiche a été considérée comme valide.

    Texte

    • champ TEXTE

    Ce champ permet de saisir le texte du paragraphe tel qu'il apparaîtra dans la documentation finale. Des cas particuliers doivent être mentionnés :

    • certains paragraphes ne sont pas insérés tels quels. C'est notamment le cas des paragraphes de titre, qui contiennent une liste de mots-clés insérés dans le code HTML de la documentation (rubrique Keywords).
    • certains paragraphes sont générés à partir du dictionnaire. Le texte qui y est saisi vient alors en complément (avant ou après le texte généré selon les cas), et n'est en général pas obligatoire.
    • dans les documentations de type APM (sommaires des documentations correcpondant à des niveaux de menus), le texte saisi est interprété comme une liste de liens supplémentaires vers les documentations correspondantes (les liens automatiques étant générés).

     

    Boutons spécifiques

    Donne accès à la génération de la documention.

    La génération permet de réaliser 2 fonctions:

    • La génération ADOCUMENT qui a pour but de créer ou mettre à jour les paragraphes de la documentation courante en fonction de la description des différents objets X3 concernés.
    • La génération finale HTML qui a pour but de créer un fichier d'extension htm, dans le répertoire défini par le paramètre DIRDOC.

    SEEREFERTTO Pour plus d'information, se référer à la documentation sur l'action de génération.

    Les champs suivants sont présents dans la fenêtre ouverte par ce bouton :

    Bloc numéro 1

    • champ OBJET

     

    • champ CLES

     

    Bloc numéro 2

    • Depuis le dossier (champ DOSORG)

    Indiquez le dossier à partir duquel la fiche va être copiée. Les syntaxes possibles sont décrites dans l'annexe dédiée.

    • Tous dossiers (champ TOUDOS)

    Cette option permet de copier la fiche vers tous les dossiers définis dans le dictionnaire (table ADOSSIER de la solution courante).

    • Vers le dossier (champ DOSDES)

    Indiquez le dossier dans lequel la fiche va être copiée. Les syntaxes possibles sont décrites dans l'annexe dédiée.

    Donne accès à la fonction de copie de tous les paragraphes de la documentation courante vers un autre dossier.

    Barre de menu

    Option / Paragraphes / Renumérotation des paragraphes

    Permet de renuméroter les paragraphes d'une documentation en précisant les bornes de renumérotation, le niveau cible, et le pas de renumérotation. Une simulation peut être faite au préalable.

    Option / Paragraphes / Cas d'emploi de paragraphe

    Dans la gestion de la documentation, cette option permet de rechercher les cas d'emploi d'un paragraphe donné dans l'ensemble des documentations existantes, pour une langue donnée.

    Selon le type de paragraphe sélectionné ou saisi, le programme recherche :

    • pour un paragraphe de type INC (inclusion de paragraphe) : à partir du lien de documentation saisi dans le texte de ce paragraphe, l'action recherche toutes les documentations utilisant ce paragraphe.
    • pour tous les autres types de paragraphes : l'action recherche toutes les documentations dans lesquelles ce paragraphe est ré-employé.

    Option / Liaisons / Fichiers liés documentation

    Permet d'ouvrir une fenêtre de saisie de documents liés (en principe des images) qui seront extraits en même temps que la documentation principale lors de la génération.

    Option / Liaisons / Liens de documentation

    Permet de passer en tunnel sur la fonction définissant les liens de documentation pour la documentation courante.

    Option / Actions / Copie documentation

    Permet de réaliser une copie en masse des documentations. Cf l'annexe technique pour les syntaxes possibles pour les dossiers.

    Option / Actions / Extraction documentation

    Permet d'extraire la totalité de la documentation courante (ou d'un ensemble de documentations courantes) sous la forme d'un fichier XML normalisé, dans le sous-répertoire XML du répertoire de génération. Ce fichier XML contient la structure et les textes de la documentation. Il peut être utilisé par des outils de traduction.

    Option / Actions / Suppression documentation

    Permet la suppression de documentation selon 2 options disponibles :

    • Si on choisi l'option "Tous les paragraphes" : permet de supprimer la totalité des paragraphes de la documentation courante dans la langue courante.
    • Si on choisi l'option "Tous les paragraphes - toutes les langues existantes" : permet de supprimer la totalité des paragraphes de la documentation courante dans toutes les langues existantes.

    Option / Actions / Priorisation traduction

    Permet de définir un ordre de priorité dans la traduction des documentations.

    Option / Vérifications / Vérification documentation

    Permet de lancer une vérification de cohérence entre la documentation et le dictionnaire (vérification des modules par exemple). Une trace d'erreur est donnée en fin d'exécution de la fonction.

    Option / Vérifications / Epuration documentation

    Option / Validation

    Permet de mettre à jour l'indicateur Validation (et la date de validation si la case est cochée) pour l'ensemble des documents de la base.

    Messages d'erreur

    Il n'y a pas de message d'erreur autre que les messages d'erreur génériques.

    Tables mises en oeuvre

    SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre