Co to jest format pliku POD?
Plik .pod to plik dokumentacji dla języka programowania Perl. Pliki POD używają specjalnej składni znaczników dla lepszej czytelności i funkcjonalności. Składnia jest bardzo podstawowa i wysoce standaryzowana - nie ma opcji zmiany rozmiaru lub koloru czcionki, dodawania obrazów ani tabel. Pozwala to na łatwą konwersję plików .pod na inne formaty, takie jak HTML, TeX, Markdown i XML. Pliki .pod można czytać interaktywnie za pomocą narzędzia perldoc.
*Plain Old Documentation* to bardzo wygodny język znaczników odpowiedni do tworzenia jasnych i zwięzłych plików dokumentacji oprogramowania. Większość dokumentacji modułów i dystrybucji Perla publikowanych w CPAN jest napisana w tym formacie.
Oprócz występowania jako samodzielne pliki .pod, dokumentacja POD może być osadzona bezpośrednio w plikach źródłowych .pl i .pm między liniami znaczników =pod i =cut - interpreter Perla po prostu ignoruje te sekcje podczas kompilacji. POD definiuje trzy typy akapitów: akapity poleceń zaczynające się od = (takie jak =head1, =over, =item, =back, =cut), akapity dosłowne (wcięte białymi znakami) oraz zwykłe akapity tekstowe z wbudowanymi kodami formatowania, takimi jak B<>, I<>, C<> i L<>. Kodowanie znaków deklaruje się za pomocą =encoding utf-8.
Dokumenty POD można łatwo przekonwertować na systemowe podręczniki pomocy (strony man) za pomocą pod2man, na HTML za pomocą pod2html lub na zwykły tekst za pomocą pod2text.
Bezpieczeństwo
RYZYKO: LOWOryginalny plik Perl POD jest zwykłym tekstem bez kodu wykonywalnego, więc można go bezpiecznie otwierać w dowolnym edytorze. Dwa ostrzeżenia: (1) jeśli .pod jest w rzeczywistości archiwum gry Terminal Reality, jest to plik binarny - nie próbuj go „naprawiać” jako tekstu; otwórz go za pomocą ekstraktora specyficznego dla gry. (2) Osadzony POD znajduje się wewnątrz kodu źródłowego Perla .pl/.pm - dokumentacja jest obojętna, ale otaczający ją kod Perla jest programem; uruchamiaj tylko skrypty, którym ufasz.
Szczegóły formatu
w pigułce- Archiwum gier Terminal Reality POD - Skompresowane archiwum zasobów gier (.pod) używane przez tytuły na silniku Terminal Reality (np. BloodRayne, FaceOff); archiwum binarne, nie dokumentacja.
- Plik multimedialny podcastu - Niektóre aplikacje/kanały oznaczają pobrane odcinki audio jako .pod; w praktyce są to pliki audio MP3/AAC, a nie odrębny format.
- VMware / wirtualizacja i inne dane - Kilka narzędzi używa .pod dla własnych danych (np. przenośne/spakowane pliki danych); niepowiązane z dokumentacją Perla.
Programy otwierające pliki POD
Szczegóły techniczne
specyfikacja| Typ formatu | Lekki język znaczników tekstowych |
| Typy akapitów | Polecenia (=head1, =over, =item, =cut), dosłowne (linie z wcięciem) i zwykły tekst |
| Znaczniki poleceń | Linie zaczynające się od „=” w kolumnie 1 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Wbudowane kody formatowania | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> dla pogrubienia, kursywy, kodu, linków, encji, braku łamania linii, wpisu indeksu i efektu zerowego |
| Deklaracja kodowania | =encoding po którym następuje nazwa zestawu znaków IANA (np. utf-8) umieszczona w pierwszym akapicie polecenia |
| Typ MIME | text/x-pod (główny); akceptowany również text/plain |
| Osadzanie w źródle | Może być umieszczony wewnątrz plików .pl / .pm między =pod a =cut; kompilator Perla ignoruje te bloki w czasie wykonywania |
| Narzędzia do konwersji | pod2man (strony man), pod2html (HTML), pod2text (zwykły tekst), pod2latex (LaTeX) - wszystkie dostarczane z Perlem lub dostępne w CPAN |
| Interaktywna przeglądarka | perldoc czyta POD z zainstalowanych modułów Perla lub samodzielnych plików .pod |
| Typowy rozmiar pliku | 1 KB - 200 KB |
| Obsługa platform | Wieloplatformowy - wszędzie tam, gdzie działa Perl (Linux, macOS, Windows, *BSD) |
| Identyfikacja pliku | Brak binarnych magicznych bajtów; identyfikowany przez akapity „=polecenie” (=head1, =pod itp.) zaczynające się w kolumnie 1 |
| Powiązane rozszerzenia źródłowe | .pl (skrypty), .pm (moduły), .t (pliki testowe) |
| Deweloper | Larry Wall i zespół rdzenia Perla (Perl Foundation) |
| Zakres dokumentacji | Używany do dokumentacji modułów, opisów skryptów, samouczków i FAQ w całym ekosystemie Perla |
| Wydano | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Najnowsza wersja | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Otwarty standard | Tak · bezpłatny (royalty-free) |
| Specyfikacja | perldoc.perl.org |
Konwersje POD
Pytania i odpowiedzi społeczności
pytania użytkownikówBrak pytań - bądź pierwszą osobą, która zapyta o pliki POD.