Auto-éditer un wikilivre/addappendix/documents et directives

Un livre de Wikilivres.
Aller à la navigation Aller à la recherche

Généralités[modifier | modifier le wikicode]

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

Directives libres de programmation[modifier | modifier le wikicode]

Directive de programmation établie par Goelette Cardabela et J Clara . Janvier 2022
y-a-t-il une contradiction entre directive et libre ?
  1. Le langage de programmation est le shell BASH non compilé afin d'être accessible à la compréhension.
  2. L'indentation des lignes de scripts est à la discrétion des programmeurs.
  3. Les fichiers de commandes pour sbin/ pourront éventuellement être compilés avec shc sans l'extension .sh.x
  4. Les fichiers sources bash auront l'extension .sh
  5. Les fichiers exécutables seront obtenus par extraction du code shell et les messages seront extraits en fichiers .pot
  6. 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
  7. Les scripts doivent être largement documentés en anglais pour assurer la maintenance universelle.
  8. Les organigrammes commencent par #O en première colonne.
  9. Les commentaires pour les programmeurs commencent par #P en première colonne.
  10. Les points particulier d'attention commencent par #w en première colonne
  11. Les entêtes commencent par #H en première colonne

Convention d'entêtes :

#!/bin/bash
#H Header doc
#H -------------------------------
#H File : <source>/<file>.sh
#H Syntax : <executable> [ ?  | -v ]
#H Created : AAMMDD by <wikibooks user>
#H Updated : AAMMDD by ... for
#O Organizational chart
#O -------------------------------
#P Programmers notes
#P -------------------------------
VERSION=AAMMDD
TEXTDOMAIN=<executable>
TEXTDOMAINDIR="/usr/share/locale"
export TEXTDOMAINDIR
#P . gettext for translation
. gettext.sh
#O Script begin here
....
#O Script end
Encodage du programme principal
Directive d'encodage établie par J Clara . Janvier 2022
  1. 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.
  2. 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.
  3. Le script addappendix.sh pourra être constitué de parties des scripts déjà éprouvés du logiciel Add_appendix.
  4. 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.
  5. 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[modifier | modifier le wikicode]

manuel wiki[modifier | modifier le wikicode]

  • 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[modifier | modifier le wikicode]

code du manuel pour annex (Dec 2021)[modifier | modifier le wikicode]

Attention : modification en cours !link={{{link}}}

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/.
.\" Création par Utilisateur:Goelette_Cardabela pour wikilivres le 26 juin 2020
.\" Vérifications UTF-8 par Clara le 6 novembre 2012
.\" Mise à jour par GC le 28 août 2021 pour Add_appendix
.\" Mise à jour par GC le 14 décembre 2021 Retouches
.\" .
.\" FILE manuel annex_fr.1 to edit in UTF-8 format

.TH annex 1 "14 Décembre 2021"

.SH NOM
annex \- Crée la page Annexe des livres de wikilivres.

.SH RÉSUMÉ
\fBannex\fP  < \fBnom du livre  |  ? \fP >   [ -v ]  [ -pb | -pc ]

.SH DESCRIPTION
\fBannex\fP permet de créer les pages \fIAnnexe\fP des livres de Wikilivres.

.SH PRÉ-REQUIS
Les répertoires de l'application doivent  être créés grâce à la commande users_install_annex.sh 
.TP
Le logiciel mkd doit être installé: https://en.wikipedia.org/wiki/Mkd_(software)
.TP
Le répertoire du livre doit être créé et contenir les wikicodes de la compilation ou du sommaire ou encore du contenu du livre. \
Pour les livres de wikibooks anglais et français ce travail peut être simplifié grâce à la commande pre-annex <url> complète du livre ou de la compilation. \
\fIannexer\fP et \fIaddappendix\fP sont aussi des commandes simplifiées

.SS Options
.TP
\fB ?\fR
Affiche la syntaxe de la commande.
.TP
\fB-v\fR
Mode bavard (Verbose mode)
.TP
\fB-pb\fR
Crée une version personnalisée du classement des images avec les données du serveur Mediawiki  \fIWikilivres\fP.
.TP
\fB-pc\fR
Crée une version personnalisée du classement des images avec les données du serveur Mediawiki \fICommons\fP

.SH "EXIT STATUS"
L'application renvoie normalement la valeur 0 et une valeur différente en cas d'erreur

.SH ERREURS
Les erreurs les plus fréquentes peuvent être causées par des débordement de la capacité de la ligne de commandes. \
Il peut être intéressant, à titre exceptionnel, de créer une page à la racine du serveur et de créer une redirection \
vers une page plus longue, afin de débloquer la ligne de commande. Il serait plus judicieux de renommer le nom de\
la page trop longue vers la racine du site Wikibooks avec un nom plus court.

.SH FICHIERS
Il existe de nombreux fichiers dont les versions peuvent changer lorsque des améliorations sont souhaitées. \
Reportez votre attention, pour cette version française vers la section 19 :\
\fIhttps://fr.wikibooks.org/w/index.php?title=Auto-éditer_un_wikilivre/Annexer_(Version_internationalisée)&section=19\fP

.SH VERSIONS
Les versions sont notée AAMMJJ - AA pour année, MM pour mois, JJ pour jour, de la dernière modification.

.SH HISTOIRE
.PP
2020 - Début de l'histoire avec les confinements au domicile à cause du virus COVID-19 : 
\fIhttps://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre\fP
2021 - Internationalisation des codes et des messages avec les versions \fIAdd_appendix\fP et \fIAnnexer\fP
 
.SH TELECHARGEMENTS
.PP
https://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre/Annexer_(Version_internationalisée)#src.orig_en_français

.SH AUTEURS
.PP
Manuel créé par le wikipédien  : Goelette Cardabela

.SH NOTES
.PP
La  version 211214 de Add_appendix est une version bêta

.SH BUGS
.PP
Il est possible de créer une discussion sur l'ensemble du projet et également pour chaque article de ce logiciel, \
il suffit se connecter sur wikibooks : https://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre/Annexer_(Version_internationalisée) \
et de consulter la page de discussion de l'article concerné.

.SH EXEMPLES
Exécuter dans le répertoire Add_appendix/bin :
.TP
"./pre-annex https://fr.wikibooks.org/wiki/Wikilivres:Compilations/Faire_sa_fleur_de_sel"
.TP 
"./annex Faire_sa_fleur_de_sel -pb"
.TP
Consulter le fichier "Faire_sa_fleur_de_sel.appendix"

.SH VOIR AUSSI
https://fr.wikibooks.org/wiki/Goélette_Cardabela/Référencement_manuel

aperçu du manuel annex (Dec 2021)[modifier | modifier le wikicode]

annex(1)                   General Commands Manual                   annex(1)

NOM
       annex - Crée la page Annexe des livres de wikilivres.

RÉSUMÉ
       annex  < nom du livre  |  ?  >   [ -v ]  [ -pb | -pc ]

DESCRIPTION
       annex permet de créer les pages Annexe des livres de Wikilivres.

PRÉ-REQUIS
       Les  répertoires  de l'application doivent  être créés grâce à la com‐
       mande users_install_annex.sh

       Le        logiciel        mkd        doit        être        installé:
       https://en.wikipedia.org/wiki/Mkd_(software)

       Le  répertoire du livre doit être créé et contenir les wikicodes de la
       compilation ou du sommaire ou encore du contenu  du  livre.  Pour  les
       livres de wikibooks anglais et français ce travail peut être simplifié
       grâce à la commande pre-annex <url> complète du livre ou de la  compi‐
       lation. annexer et addappendix sont aussi des commandes simplifiées

   Options
        ?     Affiche la syntaxe de la commande.

       -v     Mode bavard (Verbose mode)

       -pb    Crée  une  version  personnalisée du classement des images avec
              les données du serveur Mediawiki  Wikilivres.

       -pc    Crée une version personnalisée du classement  des  images  avec
              les données du serveur Mediawiki Commons

EXIT STATUS
       L'application renvoie normalement la valeur 0 et une valeur différente
       en cas d'erreur

ERREURS
       Les erreurs les plus fréquentes peuvent être causées par des  déborde‐
       ment   de  la  capacité  de  la  ligne  de  commandes.  Il  peut  être
       intéressant, à titre exceptionnel, de créer une page à  la  racine  du
       serveur et de créer une redirection vers une page plus longue, afin de
       débloquer la ligne de commande. Il serait plus judicieux  de  renommer
       le  nom dela page trop longue vers la racine du site Wikibooks avec un
       nom plus court.

FICHIERS
       Il existe de nombreux  fichiers  dont  les  versions  peuvent  changer
       lorsque  des  améliorations sont souhaitées. Reportez votre attention,
       pour cette version française  vers  la  section  19  :https://fr.wiki‐
       books.org/w/index.php?title=Auto-éditer_un_wikilivre/Annexer_(Ver‐
       sion_internationalisée)&section=19

VERSIONS
       Les versions sont notée AAMMJJ - AA pour année, MM pour mois, JJ  pour
       jour, de la dernière modification.

HISTOIRE
       2020  -  Début de l'histoire avec les confinements au domicile à cause
       du virus COVID-19 :  https://fr.wikibooks.org/wiki/Auto-éditer_un_wik‐
       ilivre  2021 - Internationalisation des codes et des messages avec les
       versions Add_appendix et Annexer

TELECHARGEMENTS
       https://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre/Annexer_(Ver‐
       sion_internationalisée)#src.orig_en_français

AUTEURS
       Manuel créé par le wikipédien  : Goelette Cardabela

NOTES
       La  version 211214 de Add_appendix est une version bêta

BUGS
       Il  est  possible  de créer une discussion sur l'ensemble du projet et
       également pour chaque article de ce logiciel, il suffit  se  connecter
       sur   wikibooks   :  https://fr.wikibooks.org/wiki/Auto-éditer_un_wik‐
       ilivre/Annexer_(Version_internationalisée) et de consulter la page  de
       discussion de l'article concerné.

EXEMPLES
       Exécuter dans le répertoire Add_appendix/bin :

       "./pre-annex         https://fr.wikibooks.org/wiki/Wikilivres:Compila‐
       tions/Faire_sa_fleur_de_sel"

       "./annex Faire_sa_fleur_de_sel -pb"

       Consulter le fichier "Faire_sa_fleur_de_sel.appendix"

VOIR AUSSI
       https://fr.wikibooks.org/wiki/Goélette_Cardabela/Référencement_manuel

                               14 Décembre 2021                      annex(1)

manuels texte[modifier | modifier le wikicode]

Ces manuels se trouvent dans /usr/share/doc/addapendix/
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:
man addappendix > addappendix_<lang>.txt

manuel html[modifier | modifier le wikicode]

Ces manuels se trouvent dans /usr/share/doc/addapendix/html/
addapendix_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)