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

Reklame

Selvom det engang var en integreret sprog til webprogrammering Hvilket programmeringssprog man skal lære - WebprogrammeringI dag skal vi se på de forskellige webprogrammeringssprog, der driver Internettet. Dette er den fjerde del i en begynderprogrammeringsserie. I del 1 lærte vi det grundlæggende i ... Læs mere , Perl er nu faldet ved vejen til fordel for mere moderne sprog som Python, Ruby og JavaScript. Meget få mennesker synes, det er værd at prøve at lære Perl i disse dage.

Men det betyder ikke, at sproget er nytteløst eller forældet. Faktisk er mange moderne websteder og webværktøjer stadig afhængige af Perl til den daglige drift - inklusive Craigslist, IMDb og DuckDuckGo - så hvis du er interesseret i at lære det, lad ikke nogen stoppe dig eller afskrække dig 7 Nyttige tricks til at mestre et nyt programmeringssprogDet er okay at blive overvældet, når du lærer at kode. Du vil sandsynligvis glemme tingene så hurtigt, som du lærer dem. Disse tip kan hjælpe dig med at bevare alle de nye oplysninger bedre. Læs mere .

Hvis du vil lære Perl, vil du også gøre dig bekendt med POD. Her er hvad det er, hvorfor det er vigtigt, og hvad man skal gøre, når du støder på sådanne filer.

Hvad er POD-filer?

POD står for Plain Old Documentation, som er et grundlæggende markup-sprog, der bruges til at formatere tekst uden særlig indsats. Det ligner Markdown-markeringssprog Hvad er Markdown? 4 grunde til, at du skulle lære det nuTræt af HTML- og WYSIWYG-redaktører? Så er Markdown svaret for dig, uanset hvem du er. Læs mere , men specifikt designet til at dokumentere Perl-kildekode og moduler.

POD kan bruges på to måder: den kan eksistere direkte inden for kildekoden for en Perl-fil ELLER den kan eksistere som en separat POD-fil. Når den findes i koden, kan du tænke på den som kommentarer på ethvert andet programmeringssprog, undtagen mere fancy og mere fleksibel.

#! / Usr / bin / perl

brug strenge;

brug advarsler;

= pod

= head1 Overskrifteksempel

Dette script gør nogle seje ting som dette og det. Følgende parametre skal findes for at det skal fungere korrekt. Forsøg ikke at gøre dette på en maskine med problemer.

= cut

udskriv “Kun denne kode udføres. \ N”;

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

Heldigvis kan POD også bruges til at oprette sider af manuel type, der er bedre egnet til brugerorienterede dokumenter (da brugere muligvis ikke ønsker at uddybe kildekoden til et script selv). Det er når POD-filer er nyttige.

Sådan læses POD-filer

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

Selvom det er muligt at åbne POD-filer i en hvilken som helst teksteditor inklusive Notepad, vil du sandsynligvis kun gøre det, hvis du rent faktisk redigerer selve den rå dokumentation. Tænk på det som at åbne en HTML-fil i en editor: med alt markup er det egentlige tekstindhold svært at læse.

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øj, der automatisk inkluderes, 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.)

Start nu kommandolinjen, naviger til hvor POD-filen er placeret, og skriv perldoc [.POD-fil] for at se det som korrekt formateret. F.eks. Hvis filen blev navngivet library.pod så skriver du perldoc library.pod og det er det.

Sådan konverteres POD til andre formater

Selvom perldoc værktøjet er ikke for svært at bruge, det er ikke nøjagtigt 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 ønsker at overveje at konvertere til et andet format.

Konvertering til HTML: Installer og brug pod2html værktøj, der giver en nem måde at oversætte enhver POD-fil til en læsbar HTML-fil. Desværre kan den kun udføre en en-til-en-konvertering (så du ikke kan kombinere flere POD-filer til en enkelt HTML-fil).

Konvertering til PDF: Installer og brug pod2pdf værktøj, der ligner og er lige så let at bruge som pod2html-værktøjet ovenfor, bortset fra at det konverteres til PDF snarere end HTML.

En anden mulighed ville være at konvertere POD til HTML ved hjælp af metoden vist ovenfor, åbne HTML-filen i en browser som Chrome eller Firefox og derefter udskrive siden som PDF.

Konvertering til Markdown: Installer og brug pod2markdown værktøj til at oversætte mellem POD og Markdown. Markdown er et almindeligt markeringssprog, hvilket betyder, at brugere er mere tilbøjelige til at kende det, og der er flere værktøjer derude, der kan acceptere og vise Markdown.

Konvertering til LaTeX: Installer og brug pod2latex værktøj. LaTeX er et andet markup-sprog, der er mindre almindeligt end Markdown, men stadig mere populært end POD. LaTeX bruges hovedsageligt i akademiske og videnskabelige dokumenter, men i tilfælde af at du har brug for det, findes denne konverter.

Konvertering til almindelig tekst: Installer og brug pod2text værktøj, der producerer en tekst-kun fil med ASCII-baseret formatering. Du har sandsynligvis ikke brug for at bruge dette, men hvis du nogensinde gør det, ved, at indstillingen findes.

Var dette indlæg nyttigt?

Når du først har fået det, er POD-filer ekstremt enkle og praktiske at bruge. Der er lidt af en læringskurve, men det er meget mindre - især hvis du har brugt et markup-sprog før. Forhåbentlig har du det nu godt med at håndtere POD-filer.

Hvis du føler dig overvældet, så spørg dig selv om disse vigtige spørgsmål til newbie-kodere 4 spørgsmål, du skal stille dig selv, før du lærer at kodeAt lære et programmeringssprog er populært. Men er det for alle? Før du forpligter dig til det, skal du stille dig selv følgende spørgsmål og være ærlig. Læs mere . At have vanskeligheder betyder ikke nødvendigvis det du er ikke meningen at være en programmør 6 tegn på, at du ikke har til hensigt at være programmererIkke alle er udskåret til at være programmerer. Hvis du ikke er helt sikker på, at du er beregnet til at være programmør, er her nogle tegn, der kan pege dig i den rigtige retning. Læs mere , men det er vigtigt at være ærlig med dig selv og styre dine forventninger.

Når det er sagt, skal du følge disse tip til lære at kode uden stress Sådan læres programmering uden al stressMåske har du besluttet at fortsætte programmeringen, hvad enten det drejer sig om en karriere eller bare som en hobby. Store! Men måske begynder du at blive overvældet. Ikke så stor. Her er hjælp til at lette din rejse. Læs mere og at vide hvordan man fortæller gode kodningsvejledninger fra dårlige Hvad gør en god programmeringsvejledning?Ikke alle programmeringsvejledninger gøres lige. Nogle gavner dig og andre ender med at spilde din tid. Her er hvad man skal kigge efter i en programmeringsvejledning af høj kvalitet. Læs mere .

Hvad bruger du Perl til? Har du andre tip til at dele eller spørgsmål at stille? Fortæl os det i kommentarerne nedenfor!