Moduł Pod::Text

Uniwersytet Gdański - Instytut Matematyki - Zakład Informatyki - Strona domowa

Co to jest?

Przetwarza dane w formacie POD w formatowany tekst ASCII.

Streszczenie
use Pod::Text; my $parser = Pod::Text->new (sentence => 0, width => 78); # Czyta POD ze standardowego wejścia a wypisuje na standardowe wyjście. $parser->parse_from_filehandle; # czyta POD z pliku file.pod a zapisuje do pliku file.txt. $parser->parse_from_file ('file.pod', 'file.txt');

Pod::Text jest to moduł który potrafi przetwarzać w formacie POD (preferowany język dokumentacji perla) w formatowany tekst ASCII. Nie używa specjalnych kontroli ani kodów formatowania, dlatego jego wyjście jest odpowiednie prawie dla każdego urządzenia.

Jako klasa wywodząca się z Pod::Simple, Pod::Text wspiera te same metody oraz interfejsy. Zobacz Pod::Simple aby zapoznać się z detalami; w skrócie, tworzy się nowy parser poprzez wywołanie Pod::Text->new() a wtedy normalnie wywołuje sie parse_file().

new() może przyjmować opcje w formie par klucz/wartość, które kontrolują zachowanie parsera. Obecnie rozpoznawanymi opcjami są:

  • alt - Jeśli ustawione na prawda, wybiera alternatywny format wyjściowy, który pośród różnych innych rzeczy używa innego stylu nagłówków oraz zaznaczenia wpisów =item z dwukropkiem w lewym marginesie.Domyślnie fałsz.

  • code - Jeśli ustawione na prawda, części na które nie są związane z POD w wejściowym pliku zostaną dołączone na wyjściu. Użyteczne do obserwowania kodu dokumentowanego przez bloki POD z przetworzonym POD a kodem pozostawionym nietkniętym.
  • indent - Numer spacji który ma zostać użyty do oddzielenia regularnego tekstu, oraz domyślnego oddzielenia bloku =over. Domyślnie wartość 4.
  • loose - Jeśli ustawione na prawda, pusta linia jest drukowana po nagłówku =head1. Jeśli na fałsz (domyślne zachowanie), nie jest drukowana pusta lina po =head1, jednak wciąż jest drukowana po nagłówku =head2. Jest to zachowanie domyślne ponieważ jest to oczekiwany format dla stron podręcznika; jeśli formatujemy przypadkowy dokumant tekstowy, ustawienie tej wartości na prawda da bardziej przejrzysty wynik.
  • margin - Szerokość lewego marginesu w spacjach. Domyślnie 0. Jest to margines dla całego tekstu, włączając w to nagłówki, nie ilość jakim regularny tekst jest oddzielony; jeśli o to ci chodziło zobacz opcje ident. Aby zobaczyć prawy margines, zobacz opcje width.
  • quotes - Ustawienie znaków cudzysłowu aby otaczały tekst C<>. Jeśli wartością jest pojedyńczy znak, jest używany zarówno jako lewy oraz prawy cudzysłów; jeśli natomiast dwa znaki, pierwszy używany jest jako lewy cudzysłów a drugi jako prawy; natomiast jeśli są to cztery znaki, dwa pierwsze używane są jako lewy cudzysłów natomiast następne dwa jako prawy.Może również tyć ustawione jako specjalna wartość none, w takim przypadku cudzysłów nie zostanie użyty.
  • sentence - Jeśli wartość ustawiona jest na prawdę, Pod::Text będzie zakładał że każde zdanie kończy się dwoma odstępami, i będzie próbował zachowywać te odstępy. Jeśli ustawione na fałsz, wszystkie kolejne białe znaki w nie dosłownym paragrafie zostaną skrócone do pojedynczej spacji.
  • width - Kolumna względem której będziemy zwijać tekst z prawej strony. domyślnie 76.
  • Standardowo metoda parse_file() z modułu Pod::Simple pobiera jeden argument, plik bądź też uchwyt do pliku z którego należy czytać, oraz pisze na standardowe wyjście, chyba że zostało to zmienione za pomocą metody output_fh(). Zobacz Pod::Simple aby poznać dokładniejsze szczegóły oraz inne alternatywne interfejsy.

    Diagnostyka

    Bizarre space in item
    Item called without tag
    Coś poszło nie tak w wewnętrznym przetwarzaniu =item. Ta wiadomość sygnalizuje błąd w Pod::Text; nigdy nie powinieneś jej zobaczyć.
    Can't open %s for reading: %s
    Pod::Text został wywołany w trybie zgodności z interfejsem pod2text() a plik który został dany nie może zostać otworzony.
    Invalid quote specification "%s"
    Dane parametry cudzysłowu (opcja quotes w konstruktorze) były błędne. Określenie cudzysłowu musi być długości jeden, dwa bądź czterech znaków.

    Dodatkowe informacje.

    Przydatne linki

    Dokumentacja tego modułu w cpan'ie

    Kontakt i informacje o autorze opracowania

    Autor modułu:

    Russ Allbery.

    Oparte na pierwotnym Pod::Text Tom Christiansen

    Autor przekładu: MD

    Numer GG: Słoneczko 2194164

    Uniwersytet Gdański - Instytut Matematyki - Zakład Informatyki - Strona domowa - Perl - Wyklady
    [c] Piotr Arłukowicz, materiały z tej strony udostępnione są na licencji GNU.