Hva er POD-filformatet?
En .pod-fil er en dokumentasjonsfil for programmeringsspråket Perl. POD-filer bruker en spesiell markeringssyntaks for bedre lesbarhet og funksjonalitet. Syntaksen er veldig grunnleggende og høyt standardisert - det er ingen mulighet for å endre skriftstørrelse eller farge, legge til bilder eller tabeller. Dette gjør at .pod-filer enkelt kan konverteres til andre formater som HTML, TeX, Markdown og XML. .pod-filer kan leses interaktivt med verktøyet perldoc.
*Plain Old Documentation* er et veldig praktisk markeringsspråk som er egnet for å lage klare og konsise dokumentasjonsfiler for programvare. Mesteparten av dokumentasjonen for Perl-moduler og distribusjoner publisert på CPAN er skrevet i dette formatet.
I tillegg til å opptre som frittstående .pod-filer, kan POD-dokumentasjon bygges direkte inn i kildekoden til .pl og .pm-filer mellom markeringslinjene =pod og =cut - Perl-tolkeren ignorerer ganske enkelt disse delene under kompilering. POD definerer tre avsnittstyper: kommandoavsnitt som begynner med = (slik som =head1, =over, =item, =back, =cut), ordrette avsnitt (innrykket med mellomrom), og vanlige tekstavsnitt med innebygde formateringskoder som B<>, I<>, C<> og L<>. Tegnkoding deklareres med =encoding utf-8.
POD-dokumenter kan enkelt konverteres til systemhjelpmanualer (man-sider) ved hjelp av pod2man, til HTML med pod2html, eller til ren tekst med pod2text.
Sikkerhet og trygghet
RISIKO: LOWEn ekte Perl POD-fil er ren tekst uten kjørbar kode, så den er trygg å åpne i enhver tekstredigerer. To forholdsregler: (1) hvis en .pod faktisk er et Terminal Reality-spillarkiv, er den binær - ikke prøv å «fikse» den som tekst; åpne den med en spillspesifikk ekstraktor. (2) Innebygd POD lever inne i .pl/.pm Perl-kildekode - dokumentasjonen er inaktiv, men den omkringliggende Perl-koden er et program; kjør kun skript du stoler på.
Formatdetaljer
i et nøtteskall- Terminal Reality POD-spillarkiv - Et pakket spillressursarkiv (.pod) brukt av titler med Terminal Reality-motoren (f.eks. BloodRayne, FaceOff); et binært arkiv, ikke dokumentasjon.
- Podcast-mediefil - Enkelte apper/feeder merker nedlastede lydepisoder med .pod; i praksis er disse MP3/AAC-lyd, ikke et eget format.
- VMware / virtualisering og diverse data - Noen få verktøy bruker .pod for sine egne data (f.eks. bærbare/pakkede datafiler); ikke relatert til Perl-dokumentasjon.
Programmer som åpner POD-filer
Windows3 apps
Notepad
Åpen kildekode Åpne .pod for å lese/redigere råmarkeringen; installer en POD/perldoc-plugin eller bruk Perl-verktøykjeden for å gjengi den. 
Strawberry Perl (perldoc / pod2html)
Åpen kildekode Kjør «perldoc file.pod» for å lese den formatert, eller «pod2html file.pod > file.html» for å generere en nettside. 
Visual Studio Code
Gratis Åpne .pod som tekst; en Perl-utvidelse legger til POD-syntaksutheving og forhåndsvisning. 
macOS2 apps
perldoc (built-in Perl)
Åpen kildekode macOS leveres med Perl: «perldoc file.pod» gjengir den; «pod2html»/«pod2man» konverterer den. 
Linux2 apps
perldoc / pod2man / pod2html
Åpen kildekode «perldoc file.pod» for å lese; «pod2man file.pod | man -l -» for en man-side; «pod2html» for HTML.
gedit / any text editor
Åpen kildekode Åpne .pod som ren tekst for å se eller redigere den rå POD-markeringen. Tekniske detaljer
dyp spesifikasjon| Format-type | Lett markeringsspråk i ren tekst |
| Avsnittstyper | Kommando (=head1, =over, =item, =cut), ordrett (innrykkede linjer) og vanlig tekst |
| Kommandomarkører | Linjer som starter med «=» i kolonne 1 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Innebygde formateringskoder | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> for fet skrift, kursiv, kode, lenker, entiteter, hardt mellomrom, indeksoppføring og null-effekt |
| Deklarasjon av koding | =encoding etterfulgt av et IANA-tegnsettnavn (f.eks. utf-8) plassert i det første kommandoavsnittet |
| MIME-type | text/x-pod (primær); text/plain er også akseptert |
| Innbygging i kildekode | Kan plasseres inne i .pl / .pm-filer mellom =pod og =cut; Perl-kompilatoren ignorerer disse blokkene ved kjøring |
| Konverteringsverktøy | pod2man (man-sider), pod2html (HTML), pod2text (ren tekst), pod2latex (LaTeX) - alle følger med Perl eller er tilgjengelige på CPAN |
| Interaktiv visning | perldoc leser POD fra installerte Perl-moduler eller frittstående .pod-filer |
| Typisk filstørrelse | 1 KB - 200 KB |
| Plattformstøtte | Plattformuavhengig - overalt hvor Perl kjører (Linux, macOS, Windows, *BSD) |
| Filidentifikasjon | Ingen binære magic bytes; identifisert av «=kommando»-avsnitt (=head1, =pod, osv.) som starter i kolonne 1 |
| Tilknyttede kildekode-endelser | .pl (skript), .pm (moduler), .t (testfiler) |
| Utvikler | Larry Wall og Perls kjerne-team (Perl Foundation) |
| Dokumentasjonsomfang | Brukt for modul-dokumentasjon, skriptbeskrivelser, veiledninger og ofte stilte spørsmål i hele Perls økosystem |
| Utgitt | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Siste versjon | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Åpen standard | Ja · royalty-fri |
| Spesifikasjon | perldoc.perl.org |
POD-konverteringer
Spørsmål og svar fra fellesskapet
spurt av brukereIngen spørsmål ennå - vær den første til å spørre om POD-filer.
