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

Publicité

Même si c'était une fois langage intégral pour la programmation web Quel langage de programmation apprendre - Programmation WebAujourd'hui, nous allons jeter un œil aux différents langages de programmation Web qui alimentent Internet. Ceci est la quatrième partie d'une série de programmation pour débutants. Dans la partie 1, nous avons appris les bases de ... Lire la suite , Perl est maintenant tombé au bord du chemin au profit de langages plus modernes comme Python, Ruby et JavaScript. Très peu de gens pensent que cela vaut la peine d’apprendre le Perl de nos jours.

Mais cela ne signifie pas que la langue est inutile ou obsolète. En fait, de nombreux sites Web et outils Web modernes dépendent toujours de Perl pour les opérations quotidiennes - y compris Craigslist, IMDb et DuckDuckGo - donc si vous êtes intéressé à l'apprendre, ne laissez personne vous arrêter ou vous dissuader 7 astuces utiles pour maîtriser un nouveau langage de programmationIl est normal d'être dépassé lorsque vous apprenez à coder. Vous oublierez probablement des 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 également vous familiariser avec POD. Voici ce que c'est, pourquoi c'est important et que faire lorsque 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 formater le texte sans trop d'effort. C'est similaire à le langage de balisage Markdown Qu'est-ce que Markdown? 4 raisons pour lesquelles vous devriez l'apprendre maintenantFatigué des éditeurs HTML et WYSIWYG? Alors Markdown est la réponse pour vous, peu importe qui vous êtes. Lire la suite , mais spécialement conçu pour documenter le code source et les modules Perl.

Le POD peut être utilisé de deux manières: il peut exister directement dans le code source d'un fichier Perl OU il peut exister en tant que fichier POD distinct. Lorsqu'il existe dans le code, vous pouvez le considérer comme des commentaires dans n'importe quel autre langage de programmation, sauf plus sophistiqué 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 présentant 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 quiconque rencontre le fichier aussi a un accès garanti à la documentation, mais cela peut être fastidieux lorsque vous souhaitez documenter une base de code entière à un niveau supérieur niveau.

Heureusement, POD peut également être utilisé pour créer des pages de type manuel mieux adaptées aux documents orientés utilisateur (car 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 des 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 disponibles dans l'un des deux formats d'extension: .PL ou .PM. Lorsque vous voyez une extension .POD, cela indique que le fichier est de la documentation pure et ne comprend 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 si vous ouvriez un fichier HTML dans un éditeur: avec tout le balisage, le contenu textuel réel est difficile à lire.

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

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

Lancez maintenant la ligne de commande, accédez à l'emplacement du fichier POD et tapez perldoc [fichier .POD] pour l'afficher comme correctement formaté. Par exemple, si le fichier a été nommé library.pod alors vous devez taper perldoc library.pod et c'est tout.

Comment convertir POD en d'autres formats

Même si le perldoc n’est pas trop difficile à utiliser, il n’est pas vraiment pratique lorsque vous souhaitez partager la documentation avec d’autres ou lorsque vous souhaitez la lire à distance de votre ordinateur. C'est à ce moment-là que vous voudrez peut-être envisager de convertir dans un autre format.

Conversion en HTML: Installez et utilisez le pod2html outil qui permet de traduire facilement 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 en un seul fichier HTML).

Conversion en PDF: Installez et utilisez le pod2pdf, qui est similaire et tout aussi facile à utiliser que l'outil pod2html ci-dessus, sauf qu'il se convertit en PDF plutôt qu'en HTML.

Une autre option serait de convertir le POD en HTML à l'aide de la méthode indiquée ci-dessus, d'ouvrir le fichier HTML dans un navigateur comme Chrome ou Firefox, puis d'imprimer la page au format PDF.

Conversion en Markdown: Installez et utilisez le pod2markdown outil pour traduire 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 d'autres outils qui peuvent accepter et afficher Markdown.

Conversion en LaTeX: Installez et utilisez le pod2latex outil. LaTeX est un autre langage de balisage, moins courant que Markdown, mais toujours plus populaire que POD. LaTeX est principalement utilisé dans les documents académiques et scientifiques, mais si vous en avez besoin, ce convertisseur existe.

Conversion en texte brut: Installez et utilisez le pod2text, qui produit un fichier texte uniquement avec un formatage ASCII. Vous n'aurez probablement pas besoin de l'utiliser, mais si jamais vous le savez, sachez que l'option existe.

Ce message a-t-il été 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 elle est très mineure - surtout si vous avez déjà utilisé un langage de balisage. J'espère que vous vous sentirez maintenant à l'aise avec les fichiers POD.

Si vous vous sentez dépassé, demandez-vous ces questions importantes pour les codeurs débutants 4 questions à se poser avant d'apprendre à coderL'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 des difficultés ne signifie pas nécessairement que vous n'êtes pas censé être programmeur 6 signes que vous n'êtes pas censé être programmeurTout le monde n'est pas conçu pour être programmeur. Si vous n'êtes pas complètement sûr d'être censé être programmeur, voici quelques signes qui peuvent 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 la programmation sans stressPeut-être que vous avez décidé de poursuivre la programmation, que ce soit pour une carrière ou simplement comme 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 sachant comment distinguer les bons tutoriels de codage des mauvais Qu'est-ce qui fait un bon tutoriel de programmation?Tous les didacticiels de programmation ne sont pas identiques. Certains vous profitent et d'autres finissent par perdre votre temps. Voici ce qu'il faut rechercher dans un tutoriel de programmation de qualité. Lire la suite .

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