Voir le texte source

{{Modèle:Pas fini/autre}}{{Modèle:mkd}}
↑ <small>[[Projet_mkd/Fichiers_en_développement|Retour vers les fichiers en développement]]</small><br/>
== Remarques ==

Ce projet beta est à l'étude depuis 2013 [https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/Paquet_%27debian%27_pour_la_maintenance_logicielle#mkmaintainerdocu Voir la version 2013 sur wikibooks] 

Cette commande  [[wikipedia:fr:Shell_Unix|shell]] est intégrée dans les sources du projet mkd pour linux ubuntu depuis 2014

== Télécharger les sources ( mkd_140515.tar.gz ) ==

[https://launchpad.net/~jean-paul-louyot/+archive/ubuntu/mkd/+packages '''packages''']

mkddocu se trouve dans les sources et dans le paquet '''mkd-doc_140315_all.deb''' (15.5 KiB) cependant, pour utiliser mkddocu il est nécessaire d'installer une version de mkd. <br/>(mkd + mkddocu pour la version linux ubuntu)

[[Shell_command_projects/mkd|'''Manuel''']]

== Le fichier mkddocu.sh ==
Le fichier mkddocu crée sa propre documentation, avec le manuel intégré.

mkddocu génère sa propre documentation par la commande ''./mkddocu.sh mkddocu -s''

<pre>
#!/bin/bash
#P File mkddocu writed by Clara Jimenez 2013-12-15
#P Fichier modifiÃ© par JPL le 22/02/2014 pour une version plus universelle
#P mkddocu.sh modifiÃ© le 22/03/2014 par JPL pour introduire l'icÃ´ne mkd dans 
#P    ~.icons de l'utilisateur pour identifier le fichier .prj de mkd
#P    suppression de l'option -s pour produire le fichier des chaÃ®nes de
#P    caractÃ¨res
#P Util : Create any debian package for mkd for multi-lang programming languages
#P modifiÃ© par JPL modification des messages. ajout de (mkddocu) pour faire la 
#P    diffÃ©rence avec les messages de mkd et invalidation pour gettext des
#P    messages qui ne supportent pas le traduction tel que ./maintenance/Backup
#P
#
#D Fichier mkddocu.sh
#D -----------------------------------------------------------------------------
#D Documentation : Manuel mkddocu(1)
#D Cette commande doit Ãªtre placÃ©e dans le rÃ©pertoire /usr/bin
#D 
#D NOM
#D    mkddocu  -  Cette commande shell gÃ©nÃ¨re la documentation informatique de tout fichier de
#D    projet reconnu par la commande mkd
#D
#D SYNOPSYS
#D    mkddocu [nom] [s]
#D
#D DESCRIPTION
#D    La commande mkd associÃ©e Ã  mkddocu, extrait les commentaires  dotÃ©s  d'un  caractÃ¨re  de
#D    repÃ¨re.
#D    Si  des  fichiers  de langage C sont prÃ©sents, mkddocu gÃ©nÃ¨re un fichier d'entÃªte global
#D    (header) du projet informatique.
#D
#D    CaractÃ¨re de repÃ¨re
#D       D - Extrait la documentation gÃ©nÃ©rale.
#D       T - Extrait le document des directives de tests.
#D       P - Extrait un document utile aux mainteneurs.
#D
#D OPTIONS
#D    nom    Cette option permet de choisir un nom de  projet  diffÃ©rent  du  nom  par  dÃ©faut
#D           project.  Si nom est le caractÃ¨re '?' la commande affiche la syntaxe.
#D
#D    s      Cette  option  gÃ©nÃ¨re  le  fichier  des  chaÃ®nes  de caractÃ¨res et le fichier des
#D           chaÃ®nes de caractÃ¨res utiles aux traductions avec gettext et poedit.
#D
#D VALEURS RETOURNÃ‰ES
#D     0 : Fin normale Ã  la fin de l'exÃ©cution de la commande.
#D     1 : Fin normale aprÃ¨s l'affichage de la syntaxe de la commande.
#D     -1 : Erreur de sauvegarde de la sÃ©rie de documents dans Backups.
#D 
#D EXEMPLES :
#D    L'auto documentation de cette commande se crÃ©e  en  renommant  pour  l'usage  mkddocu.sh
#D    L'extension importe peu, la commande sera gÃ©rÃ©e par bash. Les fichiers sans extension ou
#D    avec l'extension .bash ne sont pas pris en compte.
#D    compte.
#D    Lancer la commande 'mkddocu.sh mkddocu -s'
#D    Le rÃ©pertoire maintenance/mkddocu contiendra la documentation
#D    Les rÃ©pertoires de projet sont gÃ©nÃ©rÃ©s par sÃ©ries et peuvent avoir Ã©tÃ© sauvegardÃ©s  dans
#D    un rÃ©pertoire Backups si le nombre de fichiers de projet de la sÃ©rie ont atteind la limâ€
#D    ite BACKUPSMAX
#D    Pour les essais on peut se limiter Ã  BACKUPSMAX=2 (3 'backups' par sÃ©rie.)
#D
#D REMARQUES
#D    BACKUPSMAX est normalement fixÃ© Ã  9 mais peut Ãªtre modifiÃ© par Ã©dition du fichier.
#D
#D VOIR AUSSI 
#D    mkd(1) gettext(1) poedit(1)
#D
#D TÃ‰LÃ‰CHARGEMENTS
#D    http://edeulo.free.fr
#D
#D AUTEURS
#D    Clara, JPL
#D    Email : http://edeulo.free.fr/contacts/formmail.php
#D
#D BUGS
#D    Rapports de bugs : http://edeulo.free.fr/phpBB3/index.php
#D
#
#T Fichier mkddocu.sh
#T -----------------------------------------------------------------------------
#T Tests : Ne peut fonctionner que si la commande mkd est installÃ©e.
#T
#T Test unitaire :
#T ---------------
#T Renommer mkddocu mkddocu.sh ou .csh
#T Editer le fichier mkddocu.sh et modifier la valeur de BACKUPSMAX limiter 
#T cette valeur Ã  3 (4 sauvegardes indicÃ©es)
#T
#T La commande s'autoteste
#T 1. Lancer 4 fois la commande ./mkddoccu (sans paramÃ¨tre)
#T 2. VÃ©rifier la commande de boucle Ã  chaque fois, elle doit incrÃ©menter les 
#T    rÃ©pertoires de projets project (le dernier), puis project.1, etc.
#T    AprÃ¨s project.3 on doit vous demander si vous dÃ©sirez prÃ©server ces
#T    fichiers dans un rÃ©pertoire .Backups. RÃ©pondez oui : 'y' (yes)
#T 3. VÃ©rifier que le fichier .prj prend bien en charge tous les fichiers de
#T    langages de programmation de la commande mkd. Pour cela il faut Ã©videmment
#T    disposer des fichiers nÃ©cessaires. On peut en trouver sur le site EELL
#T    http://edeulo.free.fr/wiki/index.php/Projet_mkd/Fichiers_en_dÃ©veloppement
#T    Les fichiers en dÃ©veloppement sont accompagnÃ©s de leurs tests unitaires,
#T    notamment le fichier find.inc.c trÃ¨s sollicitÃ© par la commande mkddocu.
#T    Trouver des exemples aussi sur wikipedia, wikibooks.
#T 4. Essayer les commandes : (dans un 'Terminal' ou une 'Konsoke')
#T    ./mkddocu.sh -s
#T    ./mkddocu.sh mkddocu
#T    ./mkddocu.sh mkddocu -s
#T    ./mkddocu.sh -s mkddocu
#T    Les commandes mkd ont Ã©tÃ© Ã©prouvÃ©es par ailleurs. VÃ©rifiez tout de mÃªme
#T    que les fichiers gÃ©nÃ©rÃ©s sont bien conformes.
#T 5. VÃ©rifiez que les fichiers en langage C sont pris en compte quand ils sont
#T    prÃ©sents. les fichiers d'entÃªte (.h) n'ont pas Ã  Ãªtre pris en compte.
#T 6. VÃ©rifier le bon fonctionnement des traduction
#T    xgettext : Outil pour extraire les chaÃ®nes Ã  traduire avec poedit
#T    ne pas oublier la ligne '. gettext.sh' en tÃªte de fichier
#T    xgettext -L shell -o lang/mkddocu.po --from-code=UTF-8 mkddocu.sh
#T
#T AprÃ¨s modification de la syntaxe, vÃ©rifier la nÃ©cessitÃ© de donner le nom du 
#T    rÃ©pertoire de sauvegarde en paramÃ¨tre.
#T 
#T
#T Tests d'intÃ©gration :
#T ---------------------
#T Pour ces tests il faut Ã©videmment disposer de vrais fichiers de programmation
#T dans diffÃ©rent langages mais cela a dÃ©jÃ  Ã©tÃ© fait lors des tests
#T d'intÃ©gration de la commande mkd.
#T On peut trouver ces fichiers dans chaqu'un des fichiers de tests unitaires de
#T la page wiki 'fichiers' en dÃ©veloppement citÃ©e plus haut.
#T
#
#
#P Fichier mkddocu.sh
#P -----------------------------------------------------------------------------
#P Menu d'aide sommaire obtenu par la commande 'mkddocu ?'
#
#P Extract code mkd -twC C mkddocu.sh mkddocu 
# /*C#!/bin/bash
#P File mkddocu
. gettext.sh
#
if ! test ~/.icons/mkd.png ; then
   install -D -m644 /usr/share/icons/hicolor/128x128/apps/mkd.png \
   ~/.icons/mkd.png
fi
if test -x /usr/bin/mkd; then echo "";
else
   if test -x ./mkd ; then echo "";
   else 
      echo "$(gettext ' Please install mkd software ')" 
      exit -1 #P exit -1 : La commande mkd n'est pas trouvÃ©e
   fi
fi
#
#P -----------------------------------------------------------------------------
#P Gestion de la syntaxe Nouvelle version pour mkd 140515
#
#P CrÃ©er la fonction d'affichage 'syntaxe'.
function put_syntaxe
{
      echo "$(gettext ' Syntax : ')"
      echo "$(gettext ' mkddocu <target_dir> ')"
      echo "$(gettext '    -> example of series with date : mkddocu 2014-02-22 ')"
      echo "$(gettext '    The target directory is also writen in maintenance directory : ')"
      echo "$(gettext '    -> maintenance/2014-02-22/ ')"
      echo "$(gettext ' mkddocu ? for this help ')"
      echo ""
}
#
if ! test $1; then put_syntaxe; exit -3; fi #P exit -3 : dÃ©faut de param d'entrÃ©e
if test $1; then
   if [ $1 = "?" ]
   then
      put_syntaxe
      exit 0 #P exit 0 : Fin d'affichage de la syntaxe
   fi
fi
#P Affecttion des macros et des variables
#P    BACKUPSMAX : DÃ©finition du nombre de sauvegardes d'une sÃ©rie avant la 
#P     sauvegarde globale dans un rÃ©pertoire 'Backup'. (Valeur modifiable)
BACKUPSMAX=10 
let i=1           #P compteur
str="false"       #P false ou true
project="project" #P nom du fichier de projet .prj
#
#P -----------------------------------------------------------------------------
#P Gestion des paramÃ¨tres d'entrÃ©e
#
if test $1; then
   if test $2; then
      echo ""
#      echo " Deux paramÃ¨tres Ã  la ligne de commande "
#      echo " ParamÃ¨tres : 1=$1, 2=$2 "
      if test $1 && [ $1 != "-s" ] ; 
      then 
         project=$1; 
         if [ $2 = "-s" ]; then str="true"; fi #P VÃ©rif que c'est bien -s
      else 
         if [ $1 = "-s" ]; then str="true"; project=$2; fi
      fi
   else
      echo ""
#      echo " Un seul paramÃ¨tre Ã  la ligne de commande : $1 "
      if test $1 && [ $1 != "-s" ] ; then project=$1; fi #T ancienne version 140315
      #w if [ $1 = "-s" ]; then str="true"; fi
      if [ $1 = "-s" ]; then put_syntaxe; exit -3; fi #T version 140515
   fi
else echo "" # " Pas de paramÃ¨tre "
fi
#P force str="true" without option -s 22/03/2014
str="true" #P
# echo " Projet : $project "
# echo " Strings ? : $str "
#
#P -----------------------------------------------------------------------------
#P Gestion de sauvegarde des sÃ©ries (Transfert dans maintenance/Backup)
#
#P CrÃ©er la fonction 'sauvegarde'. (Noter que la varable i est globale)
function sauvegarde
{
   if test -d maintenance/$project 
   then
   mv maintenance/$project maintenance/$project.$i
   fi
}
#Po Tant que l'on n'a pas atteind BACKUPSMAX
    while ((i<=BACKUPSMAX)); 
    do
#Po   Si le rÃ©pertoire de projet.i existe
      if test -d maintenance/$project.$i
#Po   alors:
      then 
#Po      Si le nombre de rÃ©pertoires projet.i de la sÃ©rie dÃ©passe BACKUPSMAX
         if [ $i = $BACKUPSMAX ]
         then 
#Po         demander si il faut transfÃ©rer la sÃ©rie dans de rÃ©pertoire 'Backup'
            echo -n " (mkddocu) "
            echo "$(gettext ' Last backup before maintenance : ')"
            echo -n " (mkddocu) "
            echo -n "$(gettext ' Make backup in Backups dir, yes ? Your choice : y ? ')"
            read char
#Po         si 'y' (yes)
            if test $char &&  [ $char = "y" ]
#Po         alors:
            then 
#Po            CrÃ©er le rÃ©pertoir Backup s'il y a lieu et transfÃ©rer la sÃ©rie .*
               echo ""
               echo -n " (mkddocu) "
               echo -n "$(gettext ' If the directory ')"
               echo -n "'Backups'"
               echo "$(gettext ' does not exist, create it ')"
               install -d Backups
               ((i++))
               sauvegarde
               cp -rf  maintenance/$project.* Backups/.
               rm -rf maintenance/$project.*
               clear
               echo -n " (mkddocu) "
               echo -n "$(gettext ' Files in directory ')"
               echo "Backups "
               ls -al Backups
            else 
               echo -n " (mkddocu) "
               echo "$(gettext ' return -2 ')"
               exit -2 #P exit -2 : Fin par erreur ou abandon de l'utilisateur
            fi
         fi
#Po    sinon: Sauvegarder le dernier rÃ©pertoire par incrÃ©ment d'extension
      else 
         sauvegarde
      fi
      let i++
      #break
   done
#
#P -----------------------------------------------------------------------------
#P PrÃ©paration des rÃ©pertoires de travail, maintenance et fichier de projet .prj
#
#P    Clean, nettoyage des fichiers d'Ã©ditions *~
      rm *.c~ #w ATTENTION ! Ã  exÃ©cuter avec prÃ©caution
#P    CrÃ©er du rÃ©pertoire ./maintenance si il n'existe pas
      install -d maintenance/$project
#P    CrÃ©er le fichier de projet .prj pour tout langage de programmation
      rm -f *.prj
      ls -1 *.asm *.s *.bas *.vb *.bat *.c *.C *.h *.H *.D *.cc *.hh *.cp *.cs \
      *.c# *.c++ *.h++ *.c-- *.h-- *.cpp *.hpp  *.css *.pr *.pl *.php *.jav \
      *.jse *.js  *.f99 *.f *.pas *.p *.sh *.csh *.pl, *.rb *.py *.pyw *.pj \
      *.prj > $project.prj > /dev/null
#
#P -----------------------------------------------------------------------------
#P GÃ©nÃ©ration de la documentation :
#
#P    GÃ©nÃ©rer le fichier d'entÃªte global .h si il existe des fichiers .c??
ls *.c* *.C* > cfiles.txt
if test -s cfiles.txt ; then cfiles="true"; fi
rm -f cfiles.txt
if test $cfiles; then
   echo -n " (mkddocu) "
   echo -n "$(gettext ' -> Create header file in ')"
   echo -n "maintenance/$project/$project.h"
   echo "$(gettext ' (benchmark H) ')"
   mkd -Cjt H $project.prj ./maintenance/$project/$project.h 
#Pw   -> Remarque d'ATTENTION pour copier manuellement le fichier d'entÃªte .h
   echo -n " (mkddocu) "
   echo "$(gettext ' -> Warning : Copy manually the header file in current source directory ')"
#Pw   -> ATTENTION ligne non validÃ©e : cp -f ./maintenance/$project/$project.h . 
else 
   echo -n " (mkddocu) "
   echo "$(gettext ' C files not found ')"
fi
#
#en   Make documentation with benchmark 'D'
#P    GÃ©nÃ©rer la 'documentation' avec le repÃ¨re 'D'
#
echo -n " (mkddocu) "
echo "$(gettext ' Creating documentation, find the programming style, with the benchmark D ')"
echo " -> ./maintenance/$project/$project-documentation.txt "
mkd -fjt D $project.prj ./maintenance/$project/$project-documentation.txt
#
#en   Make individuals tests directives document; style find add number of lines
#P    GÃ©nÃ©rer le fichier des directives des tests; avec numÃ©ro de ligne repÃ¨re 'T'
#
echo -n " (mkddocu) "
echo "$(gettext ' Creates the tests document and the directives of tests, with the benchmark T ')"
echo " -> ./maintenance/$project/$project-tests-directives.txt "
mkd -fjnt T $project.prj ./maintenance/$project/$project-tests-directives.txt
#
#en   Make maintainers documentation, add line number, benchmark 'P'
#P    GÃ©nÃ©rer le fichier destinÃ© aux mainteneurs avec le repÃ¨re 'P'
#
echo -n " (mkddocu) "
echo "$(gettext ' Creates the document for the maintainers, with the benchmark P ')"
echo " -> /maintenance/$project-maintainers-doc.txt "
mkd -fjnt P $project.prj ./maintenance/$project/$project-maintainers-doc.txt
#
#P Si le paramÃ¨tre '-s' est entrÃ©e Ã  la commande:
#P    CrÃ©er les fichiers : chaÃ®nes de caractÃ¨res et chaÃ®nes pour gettext
#en If second parametre is "-s" then
#en   Get all strings and select strings for translations
#
if [ $str = "true" ]; then
   echo -n " (mkddocu) "
   echo "$(gettext ' Creates a file with strings, and a file with strings for tranlations, with benchmark ** ')"
   mkd -fpnjs '**' $project.prj ./maintenance/$project/strings.txt | \
   grep gettext > ./maintenance/$project/strings-2-translations.txt 
fi
#
#P -----------------------------------------------------------------------------
#P Afficher les recommandations de lecture des fichiers de maintenance
#
echo -n " (mkddocu) "
echo -n "$(gettext '  See in working directory: ')"
echo "./maintenance/$project/$project/* "
ls -l ./maintenance/$project
#P Quitter avec un retour Ã  la valeur 0 Fin correcte normale
echo -n " (mkddocu) "
echo "$(gettext '  end normal, return 0 ')"
exit 0 #P exit 0 : Fin d'exÃ©cution de la commande mkddocu
#*/

</pre>

[[Catégorie : Générateurs de documentation]]