Hur man öppnar och konverterar POD till PDF för att läsa Perl-dokumentation

Annons

Även om det en gång var en integrerat språk för webbprogrammering Vilket programmeringsspråk att lära sig - webbprogrammeringIdag ska vi ta en titt på de olika webbprogrammeringsspråken som driver Internet. Detta är den fjärde delen i en nybörjars programmeringsserie. I del 1 lärde vi oss det grundläggande för ... Läs mer , Perl har nu fallit vid 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 sig 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 förlitar sig fortfarande 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 dig 7 användbara trick för att behärska ett nytt programmeringsspråkDet är okej att bli överväldigad när du lär dig att koda. Du kommer förmodligen att glömma saker så snabbt som 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, vill du också bekanta dig med POD. Här är vad det är, varför det är viktigt och vad man 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 markeringsspråk som används för att formatera text utan mycket ansträngning. Det liknar Markdown-markeringsspråket Vad är Markdown? Fyra skäl till varför du borde lära dig det nuÄr du trött på HTML- och WYSIWYG-redigerare? Då är Markdown svaret för dig oavsett vem du är. Läs mer , men specifikt utformad för att dokumentera Perl-källkod och moduler.

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

#! / Usr / bin / perl

använda 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 detta på en maskin med problem.

= cut

print “Endast den här koden körs. \ 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 åtkomst till dokumentationen, men det kan vara besvärligt när du vill dokumentera en hel kodbaser på ett högre nivå.

Lyckligtvis kan POD också användas för att skapa sidor av manuell typ som är bättre lämpade för användarorienterade dokument (eftersom användare kanske inte vill gå in i källkoden för ett skript själv). Det är när POD-filer är praktiska.

Hur man läser POD-filer

För att vara tydlig finns den inbäddade POD-dokumentationen i faktiska Perl-skriptfiler mellan kodrader, och dessa skriptfiler finns i ett av två förlängningsformat: .PL eller .PM. När du ser ett .POD-förlängning indikerar det att filen är ren dokumentation och inte innehåller någon källkod.

Även om det är möjligt att öppna POD-filer i alla textredigerare inklusive Notepad, vill du förmodligen bara göra det om du faktiskt redigerar den råa dokumentationen. Tänk på det som att öppna en HTML-fil i en redaktör: med hela markeringen är det faktiska textinnehållet svårt att läsa.

Istället bör du använda ett slags läsarverktyg 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 perldoc kommandoradsverktyg som automatiskt ingår när Perl är installerat på ditt system. De flesta OS X- och Linux-system har Perl redan installerat, men Windows-användare måste installera det manuellt. (Lyckligtvis är det inte svårare än att köra en installationsfil.)

Starta nu kommandoraden, navigera till var POD-filen finns och skriv perldoc [.POD-fil] för att se den som korrekt formaterad. Om filen till exempel heter library.pod då skriver du perldoc library.pod och det är allt.

Hur konverterar jag POD till andra format

Trots att perldoc verktyget är inte för svårt att använda, det är 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 när du kanske vill överväga att konvertera till ett annat format.

Konvertera till HTML: Installera och använda pod2html verktyg som ger ett enkelt sätt att översätta alla POD-filer till en läsbar HTML-fil. Tyvärr kan den bara utföra en en-till-en-konvertering (så att du inte kan kombinera flera POD-filer i en enda HTML-fil).

Konvertera till PDF: Installera och använda pod2pdf verktyg, som liknar och lika lätt att använda som verktyget pod2html 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 sedan skriva ut sidan som PDF.

Konvertera till Markdown: Installera och använda pod2markdown verktyg för att översätta mellan POD och Markdown. Markdown är ett allmänt markeringsspråk, vilket innebär att användare ä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ända pod2latex verktyg. LaTeX är ett annat markeringsspråk, ett som är mindre vanligt än Markdown, men ändå mer populärt än POD. LaTeX används främst i akademiska och vetenskapliga dokument, men om du behöver det finns den här konverteraren.

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

Var detta inlägg användbart?

När du väl har tagit hand om det är POD-filer extremt enkla och praktiska att använda. Det finns lite av en inlärningskurva, men den är väldigt liten - särskilt om du har använt ett markeringsspråk tidigare. Förhoppningsvis känner du dig nu bekväm att hantera POD-filer.

Om du känner dig överväldigad, fråga dig själv dessa viktiga frågor för nybörjarkodare 4 frågor att ställa dig själv innan du lär dig hur du kodarAtt lära sig ett programmeringsspråk är populärt. Men är det för alla? Innan du förbinder dig till det, ställa dig själv följande frågor och vara ärlig. Läs mer . Att ha svårigheter betyder inte nödvändigtvis det du är inte tänkt att vara programmerare 6 tecken på att du inte är tänkt att vara programmerareDet är inte alla som är programmerare. Om du inte är helt säker på att du är tänkt att vara programmerare är hä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.

Som sagt, följ dessa tips för lära sig att koda utan stress Hur man lär sig programmering utan all stressDu har kanske bestämt dig för att fortsätta programmera, vare sig det gäller en karriär eller bara som en hobby. Bra! Men kanske börjar du bli överväldigad. Inte så bra. Här är hjälp för att underlätta din resa. Läs mer och att veta hur man kan säga bra kodning tutorials från dåliga Vad gör en bra programmeringshandledning?Inte alla programmeringsstudier görs lika. Vissa gynnar dig och andra slösar bort din tid. Här är vad du ska leta efter i en kvalitetsprogrammeringsstudie. Läs mer .

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