Så här öppnar du och konverterar POD till PDF för att läsa Perl-dokumentation

En POD-fil är den vanliga gamla dokumentationen av Perl-programmeringsspråket. Vi visar dig hur man konverterar POD till PDF, HTML, Markdown, LaTeX eller vanlig text.

En POD-fil är den vanliga gamla dokumentationen av Perl-programmeringsspråket.  Vi visar dig hur man konverterar POD till PDF, HTML, Markdown, LaTeX eller vanlig text.
Annons

Även om det en gång var ett integrerat språk för webbprogrammering Vilket programmeringsspråk att lära sig - Webbprogrammering Vilket programmeringsspråk som ska läras - Webbprogrammering Idag ska vi titta på de olika webbprogrammeringsspråken som driver Internet. Detta är den fjärde delen i en nybörjare programmeringsserie. I del 1 lärde vi oss grunden till ... Läs mer, Perl har nu fallit av vägen till förmån för mer moderna språk som Python, Ruby och JavaScript. Mycket få människor tycker att det är värt ansträngningen att lära Perl idag.

Men det betyder inte att språket är värdelöst eller föråldrat. Faktum är att många moderna webbplatser och webbverktyg fortfarande litar på Perl för den dagliga verksamheten - inklusive Craigslist, IMDb och DuckDuckGo - så om du är intresserad av att lära dig det, låt inte någon stoppa dig eller avskräcka du 7 användbara tricks för att behärska ett nytt programmeringsspråk 7 Användbara tricks för att behärska ett nytt programmeringsspråk Det är okej att vara överväldigad när du lär dig att koda. Du kommer noga att glömma saker så fort du lär dig dem. Dessa tips kan hjälpa dig att bättre behålla all den nya informationen. Läs mer .

Om du ska lära dig Perl så vill du också lära känna POD. Här är vad det är, varför det är viktigt och vad du ska göra när du stöter på sådana filer.

Vad är POD-filer?

POD står för Plain Old Documentation, som är ett grundläggande markup-språk som används för att formatera text utan mycket ansträngning. Det liknar markdown-språket Markdown Vad är Markdown? 4 skäl till att du borde lära dig nu Vad är Markdown? 4 Anledningar till varför du borde lära dig nu Trött på HTML och WYSIWYG redaktörer? Då är Markdown svaret för dig, oavsett vem du är. Läs mer, men speciellt utformad för att dokumentera Perl källkod och moduler.

POD kan användas på två sätt: det kan existera direkt i källkoden för en Perl-fil ELLER den kan existera som en separat POD-fil. När det finns inom koden kan du tänka på det som kommentarer i något annat programmeringsspråk, förutom mer avancerad och flexibel.

#!/usr/bin/perl

använd strikt

använd varningar

= pod

= Head1 Header Exempel

Det här skriptet gör några coola saker, som det här och det. Följande parametrar måste finnas för att den ska fungera korrekt. Försök inte göra det på en maskin med problem.

= skära

print "Endast den här koden exekveras. \ N”;

Inbyggd dokumentation fungerar bra för fristående skript eller när du vill se till att alla som kommer över filen också har garanterat tillgång till dokumentationen, men det kan vara besvärligt när du vill dokumentera en hel kodbas på en högre nivå.

Lyckligtvis kan POD också användas för att skapa sidor av manuelltyp som passar bäst för användarorienterade dokument (eftersom användare kanske inte vill dyka in i källkoden för ett manus). Det är då POD-filer kommer till nytta.

Så här läser du POD-filer

För att vara tydlig, finns inbyggd POD-dokumentation i verkliga Perl-skriptfiler mellan kodkod och dessa skriptfiler finns i ett av två filformat: .pl eller .pm. När du ser en .POD-förlängning, indikerar den att filen är ren dokumentation och innehåller ingen källkod.

Medan det är möjligt att öppna POD-filer i någon textredigerare inklusive anteckningsblock, vill du antagligen bara göra det om du faktiskt redigerar den råa dokumentationen själv. Tänk på att du öppnar en HTML-fil i en editor: med all markering är det faktiska innehållet svårt att läsa.

pod-dokumentation redigering

I stället bör du använda något slags läsverktyg som tar den råa POD-dokumentationen och presenterar den på ett lättläst sätt.

Det enklaste sättet är att använda kommandoradsverktyget perldoc som automatiskt ingår när Perl är installerat på ditt system. De flesta OS X och Linux-system levereras med Perl redan installerat, men Windows-användare måste manuellt installera det. (Lyckligtvis är det inte svårare än att köra en installationsfil.)

Lansera nu kommandoraden, navigera till var POD-filen är lokaliserad och skriv perldoc [.POD file] att visa den som korrekt formaterad. Om filen till exempel heter library.pod så skriver du perldoc library.pod och det är det.

Så här konverterar du POD till andra format

Även om verktyget perldoc inte är för svårt att använda, är det inte exakt bekvämt när du vill dela dokumentationen med andra eller när du vill läsa den från din dator. Det är då du kanske vill överväga att konvertera till ett annat format.

Konvertera till HTML: Installera och använd pod2html-verktyget som ger ett enkelt sätt att översätta någon POD-fil till en läsbar HTML-fil. Tyvärr kan det bara utföra en en-till-en-omvandling (så du kan inte kombinera flera POD-filer till en enda HTML-fil).

Konvertera till PDF: Installera och använd pod2pdf-verktyget, vilket liknar och lika enkelt är att använda som pod2html-verktyget ovan, förutom att det konverteras till PDF snarare än HTML.

Ett annat alternativ skulle vara att konvertera POD till HTML med hjälp av metoden som visas ovan, öppna HTML-filen i en webbläsare som Chrome eller Firefox och skriv sedan ut sidan som PDF.

pod-dokumentation-markdown

Konvertera till Markdown: Installera och använd pod2markdown-verktyget för att översätta mellan POD och Markdown. Markdown är ett allmänt användningsspråk, vilket betyder att användarna är mer benägna att känna till det och det finns fler verktyg där ute som kan acceptera och visa Markdown.

Konvertera till LaTeX: Installera och använd pod2latex-verktyget. LaTeX är ett annat märkningsspråk, ett som är mindre vanligt än Markdown, men fortfarande mer populärt än POD. LaTeX används huvudsakligen i akademiska och vetenskapliga dokument, men om du behöver det, finns den här konverteraren.

Konvertera till vanlig text: Installera och använd pod2text-verktyget, som producerar en text som endast är text med ASCII-baserad formatering. Du behöver nog inte använda detta, men om du någonsin gör det, vet du att alternativet finns.

Var detta inlägg användbart?

När du har hängt på det, är POD-filer extremt enkla och praktiska att använda. Det finns lite av en inlärningskurva, men det är väldigt litet - speciellt om du tidigare har använt ett spårningsspråk. Förhoppningsvis känner du dig bekväm med att hantera POD-filer.

Om du känner dig överväldigad, fråga dig själv dessa viktiga frågor för nybörjare kodare 4 Frågor att fråga dig själv innan du lär dig Hur man kodar 4 frågor att fråga sig innan man lär sig Hur man kodar Att lära sig ett programmeringsspråk är populärt. Men är det för alla? Innan du förbinder dig, fråga dig själv följande frågor och vara ärliga. Läs mer . Att ha svårigheter betyder inte nödvändigtvis att du inte är avsedd att vara en programmerare. 6 Tecken på att du inte är avsedd att vara en programmerare. 6 Tecken på att du inte är avsedd att vara programmerare. Inte alla är utklippna för att vara programmerare. Om du inte är helt säker på att du är avsedd att vara programmerare, här är några tecken som kan peka dig i rätt riktning. Läs mer, men det är viktigt att vara ärlig mot dig själv och hantera dina förväntningar.

Det sägs att du följer dessa tips för att lära dig hur man kodar utan stress. Hur man läser programmering utan all stress. Hur man lär sig programmering utan all stress. Kanske har du bestämt dig för att fortsätta programmera, oavsett om du är en karriär eller bara som en hobby. Bra! Men kanske börjar du känna dig överväldigad. Inte så bra. Här är hjälp för att underlätta din resa. Läs mer och veta hur man berättar bra kodningstutorials från dålig Vad gör en bra programmeringstutorial? Vad gör en bra programmeringstutorial? Inte alla programmeringstutorials görs lika. Några gagnar dig och andra slutar slösa din tid. Här är vad du ska leta efter i en kvalitetsprogram för programmering. Läs mer .

Vad använder du Perl för? Har du några andra tips för att dela eller frågor att fråga? Låt oss veta i kommentarerna nedan!

In this article