# Mkd (Extracteur de documents)/Introduction aux exercices/Version imprimable

Mkd (Extracteur de documents)
Exercices
https://fr.wikibooks.org/wiki/Mkd(Extracteur_de_documents)
* Ce livre fait environ ~=28 pages au format A4 (dans la version du 2013-09-30).
* Si vous imprimez cette page, choisissez « Aperçu avant impression » dans votre navigateur, ou cliquez sur le lien Version imprimable dans la boîte à outils, vous verrez cette page sans ce message, ni éléments de navigation sur la gauche ou en haut.
* Cliquez sur Rafraîchir cette page pour obtenir la dernière version du wikilivre.
* Pour plus d'informations sur les version imprimables, y compris la manière d'obtenir une version PDF, vous pouvez lire l'article Versions imprimables.
Une version à jour et éditable de ce livre est disponible sur Wikilivres, une bibliothèque de livres pédagogiques, à l'URL : https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/Introduction_aux_exercices

# Aperçu

mkd est une commande Unix / Linux utilisée dans les fichiers de commandes et dans les Makefile pour maintenir à jour la documentation logicielle.
Des versions sont disponibles pour MASM / MS-DOS et pour Visual studio / MS-Windows.
Très simple et très pratique d'utilisation, mkd peut être proposé aux les travaux pratiques de l'informatique pour l'étude du cycle en V.

# Sommaire
## Une version plus complète est disponible

    https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/Livre_imprimable

# Exercices
## Introduction

Pour ce faire il faut évidemment disposer du matériel (Extrateur de documents, fichiers encodés, etc.) Nous proposons ici des fichiers déjà disponibles, mais vous pouvez essayer avec vos propres fichiers dans la langue et le langage qui vous convient.

## Télécharger mkd

* Version Windows:
    Binaire 32 bits mkd.10.03.zip (Compilé avec Visual VC10).
    sources-mkd.10.03.beta.zip Pour MSDEV, Visual VC10, UNIX / LINUX.
* Versions Unix / Linux: (Paquets sécurisés sur Launchpad)
    Version Debian / Ubuntu sur Launchpad: Binaires, et sources sous réserve d'adapter les chemins des répertoires man et catman.:
       Paquets pour Ubuntu / Debian
    Version RPM (Fedora): (Paquets sécurisés sur le serveur eell.fr)
       Paquets RPM
       Autres systèmes linux : Convertissez les paquets debian avec la commande alien
* Vous pouvez tenter de compiler mkd sur Mac:
       Exercices en langage C - GCC standard sur Mac

## Sources pour les exercices

Les fichiers ci après sont universels (pour tous les exercices et tous systèmes d'exploitation.)
cpp.c pour exercices
asm.c pour exercices
Autres formats de fichiers

## Exercices élémentaires pour se familiariser avec la commande mkd

VOTRE ATTENTION: À l'impression les solutions n'apparaissent pas dans le texte. Les solutions aux exercices se trouvent dans la section suivante, dans le chapitre nommé Comprendre les options de la commande mkd.
* Vérifiez votre commande mkd. Tapez la commande mkd. L'erreur de syntaxe devrait s'afficher:
* Inspirez-vous du manuel en français ou en anglais
* Observez l'effets des options a,s,t,v,w de la commande mkd
* Observez ensuite l'action des codes de sélection de commentaires D, H, O, P, S, T, w (5 maximun)
* Rappel de la commande: mkd [-ABCFPSafjlnpstvw] codes chemin_source [chemin_cible]
    Dans le répertoire des fonctions, tapez les commandes ci dessous dans un terminal:

### Commande: mkd -Cwsv H cpp.c

Testez mkd -Cwsv H cpp.c ( pour décoder le Header de style C, w pour écraser un fichier existant, s et v pour afficher à l'écran en mode bavard ) :
    Comprendre les options : aperçu 1.1

### Commande: mkd -Cws H cpp.c

    Comprendre les options : aperçu 1.2

### Commande: mkd -Cwts H cpp.c

    Comprendre les options : aperçus 1.3

### Commande: mkd -Cwt H cpp.c *.h

    Comprendre les options : aperçus 1.3

### Résumé des observations sur les options s, t, v

Essayez aussi l'option -n
    Comprendre les options : Résumé des observations sur les options s, t, v

### Créez ou écrasez le fichier cible de l'organigramme cpp.organigramme

* Organigramme simple avec numérotation des lignes: code 'O'
* Organigramme avec structure avec numérotation des lignes: codes "OS"
* Organigramme complet avec les tests warnings et numérotation des lignes: Codes "POSTw"
    Comprendre les options : Solution 1.5

### Crééz ou écrasez le fichier de documentation logicielle html du fichier cpp.c

* Le but de l’exercice est de se familiariser avec l'option -a.
* Le Fichier cible: aura pour nom "cpp-documentation_logicielle_codage.html".
* Créez la tête du fichier html avec le code 'h' options -Cwt
    Exemple: mkd -Ctw h cpp.c cpp-documentation_logicielle_codage.html
* Ajoutez le corps avec le code 'd' et les options -Cat (Option -a comme append, ajouter au fichier cible)
* Ajoutez le pied du fichier html avec le code 'f' et les options -Cat
* Visualisez le fichier cpp-documentation_logicielle_codage.html avec votre navigateur
* Quelle meilleure solution proposez-vous pour créer cpp-documentation_logicielle_codage.html ?
    Comprendre les options : Solution 1.6

## Exercices pour se familiariser avec les fichiers de projets

ci-après: fichier est un nom quelconque sensé représenter votre projet dans le répertoire des fichiers sources.
Utiliser l'option -f (finder): Pour valoriser cette option il serait utile d'ajouter un fichier d'un autre langage de programmation à votre convenance (Trouvez sur wikibooks ou wikipedia). À défaut, recopiez et collez le texte ci-dessous dans un fichier nommé putchar.asm sous Windows ou putchar.s sous Linux, à placer dans le répertoire du projet, avec cpp.c et asm.c Trouvez l'exemple en assembleur Microsoft (MASM) sur wikipédia:
putchar.asm
Ce court fichier est utilisé à titre d'exemple pour donner une solution réaliste aux exercices et peut être remplacé par tout autre fichier en assembleur.
Aperçus et solutions des exercices pour comprendre les "Fichiers de projets"

### Créer un fichier de projet manuellement

Projet exercice.prj ; à créer manuellement avec les fichiers disponibles asm.c cpp.c putchar.s
    Comprendre les fichiers de projets : Aperçu

### Créer un fichier de projet avec les commandes système

Projet exercice.prj ; à créer avec les commandes de votre système d'exploitation; ls, dir.
    Comprendre les fichiers de projets : Solution

### Créer un fichier de commandes pour :

Vous aurez copié les fichiers à éprouver dans le répertoire des essais . exécutez la commande mkd \? pour visualiser les extensions reconnues par votre mkd. Ces extensions dépendent des options de compilation.
Les fichiers sont écrits dans des langages de programmation différents, le but est de créer des documentations globales avec ou sans le finder (option -f).
    Comprendre les fichiers de projets : Aperçus et solutions des "Fichiers de commandes"

#### Mettre à jour le fichier d'entête. header global

(header global, exercice.h)
    Comprendre les fichiers de projets : Solutionl

#### Mettre à jour l'organigramme de chaque fichier de programme

Pseudo-code; Code de repérage 'O', asm.org, cpp.org, putchar.org
    Comprendre les fichiers de projets : Solution et aperçu avec commentaires

#### Mettre à jour la structure de chaque fichier

avec le pseudo code. Code 'S' et 'O' et 'w', fichier.struct Fichier:s asm.struct, putchar.struct.
    Comprendre les fichiers de projets : Aperçus

#### Mettre à jour la documentation globale pour les programmeurs

avec les dates de mise à jour etc. Code 'P' Fichier: exercice.info_programmeurs
    Comprendre les fichiers de projets : Aperçu

#### Mettre à jour de la documentation logicielle globale

(Conception détaillée, Tests unitaires, du cycle en V) Code 'D' Fichier: exercice.docu
    Comprendre les fichiers de projets : Aperçu

### Notes sur le finder

Le finder (trouveur) cherche le style du langage par examen de l'extension du nom de fichier, l'option -f est rarement utilisée.
Extensions spécifique à Windows et MS-DOS: Assembleur, Basic, C, Fortran, Pascal, C ou Prolog.
    .ASM .BAS .C .FOR .PAS .PRO extensions en majuscules ou minuscules.
Extensions spécifique à unix / linux: assembleur, C, Fortran, Ratfor, Pascal, Shell, Cshell
    .s .S .c .h .i .f .F .r .p .sh .csh
Notez que les extensions de fichiers .c .h et .prj sont toujours reconnus alors que .c++, .cpp, .hpp ne sont pas reconnus par le finder tout au moins jusqu'à la version 2012. Il est nécessaire de préciser l'option 'C' dans la ligne de commande.
REMARQUES:
c++, cpp, hpp seront probablement reconnus dans les prochaines mises à jour. Il est relativement facile de l'implémenter dans le fichier "find.inc.c" ou find.i
Les commentaires en style ADA commencent par deux tirets et ne sont pas reconnus en standard par le finder (trouveur) de mkd, cependant si il est facile de l'implémenter dans le fichier "find.i" il faudra aussi créer un fichier spécifique à ADA (ada.c ou ada.i)

## Fichiers de tests unitaires

* Inspirez-vous de la documentation de la fonction cpp_ (fichier cpp.c) pour créer un fichier de commandes qui met la fonction cpp_ à l'épreuve.
* Conditions des tests: tous les tests se feront avec l'option impérative -C
* Vérifiez les options de la fonction: n, s, t, séparément.
    Vérifiez que la numérotation des lignes est correcte dans tous les cas de décodage (lignes et blocs). n, ns. nt, nst.
    Vérifiez que le texte reste à la bonne place dans tous les cas de décodage: toute la ligne (dans la cas de la directive de compilation FULL_LINE), ou texte seul.
       - Vérifiez que les tabulations sont bien prises en charge dans tous les cas, décodage des lignes et des blocs
       - Vérifiez de même pour les espaces.
    Vérifiez que le caractère de fin de fichier n'apparaît pas en fin de texte lorsque le commentaire ne se termine pas par une fin de ligne.
* Documentation:
       Ajouter des modules : Documentation pour éprouver les modules.
       Ajouter des modules : Une solution à cet exercice

## Notes et références

Philosophie de la méthode en génie logiciel avec ADA
* ↑ wikipedia:Assembleur#Macro-assembleur

# Comprendre les options de la commande mkd
## Généralités
### Syntaxe de la ligne de commande

    mkd [-ABCFPSafjlnpstvw] codes chemin_source [chemin_cible]

### Distinguer les options impératives

    Les options de langages en majuscules ABCFPS permettent d'extraire les commentaires codés dans un style de langage générique.
       Le style C par exemple peut décoder le C, c++, c--, c#, CSS, java, javascript, php
    Les options de langage en minuscules l et p
       Ces options dépendent de la compilation CD1, CD2, CD3, CD4, CD5. On peut connaître ces options par la commande mkd \?; options l et p
       Les options -l d'extraction des lignes peuvent être utilisées simultanément;
       les options -l; CD1 et CD2 :'%' '<' et CD3 '!' on peut simultanément extraire le PostsScript, les tags html, les commentaires Fortran 90
       L'option -p d'extraction de blocs permet d'extraire des blocs de chaînes de caractères avec les options CD4=CD5= '\"'. CD1 '(' avec CD5 ')' permet d'extraire des blocs entre parenthèses

### Les options d'extraction et d'ouverture des fichiers anstvw

    L'ouverture des fichiers peut être la création du fichier cible avec l'option -w ou l'ajout avec l'option -a
    Les options nstv sont des options d'extration et d'affichage
       n permet de connaître le numéro de la ligne extraite
       s permet une copie vers la sortie standard (un écran, un fichier, une imprimante, etc.
       t permet d'éliminer les codes d'extraction et les caractères de début et de fin de commentaire
       v mode bavard qui permet d'afficher les conditions d'extraction au terminal ou à la sortie standard

## Exercices élémentaires pour se familiariser avec la commande mkd
#### Commande: mkd -Cwsv H cpp.c

    en mode bavard (-v), vous devez obtenir à la console:
    Le fichier cpp.doc contient:
       Notez qu'avec l'option -v on ne peut pas obtenir un fichier d'entête cpp.h car cette option crée une première ligne avec le nom du fichier.

#### Commande: mkd -Cws H cpp.c

    Sans l'option -v on obtient au terminal:
    Le fichier cpp.doc contient:
       Les options Cw ou Cws ne suffisent pas pas pour créer le fichier d'entête cpp.h car les caractères de commentaires sont recopiés.

#### Commande: mkd -Cwts H cpp.c

Avec l'option -t et sans l'option -v on obtient au terminal:
    Le fichier cpp.doc contient:

#### Commande: mkd -Cwt H cpp.c *.h

    Cette fois le fichier d'entête cpp.h peut être créé correctement et cette syntaxe doit être employée dans les fichiers de commandes, ainsi que dans les Makefiles

#### Résumé des observations sur les options s, t, v

* L'option -v, mode bavard, est inappropriée pour générer des documents imprimables. Elle sert pour la mise au point des fichiers de commandes avec l'option -s
* L'option -s permet la mise au point des fichiers de commandes sans nécessité d'éditer le fichier cible.
* L'option -t est nécessaire pour obtenir des document présentables et imprimables.

#### Créez ou écrasez le fichier cible de l'organigramme cpp.organigramme

* Organigramme simple avec numérotation des lignes:
mkd -Cnstw O cpp.c cpp.organigramme
* Organigramme avec structure avec numérotation des lignes:
mkd -Cnstw OS cpp.c cpp.organigramme
* Organigramme complet avec les tests warnings et numérotation des lignes:
mkd -Cnstw POSTw cpp.c cpp.organigramme

#### Crééz ou écrasez le fichier de documentation logicielle html du fichier cpp.c

* Familiarisation avec l'option -a
mkd -Ctw h cpp.c cpp-documentation_logicielle_codage.html
mkd -Cat d cpp.c cpp-documentation_logicielle_codage.html
mkd -Cat f cpp.c cpp-documentation_logicielle_codage.html
* Solution globale pour un seul fichier:
mkd -Cat hdf cpp,c cpp-documentation_logicielle_codage.html

## Notes et références

Notez que:
    Les options impératives -ABCFPS sont incompatibles entre elles et avec l'option -f (find - trouver le style du langage de programmation).
    Les options -a (append - ajouter) et -w (overwrite - écraser) sont difficilement compatibles ...

# Comprendre les fichiers de projets pour mkd
## Exercices pour se familiariser avec les fichiers de projets

Les fichiers de projets d'extension .prj ou .pj sont des fichiers qui contiennent la liste des fichiers (sources) pour générer les documents (cibles).
Les fichiers de la liste ont parfois des extensions différentes.
Si les fichier sont tous de même style de commentaires on peut imposer une des options impératives pour générer les documents, mais pour utiliser un fichier de projet il est nécessaire de préciser que le fichier source est un fichier de projet avec l'option -j souvent associé à l'option -f (find). Dans le cas où find ne trouve pas le type de fichier, les styles compilés sont proposés à la sortie standard (Terminal en général) L'option -j est compatible avec les options impératives.

#### Créer un fichier de projet manuellement

Projet exercice.prj ; à créer manuellement avec les fichiers disponibles asm.c cpp.c putchar.s
Manuellement on est maître de la liste des fichier et de l'ordre nécessaire au décodage.
Nom du fichier de projet exercice.prj ; dans l'ordre alphabétique:

#### Créer un fichier de projet avec les commandes système

Projet exercice.prj ; à créer avec les commandes de votre système d'exploitation; ls, dir.
* Avec terminal linux: ls
Fichier exercice.prj : La mise en ordre alphabétique est automatique.
* Avec terminal cmd Windows 7, dir: option /B: noms courts, et option /ON: tri alphabétique. Notez que le terminal PowerShell ne convient pas.
Fichier exercice.prj :

#### Créer un fichier de commandes pour :

Vous aurez copié les fichiers à éprouver dans le répertoire des essais . exécutez la commande mkd \? pour visualiser les extensions reconnues par votre mkd. Ces extensions dépendent des options de compilation.
Les fichiers sont écrits dans des langages de programmation différents, le but est de créer des documentations globales avec ou sans le finder (option -f).

##### Mettre à jour le fichier d'entête. header global

exercice.h
La commande doit trouver le type de fichier du projet exercice.prj avec l'option -f
Fichier exercice.h:

##### Mettre à jour l'organigramme de chaque fichier de programme

Pseudo-code; Code de repérage 'O',
asm.org, cpp.org, putchar.org
* mkd -Cstw O asm.c asm.org
* mkd -Cstw O cpp.c cpp.org
* mkd -Astw O putchar.asm putchar.org
(L'exemple putchar avec MASM est forcément sous MS-DOS)
Fichier putchar.org:
Notez que la première ligne est correcte: macro.asm, alors que les commentaires qui suivent sont précédés du caractère O du fait que toute la ligne est recopiée sauf le caractère ; (Ceci est dû à l'option de compilation FULL LINE): La copie de la ligne est entière le caractère de commentaire est remplacé par un espace ligne 256 du fichier asm.c. (Voir asm.struct de l'exercice suivant "Mettre à jour la structure de chaque fichier") Pour éviter ce qui pourrait être un inconvénient il suffit de recompiler mkd sans l'option FULL_LINE. Pour une bonne présentation on a toujours intérêt à écrire le pseudo-code sur des lignes séparées avec le caractère ; en première colonne.
Bug: Un des bugs connus est la fin de ligne qui se termine par EOF à la place de EOL (NL retour chariot)

##### Mettre à jour la structure de chaque fichier

avec le pseudo code. Code 'S' et 'O' et 'w',
asm.struct
mkd -Cswn OSw asm.c asm.struct
Fichier asm.struct (édité avec Bluefish)
Notez la fin de fichier avec le caractère ÿ qui témoigne d'une fin incorrecte sur EOF
putchar.struct
mkd -Aswn OSw putchar.asm putchar.struct
Notez la fin de fichier correcte qui témoigne d'une fin correcte sur EOL (New Line) Notez aussi qu'un des caractères n'est pas au format UTF-8 (le é de défini)

##### Mettre à jour la documentation globale pour les programmeurs

avec les dates de mise à jour etc. Code 'P'
exercice.info_programmeurs
mkd -fjstw P exercice.prj *.info_programmeurs

##### Mettre à jour de la documentation logicielle globale

(Conception détaillée, Tests unitaires, du cycle en V) Code 'D'
exercice.docu
mkd -fjst D exercice.prj *.docu

## Notes et références
# Codes QR des téléchargements

Cette page est susceptible de subir des modifications occasionnelles
Les codes QR (Quick Response) permettent aux lecteurs des pages imprimées de se connecter rapidement sur le wikilivre à l'aide d'un lecteur de codes QR (disponible sur les smartphones) pour:
    recompiler le livre sous une forme différente ou obtenir une version à jour,
    compiler d'autres pages.
* Article wikibook Mkd Extracteur de documents
* Compilation La commande mkd avec QR des téléchargements
* Compilation pour ePub Exercices avec mkd, avec les réponses aux exercices
* Compilation:Extracteur de documents mkd avec Exercices et QR des téléchargements
* Packs mkd sources + binaires Ubuntu (i386+amd64) Téléchargement
* Packs mkdcppw sources + binaires Ubuntu (i386+amd64) Téléchargement
* mkd Windows Beta 2010 (x86) Téléchargement Lien à corriger

# Licence de documentation libre GNU
### Résumé

La licence de documentation libre GNU (GNU Free Documentation License) est une licence produite par la Free Software Foundation. Cette licence a pour but de permettre la diffusion de contenu libre.
L'objet de cette Licence est de rendre tout manuel, livre ou autre document écrit « libre » au sens de la liberté d'utilisation, à savoir : assurer à chacun la liberté effective de le copier ou de le redistribuer, avec ou sans modifications, commercialement ou non.
Attention, contenu libre ne veut pas dire domaine public. Les différents créateurs de documents sous licence GFDL restent propriétaire de leurs écrits ou de leurs images. La licence GNU requiert que les auteurs gardent le crédit de leurs contributions. Pour cette raison, toute utilisation de document sous licence GFDL doit mentionner la source de ce contenu (par exemple, soit en créditant l'organisation d'où origine le document ou encore le document directement).
* en français (traduction non officielle, version 1.1): http://cesarx.free.fr/gfdlf.html
* version officielle en anglais: http://www.gnu.org/copyleft/fdl.html