Sådan åbnes og konverteres POD til PDF for at læse Perl-dokumentation

En POD-fil er den almindelige gamle dokumentation af Perl-programmeringssproget. Vi viser dig hvordan du konverterer POD til PDF, HTML, Markdown, LaTeX eller almindelig tekst.

En POD-fil er den almindelige gamle dokumentation af Perl-programmeringssproget.  Vi viser dig hvordan du konverterer POD til PDF, HTML, Markdown, LaTeX eller almindelig tekst.
Reklame

Selv om det engang var et integreret sprog til webprogrammering Hvilket programmeringssprog at lære - Webprogrammering Hvilket programmeringssprog at lære - Webprogrammering I dag tager vi et kig på de forskellige webprogrammeringssprog, der styrer internettet. Dette er den fjerde del i en begynderprogrammeringsserie. I del 1 lærte vi grunden til ... Læs mere, Perl er nu faldet af vejen til fordel for mere moderne sprog som Python, Ruby og JavaScript. Meget få mennesker synes det er umagen værd at lære Perl i disse dage.

Men det betyder ikke, at sproget er ubrugeligt eller forældet. Faktisk er mange moderne websites og webværktøjer stadig afhængige af Perl til den daglige drift - herunder Craigslist, IMDb og DuckDuckGo - så hvis du er interesseret i at lære det, lad ikke nogen stoppe dig eller afskrække du 7 nyttige tricks til at mestre et nyt programmeringssprog 7 nyttige tricks til at mestre et nyt programmeringssprog Det er okay at være overvældet, når du lærer at kode. Du vil nok glemme ting så hurtigt som du lærer dem. Disse tips kan hjælpe dig med bedre at beholde alle de nye oplysninger. Læs mere .

Hvis du vil lære Perl, så vil du også gerne lære POD. Her er hvad det er, hvorfor det er vigtigt, og hvad skal du gøre, når du løber ind i sådanne filer.

Hvad er POD-filer?

POD står for Plain Old Documentation, som er et grundlæggende markupsprog, der bruges til at formatere tekst uden stor indsats. Det ligner markdown-sproget Markdown Hvad er Markdown? 4 grunde til, at du bør lære det nu Hvad er Markdown? 4 grunde til, at du bør lære det nu Træt af HTML og WYSIWYG redaktører? Så Markdown er svaret for dig, uanset hvem du er. Læs mere, men specielt designet til dokumentation af Perl kildekoden og moduler.

POD kan bruges på to måder: den kan eksistere direkte i kildekoden til en Perl-fil, eller den kan eksistere som en separat POD-fil. Når det findes inden for koden, kan du tænke på det som kommentarer i et hvilket som helst andet programmeringssprog, bortset fra mere avanceret og mere fleksibel.

#!/usr/bin/perl

brug strenge

brug advarsler

= pod

= Head1 Header Eksempel

Dette script gør nogle seje ting, som dette og det. Følgende parametre skal eksistere for at det fungerer korrekt. Prøv ikke at gøre dette på en maskine med problemer.

= skåret

print "Kun denne kode udføres. \ N”;

Embedded dokumentation fungerer godt for frittstående scripts, eller når du vil sikre dig, at alle, der kommer på tværs af filen, også har garanteret adgang til dokumentationen, men det kan være besværligt, når du vil dokumentere en hel kodebase på et højere niveau.

Heldigvis kan POD også bruges til at oprette manueltype sider, der er bedre egnet til brugerorienterede dokumenter (da brugere måske ikke ønsker at dykke ind i kildekode for et script selv). Det er, når POD-filer kommer til nytte.

Sådan læses POD-filer

For at være klar er indlejret POD-dokumentation fundet i faktiske Perl-scriptfiler mellem kodelinjer, og disse script-filer kommer i et af to udvidelsesformater: .PL eller .PM. Når du ser en .POD-udvidelse, indikerer den, at filen er ren dokumentation og ikke indeholder nogen kildekode.

Selvom det er muligt at åbne POD-filer i ethvert tekstredigeringsprogram, herunder Notesblok, vil du sandsynligvis kun gøre det, hvis du faktisk redigerer selve dokumentationen. Tænk på det som at åbne en HTML-fil i en editor: med hele markeringen er det faktiske tekstindhold svært at læse.

pod-dokumentation-redigering

I stedet skal du bruge en slags læserværktøj, der tager den rå POD-dokumentation og præsenterer den på en letlæselig måde.

Den nemmeste måde er at bruge perldoc kommandolinjeværktøjet, som automatisk medtages, når Perl er installeret på dit system. De fleste OS X og Linux systemer leveres med Perl allerede installeret, men Windows-brugere skal manuelt installere det. (Heldigvis er det ikke sværere end at køre en installationsfil.)

perldoc [.POD file] nu kommandolinjen, naviger til, hvor POD-filen er placeret, og skriv perldoc [.POD file] at se det som korrekt formateret. For eksempel, hvis filen blev navngivet library.pod så ville du skrive perldoc library.pod og det er det.

Sådan konverteres POD til andre formater

Selv om perldoc værktøjet ikke er for svært at bruge, er det ikke ligefrem praktisk, når du vil dele dokumentationen med andre, eller når du vil læse den væk fra din computer. Det er, når du måske vil overveje at konvertere til et andet format.

Konvertere til HTML: Installer og brug værktøjet pod2html, som giver en nem måde at oversætte enhver POD-fil til en læsbar HTML-fil. Det kan desværre kun udføre en en til en konvertering (så du kan ikke kombinere flere POD-filer i en enkelt HTML-fil).

Konvertere til PDF: Installer og brug pod2pdf-værktøjet, som ligner og lige så nemt at bruge som pod2html-værktøjet ovenfor, bortset fra det konverteres til PDF i stedet for HTML.

En anden mulighed ville være at konvertere POD til HTML ved hjælp af den ovenfor viste fremgangsmåde. Åbn HTML-filen i en browser som Chrome eller Firefox, og tryk derefter på siden som PDF.

pod-dokumentation-markdown

Konvertering til Markdown: Installer og brug pod2markdown-værktøjet til at oversætte mellem POD og Markdown. Markdown er et generelt markupsprog, hvilket betyder, at brugerne er mere tilbøjelige til at være bekendt med det, og der er flere værktøjer derude, der kan acceptere og vise Markdown.

Konvertering til LaTeX: Installer og brug pod2latex værktøjet. LaTeX er et andet mærkningssprog, en der er mindre almindelig end Markdown, men stadig mere populær end POD. LaTeX bruges hovedsagelig i akademiske og videnskabelige dokumenter, men hvis du har brug for det, eksisterer denne konverter.

Konvertering til almindelig tekst: Installer og brug pod2textværktøjet, som producerer en tekstbeskyttet fil med ASCII-baseret formatering. Du skal sandsynligvis ikke bruge dette, men hvis du nogensinde gør det, ved du, at muligheden findes.

Var dette indlæg nyttigt?

Når du har lagt fat på det, er POD-filer ekstremt enkle og nemme at bruge. Der er lidt af en læringskurve, men det er meget mindre - især hvis du tidligere har brugt et markupsprog. Forhåbentlig føler du dig nu komfortabel med at håndtere POD-filer.

Hvis du føler dig overvældet, så spørg dig selv disse vigtige spørgsmål til newbie coders. 4 Spørgsmål til at spørge dig selv, før du lærer Sådan kodes 4 spørgsmål til at spørge dig selv, før du lærer. Sådan kodes At lære et programmeringssprog er populært. Men er det for alle? Før du forpligter dig til det, skal du stille dig selv de følgende spørgsmål og være ærlige. Læs mere . At have vanskeligheder betyder ikke nødvendigvis, at du ikke er ment som programmør. 6 Tegn på, at du ikke har tænkt dig at være en programmør. 6 Tegn på, at du ikke har tænkt dig at være en programmør Ikke alle er skåret ud til at være en programmør. Hvis du ikke er helt sikker på, at du er ment som programmør, er der nogle tegn, der kan vise dig i den rigtige retning. Læs mere, men det er vigtigt at være ærlig over for dig selv og håndtere dine forventninger.

Når det er sagt, følg disse tips for at lære at kode uden stress. Sådan lærer du programmering uden al stress Sådan lærer du programmering uden al stress. Du har måske valgt at forfølge programmering, uanset om du er en karriere eller bare som en hobby. Store! Men måske begynder du at føle dig overvældet. Ikke så stor. Her er hjælp til at lette din rejse. Læs mere og vide hvordan man fortæller gode kodningstutorials fra dårlig Hvad laver en god programmeringsvejledning? Hvad laver en god programmeringsvejledning? Ikke alle programmeringstutorials er lavet ens. Nogle gavner dig og andre ender med at spilde din tid. Her er hvad man skal se efter i en kvalitetsprogrammeringstutorial. Læs mere .

Hvad bruger du Perl til? Har du fået andre tips til at dele eller spørgsmål til at spørge? Lad os vide i kommentarerne nedenfor!

In this article