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 Documentation est 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)

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

• Type de doc (champ TYP)

Définit le type de documentation à prendre en compte.

• Code (champ COD)

Définit le code de la documentation à prendre en compte.

• Niveau (champ LEVSTR)

Définit le niveau minimum des paragraphes à renuméroter.

• champ LEVEND

Définit le niveau maximum des paragraphes à renuméroter.

• Sous-niveau (champ SUBLEVSTR)

Définit le sous-niveau minimum des paragraphes à renuméroter.

• champ SUBLEVEND

Définit le sous-niveau maximum des paragraphes à renuméroter.

• A partir de (champ LEVNUM)

Définit le premier niveau dans lequel les paragraphes vont être renumérotés.

• Incrément (champ LEVSTP)

Définit l'incrément de renumérotation des niveaux de paragraphes. Si cet incrément est nul, on ne touche pas aux niveaux d'origine (seuls les sous-niveaux sont renumérotés).

• A partir de (champ SUBLEVNUM)

Définit le premier sous-niveau dans lequel les paragraphes vont être renumérotés.

• Incrément (champ SUBLEVSTP)

Définit l'incrément de renumérotation des sous-niveaux de paragraphes.

• Simulation (champ SIMUL)

Lorsque cette case est cochée, la renumérotation n'est pas réellement faite, mais l'affichage d'une trace liste les numérotations de paragrapheà faire. Une fois la trace affichée, on revient dans l'écran de saisie des paramètres. On peut alors soit abandonner, soit décocher la case et valider pour déclencher la renumérotation.

• Respecter la rupture des niveaux (champ RUPT)

Si cette case est cochée, les différents niveaux concernés de paragraphe concernés par la renumérotation restent différents (soit ils sont renumérotés si un pas de renumérotation est donné, soit ils restent identiques si aucun pas n'est donné).

Si elle n'est pas cochée, l'ensemble des paragraphes sont renumérotés dans un seul niveau.

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

• Type (champ TYPBLB)

• Nom (champ NAM)

Correspond au nom du fichier à extraire. Si ce nom est vide, le fichier extrait prend pour nom le code de la documentation, suivi du caractère de soulignement '_' et du numéro de la ligne sur 3 caractères (complétés à gauche par des zéros), avec une extension jpg (images JPEG). Ainsi, par exemple, sur une documentation nommée GESADO.htm, les fichiers par défaut seront nommés GESADO_001.jpg, GESADO_002.jpg, etc. Il est important de noter que ceci suppose que les fichiers joints soient positionnés sur un seul paragraphe de la documentation (ou alors ceux positionnés sur un autre paragraphe doivent être renommés).

Lorsqu'on veut inclure un nouveau fichier de type Autre, on dispose sur ce champ par clic droit d'une possibilité de Sélection document. Cette fonction ouvre une fenêtre permettant de charger le document y compris par choix depuis le poste local.

Lorsque le fichier à inclure est une image, on utilise le clic droit Sélectionner sur le bloc de l'image.

• A traduire (champ TRAFIL)

Indique si le fichier lié contient des éléments traduisibles.

Dans ce cas, le fichier lié sera pris en compte dans le processus de traduction quelque soit le type de la documentation.

• Répertoire (champ REPERT)

• champ PHOTO

Affiche l'image de la ligne courante.

• Taille (K-octets) (champ TAILLE)

Affiche la taille du fichier joint courant.

• Toutes langues (champ ALLLAN)

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 :

• la langue par défaut de l'utilisateur, si aucun code langue n'est saisi.
• la langue saisie par ailleurs sinon.

• Langue (champ LAN)

Définit la langue dans laquelle un texte est exprimé.

• Tous types (champ ALLTYP)

Si cette case est cochée, tous les types sont pris en compte pour l'opération. Sinon, il faudra saisir le type qui sera pris en compte.

• Type (champ TYP)

Définit le type de documentation à traiter (lorsqu'il est unique).

• Tous codes (champ ALLCOD)

Si cette case est cochée, tous les codes sont pris en compte pour l'opération (sinon, on ne prendra en compte que les codes correspondant aux bornes saisies).

• Code (champ COD)

Définit le code de la documentation qui doit être traitée (lorsqu'elle est unique).

• Depuis le dossier (champ DOSORG)

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

• Vers le dossier (champ DOSDES)

Ce champ permet de définir le dossier dans lequel la fiche va être copiée. Les syntaxes possibles sont décrites dans l'annexe dédiée.

• Choix d'extraction (champ CHOICE)

Détermination du choix d'extraction XML :

• Extraction par langue : extraction simple selon une ou plusieurs langues d'extraction.
• Extraction pour traduction : extraction à des fins de traduction d'un documentation dans une langue cible et selon une langue de référence.
• Extraction pour (re)traduction : extraction à des fins de (re)traduction d'un documentation dans une langue cible et selon une langue de référence. Dans ce cas, la data de validité n'est pas testée.

• Répertoire (champ REPERT)

Indique le répertoire à partir duquel sera fait l'export de documentations, en sachant que les aides sur champs seront extraits dans le sous-répertoire FLD, et les fichiers liés dans le sous-répertoire FILE.

• Sous-répertoire par type (champ REPERTTYP)

Indique si le sous-répertoire par type de documentation sera utilisé pour être concaténé avec le répertoire principal à partir duquel sera fait l'export de documentations.

Les aides sur champs liées seront extraits dans le sous répertoire par type puis FLD.

Les fiés liés seront extraits dans le sous répertoire par type puis FILE.

• Documentations prise en compte (champ VALDOC)

• Toutes langues (champ ALLLAN)

Si cette case est cochée, toutes les langues sont prises en compte pour l'opération.

• Langue d'extraction (champ LAN)

Définit le code langue à traiter lorsqu'il est unique.

• Langue de référence (champ LANREF)

• Extraire aussi en langue de référence (champ ENLANREF)

• Tous types (champ ALLTYP)

Si cette case est cochée, tous les types sont pris en compte pour l'opération. Sinon, il faudra saisir le type qui sera pris en compte.

• Type (champ TYP)

Définit le type de documentation à traiter (lorsqu'il est unique).

• Exclusion APM, AT*, AML (champ EXCTYP)

• Tous codes (champ ALLCOD)

Si cette case est cochée, tous les codes sont pris en compte pour l'opération (sinon, on ne prendra en compte que les codes correspondant aux bornes saisies).

• Code de (champ CODDEB)

Permet de donner une borne de début sur le critère pour déterminer les données prises en compte par l'opération.

• à (champ CODFIN)

Permet de donner une borne de fin sur le critère pour déterminer les données prises en compte par l'opération.

• Tous codes activités (champ ALLACV)

• Code activité (champ ACV)

• Tous modules (champ ALLMOD)

• Module (champ MODULE)

• Exclure un module (champ EXCMOD)

• Module (champ MODTOEXC)

• Fichiers liés (champ HLPFIL)

Si cette case est cochée, on traite également les fichiers liés aux documentations. Ces fichiers sont en général des images.

• Aides sur champs liés (champ HLPLNKFLD)

Si cette case est cochée, on traite 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, on explore les écrans associés aux paragraphes de documentation correspondants.

• Aides sur champs (champ HLPFLD)

Si cette case est cochée, on traite également la documentation sur champs.

• De (champ FLDDEB)

Permet de borner le traitement de l'aide sur champ entre deux mots-clés.

• champ FILLER4

• A (champ FLDFIN)

• Toutes langues (champ ALLLAN)

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 :

• la langue par défaut de l'utilisateur, si aucun code langue n'est saisi.
• la langue saisie par ailleurs sinon.

• Langue (champ LAN)

Définit la langue à prendre en compte dans le traitement.

• Tous types (champ ALLTYP)

Si cette case est cochée, tous les types de documentation sont concernés.

• Type (champ TYP)

Définit le type de documentation à prendre en compte dans l'opération.

• Tous codes (champ ALLCOD)

Si cette case est cochée, tous les codes sont pris en compte pour l'opération (sinon, on ne prendra en compte que les codes correspondant aux bornes saisies).

• Code (champ COD)

Définit le code de la documentation à prendre en compte.

• Validation (champ VALID)

Si cette case est cochée, on valide tous les paragraphes concernés et on met à jour la date de validation. Si elle ne l'est pas, on décoche la case validation sur tous les paragraphes concernés.

• Date validation (champ DAT)

Définit la date à laquelle la documentation a été considérée comme valide (par défaut, la date du jour lorsqu'on lance la validation des paragraphes de la documentation).