Comment ouvrir un POD et le convertir en PDF pour lire la documentation Perl
Alors que Perl était autrefois un langage indispensable pour la programmation Web, il a maintenant été remplacé par des langages plus modernes tels que Python, Ruby et JavaScript. Peu de gens pensent qu’apprendre Perl en vaut la peine de nos jours.
Mais cela ne signifie pas que le langage est inutile ou obsolète. En fait, de nombreux sites Web et outils Web modernes dépendent encore de Perl pour leurs opérations quotidiennes – y compris Craigslist, IMDb et DuckDuckGo – donc si vous êtes intéressé à l’apprendre, ne laissez personne s’arrêter ou décourager tu.
Si vous voulez apprendre Perl, vous devez également être familiarisé avec POD. Voici ce que c’est, pourquoi c’est important et que faire lorsque vous rencontrez de tels fichiers.
Qu’est-ce qu’un fichier POD ?
POD signifie Plain Old Document et c’est un langage de balisage de base pour formater du texte sans trop d’effort. Il est similaire au langage de balisage Markdown, mais spécifiquement conçu pour documenter le code source et les modules Perl.
Les POD peuvent être utilisés de deux manières : Il peut exister directement dans le code source du fichier Perl ou sous la forme d’un fichier POD séparé. Lorsqu’il existe dans le code, vous pouvez le considérer comme un commentaire dans n’importe quel autre langage de programmation, sauf plus sophistiqué et plus flexible.
Faire une vidéo du jour
#!/usr/bin/perl
utiliser strict ;
utiliser l’avertissement ;
= gousse
=head1 Exemple de titre
Ce script fait des trucs sympas comme ceci et cela. Les paramètres suivants doivent être présents pour que cela fonctionne. N’essayez pas de le faire sur la machine en question.
= couper
print « Exécutez simplement ce code.
» ;
La documentation intégrée est idéale pour les scripts autonomes ou lorsque vous voulez vous assurer que toute personne rencontrant le fichier a également un accès garanti à la documentation, mais peut être fastidieuse lorsque vous souhaitez documenter l’intégralité de votre base de code à un niveau supérieur.
Heureusement, les POD peuvent également être utilisés pour créer des pages de type manuel qui conviennent mieux à la documentation destinée à l’utilisateur. (parce que l’utilisateur peut ne pas vouloir creuser dans le code source du script lui-même). C’est là que les fichiers POD sont utiles.
Comment lire les fichiers POD
Pour être clair, la documentation POD intégrée se trouve dans les fichiers de script Perl réels entre les lignes de code, et ces fichiers de script sont dans l’un des deux formats étendus : .PL ou .PM. Lorsque vous voyez l’extension .POD, cela indique que le fichier est un document pur et ne contient aucun code source.
Bien que vous puissiez ouvrir des fichiers POD dans n’importe quel éditeur de texte, y compris le Bloc-notes, vous ne souhaitez probablement le faire que lors de la modification du document d’origine lui-même. Pensez-y comme si vous ouvriez un fichier HTML dans un éditeur : avec tout le balisage, le contenu réel du texte est difficile à lire.
Au lieu de cela, vous devez utiliser une sorte d’outil de lecture pour obtenir la documentation POD brute et la rendre dans un format facile à lire.
Le plus simple est d’utiliser
perldoc
Un outil en ligne de commande qui est automatiquement inclus lorsque Perl est installé sur votre système. La plupart des systèmes OS X et Linux ont déjà installé Perl, mais les utilisateurs de Windows doivent l’installer manuellement. (Heureusement, ce n’est pas plus difficile que d’exécuter le fichier d’installation.)
Maintenant, démarrez la ligne de commande, accédez à l’emplacement du fichier POD et tapez
perldoc [.POD file]
Affichez-le dans le bon format.Par exemple, si le nom du fichier est bibliothèque.pod Ensuite, vous taperiez
bibliothèque perldoc.pod
C’est ça.
Comment convertir POD vers d’autres formats
même si
perldoc
L’outil n’est pas trop difficile à utiliser et il n’est pas très pratique lorsque vous souhaitez partager des documents avec d’autres ou les lire à partir de votre ordinateur. À ce stade, vous voudrez peut-être envisager de convertir vers un autre format.
Convertir en HTML : Installez et utilisez l’outil pod2html, qui permet de convertir facilement n’importe quel fichier POD en un fichier HTML lisible. Malheureusement, il ne peut effectuer que des conversions un à un (vous ne pouvez donc pas combiner plusieurs fichiers POD en un seul fichier HTML).
Convertir en PDF : Installez et utilisez l’outil pod2pdf, qui est similaire et facile à utiliser comme l’outil pod2html ci-dessus, sauf qu’il convertit en PDF au lieu de HTML.
Une autre option consiste à convertir le POD en HTML à l’aide de la méthode indiquée ci-dessus, à ouvrir le fichier HTML dans un navigateur tel que Chrome ou Firefox et à imprimer la page au format PDF.
Convertir en démarque : Installez et utilisez l’outil pod2markdown pour convertir entre POD et Markdown. Markdown est un langage de balisage à usage général, ce qui signifie que les utilisateurs sont plus susceptibles de le connaître et qu’il existe davantage d’outils pour accepter et afficher Markdown.
Convertir en LaTeX : Installez et utilisez l’outil pod2latex. LaTeX est un autre langage de balisage moins courant que Markdown, mais toujours plus populaire que POD. LaTeX est principalement utilisé pour les documents académiques et scientifiques, mais si vous en avez besoin, ce convertisseur existe.
Convertir en texte brut : Installez et utilisez l’outil pod2text, qui génère des fichiers de texte brut au format ASCII. Vous n’avez probablement pas besoin de l’utiliser, mais si jamais vous le faites, sachez que l’option existe.
Cet article a-t-il été utile?
Une fois que vous avez compris, les fichiers POD sont assez simples à utiliser. Il y a un peu de courbe d’apprentissage, mais très petite – surtout si vous avez déjà travaillé avec des langages de balisage. J’espère que vous pouvez maintenant gérer facilement les fichiers POD.
Si vous vous sentez dépassé, posez-vous ces questions importantes pour les codeurs novices. Avoir des problèmes ne signifie pas nécessairement que vous n’êtes pas un programmeur, mais il est important d’être honnête avec vous-même et de gérer vos attentes.
Cela dit, faites attention à ces conseils pour apprendre à coder sans stress et savoir faire la différence entre les bons tutoriels de codage et les mauvais.
Que fais-tu avec Perl ? Vous avez d’autres conseils à partager ou des questions à poser ? Faites-nous savoir dans les commentaires ci-dessous!
A propos de l’auteur
