Auto-éditer un wikilivre/Auto-référencer/Description du projet

Un livre de Wikilivres.
Sauter à la navigation Sauter à la recherche
Information : Les fichiers ont été modifiés depuis la version originale du 10 avril avec la description détaillée des premiers codes.
Pour des examens approfondis il est possible d'accéder à ces modules d'origine dans le chapitre déroulable Nouveautés, section 3.1 : Programmes_d'évaluations_et_de_tests.
Cliquer sur l'historique de chaque module pour visualiser les codes correspondants aux dates des évaluations et des tests.
Voilà de bons exercices pour le(s) confinement(s)
--------
Pourquoi avoir choisi le shell bash ?
Les codes shells sont les plus proches du code machine, ils sont donc ultra-rapides, même sur de très vieux micro-ordinateurs, ils sont disponibles pour tous les systèmes d'exploitation, gratuits, efficaces, parfois difficiles à mettre en œuvre ou à comprendre car les règles sont strictes et les différentes versions diffèrent quelque peu selon que l'on choisit les versions posix[1] ou gnu ou autres shells : csh, tcsh, ksh, etc.
Synopsis de ce projet
Examiner le projet en préétude, avec le LivreTest
Ce projet doit permettre de créer la page Annexe des livres de wikilivres, avec :
  1. Les références.
  2. La liste des articles avec le lien, la licence associée, ainsi que les noms des contributeurs.
  3. La liste des illustrations avec le lien, la licence associée, ainsi que les noms des auteurs.
  4. La licence de la page principale ou de sa version imprimable.
Outils de programmation
  1. Le shell BASH : Le programme sera écrit en code bash (Bourne again shell) ou Bourne_shell(bsh ou sh), sous linux de préférence. Il existe des versions de bash pour d'autres systèmes d'exploitation[2].
  2. Le système d'exploitation : Préférez Ubuntu pour avoir un accès direct aux paquets de mkd et ses applications dérivées, par le serveur sécurisé launchpad
  3. Le logiciel mkd : extracteur de documents. Il est recommandé de l'installer dès que possible. [3].
  4. En complément de mkd, le shell mkddocu extracteur de documents écrit en bash. Avec l'option -s il extrait toutes les chaînes de caractères pré-encodées pour les traductions avec gettext.
À défaut de mkd vous pouvez compiler mkdcpp[4][5]
Directives de programmation
Les modules du programme devront être indépendants et éprouvés séparément avant d'être intégrés dans le programme principal. Pour ce faire on écrira un module d'entête header.sh qui servira aux tests de chaque module. Ce module d'entête fonctionnera comme les module "include" des langages C, c++ etc. Ce sera le fichier d'entête de chaque module inclus avec la commande shell source. Exemple : source header.sh
    Utiliser les codes d'extraction suivants pour les logiciels de documentation
#H pour les commentaires d'entête. On va les retrouver dans toutes les commandes du projet
#O pour les commentaires d'organigramme.
#P pour les commentaires destinés aux Programmeurs.
#S pour les commentaires de structure.
#T pour les commentaire de tests, ce sont souvent des points d'arrêt pour la mise au point.
#w pour des commentaires d'attention, de mise en garde.
Internationalisation des messages
Tous le messages affichés avec la commande echo devront être traduits en anglais, langue de base pour les traductions, puis intégrés dans le programme final. Un fichier .pot sera créé pour les messages puis traduits à l'aide de Poedit et compilés sous forme de fichier .mo copiés dans les répertoires de traduction habituels.
Internationalisation des manuels
  1. Un manuel man(1) unix sera écrit en français puis traduit en anglais.
  2. Un manuel html sera écrit en français et en anglais pour être lus à l'aide de navigateurs internet.
Références
  1. http://pwet.fr/man/linux/commandes/posix/
  2. https://korben.info/installer-shell-bash-linux-windows-10.html
  3. Mkd_(Extracteur_de_documents)/La_commande_mkd#Disponibilité
  4. Mkd_(Extracteur_de_documents)/Ajouter_des_modules#
  5. https://fr.wikibooks.org/wiki/Utilisateur:Goelette_Cardabela/mkdcpp