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)

Administration Linux avec PowerShell

Magazine
Marque
Linux Pratique
Numéro
140
Mois de parution
novembre 2023
Spécialité(s)
Résumé

Rassurez-vous, nous n’allons pas vous entraîner vers le Mordor ou autres terres maléfiques dans cet article. Cependant, en tant que fan de Tux, il est fort probable que nous n’ayez jamais voyagé dans cette lointaine contrée que constitue l’univers Microsoft et plus particulièrement PowerShell dans sa version Linux.

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.

Les derniers articles Premiums

Les derniers articles Premium

Brève introduction pratique à ZFS

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

Il est grand temps de passer à un système de fichiers plus robuste et performant : ZFS. Avec ses fonctionnalités avancées, il assure une intégrité des données inégalée et simplifie la gestion des volumes de stockage. Il permet aussi de faire des snapshots, des clones, et de la déduplication, il est donc la solution idéale pour les environnements de stockage critiques. Découvrons ensemble pourquoi ZFS est LE choix incontournable pour l'avenir du stockage de données.

Générez votre serveur JEE sur-mesure avec Wildfly Glow

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

Et, si, en une ligne de commandes, on pouvait reconstruire son serveur JEE pour qu’il soit configuré, sur mesure, pour les besoins des applications qu’il embarque ? Et si on pouvait aller encore plus loin, en distribuant l’ensemble, assemblé sous la forme d’un jar exécutable ? Et si on pouvait même déployer le tout, automatiquement, sur OpenShift ? Grâce à Wildfly Glow [1], c’est possible ! Tout du moins, pour le serveur JEE open source Wildfly [2]. Démonstration dans cet article.

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 123 listes de lecture

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous