Ajouter à une liste de lectureIl existe de nombreux outils logiciels pour écrire de la documentation. La plupart sont plutôt orientés vers les programmeurs, mais certains sont plus polyvalents. Ils s’adaptent parfaitement à différents publics tels que les administrateurs systèmes. Le format POD en fait partie.
Le format POD (Plain Old Documentation) est un langage de balisage léger conçu originellement pour l’écosystème du langage Perl. L’objectif était de fournir un format simple pour écrire de la documentation et un ensemble d’outils logiciels pour la manipuler ou la transformer. D’un point de vue historique, le format POD est apparu en octobre 1994 avec la version 5 du langage. Il peut donc être considéré comme étant l’un des plus anciens formats de documentation électronique prenant en compte l’interopérabilité et la préservation de son contenu. POD répond aux critères du Single-source publishing [1] puisqu’un même document peut être publié vers de multiples formats.
1. Mise en œuvre de POD
L’utilisation de POD n’implique pas l’installation de nombreux outils accompagnés de multiples dépendances. Contrairement à une solution de type Markdown qui va généralement nécessiter l’usage de logiciels complexes tels que Pandoc [2]<…
- Accédez à tous les contenus de Connect en illimité
- Découvrez des listes de lecture et des contenus Premium
- Consultez les nouveaux articles en avant-première
[1] Single-source publishing : https://en.m.wikipedia.org/wiki/Single-source_publishing
[2] AUVERLOT O., « Produire des documents avec Pandoc », Linux Pratique n°110, novembre-décembre 2018, p. 22 à 29 : https://connect.ed-diamond.com/Linux-Pratique/lp-110/produire-des-documents-avec-pandoc
[3] Perl 5 pour Microsoft Windows : https://strawberryperl.com
[4] Le module Pod::Simple : https://metacpan.org/dist/Pod-Simple/view/lib/Pod/Simple.pod
[5] Formats d’encodage supportés : https://perldoc.perl.org/Encode::Supported
[6] L’utilitaire pod2html : https://metacpan.org/dist/perl/view/ext/Pod-Html/bin/pod2html
[7] Le serveur HTTP Plack : https://metacpan.org/pod/Plack
[8] La feuille de style water.css : https://watercss.kognise.dev
[9] L’utilitaire pod2man : https://metacpan.org/pod/pod2man
[10] Introduction à Makefile : https://gl.developpez.com/tutoriel/outil/makefile
