Slik åpner og konverterer POD til PDF for å lese Perl-dokumentasjon

Annonse

Skjønt det en gang var et integrert språk for nettprogrammering Hvilket programmeringsspråk å lære - nettprogrammeringI dag skal vi se på de forskjellige nettprogrammeringsspråkene som driver Internett. Dette er den fjerde delen i en nybegynner-programmeringsserie. I del 1 lærte vi det grunnleggende om ... Les mer , Perl har nå falt ved veikanten til fordel for mer moderne språk som Python, Ruby og JavaScript. Svært få mennesker synes det er verdt innsatsen å lære Perl i disse dager.

Men det betyr ikke at språket er ubrukelig eller foreldet. Faktisk er mange moderne nettsteder og nettverktøy fortsatt avhengige av Perl for den daglige driften - inkludert Craigslist, IMDb og DuckDuckGo - så hvis du er interessert i å lære det, ikke la noen stoppe deg eller fraråde deg 7 nyttige triks for å mestre et nytt programmeringsspråkDet er greit å bli overveldet når du lærer å kode. Du vil sannsynligvis glemme ting så raskt som du lærer dem. Disse tipsene kan hjelpe deg med å beholde all den nye informasjonen bedre. Les mer .

Hvis du skal lære Perl, vil du også bli kjent med POD. Dette er hva det er, hvorfor det er viktig, og hva du skal gjøre når du støter på slike filer.

Hva er POD-filer?

POD står for Plain Old Documentation, som er et grunnleggende markeringsspråk som brukes til å formatere tekst uten mye krefter. Det ligner på Markdown-markeringsspråket Hva er Markdown? 4 grunner til at du burde lære det nåEr du lei av HTML- og WYSIWYG-redigerere? Da er Markdown svaret for deg uansett hvem du er. Les mer , men spesielt designet for å dokumentere Perl-kildekoden og modulene.

POD kan brukes på to måter: den kan eksistere direkte innenfor kildekoden til en Perl-fil ELLER den kan eksistere som en egen POD-fil. Når den finnes i koden, kan du tenke på den som kommentarer på et hvilket som helst annet programmeringsspråk, bortsett fra mer avanserte og mer fleksible.

#! / Usr / bin / perl

bruk streng;

bruk advarsler;

= pod

= head1 Overskrifteksempel

Dette skriptet gjør noen kule ting, som dette og det. Følgende parametere må eksistere for at den skal fungere ordentlig. Ikke prøv å gjøre dette på en maskin med problemer.

= kutt

print “Bare denne koden blir utført. \ N”;

Innebygd dokumentasjon fungerer bra for frittstående skript, eller når du vil være sikker på at alle som kommer over filen også har garantert tilgang til dokumentasjonen, men det kan være tungvint når du vil dokumentere en hel kodebase på en høyere nivå.

Heldigvis kan POD også brukes til å lage sider med manuell type som er bedre egnet for brukerorienterte dokumenter (siden brukere kanskje ikke ønsker å fordype seg i kildekoden til et skript selv). Det er da POD-filer kommer godt med.

Hvordan lese POD-filer

For å være tydelig, er innebygd POD-dokumentasjon funnet i faktiske Perl-skriptfiler i mellom kodelinjer, og disse skriptfilene kommer i ett av to utvidelsesformater: .PL eller .PM. Når du ser en .POD-utvidelse, indikerer den at filen er ren dokumentasjon og inkluderer ingen kildekode.

Selv om det er mulig å åpne POD-filer i en hvilken som helst tekstredigerer inkludert Notisblokk, vil du sannsynligvis bare gjøre det hvis du faktisk redigerer selve rå dokumentasjonen. Tenk på det som å åpne en HTML-fil i en redaktør: med hele markeringen er det faktiske tekstinnholdet vanskelig å lese.

I stedet bør du bruke et slags leserverktøy som tar den rå POD-dokumentasjonen og presenterer den på en lettlest måte.

Den enkleste måten er å bruke perldoc kommandolinjeverktøy som automatisk blir inkludert når Perl er installert på systemet ditt. De fleste OS X- og Linux-systemer har Perl allerede installert, men Windows-brukere må installere det manuelt. (Heldigvis er det ikke vanskeligere enn å kjøre en installasjonsfil.)

Start nå kommandolinjen, naviger til der POD-filen ligger, og skriv inn perldoc [.POD-fil] for å se den som riktig formatert. Hvis filen for eksempel ble navngitt library.pod så skriver du perldoc library.pod og det er det.

Hvordan konvertere POD til andre formater

Selv om perldoc verktøyet er ikke for vanskelig å bruke, det er ikke akkurat praktisk når du vil dele dokumentasjonen med andre eller når du vil lese den vekk fra datamaskinen. Det er da du kanskje vil vurdere å konvertere til et annet format.

Konvertering til HTML: Installer og bruk pod2html verktøy som gir en enkel måte å oversette alle POD-filer til en lesbar HTML-fil. Dessverre kan den bare utføre en en-til-en-konvertering (slik at du ikke kan kombinere flere POD-filer til en enkelt HTML-fil).

Konvertering til PDF: Installer og bruk pod2pdf, som ligner og er like enkelt å bruke som pod2html-verktøyet over, bortsett fra at det konverteres til PDF i stedet for HTML.

Et annet alternativ vil være å konvertere POD til HTML ved å bruke metoden vist over, åpne HTML-filen i en nettleser som Chrome eller Firefox, og deretter skrive ut siden som PDF.

Konvertering til Markdown: Installer og bruk pod2markdown verktøy for å oversette mellom POD og Markdown. Markdown er et generelt merkespråk, noe som betyr at det er mer sannsynlig at brukere er kjent med det, og det er flere verktøy der ute som kan godta og vise Markdown.

Konvertering til LaTeX: Installer og bruk pod2latex verktøy. LaTeX er et annet merkespråk, et som er mindre vanlig enn Markdown, men som fortsatt er mer populært enn POD. LaTeX brukes hovedsakelig i akademiske og vitenskapelige dokumenter, men i tilfelle du trenger det, eksisterer denne omformeren.

Konvertering til vanlig tekst: Installer og bruk pod2text verktøyet, som produserer en tekst-bare fil med ASCII-basert formatering. Du trenger sannsynligvis ikke å bruke dette, men i tilfelle du noen gang gjør det, vet at alternativet eksisterer.

Var dette innlegget nyttig?

Når du har fått tak i det, er POD-filer ekstremt enkle og praktiske å bruke. Det er litt av en læringskurve, men den er veldig liten - spesielt hvis du har brukt et markeringsspråk før. Forhåpentligvis føler du deg nå komfortabel med å håndtere POD-filer.

Hvis du føler deg overveldet, kan du spørre deg selv om disse viktige spørsmål for nybegynnerkodere 4 spørsmål du må stille deg før du lærer å kodeÅ lære et programmeringsspråk er populært. Men er det for alle? Før du forplikter deg til det, må du stille deg følgende spørsmål og være ærlig. Les mer . Å ha vanskeligheter betyr ikke nødvendigvis det du er ikke ment som programmerer 6 tegn på at du ikke har ment å være programmererIkke alle er kuttet ut til å være programmerer. Hvis du ikke er helt sikker på at du er ment som programmerer, her er noen tegn som kan peke deg i riktig retning. Les mer , men det er viktig å være ærlig med deg selv og styre forventningene dine.

Når det er sagt, følger du disse tipsene lære å kode uten stress Slik lærer du programmering uten all stressKanskje har du bestemt deg for å satse på programmering, enten det er for en karriere eller bare som en hobby. Flott! Men kanskje du begynner å bli overveldet. Ikke så bra. Her er hjelp til å lette reisen. Les mer og å vite hvordan du kan fortelle gode kodingsopplæringer fra dårlig Hva gjør en god programmeringsopplæring?Ikke alle programmeringsveiledninger blir gjort like. Noen fordeler deg og andre ender opp med å kaste bort tiden din. Her er hva du skal se etter i en programmeringsopplæring av høy kvalitet. Les mer .

Hva bruker du Perl til? Har du noen andre tips å dele eller spørsmål du kan stille? Gi oss beskjed i kommentarene nedenfor!