Auto-éditer un wikilivre/addappendix/manuel Add appendix fr

Création par : Utilisateur:Goelette_Cardabela pour wikilivres le 21 mars 2022
Voir aussi manuel wiki: https://en.wikibooks.org/wiki/Add_appendix_(experimental_software)
Dernière mise à jour : 31/03/2022

LOGICELS Add_appendix
MANUEL DESCRIPTIF


Révision : 21 mars 2022

DESCRIPTIONSModifier

Les logiciels annexer (VO), annex, add_appendix/annexer (VI), addappendix créent les pages Annexe des livres de wikilivres.
Pré-requis pour toutes les versions: Le logiciel mkd[1] doit être installé.

VERSIONSModifier

  • Lexique:
    (VO): Version d'origine en français.
    (VI): Version internationalisée.
    Livre compilé: Collection de pages obtenue grâce au menu Créer une compilation d'articles afin de produire un document imprimable avec PediaPress ou l'annexe d'un livre imprimable avec le logiciel addappendix.
  1. annexer (VO) est la version originale de cette série de logiciels créateurs de pages d'annexes: annex, add_appendix, addappendix. Les messages des scripts exécutables sont en français, ils sont exécutables dans l'ordre suivant: lister, télécharger, ajouter_sclt, ajouter_sclic, ajouter_sclip.inc, sclipwb, sclipco, ou globalement : annexer
    La construction de l'annexe du livre peut ainsi être contrôlée pas à pas comme prévu dans la directive destinée à l'apprentissage de la programmation bash[2].
    - Remarque - Les annexes des livres et livrets de la goélette Cardabela[3] ont été produites avec cette version de juin 2020.
  2. annex fait suite à la version annexer (VO). Cette version internationalisée permet d'être utilisée dans toutes les langues. La langue originale des messages est l'anglais comme il se doit pour l'internationalisation avec gettext.
    Les scripts sont exécutables successivement et les messages traduits en français peuvent être traduits individuellement dans toutes les langues. On peut se faire aider avec le programme pre-annex.
  3. add_appendix/annexer (VI) est la version finale après annex. Elle est composée des fichiers de base de la version annex à laquelle on a ajouté deux scripts destinés à faciliter la création du répertoire du livre contenant les fichiers nécessaires à l'exécution du programme annex qui en est la composante principale. De la même façon qu'avec annex, les scripts sont exécutables successivement, en commençant par pre-annex
    Le Makefile add_appendix.mak facilite l'installation de cette version dans le répertoire utilisateur ~/Add_appendix
  4. addappendix est la version empaquetée pour faciliter l'installation sous linux. Le paquet ubuntu peut être converti pour d'autres systèmes comme fedora, red hat, et autres.
    Le Makefile addappendix.mak facilite l'installation de cette version dans le répertoire utilisateur ~/Add_appendix et dans le système /usr/local sans passer par le paquet.
Particularités de chaque logiciel::
annexer (VO) est simple, et les messages sont d'origine, exclusivement en français.
annex nécessite une action manuelle pour créer le répertoire du livre et y copier le sommaire ou le contenu du livre. On peut se faire aider avec le programme pre-annex.
add_appendix/annexer (VI) crée le répertoire du livre et y copie les fichiers nécessaire à l'exécution du programme, il prend en compte les sommaires, contenus, compilations.
addapendix crée les conditions d'exécution du programme et s'exécute exclusivement à partir d'une URL de livre compilé.

annexer (VO)Modifier

Pages de références: Auto-éditer un wikilivre/Auto-référencer/Annexer (Version orignale)[4]
Date de révision: 01/07/2020
Lang: français
Téléchargement: oui[5]
Installation manuelle: possible (facile): Copier les scripts de wikibooks et les coller dans les fichiers du répertoire ~/Annexer
Manuel linux traditionnel: français. 'annexer_fr.1'
Usage: annexer < Nom_du_livre | ? > [ -v ] [ -pb | -pc ]
Options:
? : Aide
-v : Mode bavard
-pb : Recherche les images du livre dans wikibooks français.
-pc : Recherche les images dans commons
Exemple: LivreTest
  1. Ouvrir un terminal
  2. Créer le répertoire ~/Annexer/LivreTest.
  3. Entrer dans le répertoire Annexer.
  4. Éditer https://fr.wikibooks.org/wiki/Utilisateur:Goelette_Cardabela/Sandbox/LivreTest/contenu
  5. Copier la partie éditée dans ~/Annexer/LivreTest/LivreTest.contenu
  6. Éxécuter ./annexer LivreTest
  7. Comparer avec ./annexer LivreTest -pb et ./annexer LivreTest -pc
- Remarque: - Pour intégrer les images de la racine du livre on peut ajouter l'adresse du livre au début du fichier LivreTest.contenu :
; Article maître du livre
[[Utilisateur:Goelette Cardabela/Sandbox/LivreTest|LivreTest]]
; Contenus
[[Utilisateur:Goelette Cardabela/Sandbox/LivreTest/ArticleUn|ArticleUn]]<br />
[[Utilisateur:Goelette Cardabela/Sandbox/LivreTest/ArticleDeux|ArticleDeux]]<br />
[[Utilisateur:Goelette Cardabela/Sandbox/LivreTest/ArticleTrois|ArticleTrois]]
Noter que le logiciel annexer ne connaît que le site https://fr.wikibooks.org, on ne cherche pas le nom du site d'origine du livre.

annexModifier

Pages de références: Auto-éditer_un_wikilivre/Annexer_(Version_internationalisée)#Développement_du_logiciel[6]
Date de révision: 04/10/2021
Lang: anglais, français: annex_fr.mo
Téléchargement: non
Installation manuelle: oui ou avec l'installation par add_appendix.mak qui inclut annex
Manuel linux traditionnel: English annex_en.1, French annex_fr.1
Usage: annex < Nom_du_livre | ? > [ -v ] [ -pb | -pc ]
Options:
? : Aide
-v : Mode bavard
-pb : Rechercher les images du livre dans wikibooks.
-pc : Rechercher les images dans commons
Exemple: projet TestBook

Depuis mai 2021 on utilise pre-annex pour configurer le répertoire du livre :

Documentation d'entête de pre-annex.sh
#H Workdir is ~/Add_appendix or ~/Annexer
#H Executable file : Workdir/bin/pre-annex
#H Syntax : pre-annex <Full-url-of-book >
Documentation du programme pre-annex
#F Ce programme pré-annexe la construction de l'annexe du livre
#F Si ce programme s'est bien exécuté, le répertoire de projet aura été créé
#F - le fichier projet.suffixe et un fichier html local auront été créés dans
#F - le répertoire du projet
#F Il est proposé d'éditer la page 'Contenu' ou 'Sommaire' ou de 'Compilation'
#F   afin d'être éventuellement recopiée manuellement dans le fichier 
#F   projet.suffixe
  1. Ouvrir un terminal
  2. Entrer dans le répertoire ~/Add_appendix
  3. Éxécuter bin/pre-annex https://en.wikibooks.org/wiki/User:Goelette_Cardabela/Sandbox/TestBook
  4. Éxécuter bin/annex TestBook
  5. Comparer avec bin/annex TestBook -pb et bin/annex TestBook -pc
- Remarque: - Pour intégrer les images de la racine du livre vérifier que l'adresse du livre soit présente dans Add_appendix/books/TestBook.contents.

add_appendix/annexer (VI)Modifier

Pages de références: Auto-éditer_un_wikilivre/Annexer_(Version_internationalisée)#Développement_du_logiciel[6]
Date de révision: 04/03/2022
Lang: anglais, français
Téléchargement: non
Installation manuelle: oui avec l'installation par add_appendix.mak
Manuel linux traditionnel: anglais, français.
Usage: add_appendix < URL complète du livre | ? > [ -v ] [ -pb | -pc ]
Options:
? : Aide
-v : Mode bavard
-pb : Rechercher les images du livre dans wikibooks.
-pc : Rechercher les images dans commons
Exemple 1: projet TestBook. Comparer la facilité d'exécution par rapport aux exemples précédents avec annexer (VO) et annex
  1. Ouvrir un terminal
  2. Entrer dans le répertoire des exécutables (Bindir) ~/Annexer/bin ou ~/Add_appendix/bin
  3. Éxécuter './add_appendix https://en.wikibooks.org/wiki/User:Goelette_Cardabela/Sandbox/TestBook/Content
  4. La structure du répertoire du livre étant créée, exécuter ./annex TestBook -pb et ./annex TestBook -pc puis comparer les fichiers créés
- Remarque1: - Pour intégrer les images de la racine du livre on peut ajouter l'adresse du livre au début de TestBook.content.
Exemple 2: projet Hélices de navires à déplacement
Bindir = répertoire où se trouvent les exécutables du logiciel ~/Annexer/bin ou ~/Add_appendix/bin
Éxécuter Bindir/annexer https://fr.wikibooks.org/wiki/Hélices_de_navires_à_déplacement/Sommaire
- Remarque: - Si les exécutables se trouvent dans /usr/local/bin il est inutile de préciser Bindir

addapendixModifier

Pages de références: Auto-éditer un wikilivre/addappendix[7]
Date de révision: jj/mm/2022
Lang: anglais, français
Téléchargement: -->avril ou mai
Usage: addappendix < URL complète du livre | ? > [ --v ]
Options:
? : Aide
--v : Afficher la version de addappendix
Exemple: Faire sa fleur de sel compilé
  1. Ouvrir un terminal
  2. exécuter la commande : addappendix https://fr.wikibooks.org/wiki/Wikilivres:Compilations/Faire_sa_fleur_de_sel
- Remarque: -
La commande addappendix est installée dans /usr/local/bin.
Le répertoire de travail est ~/Add_apendix
Après l'exécution de la commande précédente le répertoire du livre sera ~/Add_apendix/books/Faire_sa_fleur_de_sel

VOIR AUSSIModifier

Liste des répertoires Add_appendixModifier

Auto-éditer un wikilivre/Structure du répertoire Add appendix[8]

ManuelsModifier

Usages:
'man man1 manuel' si le manuel est installé, sinon : 'nroff -man manuel.1 | less'

'nroff -man manuel.1 | col -b > manuel.txt' (Manuel texte pour corriger l’orthographe)
'nroff -man -Tps manuel.1 > manuel.ps' (Postscript ou PDF)
'man2html manuel.1 > manuel.html'

Généralités:

Si le manuel est installé il peut être affiché dans la langue déclarée de l'environnement (echo $LANG) ou en anglais.

man1: 26/03/2022: vert en cours, bleu en révision, orange en création

  • Manuel de l'utilisateur.,
bin: annexer, annex, add_appendix, addappendix, header.inc, lister, télécharger, ajouter_sclt, ajouter_sclic, ajouter_sclip.inc, sclipwb.
sbin: compil2bin, docu2html, htmlman, install_datasfiles, textman, updt-manuals, userman, users_install_annex

man3:

  • Manuel des sous-routines et fonctions de librairies.
lib: findbook, cpcleaned2bin.sh, ecfpc.sh, killalldoc.sh

man7:

  • Divers, paquets, conventions, etc.
Makefiles: add_appedix, addapendix
Packages: addappendix

LangModifier

Répertoire: Add_appendix/share/resources/lang/po

Fichiers de références en anglais (.pot): add_appendix.pot, add_sclic.pot, add_sclipco.pot, add_sclipwb.pot, add_sclt.pot, annexer.pot,annex.pot, en_sclic.inc.pot,en_sclipco.inc.pot, en_sclt.inc.pot, header.inc.pot, list.pot, pre-annex.pot, scli.inc.pot

Répertoire: Add_appendix/share/resources/lang/po/fr

Fichiers de traduction en français (.po): add_sclic.po, add_sclipco.po, add_sclipwb.po, add_sclt.po, annexer.po, annex.po, en_sclic.inc.po, en_sclipco.inc.po, en_sclipwb.inc.po, en_sclt.inc.po, fr_FR_addappendix.po, header.inc.po, scli.inc.po

Répertoires des fichiers traduits .mo

Fichiers traduits en français (.mo): addappendix.mo, add_sclic.mo, add_sclipco.mo, add_sclipwb.mo, add_sclt.mo, annexer.mo, annex.mo, en_sclic.inc.mo, en_sclipco.inc.mo, en_sclipwb.inc.mo, en_sclt.inc.mo, fr_FR_addappendix.mo, header.inc.mo, scli.inc.mo
  • Répertoire: Add_appendix/share/locale/fr/LC_MESSAGES, pour les fichiers de l'utilisateur traduits en français, avec TEXTDOMAINDIR="~/Add_appendix/share/locale" en tête de fichier exécutable.
  • Répertoire: /usr/share/locale/fr/LC_MESSAGES, pour les fichiers traduits en français pour tous les utilisateurs, avec TEXTDOMAINDIR="/usr/share/locale" en tête de fichier exécutable.

DocumentsModifier

Répertoire: Add_appendix/share/doc/Add_appendix

Copyright
README

RÉFÉRENCESModifier

  1. https://en.wikipedia.org/wiki/mkd_(software)
  2. https://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre/Auto-référencer
  3. https://fr.wikibooks.org/wiki/Goélette_Cardabela
  4. https://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre/Auto-référencer/Annexer_(Version_orignale)
  5. https://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre/Auto-référencer/télécharger_par_ftp
  6. 6,0 et 6,1 https://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre/Annexer_(Version_internationalisée)#Développement_du_logiciel
  7. https://fr.wikibooks.org/wiki/addappendix
  8. https://fr.wikibooks.org/wiki/Auto-éditer_un_wikilivre/Structure_du_répertoire_Add_appendix