# Auto-éditer un wikilivre/addappendix/documents et directives
## Généralités

* Les messages et les manuels doivent être écrits en anglais puis traduits dans d'autres langues.

## Directives libres de programmation

    Directive de programmation établie par Goelette Cardabela et J Clara . Janvier 2022
    y-a-t-il une contradiction entre directive et libre ?
* Le langage de programmation est le shell BASH non compilé afin d'être accessible à la compréhension.
* L'indentation des lignes de scripts est à la discrétion des programmeurs.
* Les fichiers de commandes pour sbin/ pourront éventuellement être compilés avec shc sans l'extension .sh.x
* Les fichiers sources bash auront l'extension .sh
* Les fichiers exécutables seront obtenus par extraction du code shell et les messages seront extraits en fichiers .pot
* Les fichiers .pot devront rester à la disposition des mainteneurs et des utilisateurs pour assurer les traductions dans d'autres langues sans qu'il soit nécessaire de mettre le paquet à jour. Ces fichiers .pot seront disponibles dans le répertoire /usr/share/doc/addapendix
* Les scripts doivent être largement documentés en anglais pour assurer la maintenance universelle.
* Les organigrammes commencent par #O en première colonne.
* Les commentaires pour les programmeurs commencent par #P en première colonne.
* Les points particulier d'attention commencent par #w en première colonne
* Les entêtes commencent par #H en première colonne
Convention d'entêtes :

### Encodage du programme principal

    Directive d'encodage établie par J Clara . Janvier 2022
* Le logiciel addappendix n'aura qu'un seul programme principal contrairement aux logiciels Annexer et Add_appendix qui disposent de plusieurs points d'entrée dont la principale est annex.
* La ligne de commandes contiendra uniquement le lien vers le livre compilé et les deux options « ? » et « -v » la commande sera détaillée dans le manuel.
* Le script addappendix.sh pourra être constitué de parties des scripts déjà éprouvés du logiciel Add_appendix.
* Les fichiers qui ne contiennent pas de texte traductible avec gettext pourront être inclus dans le script addappendix.sh avec la directive « source » ou « . ». Ces scripts devront être accessibles dans la librairie addappendix.lib (/usr/lib/addappendix.lib ou /usr/local/lib/addapendix.lib) selon la directive d'installation du paquet.
* Les scripts seront éprouvés dans le répertoire des tests puis assemblés progressivement en un seul. Noter que les scripts ont déjà été éprouves avec Add_apendix.

## Documents pour l'utilisateur
### manuel wiki

* Ce manuel est commun à la série des logiciels Add_appendix (annexer, annex, add_appendix, addappendix)
    français: Manuels Wiki pour les logiciels Add_appendix
    anglais: Wiki manuals for Add_appendix softwares

### manuel traditionnel
#### code du manuel pour annex (Dec 2021)

Un contributeur est en train de retravailler en profondeur cette page. Vous êtes prié(e) d'éviter de le modifier pour limiter les risques de conflit de versions jusqu'à disparition de cet avertissement. Merci.
* Le code comprimé addappendix.1.gz en anglais doit être placé dans le répertoire par défaut /usr/share/man/man1/.
* Le code comprimé addappendix.1.gz traduit en français doit être placé dans /usr/share/man/fr.UTF-8/man1/.

#### aperçu du manuel annex (Dec 2021)
### manuels texte
#### Ces manuels se trouvent dans /usr/share/doc/addappendix/

    addapendix_de.txt, addappendix_en.txt, addappendix_fr.txt
    Si le manuel existe dans d'autres langues on peut les créer par la commande:

### manuel html
#### Ces manuels se trouvent dans /usr/share/doc/addappendix/html/

    addappendix_de.html, addappendix_en.html, addappendix_fr.html
    Ces manuels sont généralement accessibles par un fichier d'index ou par un alias (voir: comment créer un alias)
    Si le manuel existe dans d'autres langues on peut utiliser la commande man2html (voir le manuel: man man2html)