Hoe POD te openen en converteren naar PDF om Perl-documentatie te lezen

Hoewel het ooit een integrale taal was voor webprogrammering Welke programmeertaal om te leren - Webprogrammering Welke programmeertaal om te leren - Webprogrammering Vandaag gaan we de verschillende webprogrammeertalen bekijken die het internet voeden. Dit is het vierde deel in een beginnersprogrammaserie. In deel 1 leerden we de basis van ... Lees meer, Perl is nu ten prooi gevallen aan modernere talen zoals Python, Ruby en JavaScript. Zeer weinig mensen denken dat het de moeite waard is om Perl tegenwoordig te leren kennen.

Maar dat betekent niet dat de taal nutteloos of achterhaald is. Sterker nog, veel moderne websites en webtools zijn nog steeds afhankelijk van Perl voor de dagelijkse activiteiten - inclusief Craigslist, IMDb en DuckDuckGo - dus als je erin geïnteresseerd bent om het te leren, laat dan niemand je stoppen of ervan weerhouden jij 7 nuttige trucs voor het beheersen van een nieuwe programmeertaal 7 nuttige trucs voor het beheersen van een nieuwe programmeertaal Het is goed om overweldigd te zijn wanneer je leert programmeren. Je zult dingen waarschijnlijk zo snel vergeten als je ze leert. Deze tips kunnen u helpen om al die nieuwe informatie beter te bewaren. Lees verder .

Als je Perl gaat leren, wil je ook graag kennis maken met POD. Dit is wat dat is, waarom het belangrijk is en wat te doen als je dergelijke bestanden tegenkomt.

Wat zijn POD-bestanden?

POD staat voor Plain Old Documentation, wat een standaard opmaaktaal is die wordt gebruikt om tekst op te maken zonder veel moeite. Het is vergelijkbaar met de Markdown-markup-taal What Is Markdown? 4 redenen waarom je het nu moet leren Wat is een daling? 4 redenen waarom u het nu zou moeten leren Moe van HTML en WYSIWYG-editors? Dan is Markdown het antwoord voor jou, ongeacht wie je bent. Meer lezen, maar specifiek ontworpen voor het documenteren van Perl-broncode en -modules.

POD kan op twee manieren worden gebruikt: het kan direct in de broncode van een Perl-bestand bestaan ​​OF het kan als een afzonderlijk POD-bestand bestaan. Als het in de code voorkomt, kunt u het als opmerkingen in een andere programmeertaal beschouwen, behalve liefhebber en flexibeler.

#! / Usr / bin / perl

gebruik strikt;

gebruik waarschuwingen;

= pod

= head1 Header Voorbeeld

Dit script bevat een aantal leuke dingen, zoals dit en dat. De volgende parameters moeten aanwezig zijn om te kunnen werken. Probeer dit niet te doen op een computer met problemen.

= cut

afdrukken “Alleen deze code wordt uitgevoerd. \ n”;

Ingesloten documentatie werkt goed voor zelfstandige scripts of wanneer u ervoor wilt zorgen dat iedereen die het bestand tegenkomt ook gegarandeerde toegang tot de documentatie heeft, maar het kan omslachtig zijn wanneer u een volledige codebase op een hoger niveau wilt documenteren.

Gelukkig kan POD ook worden gebruikt om pagina's van het handmatige type te maken die beter geschikt zijn voor gebruikersgerichte documenten (aangezien gebruikers zich misschien niet willen verdiepen in de broncode van een script zelf). Dat is wanneer POD-bestanden van pas komen.

Hoe POD-bestanden te lezen

Voor alle duidelijkheid: embedded POD-documentatie bevindt zich in de werkelijke Perl-scriptbestanden tussen regels code en deze scriptbestanden zijn beschikbaar in een van de twee extensie-indelingen: .PL of .PM. Wanneer u de extensie .POD ziet, geeft dit aan dat het bestand pure documentatie is en geen broncode bevat.

Hoewel het mogelijk is om POD-bestanden te openen in elke teksteditor inclusief Kladblok, wilt u dat waarschijnlijk alleen doen als u de onbewerkte documentatie zelf bewerkt. Zie het als het openen van een HTML-bestand in een editor: met alle markeringen is de daadwerkelijke tekstinhoud moeilijk te lezen.

In plaats daarvan moet u een soort lezertool gebruiken dat de onbewerkte POD-documentatie gebruikt en deze op een gemakkelijk leesbare manier presenteert.

De eenvoudigste manier is om de perldoc opdrachtregelprogramma dat automatisch wordt toegevoegd wanneer Perl op uw systeem is geïnstalleerd. De meeste OS X- en Linux-systemen worden geleverd met Perl al geïnstalleerd, maar Windows-gebruikers zullen het handmatig moeten installeren. (Gelukkig is het niet moeilijker dan een installatiebestand uit te voeren.)

Start nu de opdrachtregel, navigeer naar waar het POD-bestand zich bevindt en typ perldoc [.POD bestand] om het als correct geformatteerd te bekijken. Bijvoorbeeld, als het bestand een naam heeft library.pod dan zou je typen perldoc library.pod en dat is het.

Hoe POD naar andere formaten te converteren

Hoewel het perldoc hulpmiddel is niet te moeilijk om te gebruiken, het is niet echt handig als u de documentatie met anderen wilt delen of als u het wilt lezen, weg van uw computer. Dat is het moment waarop u misschien wilt overwegen om naar een ander formaat te converteren.

Converteren naar HTML: Installeer en gebruik de pod2html-tool die een eenvoudige manier biedt om elk POD-bestand te vertalen naar een leesbaar HTML-bestand. Helaas kan het alleen een één-op-één conversie uitvoeren (dus je kunt niet meerdere POD-bestanden combineren in één HTML-bestand).

Converteren naar PDF: Installeer en gebruik de pod2pdf-tool, die vergelijkbaar is met en net zo eenvoudig te gebruiken is als de bovenstaande pod2html-tool, behalve dat deze converteert naar PDF in plaats van HTML.

Een andere optie is om POD naar HTML te converteren met de hierboven getoonde methode, het HTML-bestand in een browser zoals Chrome of Firefox te openen en de pagina vervolgens als PDF af te drukken..

Converteren naar Markdown: Installeer en gebruik de pod2markdown-tool om te vertalen tussen POD en Markdown. Markdown is een opmaaktaal voor algemene doeleinden, wat betekent dat gebruikers er waarschijnlijk meer vertrouwd mee zijn en dat er meer tools zijn die Markdown kunnen accepteren en weergeven.

Converteren naar LaTeX: Installeer en gebruik het hulpprogramma pod2latex. LaTeX is een andere opmaaktaal, een die minder vaak voorkomt dan Markdown, maar nog steeds populairder is dan POD. LaTeX wordt voornamelijk gebruikt in academische en wetenschappelijke documenten, maar voor het geval u het nodig hebt, bestaat deze converter.

Converteren naar gewone tekst: Installeer en gebruik de pod2text-tool, die een tekstbestand met op ASCII-gebaseerde opmaak produceert. U zult dit waarschijnlijk niet nodig hebben, maar voor het geval u het ooit doet, weet dat de optie bestaat.

Was deze bericht nuttig?

Zodra je het onder de knie hebt, zijn POD-bestanden extreem eenvoudig en handig in gebruik. Er is een beetje een leercurve, maar deze is erg klein - vooral als je eerder een opmaaktaal hebt gebruikt. Hopelijk voel je je nu comfortabel met het omgaan met POD-bestanden.

Als je je overweldigd voelt, stel jezelf dan deze belangrijke vragen voor newbie-coders 4 Vragen om jezelf te stellen voordat je leert Hoe te coderen 4 vragen om jezelf te stellen voordat je leert Hoe te programmeren Een programmeertaal leren is populair. Maar is het voor iedereen? Voordat u zich eraan verbindt, moet u uzelf de volgende vragen stellen en eerlijk zijn. Lees verder . Moeilijkheden hebben betekent niet noodzakelijk dat je geen programmeur hoeft te zijn. 6 Borden die je niet als programmeur mag beschouwen 6 Tekenen dat je niet programmeur wilt zijn Niet iedereen is een programmeur. Als je niet helemaal zeker bent dat je een programmeur moet zijn, zijn hier enkele aanwijzingen die je in de juiste richting kunnen wijzen. Lees meer, maar het is belangrijk om eerlijk tegen jezelf te zijn en je verwachtingen te beheren.

Dat gezegd hebbende, luister naar deze tips voor het leren coderen zonder stress. Leren programmeren zonder al de stress Leren programmeren zonder al de stress Misschien heb je besloten om te blijven programmeren, of het nu voor een carrière is of gewoon als een hobby. Super goed! Maar misschien begin je je overweldigd te voelen. Niet zo goed. Hier is hulp om uw reis te vergemakkelijken. Meer lezen en weten hoe je goede codeerlessen tegen slecht advies moet leren Wat is een goede programmeerinstructie? Wat maakt een goede programmeerhandleiding? Niet alle programmeerinstructies zijn hetzelfde. Sommigen hebben er baat bij dat jij en anderen je tijd verspillen. Hier is wat u moet zoeken in een zelfstudie over kwaliteit. Lees verder .

Waarvoor gebruikt u Perl? Heb je nog andere tips om te delen of vragen om te stellen? Laat het ons weten in de comments hieronder!

Ontdek meer over: Bestandsconversie, PDF, Programmeren.