Vanlig gammal dokumentation

Plain old documentation ( eng.  Plain old documentation , förkortat pod ; i betydelsen nära det ursprungliga ryska uttrycket - "Good Old Documentation") är ett enkelt märkningsspråk som används för att dokumentera programmeringsspråket Perl .

Enhet

Pod är designad för att vara ett enkelt och rent språk med minimal användbar syntax. Det utesluter avsiktligt mekanismer för att beskriva typsnitt, bilder, färger eller tabeller. Även om Pod inte är lika uttrycksfull som språk som XML eller LaTeX , har författarna medvetet offrat uttrycksfullhet för enkelhetens och bekvämlighetens skull [1] . Huvudmålen för podutveckling är:

• Enkel att analysera
• Enkel konvertering till andra format och språk som HTML eller TeX
• Lätt att inkludera exempel med kod
• Lätt att läsa i sin ursprungliga form, d.v.s. utan bearbetning genom att formatera program
• Lätt att skriva (annars kommer inte programmerare att skriva dokumentation!)

Det här formatet beskrivs på perlpodman-sidan , och vissa podöversättare beskrivs på man-sidorna pod2man , pod2html och pod2text . Även om författarna till perlpodmanualen påpekar att kapaciteten hos en pod förmodligen inte räcker till för att skriva böcker på den [2] , finns det faktiskt böcker skrivna i en utökad version av podden. Denna utökade version innehåller funktioner för tabellformatering och fotnoter och har använts av O'Reilly & Associates för att producera flera böcker om Perl (mest känd Perl-programmering [1] av Larry Wall , Tom Christiansen och John Orvant). En annan utökad version av pod, kallad mod, användes i en:Higher-Order Perl- boken av Mark Jason Dominus.

Använda programvarans inbyggda POD-dokumentation

Du kan läsa den formaterade POD-dokumentationen som är inbyggd i programmet med hjälp av det medföljande visningsverktyget: