Documentation

• Langue (champ LAN)

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

• Type de doc (champ TYP)

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).

• Paragraphe (champ PAR)

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.

• Ecran (champ MSK)

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.

• Code activité (champ CODACT)

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)

• 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.

• 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).