Documenter avec POD

Magazine
Marque
Linux Pratique
Numéro
141
Mois de parution
janvier 2024
Spécialité(s)


Résumé

Il 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] ou...

Cet article est réservé aux abonnés. Il vous reste 96% à découvrir.
S'abonner à Connect
  • 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
Je m'abonne
Références

[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

 



Article rédigé par

Par le(s) même(s) auteur(s)

Présenter avec Marp

Magazine
Marque
Linux Pratique
Numéro
132
Mois de parution
juillet 2022
Spécialité(s)
Résumé

Alternative à des logiciels bureautiques tels que PowerPoint ou Impress, Marp est une solution efficace pour créer des présentations à l’aide de Markdown. Inutile donc d’utiliser une application dédiée, il suffit de disposer d’un simple éditeur de texte et surtout, d’avoir un bon plan et de bonnes idées.

Perl pour les administrateurs systèmes

Magazine
Marque
Linux Pratique
Numéro
129
Mois de parution
janvier 2022
Spécialité(s)
Résumé

Depuis 1987, Perl a su évoluer et intégrer de nombreuses technologies jusqu’à éclipser son successeur Raku. Partons à la découverte de ce langage et de son riche écosystème afin de comprendre pourquoi il est toujours indissociablement lié à l’administration système.

Les derniers articles Premiums

Les derniers articles Premium

Les nouvelles menaces liées à l’intelligence artificielle

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Sommes-nous proches de la singularité technologique ? Peu probable. Même si l’intelligence artificielle a fait un bond ces dernières années (elle est étudiée depuis des dizaines d’années), nous sommes loin d’en perdre le contrôle. Et pourtant, une partie de l’utilisation de l’intelligence artificielle échappe aux analystes. Eh oui ! Comme tout système, elle est utilisée par des acteurs malveillants essayant d’en tirer profit pécuniairement. Cet article met en exergue quelques-unes des applications de l’intelligence artificielle par des acteurs malveillants et décrit succinctement comment parer à leurs attaques.

Migration d’une collection Ansible à l’aide de fqcn_migration

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Distribuer du contenu Ansible réutilisable (rôle, playbooks) par l’intermédiaire d’une collection est devenu le standard dans l’écosystème de l’outil d’automatisation. Pour éviter tout conflit de noms, ces collections sont caractérisées par un nom unique, formé d’une espace de nom, qui peut-être employé par plusieurs collections (tel qu'ansible ou community) et d’un nom plus spécifique à la fonction de la collection en elle-même. Cependant, il arrive parfois qu’il faille migrer une collection d’un espace de noms à un autre, par exemple une collection personnelle ou communautaire qui passe à un espace de noms plus connus ou certifiés. De même, le nom même de la collection peut être amené à changer, si elle dépasse son périmètre d’origine ou que le produit qu’elle concerne est lui-même renommé.

Mise en place d'Overleaf Community pour l’écriture collaborative au sein de votre équipe

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Si vous utilisez LaTeX pour vos documents, vous connaissez vraisemblablement Overleaf qui vous permet de rédiger de manière collaborative depuis n’importe quel poste informatique connecté à Internet. Cependant, la version gratuite en ligne souffre de quelques limitations et le stockage de vos projets est externalisé chez l’éditeur du logiciel. Si vous désirez maîtriser vos données et avoir une installation locale de ce bel outil, cet article est fait pour vous.

Les listes de lecture

9 article(s) - ajoutée le 01/07/2020
Vous désirez apprendre le langage Python, mais ne savez pas trop par où commencer ? Cette liste de lecture vous permettra de faire vos premiers pas en découvrant l'écosystème de Python et en écrivant de petits scripts.
11 article(s) - ajoutée le 01/07/2020
La base de tout programme effectuant une tâche un tant soit peu complexe est un algorithme, une méthode permettant de manipuler des données pour obtenir un résultat attendu. Dans cette liste, vous pourrez découvrir quelques spécimens d'algorithmes.
10 article(s) - ajoutée le 01/07/2020
À quoi bon se targuer de posséder des pétaoctets de données si l'on est incapable d'analyser ces dernières ? Cette liste vous aidera à "faire parler" vos données.
Voir les 121 listes de lecture

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous