Qu'est-ce que le format de fichier POD ?
Un fichier .pod est un fichier de documentation pour le langage de programmation Perl. Les fichiers POD utilisent une syntaxe de balisage spéciale pour une meilleure lisibilité et fonctionnalité. La syntaxe est très basique et hautement standardisée - il n'y a aucune option pour changer la taille ou la couleur de la police, ajouter des images ou des tableaux. Cela permet aux fichiers .pod d'être facilement convertis vers d'autres formats tels que HTML, TeX, Markdown et XML. Les fichiers .pod peuvent être lus de manière interactive avec l'outil perldoc.
La *Plain Old Documentation* est un langage de balisage très pratique, adapté à la création de fichiers de documentation logicielle clairs et succincts. La plupart des documentations pour les modules et distributions Perl publiés sur le CPAN sont écrites dans ce format.
En plus d'apparaître comme des fichiers .pod autonomes, la documentation POD peut être intégrée directement à l'intérieur des fichiers sources .pl et .pm entre les lignes de marquage =pod et =cut - l'interprète Perl ignore simplement ces sections lors de la compilation. Le format POD définit trois types de paragraphes : les paragraphes de commande commençant par = (tels que =head1, =over, =item, =back, =cut), les paragraphes textuels (indentés par des espaces blancs) et les paragraphes de texte ordinaire avec des codes de formatage en ligne comme B<>, I<>, C<> et L<>. L'encodage des caractères est déclaré avec =encoding utf-8.
Les documents POD peuvent être facilement convertis en manuels d'aide système (pages man) à l'aide de pod2man, en HTML avec pod2html, ou en texte brut avec pod2text.
Sécurité et sûreté
RISQUE : LOWUn véritable fichier Perl POD est du texte brut sans code exécutable, il est donc sûr de l'ouvrir dans n'importe quel éditeur. Deux précautions : (1) si un .pod est en réalité une archive de jeu Terminal Reality, il est binaire - n'essayez pas de le « réparer » comme du texte ; ouvrez-le avec un extracteur spécifique au jeu. (2) Le format POD intégré réside dans le code source Perl .pl/.pm - la documentation est inerte, mais le code Perl environnant est un programme ; n'exécutez que des scripts en lesquels vous avez confiance.
Détails du format
en bref- Archive de jeu Terminal Reality POD - Une archive de ressources de jeu compressée (.pod) utilisée par les titres du moteur Terminal Reality (ex: BloodRayne, FaceOff) ; une archive binaire, pas de la documentation.
- Fichier média Podcast - Certaines applications ou flux étiquettent les épisodes audio téléchargés en .pod ; en pratique, il s'agit d'audio MP3/AAC, pas d'un format distinct.
- VMware / virtualisation et données diverses - Quelques outils utilisent .pod pour leurs propres données (ex: fichiers de données portables/compressés) ; sans rapport avec la documentation Perl.
Programmes qui ouvrent les fichiers POD
Windows3 apps
Notepad
Open-source Ouvrez le .pod pour lire/modifier le balisage brut ; installez un plugin POD/perldoc ou utilisez la chaîne d'outils Perl pour le rendu. 
Strawberry Perl (perldoc / pod2html)
Open-source Lancez « perldoc file.pod » pour le lire avec mise en forme, ou « pod2html file.pod > file.html » pour générer une page web. 
Visual Studio Code
Gratuit Ouvrez le .pod comme du texte ; une extension Perl ajoute la coloration syntaxique et l'aperçu POD. 
macOS2 apps
perldoc (built-in Perl)
Open-source macOS inclut Perl : « perldoc file.pod » assure le rendu ; « pod2html »/« pod2man » permettent la conversion. 
Linux2 apps
perldoc / pod2man / pod2html
Open-source « perldoc file.pod » pour lire ; « pod2man file.pod | man -l - » pour une page man ; « pod2html » pour le HTML.
gedit / any text editor
Open-source Ouvrez le .pod comme texte brut pour visualiser ou modifier le balisage POD brut. Détails techniques
spécifications approfondies| Type de format | Langage de balisage léger en texte brut |
| Types de paragraphes | Commande (=head1, =over, =item, =cut), textuel (lignes indentées) et texte ordinaire |
| Marqueurs de commande | Lignes commençant par « = » à la colonne 1 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Codes de formatage en ligne | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> pour le gras, l'italique, le code, les liens, les entités, l'espace insécable, l'entrée d'index et l'effet nul |
| Déclaration d'encodage | =encoding suivi d'un nom de jeu de caractères IANA (ex: utf-8) placé dans le premier paragraphe de commande |
| Type MIME | text/x-pod (principal) ; text/plain également accepté |
| Intégration dans le code source | Peut être placé à l'intérieur des fichiers .pl / .pm entre =pod et =cut ; le compilateur Perl ignore ces blocs à l'exécution |
| Outils de conversion | pod2man (pages man), pod2html (HTML), pod2text (texte brut), pod2latex (LaTeX) - tous fournis avec Perl ou disponibles sur le CPAN |
| Visionneuse interactive | perldoc lit le format POD à partir des modules Perl installés ou des fichiers .pod autonomes |
| Taille de fichier typique | 1 Ko - 200 Ko |
| Prise en charge des plateformes | Multiplateforme - partout où Perl s'exécute (Linux, macOS, Windows, *BSD) |
| Identification du fichier | Pas d'octets magiques binaires ; identifié par les paragraphes « =commande » (=head1, =pod, etc.) commençant à la colonne 1 |
| Extensions sources associées | .pl (scripts), .pm (modules), .t (fichiers de test) |
| Développeur | Larry Wall et l'équipe principale de Perl (Perl Foundation) |
| Portée de la documentation | Utilisé pour la documentation des modules, les descriptions de scripts, les tutoriels et les FAQ dans tout l'écosystème Perl |
| Publié | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Dernière version | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Standard ouvert | Oui · libre de droits |
| Spécification | perldoc.perl.org |
Conversions POD
Q&R de la communauté
posées par les utilisateursPas encore de questions - soyez le premier à poser une question sur les fichiers POD.
