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

En POD-fil er den vanlige gamle dokumentasjonen av Perl-programmeringsspråket. Vi viser deg hvordan du konverterer POD til PDF, HTML, Markdown, LaTeX eller vanlig tekst.

En POD-fil er den vanlige gamle dokumentasjonen av Perl-programmeringsspråket.  Vi viser deg hvordan du konverterer POD til PDF, HTML, Markdown, LaTeX eller vanlig tekst.
Annonse

Selv om det en gang var et integrert språk for webprogrammering Hvilket programmeringsspråk å lære - Webprogrammering Hvilket programmeringsspråk å lære - Webprogrammering I dag skal vi ta en titt på de forskjellige webprogrammeringsspråkene som driver Internett. Dette er den fjerde delen i en nybegynnere programmeringsserie. I del 1 lærte vi grunnlaget for ... Les mer, Perl har nå falt av vei til fordel for mer moderne språk som Python, Ruby og JavaScript. Svært få mennesker synes det er verdt innsatsen for å 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 avhengig 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 avskrekke du 7 nyttige triks for å mestre et nytt programmeringsspråk 7 nyttige triks for å mestre et nytt programmeringsspråk Det er greit å være overveldet når du lærer å kode. Du vil sikkert glemme ting så fort du lærer dem. Disse tipsene kan hjelpe deg å bedre beholde all den nye informasjonen. Les mer .

Hvis du skal lære Perl, vil du også bli kjent med POD. Her er hva det er, hvorfor det er viktig, og hva skal du gjøre når du kjører inn i slike filer.

Hva er POD-filer?

POD står for Vanlig gammel dokumentasjon, som er et grunnleggende oppslagsspråk som brukes til å formatere tekst uten mye innsats involvert. Det ligner på Markdown-oppslagsspråket Hva er Markdown? 4 grunner til at du bør lære det nå Hva er Markdown? 4 grunner til at du bør lære det nå Lei av HTML og WYSIWYG redaktører? Så Markdown er 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 i kildekoden til en Perl-fil ELLER den kan eksistere som en egen POD-fil. Når det finnes i koden, kan du tenke på det som kommentarer i et annet programmeringsspråk, unntatt mer avansert og mer fleksibelt.

#!/usr/bin/perl

bruk strenge;

bruk advarsler

= pod

= head1 Header Eksempel

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

= kutte

print "Bare denne koden er utført. \ N”;

Embedded dokumentasjon fungerer godt for frittstående skript eller når du vil sørge for 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å et høyere nivå.

Heldigvis kan POD også brukes til å lage sider av manuell type som er bedre egnet for brukerorienterte dokumenter (siden brukere kanskje ikke vil dykke inn i kildekoden til et skript i seg selv). Det er da POD-filer kommer til nytte.

Slik leser du POD-filer

For å være klar, er innebygd POD-dokumentasjon funnet i faktiske Perl-skriptfiler 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 inneholder ingen kildekode.

Mens det er mulig å åpne POD-filer i et tekstredigeringsprogram, inkludert Notisblokk, vil du sannsynligvis bare gjøre det hvis du faktisk redigerer selve dokumentasjonen. Tenk på det som å åpne en HTML-fil i et redigeringsprogram: Med hele oppmerkningen er det faktiske tekstinnholdet vanskelig å lese.

pod-dokumentasjon-redigering

I stedet bør du bruke en 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øyet som automatisk inkluderes når Perl er installert på systemet. De fleste OS X og Linux-systemer kommer med Perl allerede installert, men Windows-brukere må manuelt installere det. (Heldigvis er det ikke vanskeligere enn å kjøre en installasjonsfil.)

perldoc [.POD file] nå kommandolinjen, naviger til hvor POD-filen er plassert, og skriv perldoc [.POD file] å vise den som riktig formatert. For eksempel, hvis filen ble kalt library.pod så ville du skrive perldoc library.pod og det er det.

Slik konverterer du POD til andre formater

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

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

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

Et annet alternativ ville være å konvertere POD til HTML ved hjelp av metoden vist ovenfor, åpne HTML-filen i en nettleser som Chrome eller Firefox, og skriv deretter ut siden som PDF.

pod-dokumentasjon-Markdown

Konvertere til Markdown: Installer og bruk pod2markdown verktøyet for å oversette mellom POD og Markdown. Markdown er et generelt merket språk, noe som betyr at brukerne er mer sannsynlig å være kjent med det, og det finnes flere verktøy der ute som kan akseptere og vise Markdown.

Konvertere til LaTeX: Installer og bruk pod2latex verktøyet. LaTeX er et annet oppslagsspråk, en som er mindre vanlig enn Markdown, men fortsatt mer populær enn POD. LaTeX brukes hovedsakelig i akademiske og vitenskapelige dokumenter, men hvis du trenger det, eksisterer denne konverteren.

Konvertere 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 hvis du noen gang gjør det, vet du at alternativet finnes.

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 det er veldig liten - spesielt hvis du har brukt et opptakspråk før. Forhåpentligvis føler du deg komfortabel med å håndtere POD-filer.

Hvis du føler deg overveldet, spør deg selv om disse viktige spørsmålene for nybegynnere kodere. 4 Spørsmål til å spørre deg selv før du lærer. Slik koder du 4 spørsmål for å spørre deg selv før du lærer. Slik koder du Læring 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 problemer betyr ikke nødvendigvis at du ikke er ment å være programmerer. 6 Tegn på at du ikke har tenkt å være programmerer. 6 Tegn på at du ikke er ment å være programmerer. Ikke alle er kuttet ut for å være programmerer. Hvis du ikke er helt sikker på at du er ment å være programmerer, er det noen tegn som kan vise deg i riktig retning. Les mer, men det er viktig å være ærlig med deg selv og håndtere dine forventninger.

Når det blir sagt, følg disse tipsene for å lære å kode uten stress. Hvordan lære programmering uten all stress. Hvordan lære programmering uten all stress. Kanskje du har bestemt deg for å forfølge programmering, enten for en karriere eller bare som en hobby. Flott! Men kanskje du begynner å føle deg overveldet. Ikke så bra. Her er hjelp til å lette reisen din. Les mer og vite hvordan du forteller gode kodingstutorials fra dårlig Hva gjør en god programmeringsveiledning? Hva gjør en god programmeringsveiledning? Ikke alle programmeringsopplæringene er gjort like. Noen drar nytte av deg og andre, og sliter bort tiden din. Her er det å se etter i en kvalitetsprogrammeringstutorial. Les mer .

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

In this article