Hvad er POD-filformatet?
En .pod-fil er en dokumentationsfil til programmeringssproget Perl. POD-filer bruger en speciel markup-syntaks for bedre læsbarhed og funktionalitet. Syntaksen er meget grundlæggende og højt standardiseret - der er ingen mulighed for at ændre skrifttype eller farve, tilføje billeder eller tabeller. Dette gør det muligt nemt at konvertere .pod-filer til andre formater såsom HTML, TeX, Markdown og XML. .pod-filer kan læses interaktivt med værktøjet perldoc.
*Plain Old Documentation* er et meget praktisk markup-sprog, der er velegnet til at oprette klare og kortfattede softwaredokumentationsfiler. Det meste dokumentation til Perl-moduler og distributioner udgivet på CPAN er skrevet i dette format.
Udover at optræde som selvstændige .pod-filer, kan POD-dokumentation indlejres direkte i .pl og .pm kildefiler mellem =pod og =cut markørlinjer - Perl-fortolkeren ignorerer blot disse sektioner under kompilering. POD definerer tre paragraftyper: kommandoparagraffer, der begynder med = (såsom =head1, =over, =item, =back, =cut), verbatim-paragraffer (indrykket med hvidrum) og almindelige tekstparagraffer med inline-formateringskoder som B<>, I<>, C<> og L<>. Tegnkodning erklæres med =encoding utf-8.
POD-dokumenter kan nemt konverteres til systemhjælpsmanualer (man-sider) ved hjælp af pod2man, til HTML med pod2html eller til almindelig tekst med pod2text.
Sikkerhed og tryghed
RISIKO: LOWEn ægte Perl POD-fil er almindelig tekst uden eksekverbar kode, så den er sikker at åbne i enhver editor. To forholdsregler: (1) hvis en .pod faktisk er et Terminal Reality-spilarkiv, er den binær - forsøg ikke at „rette“ den som tekst; åbn den med en spilspecifik ekstraktor. (2) Indlejret POD findes inde i .pl/.pm Perl-kildekode - dokumentationen er inaktiv, men den omgivende Perl-kode er et program; kør kun scripts, du har tillid til.
Formatdetaljer
kort fortalt- Terminal Reality POD-spilarkiv - Et pakket spilaktiv-arkiv (.pod) brugt af titler med Terminal Reality-motoren (f.eks. BloodRayne, FaceOff); et binært arkiv, ikke dokumentation.
- Podcast-mediefil - Nogle apps/feeds mærker downloadede lydepisoder med .pod; i praksis er disse MP3/AAC-lyd, ikke et særskilt format.
- VMware / virtualisering & diverse data - Enkelte værktøjer bruger .pod til deres egne data (f.eks. bærbare/pakkede datafiler); ikke relateret til Perl-dokumentation.
Programmer der åbner POD-filer
Windows3 apps
Notepad
Open-source Åbn .pod-filen for at læse/redigere den rå markup; installer et POD/perldoc-plugin eller brug Perl-værktøjskæden til at rendere den. 
Strawberry Perl (perldoc / pod2html)
Open-source Kør „perldoc file.pod“ for at læse den formateret, eller „pod2html file.pod > file.html“ for at rendere til en webside. 
Visual Studio Code
Gratis Åbn .pod som tekst; en Perl-udvidelse tilføjer POD-syntaksfremhævning og forhåndsvisning. 
macOS2 apps
perldoc (built-in Perl)
Open-source macOS leveres med Perl: „perldoc file.pod“ renderer den; „pod2html“/„pod2man“ konverterer den. 
Linux2 apps
perldoc / pod2man / pod2html
Open-source „perldoc file.pod“ for at læse; „pod2man file.pod | man -l -“ for en man-side; „pod2html“ for HTML.
gedit / any text editor
Open-source Åbn .pod som almindelig tekst for at se eller redigere den rå POD-markup. Tekniske detaljer
dyb specifikation| Format-type | Tekstbaseret letvægts-markup-sprog |
| Paragraftyper | Kommando (=head1, =over, =item, =cut), verbatim (indrykkede linjer) og almindelig tekst |
| Kommandomarkører | Linjer der starter med „=“ i kolonne 1 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Inline-formateringskoder | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> for fed, kursiv, kode, links, entiteter, hårdt mellemrum, indeksindgang og nul-effekt |
| Kodningserklæring | =encoding efterfulgt af et IANA-tegnsætnavn (f.eks. utf-8) placeret i den første kommandoparagraf |
| MIME-type | text/x-pod (primær); text/plain accepteres også |
| Indlejring i kildekode | Kan placeres inde i .pl / .pm filer mellem =pod og =cut; Perl-kompileren ignorerer disse blokke under kørsel |
| Konverteringsværktøjer | pod2man (man-sider), pod2html (HTML), pod2text (almindelig tekst), pod2latex (LaTeX) - alle følger med Perl eller er tilgængelige på CPAN |
| Interaktiv fremviser | perldoc læser POD fra installerede Perl-moduler eller selvstændige .pod-filer |
| Typisk filstørrelse | 1 KB - 200 KB |
| Platformunderstøttelse | Platformsuafhængig - overalt hvor Perl kører (Linux, macOS, Windows, *BSD) |
| Filidentifikation | Ingen binære magic bytes; identificeres ved „=kommando“-paragraffer (=head1, =pod, osv.) der starter i kolonne 1 |
| Associerede kilde-filendelser | .pl (scripts), .pm (moduler), .t (testfiler) |
| Udvikler | Larry Wall og Perl-kerneteamet (Perl Foundation) |
| Dokumentationsomfang | Bruges til modul-dokumentation, script-beskrivelser, vejledninger og FAQ'er i hele Perl-økosystemet |
| Udgivet | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Seneste version | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Åben standard | Ja · royaltyfri |
| Specifikation | perldoc.perl.org |
POD-konverteringer
Fællesskabets Q&A
spurgt af brugereIngen spørgsmål endnu - vær den første til at spørge om POD-filer.
