Comment ouvrir et convertir POD en PDF pour lire la documentation Perl

Un fichier POD est l'ancienne documentation du langage de programmation Perl. Nous vous montrons comment convertir POD en PDF, HTML, Markdown, LaTeX, ou en texte brut.

Un fichier POD est l'ancienne documentation du langage de programmation Perl.  Nous vous montrons comment convertir POD en PDF, HTML, Markdown, LaTeX, ou en texte brut.
Publicité

Bien que ce fut une langue intégrale pour la programmation web Quel langage de programmation pour apprendre - Programmation Web Quel langage de programmation pour apprendre - Programmation Web Aujourd'hui, nous allons jeter un oeil aux différents langages de programmation Web qui alimentent l'Internet. C'est la quatrième partie d'une série de programmation pour débutants. Dans la partie 1, nous avons appris la base de ... Lire la suite, Perl est maintenant tombé au bord du chemin en faveur de langages plus modernes comme Python, Ruby et JavaScript. Très peu de gens pensent que ça vaut la peine d'apprendre Perl ces jours-ci.

Mais cela ne veut pas dire que la langue est inutile ou obsolète. En fait, beaucoup de sites Web modernes et d'outils Web dépendent toujours de Perl pour les opérations quotidiennes, y compris Craigslist, IMDb et DuckDuckGo. Si vous êtes intéressé à l'apprendre, ne laissez personne vous arrêter ou dissuader. 7 trucs utiles pour maîtriser un nouveau langage de programmation 7 astuces utiles pour maîtriser un nouveau langage de programmation Il est normal d'être submergé lorsque vous apprenez à coder. Vous oublierez probablement les choses aussi vite que vous les apprenez. Ces conseils peuvent vous aider à mieux conserver toutes ces nouvelles informations. Lire la suite .

Si vous allez apprendre Perl, vous voudrez aussi vous familiariser avec POD. Voici ce que c'est, pourquoi c'est important, et que faire quand vous rencontrez de tels fichiers.

Que sont les fichiers POD?

POD signifie Plain Old Documentation, qui est un langage de balisage de base utilisé pour mettre en forme du texte sans trop d'effort. C'est similaire au langage de balisage Markdown Qu'est-ce que Markdown? 4 raisons pour lesquelles vous devriez apprendre maintenant Qu'est-ce que Markdown? 4 raisons pour lesquelles vous devriez apprendre maintenant fatigué des éditeurs HTML et WYSIWYG? Alors Markdown est la réponse pour vous, peu importe qui vous êtes. Lire la suite, mais spécifiquement conçu pour documenter le code source Perl et les modules.

POD peut être utilisé de deux manières: il peut exister directement dans le code source d'un fichier Perl OU il peut exister sous la forme d'un fichier POD distinct. Quand il existe dans le code, vous pouvez y penser comme des commentaires dans n'importe quel autre langage de programmation, sauf colombophile et plus flexible.

#!/usr/bin/perl

utiliser strict;

utiliser des avertissements;

= pod

= head1 Exemple d'en-tête

Ce script fait des trucs sympas, comme ceci et cela. Les paramètres suivants doivent exister pour qu'il fonctionne correctement. N'essayez pas de le faire sur une machine avec des problèmes.

= couper

print "Seul ce code est exécuté. \ n ";

La documentation intégrée fonctionne bien 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 elle peut être lourde lorsque vous voulez documenter une base de code entière à un niveau supérieur.

Heureusement, le POD peut également être utilisé pour créer des pages de type manuel mieux adaptées aux documents orientés utilisateur (puisque les utilisateurs peuvent ne pas vouloir se plonger dans le code source d'un script lui-même). C'est à ce moment 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 viennent dans l'un des deux formats d'extension: .PL ou .PM. Lorsque vous voyez une extension .POD, cela indique que le fichier est une documentation pure et ne contient aucun code source.

Bien qu'il soit possible d'ouvrir des fichiers POD dans n'importe quel éditeur de texte, y compris le Bloc-notes, vous ne voulez probablement le faire que si vous modifiez réellement la documentation brute elle-même. Pensez-y comme l'ouverture d'un fichier HTML dans un éditeur: avec tout le balisage, le contenu du texte est difficile à lire.

pod-documentation-editing

Au lieu de cela, vous devriez utiliser une sorte d'outil de lecture qui prend la documentation brute de POD et la présente d'une manière facile à lire.

Le plus simple est d'utiliser l'outil de ligne de commande perldoc qui est automatiquement inclus lorsque Perl est installé sur votre système. Perl est déjà installé sur la plupart des systèmes OS X et Linux, mais les utilisateurs Windows devront l'installer manuellement. (Heureusement, ce n'est pas plus difficile que d'exécuter un fichier d'installation.)

Maintenant, lancez la ligne de commande, naviguez jusqu'à l'emplacement du fichier POD et tapez perldoc [.POD file] pour l'afficher correctement formaté. Par exemple, si le fichier s'appelait library.pod, vous devez taper perldoc library.pod et c'est tout.

Comment convertir POD en d'autres formats

Même si l'outil perldoc n'est pas trop difficile à utiliser, ce n'est pas très pratique lorsque vous voulez partager la documentation avec d'autres personnes ou lorsque vous voulez la lire à partir de votre ordinateur. C'est quand vous voudrez peut-être envisager de convertir dans un autre format.

Conversion au format HTML: installez et utilisez l'outil pod2html qui fournit un moyen facile de traduire n'importe quel fichier POD en un fichier HTML lisible. Malheureusement, il ne peut effectuer qu'une conversion un-à-un (vous ne pouvez donc pas combiner plusieurs fichiers POD dans un seul fichier HTML).

Convertir en PDF: Installez et utilisez l'outil pod2pdf, qui est similaire à l'outil pod2html et qui est aussi facile à utiliser que celui-ci, sauf qu'il est converti en PDF plutôt qu'en HTML.

Une autre option serait de convertir POD en HTML en utilisant la méthode indiquée ci-dessus, ouvrez le fichier HTML dans un navigateur comme Chrome ou Firefox, puis imprimez la page au format PDF.

pod-documentation-markdown

Conversion en Markdown: installez et utilisez l'outil pod2markdown pour traduire entre POD et Markdown. Markdown est un langage de balisage général, ce qui signifie que les utilisateurs sont plus susceptibles de le connaître et qu'il existe d'autres outils qui peuvent accepter et afficher Markdown.

Conversion en LaTeX: installez et utilisez l'outil pod2latex. LaTeX est un autre langage de balisage, moins commun que Markdown, mais plus populaire que le POD. LaTeX est principalement utilisé dans les documents académiques et scientifiques, mais au cas où vous en auriez besoin, ce convertisseur existe.

Conversion en texte brut: installez et utilisez l'outil pod2text, qui produit un fichier texte uniquement avec formatage ASCII. Vous n'aurez probablement pas besoin de l'utiliser, mais au cas où vous le feriez, sachez que l'option existe.

Ce message était-il utile?

Une fois que vous avez compris, les fichiers POD sont extrêmement simples et pratiques à utiliser. Il y a un peu de courbe d'apprentissage, mais c'est très mineur - surtout si vous avez déjà utilisé un langage de balisage. J'espère que vous vous sentez à l'aise avec les fichiers POD.

Si vous vous sentez dépassé, posez-vous ces questions importantes pour les codeurs débutants 4 Questions à vous poser avant d'apprendre à coder 4 Questions à vous poser avant d'apprendre à coder L'apprentissage d'un langage de programmation est populaire. Mais est-ce pour tout le monde? Avant de vous y engager, posez-vous les questions suivantes et soyez honnête. Lire la suite . Avoir de la difficulté ne signifie pas nécessairement que vous n'êtes pas destiné à être un programmeur 6 Signes que vous n'êtes pas censé être un programmeur 6 Signs que vous n'êtes pas censé être un programmeur Tout le monde n'est pas découpé pour être un programmeur. Si vous n'êtes pas complètement sûr que vous êtes destiné à être programmeur, voici quelques signes qui pourraient vous orienter dans la bonne direction. Lire la suite, mais il est important d'être honnête avec vous-même et de gérer vos attentes.

Cela étant dit, tenez compte de ces conseils pour apprendre à coder sans stress Comment apprendre sans programmer tout stress Comment apprendre à programmer sans stress Peut-être que vous avez décidé de poursuivre la programmation, que ce soit pour une carrière ou tout simplement un passe-temps. Génial! Mais peut-être que vous commencez à vous sentir dépassé. Pas si bien. Voici de l'aide pour faciliter votre voyage. Lire la suite et savoir comment dire de bons tutoriels de codage à partir de mauvais Qu'est-ce qu'un bon tutoriel de programmation? Qu'est-ce qui fait un bon tutoriel de programmation? Tous les didacticiels de programmation ne sont pas égaux. Certains vous profitent et d'autres finissent par perdre votre temps. Voici ce qu'il faut rechercher dans un didacticiel de programmation de qualité. Lire la suite .

À quoi utilisez-vous Perl? Vous avez d'autres conseils à partager ou des questions à poser? Faites-nous savoir dans les commentaires ci-dessous!

In this article