Che cos'è il formato di file POD?
Un file .pod è un file di documentazione per il linguaggio di programmazione Perl. I file POD utilizzano una speciale sintassi di markup per una migliore leggibilità e funzionalità. La sintassi è molto semplice e altamente standardizzata - non c'è opzione per cambiare la dimensione o il colore del carattere, aggiungere immagini o tabelle. Ciò consente ai file .pod di essere facilmente convertiti in altri formati come HTML, TeX, Markdown e XML. I file .pod possono essere letti interattivamente con lo strumento perldoc.
La *Plain Old Documentation* è un linguaggio di markup molto conveniente, adatto alla creazione di file di documentazione software chiari e succinti. La maggior parte della documentazione per i moduli Perl e le distribuzioni pubblicate su CPAN è scritta in questo formato.
Oltre ad apparire come file .pod autonomi, la documentazione POD può essere incorporata direttamente all'interno dei file sorgente .pl e .pm tra le righe marcatore =pod e =cut - l'interprete Perl ignora semplicemente quelle sezioni durante la compilazione. POD definisce tre tipi di paragrafi: paragrafi di comando che iniziano con = (come =head1, =over, =item, =back, =cut), paragrafi letterali (rientrati con spazi bianchi) e paragrafi di testo ordinario con codici di formattazione inline come B<>, I<>, C<> e L<>. La codifica dei caratteri viene dichiarata con =encoding utf-8.
I documenti POD possono essere facilmente convertiti in manuali di aiuto di sistema (man pages) usando pod2man, in HTML con pod2html o in testo semplice con pod2text.
Sicurezza e incolumità
RISCHIO: LOWUn autentico file Perl POD è testo semplice senza codice eseguibile, quindi è sicuro da aprire in qualsiasi editor. Due avvertenze: (1) se un .pod è in realtà un archivio di gioco Terminal Reality, è binario - non cercare di «ripararlo» come testo; aprilo con un estrattore specifico per il gioco. (2) Il formato POD incorporato vive all'interno dei sorgenti Perl .pl/.pm - la documentazione è inerte, ma il codice Perl circostante è un programma; esegui solo script di cui ti fidi.
Dettagli del formato
in sintesi- Archivio di gioco Terminal Reality POD - Un archivio compresso di asset di gioco (.pod) utilizzato dai titoli con motore Terminal Reality (es. BloodRayne, FaceOff); un archivio binario, non documentazione.
- File multimediale Podcast - Alcune app/feed etichettano gli episodi audio scaricati come .pod; in pratica si tratta di audio MP3/AAC, non di un formato distinto.
- VMware / virtualizzazione e dati vari - Alcuni strumenti usano .pod per i propri dati (es. file di dati portatili/compressi); non correlato alla documentazione Perl.
Programmi che aprono file POD
Windows3 apps
Notepad
Open-source Apri il file .pod per leggere/modificare il markup grezzo; installa un plugin POD/perldoc o usa la toolchain Perl per il rendering. 
Strawberry Perl (perldoc / pod2html)
Open-source Esegui «perldoc file.pod» per leggerlo formattato, o «pod2html file.pod > file.html» per renderizzarlo in una pagina web. 
Visual Studio Code
Gratuito Apri il file .pod come testo; un'estensione Perl aggiunge l'evidenziazione della sintassi POD e l'anteprima. 
macOS2 apps
perldoc (built-in Perl)
Open-source macOS include Perl: «perldoc file.pod» lo renderizza; «pod2html»/«pod2man» lo convertono. 
Linux2 apps
perldoc / pod2man / pod2html
Open-source «perldoc file.pod» per leggere; «pod2man file.pod | man -l -» per una pagina man; «pod2html» per HTML.
gedit / any text editor
Open-source Apri il file .pod come testo semplice per visualizzare o modificare il markup POD grezzo. Dettagli tecnici
specifiche approfondite| Tipo di formato | Linguaggio di markup leggero in testo semplice |
| Tipi di paragrafo | Comando (=head1, =over, =item, =cut), letterale (righe rientrate) e testo ordinario |
| Marcatori di comando | Righe che iniziano con «=» alla colonna 1 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Codici di formattazione inline | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> per grassetto, corsivo, codice, collegamenti, entità, spazio non interruttibile, voce di indice ed effetto zero |
| Dichiarazione di codifica | =encoding seguito da un nome di charset IANA (es. utf-8) inserito nel primo paragrafo di comando |
| Tipo MIME | text/x-pod (primario); accettato anche text/plain |
| Incorporamento nel sorgente | Può essere inserito all'interno di file .pl / .pm tra =pod e =cut; il compilatore Perl ignora questi blocchi in fase di esecuzione |
| Strumenti di conversione | pod2man (pagine man), pod2html (HTML), pod2text (testo semplice), pod2latex (LaTeX) - tutti inclusi in Perl o disponibili su CPAN |
| Visualizzatore interattivo | perldoc legge il formato POD dai moduli Perl installati o dai file .pod autonomi |
| Dimensione tipica del file | 1 KB - 200 KB |
| Supporto piattaforma | Multipiattaforma - ovunque giri Perl (Linux, macOS, Windows, *BSD) |
| Identificazione del file | Nessun byte magico binario; identificato dai paragrafi «=comando» (=head1, =pod, ecc.) che iniziano alla colonna 1 |
| Estensioni sorgente associate | .pl (script), .pm (moduli), .t (file di test) |
| Sviluppatore | Larry Wall e il team core di Perl (Perl Foundation) |
| Ambito della documentazione | Utilizzato per documentazione di moduli, descrizioni di script, tutorial e FAQ in tutto l'ecosistema Perl |
| Rilasciato | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Ultima versione | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Standard aperto | Sì · royalty-free |
| Specifica | perldoc.perl.org |
Conversioni POD
Domande e risposte della community
chiesto dagli utentiAncora nessuna domanda - sii il primo a chiedere informazioni sui file POD.
