LOCALE::PO4A::POD.3PM(1) | User Contributed Perl Documentation | LOCALE::PO4A::POD.3PM(1) |
NAZWA
Locale::Po4a::Pod - konwersja danych POD z/do plików PO
SKŁADNIA
use Locale::Po4a::Pod; my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78); # Czytanie POD ze STDIN i zapisanie do STDOUT. $parser->parse_from_filehandle; # Czytanie POD z plik.pod i zapisanie do plik.txt. $parser->parse_from_file ('plik.pod', 'plik.txt');
OPIS
Locale::Po4a::Pod jest modułem ułatwiającym tłumaczenie dokumentacji w formacie POD (preferowany język dokumentowania programów napisanych w Perlu) do innych języków [używanych przez ludzi].
STATUS MODUŁU
Myślę, że ten moduł jest stabilny jak skała. Istnieje tylko jeden znany błąd związany z /usr/lib/perl5/Tk/MainWindow.pod (i innymi stronami, patrz niżej), który zawiera:
C<" #n">
Lack of luck, in the po4a version, this was split on the space by the wrapping. As result, in the original version, the man page contains:
" #n"
and mine contains:
"" #n""
co jest logiczne, skoro C<cośtam> jest przepisane jako "cośtam".
Complete list of pages having this problem on my box (from 564 pages; note that it depends on the chosen wrapping column):
/usr/lib/perl5/Tk/MainWindow.pod /usr/share/perl/5.8.0/overload.pod /usr/share/perl/5.8.0/pod/perlapi.pod /usr/share/perl/5.8.0/pod/perldelta.pod /usr/share/perl/5.8.0/pod/perlfaq5.pod /usr/share/perl/5.8.0/pod/perlpod.pod /usr/share/perl/5.8.0/pod/perlre.pod /usr/share/perl/5.8.0/pod/perlretut.pod
STRUKTURY WEWNĘTRZNE
Locale::Po4a::Pod, jako klasa dziedziczona z Pod::Parser, obsługuje te same interfejsy i metody. Wszystkie szczegóły można znaleźć w Pod::Parser; w skrócie: najpierw trzeba utworzyć parser, używając "Locale::Po4a::Pod->new()", a potem wywołać albo parse_from_filehandle() albo parse_from_file().
new() może pobrać opcje, w postaci par klucz/wartość, kontrolujące zachowanie parsera. Następujące wspólne opcje są rozpoznawane przez wszystkie dzieci Pod::Parser:
- alt
- Jeśli ustawione na true, wybiera alternatywny format wyjścia, między innymi używa innego stylu nagłówka i oznacza wpisy =item dwukropkiem na lewym marginesie. Domyślną wartością jest false.
- code
- Jeśli ustawione na true, części nie-POD pliku wejściowego będą dołączone do pliku wyjściowego. Użyteczne podczas oglądania dokumentu mającego bloki POD z POD przekształconym, a kodem pozostawionym bez zmian.
- indent
- Liczba spacji wcinania zwykłego tekstu i domyślne wcinanie bloków =over. Domyślnie 4.
- loose
- Jeśli ustawione na true, po nagłówku =head1 jest dodawana pusta linia. Jeśli ustawione na false (domyślnie), to nie jest wypisywana pusta linia po =head1, ale jest wciąż wypisywana po =head2. Jest to wartość domyślna, ponieważ jest to oczekiwane formatowanie stron podręcznika ekranowego. Podczas formatowania dowolnych dokumentów tekstowych, ustawienie tego na true może wygenerować przyjemniejsze wyjście.
- quotes
- Ustawia znaki cudzysłowu używane do otaczania tekstów
C<>. Jeżeli wartością jest pojedynczy znak, to
jest on używany jako lewy i prawy cudzysłów;
jeśli są to dwa znaki, to pierwszy z nich jest lewym
cudzysłowem, a drugi - prawym; jeśli są cztery znaki,
to pierwsze dwa są lewym cudzysłowem, a kolejne dwa -
prawym.
Może to także przyjmować na specjalną wartość none, określającą, że tekst C<> nie zostanie otoczony znakami cudzysłowu.
- sentence
- Jeśli jest ustawione na true, Locale::Po4a::Pod przyjmie, że każde zdanie kończy się dwoma spacjami i postara się to zachować. Jeśli ustawione na false, wszystkie kolejne białe znaki w niedosłownych akapitach są zamieniane na jedną spację. Domyślną wartością jest true.
- width
- Numer kolumny, według której zawijać tekst po jego prawej stronie. Domyślnie jest to 76.
ZOBACZ TAKŻE
Pod::Parser, Locale::Po4a::Man(3pm), Locale::Po4a::TransTractor(3pm), po4a(7)
AUTORZY
Denis Barbier <barbier@linuxfr.org> Martin Quinson (mquinson#debian.org)
TŁUMACZENIE
Robert Luberda <robert@debian.org>
PRAWA AUTORSKIE I LICENCJA
Copyright © 2002 SPI, Inc.
This program is free software; you may redistribute it and/or modify it under the terms of GPL v2.0 or later (see the COPYING file).
2024-04-28 | perl v5.38.2 |