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

Advertentie

Hoewel het ooit een integrale taal voor webprogrammering Welke programmeertaal om te leren - WebprogrammeringVandaag gaan we kijken naar de verschillende webprogrammeertalen die het internet van stroom voorzien. Dit is het vierde deel van een programmeerserie voor beginners. In deel 1 leerden we de basis van ... Lees verder Perl is nu aan de kant gevallen voor meer moderne talen zoals Python, Ruby en JavaScript. Heel weinig mensen denken dat het de moeite waard is om Perl tegenwoordig te leren.

Maar dat betekent niet dat de taal nutteloos of verouderd is. Sterker nog, veel moderne websites en webtools vertrouwen nog steeds op Perl voor dagelijkse handelingen - inclusief Craigslist, IMDb en DuckDuckGo - dus als je geïnteresseerd bent om het te leren, laat niemand je stoppen of je ervan weerhouden 7 Handige trucs voor het beheersen van een nieuwe programmeertaalHet is prima om overweldigd te worden als je leert programmeren. U vergeet de dingen waarschijnlijk net zo snel als u ze leert. Deze tips kunnen u helpen om al die nieuwe informatie beter te bewaren. Lees verder .

Als je Perl gaat leren, dan wil je ook kennismaken met POD. Dit is wat dat is, waarom het belangrijk is en wat u moet doen als u dergelijke bestanden tegenkomt.

Wat zijn POD-bestanden?

POD staat voor Plain Old Documentation, een standaard opmaaktaal die wordt gebruikt om tekst zonder veel moeite op te maken. Het lijkt op de Markdown-opmaaktaal Wat is Markdown? 4 redenen waarom u het nu zou moeten lerenMoe van HTML- en WYSIWYG-editors? Dan is Markdown het antwoord voor u, ongeacht wie u bent. Lees verder , maar speciaal ontworpen voor het documenteren van Perl-broncode en modules.

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

#! / usr / bin / perl

strikt gebruiken;

waarschuwingen gebruiken;

= pod

= head1 Voorbeeld van koptekst

Dit script doet coole dingen, zoals dit en dat. De volgende parameters moeten bestaan ​​om goed te kunnen werken. Probeer dit niet te doen op een machine met problemen.

= knippen

print “Alleen deze code wordt uitgevoerd. \ n ";

Ingesloten documentatie werkt goed voor standalone scripts of wanneer u ervoor wilt zorgen dat iedereen die het bestand ook tegenkomt heeft gegarandeerd toegang tot de documentatie, maar het kan omslachtig zijn als je een hele codebase hoger wilt documenteren niveau.

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

Hoe POD-bestanden te lezen

Voor alle duidelijkheid, ingesloten POD-documentatie is te vinden in daadwerkelijke Perl-scriptbestanden tussen coderegels, en deze scriptbestanden hebben een van de twee extensie-indelingen: .PL of .PM. Wanneer u een .POD-extensie 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, wil je dat waarschijnlijk alleen doen als je 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 zou je een soort reader-tool moeten gebruiken die de ruwe POD-documentatie gebruikt en deze op een gemakkelijk te lezen manier presenteert.

De eenvoudigste manier is om de perldoc opdrachtregelprogramma dat automatisch wordt opgenomen wanneer Perl is op uw systeem geïnstalleerd. Op de meeste OS X- en Linux-systemen is 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 te zien als correct opgemaakt. Als het bestand bijvoorbeeld een naam heeft bibliotheek.pod dan typ je perldoc library.pod en dat is het.

Hoe POD naar andere formaten te converteren

Hoewel de perldoc tool is niet zo moeilijk te gebruiken, het is niet bepaald handig wanneer u de documentatie met anderen wilt delen of wanneer u deze van uw computer wilt lezen. Dat is wanneer u zou kunnen overwegen om te converteren naar een ander formaat.

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

Converteren naar PDF: Installeer en gebruik de pod2pdf tool, vergelijkbaar met en net zo makkelijk te gebruiken als de pod2html tool hierboven, behalve dat het converteert naar PDF in plaats van HTML.

Een andere optie zou zijn om POD naar HTML te converteren met behulp van de hierboven weergegeven methode, het HTML-bestand te openen in een browser zoals Chrome of Firefox 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 eerder bekend mee zijn en dat er meer tools zijn die Markdown kunnen accepteren en weergeven.

Converteren naar LaTeX: Installeer en gebruik de pod2latex gereedschap. LaTeX is een andere opmaaktaal, een taal 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 je het nodig hebt, bestaat deze converter.

Converteren naar platte tekst: Installeer en gebruik de pod2text tool, die een alleen-tekstbestand produceert met op ASCII gebaseerde opmaak. U hoeft dit waarschijnlijk niet te gebruiken, maar als u dat ooit doet, weet dan dat de optie bestaat.

Was dit bericht nuttig?

Als je het eenmaal onder de knie hebt, zijn POD-bestanden extreem eenvoudig en gemakkelijk te gebruiken. Er is een beetje een leercurve, maar deze is erg klein, vooral als je eerder een opmaaktaal hebt gebruikt. Hopelijk voel je je nu op je gemak bij het omgaan met POD-bestanden.

Als je je overweldigd voelt, vraag jezelf deze dan af belangrijke vragen voor beginnende programmeurs 4 vragen om jezelf te stellen voordat je leert coderenEen programmeertaal leren is populair. Maar is het voor iedereen? Stel uzelf de volgende vragen voordat u zich ertoe verbindt en wees eerlijk. Lees verder . Moeilijkheden hebben betekent niet noodzakelijkerwijs dat je bent niet bedoeld als programmeur 6 tekenen dat u niet bedoeld bent om programmeur te zijnNiet iedereen is bedoeld als programmeur. Als u niet helemaal zeker weet of u programmeur wilt worden, volgen hier enkele aanwijzingen die u in de goede richting kunnen wijzen. Lees verder , maar het is belangrijk om eerlijk tegen jezelf te zijn en je verwachtingen te managen.

Dat gezegd hebbende, let op deze tips voor zonder stress leren coderen Programmeren leren zonder alle stressMisschien heb je besloten om te gaan programmeren, voor een carrière of gewoon als hobby. Super goed! Maar misschien begin je je overweldigd te voelen. Niet zo goed. Hier is hulp om uw reis te vergemakkelijken. Lees verder en weten hoe goede tutorials over coderen te onderscheiden van slechte Wat is een goede programmeerhandleiding?Niet alle programmeerlessen zijn gelijk gemaakt. Sommigen profiteren ervan en anderen verspillen uiteindelijk uw tijd. Hier is waar u op moet letten in een tutorial over kwaliteitsprogrammering. Lees verder .

Waar gebruik je Perl voor? Heeft u nog andere tips om te delen of vragen te stellen? Laat het ons weten in de reacties hieronder!