Come aprire e convertire POD in PDF per leggere la documentazione di Perl

Un file POD è la semplice vecchia documentazione del linguaggio di programmazione Perl. Ti mostriamo come convertire POD in PDF, HTML, Markdown, LaTeX o testo normale.

Un file POD è la semplice vecchia documentazione del linguaggio di programmazione Perl.  Ti mostriamo come convertire POD in PDF, HTML, Markdown, LaTeX o testo normale.
Annuncio pubblicitario

Anche se era una volta un linguaggio integrale per la programmazione web Che linguaggio di programmazione da imparare - Programmazione Web Quale linguaggio di programmazione da imparare - Programmazione Web Oggi daremo un'occhiata ai vari linguaggi di programmazione Web che alimentano Internet. Questa è la quarta parte di una serie di programmazione per principianti. Nella parte 1, abbiamo appreso le basi di ... Per saperne di più, Perl ora è caduto nel dimenticatoio a favore di linguaggi più moderni come Python, Ruby e JavaScript. Pochissime persone pensano che valga la pena di imparare Perl in questi giorni.

Ma ciò non significa che il linguaggio sia inutile o obsoleto. In effetti, molti siti Web e strumenti Web moderni fanno ancora affidamento su Perl per le operazioni quotidiane - inclusi Craigslist, IMDb e DuckDuckGo - quindi se sei interessato ad apprenderlo, non permettere a nessuno di fermarti o di dissuaderlo 7 trucchi utili per padroneggiare un nuovo linguaggio di programmazione 7 Trucchi utili per padroneggiare un nuovo linguaggio di programmazione Va bene essere sopraffatti quando si sta imparando a programmare. Probabilmente dimenticherai le cose così velocemente come le impari. Questi suggerimenti possono aiutarti a conservare meglio tutte le nuove informazioni. Leggi di più .

Se hai intenzione di imparare Perl, allora vorrai anche conoscere POD. Ecco di cosa si tratta, perché è importante e cosa fare quando si eseguono tali file.

Cosa sono i file POD?

POD sta per Plain Old Documentation, che è un linguaggio di markup di base utilizzato per formattare il testo senza troppi sforzi. È simile al linguaggio Markdown Markup What Is Markdown? 4 motivi per cui dovresti impararlo ora Cos'è Markdown? 4 motivi per cui dovresti impararlo ora Stanco degli editor HTML e WYSIWYG? Allora Markdown è la risposta per te, indipendentemente da chi tu sia. Ulteriori informazioni, ma specificamente progettato per documentare codice sorgente e moduli Perl.

Il POD può essere utilizzato in due modi: può esistere direttamente all'interno del codice sorgente di un file Perl OPPURE può esistere come un file POD separato. Quando esiste all'interno del codice, puoi considerarlo come un commento in qualsiasi altro linguaggio di programmazione, ad eccezione del più elaborato e più flessibile.

#!/usr/bin/perl

usare rigorosamente;

usare avvertenze;

= pod

= Head1 Esempio di intestazione

Questo script fa cose interessanti, come questo e quello. I seguenti parametri devono esistere affinché funzioni correttamente. Non provare a farlo su una macchina con problemi.

= tagliare

print "Viene eseguito solo questo codice. \ N”;

La documentazione integrata funziona bene per script autonomi o quando si vuole essere sicuri che chiunque trovi il file abbia anche accesso garantito alla documentazione, ma può essere ingombrante quando si desidera documentare un'intera base di codice a un livello più alto.

Fortunatamente, il POD può anche essere usato per creare pagine di tipo manuale che sono più adatte per i documenti orientati all'utente (poiché gli utenti potrebbero non voler approfondire il codice sorgente di uno script stesso). Ecco quando i file POD tornano utili.

Come leggere i file POD

Per essere chiari, la documentazione POD incorporata si trova all'interno dei file di script Perl effettivi tra le righe di codice e questi file di script sono disponibili in uno dei due formati di estensione: .PL o .PM. Quando vedi un'estensione .POD, indica che il file è pura documentazione e non include alcun codice sorgente.

Mentre è possibile aprire i file POD in qualsiasi editor di testo incluso Blocco note, probabilmente lo si vuole solo se si sta effettivamente modificando la documentazione grezza stessa. Pensa ad aprire un file HTML in un editor: con tutto il markup, il contenuto del testo reale è difficile da leggere.

pod-documentazione-editing

Invece, dovresti usare qualche tipo di strumento di lettura che prende la documentazione POD grezza e la presenta in un modo facile da leggere.

Il modo più semplice è usare lo strumento per riga di comando perldoc che viene automaticamente incluso quando Perl è installato sul tuo sistema. La maggior parte dei sistemi OS X e Linux vengono forniti con Perl già installato, ma gli utenti Windows dovranno installarlo manualmente. (Fortunatamente, non è più difficile che eseguire un file di installazione.)

Ora avvia la riga di comando, vai a dove si trova il file POD e digita perldoc [.POD file] per visualizzarlo correttamente formattato. Ad esempio, se il file è stato chiamato perldoc library.pod e il gioco è fatto.

Come convertire il POD in altri formati

Anche se lo strumento perldoc non è troppo difficile da utilizzare, non è esattamente conveniente quando si desidera condividere la documentazione con gli altri o quando si desidera leggerlo lontano dal computer. Questo è quando potresti voler prendere in considerazione la conversione in un altro formato.

Conversione in HTML: installa e utilizza lo strumento pod2html che fornisce un modo semplice per tradurre qualsiasi file POD in un file HTML leggibile. Sfortunatamente, può eseguire solo una conversione one-to-one (quindi non è possibile combinare più file POD in un singolo file HTML).

Conversione in PDF: installa e utilizza lo strumento pod2pdf, che è simile e altrettanto facile da usare come lo strumento pod2html sopra, tranne che converte in PDF piuttosto che in HTML.

Un'altra opzione sarebbe quella di convertire POD in HTML usando il metodo mostrato sopra, aprire il file HTML in un browser come Chrome o Firefox, e quindi stampare la pagina come PDF.

pod-documentazione-Markdown

Conversione in Markdown: installa e utilizza lo strumento pod2markdown per tradurre tra POD e Markdown. Markdown è un linguaggio di markup generico, il che significa che è più probabile che gli utenti abbiano familiarità con esso e ci sono più strumenti là fuori che possono accettare e visualizzare Markdown.

Conversione in LaTeX: installare e utilizzare lo strumento pod2latex. LaTeX è un altro linguaggio di markup, meno comune di Markdown, ma ancora più popolare di POD. LaTeX viene utilizzato principalmente in documenti accademici e scientifici, ma nel caso sia necessario, questo convertitore esiste.

Conversione in testo normale: installa e utilizza lo strumento pod2text, che produce un file di solo testo con formattazione basata su ASCII. Probabilmente non avrai bisogno di usarlo, ma nel caso tu lo faccia, sappi che l'opzione esiste.

Questo post è stato utile?

Una volta capito, i file POD sono estremamente semplici e pratici da usare. C'è un po 'di una curva di apprendimento, ma è molto minore - specialmente se hai già usato un linguaggio di markup prima. Speriamo che ora ti senta a tuo agio nel trattare con i file POD.

Se ti senti sopraffatto, poniti queste importanti domande per i programmatori principianti 4 Domande da porsi prima di apprendere Come codificare 4 domande da porsi prima di imparare Come codificare L'apprendimento di un linguaggio di programmazione è popolare. Ma è per tutti? Prima di impegnarti a farlo, poniti le seguenti domande e sii onesto. Leggi di più . Avere difficoltà non significa necessariamente che non si intende essere un programmatore 6 Segni che non si intende essere un programmatore 6 Segni che non si intende essere programmatori Non tutti sono tagliati per essere programmatori. Se non sei completamente sicuro di essere un programmatore, ecco alcuni segnali che potrebbero indirizzarti nella giusta direzione. Leggi di più, ma è importante essere onesti con te stesso e gestire le tue aspettative.

Detto questo, prendi in considerazione questi suggerimenti per imparare come codificare senza stress Come imparare la programmazione senza tutti gli stress Come imparare la programmazione senza tutti gli stress Forse hai deciso di perseguire la programmazione, sia per una carriera o semplicemente per hobby. Grande! Ma forse stai iniziando a sentirti sopraffatto. Non così eccezionale. Ecco l'aiuto per facilitare il tuo viaggio. Per saperne di più e sapere come distinguere le buone esercitazioni di codifica da ciò che fa un buon tutorial di programmazione? Cosa rende un buon tutorial di programmazione? Non tutte le esercitazioni di programmazione sono uguali. Alcuni ti aiutano e altri finiscono per perdere tempo. Ecco cosa cercare in un tutorial di programmazione di qualità. Leggi di più .

Per cosa stai usando Perl? Hai altri suggerimenti da condividere o domande da porre? Fateci sapere nei commenti qui sotto!

In this article