Linux Certif

Toute la documentation sur la certification Linux LPI

Locale::Po4a::TeX.3pm

NAZWA

Locale::Po4a::TeX - Konwersja dokumentA~Xw TeX z/do plikA~Xw PO

OPIS

Celem projektu po4a (``po for anything'') jest uA°Xatwienie tA°XumaczeA°X (oraz, co ciekawsze, zarzA.Xdzania tA°Xumaczeniami) przy uA°Xyciu narzA.Xdzi gettext w tych obszarach, gdzie nie byA°Xy uA°Xywane, jak na przykA°Xad w obszarze dokumentacji.

Locale::Po4a::TeX jest moduA°Xem uA°XatwiajA.Xcym tA°Xumaczenie dokumentacji w formacie TeX do innych jA.XzykA~Xw [uA°Xywanych przez ludzi].

UA°Xytkownicy najprawdopodobniej powinni uA°XywaA.X moduA°Xu LaTeX, ktA~Xry dziedziczy z moduA°Xu TeX i zawiera definicjA.X czA.Xstych poleceA°X LaTeX.

TA°XUMACZENIE Z POMOCA.X PO4A::TEX

Tego moduA°Xu moA°Xna bezpoA°Xrednio uA°XyA.X do obsA°Xugi ogA~Xlnych dokumentA~Xw w formacie TeX. Podzieli on dokument na mniejsze bloki (akapity, bloki dosA°Xowych tekstA~Xw, a nawet jeszcze mniejsze jak tytuA°Xy czy indeksy).

Istnieje kilka opcji (opisanych w nastA.Xpnej sekcji), ktA~Xre mogA.X dostosowaA.X zachowanie do Twoich wymagaA°X. JeA°Xli nie pasuje ono do formatu Twojego dokumentu, zachA.Xcamy do napisania wA°Xasnego moduA°Xu dziedziczA.Xcego z tego, opisujA.Xcego szczegA~XA°Xy formatu. SzczegA~XA°Xy moA°Xna znaleA°XA.X w sekcji ``Pisanie moduA°XA~Xw pochodnych'' poniA°Xej.

Zachowanie moduA°Xu moA°Xe byA.X takA°Xe zmieniane w pliku TeX za pomocA.X linii zaczynajA.Xcych siA.X od ``% po4a:''. Takie zmiany sA.X opisane w sekcji DOSTOSOWYWANIE ZA POMOCA.X OPCJI W PLIKU A°XRA~XDA°XOWYM.

OPCJE AKCEPTOWANE PRZEZ TEN MODUA°X

Opcje tego moduA°Xu:

debug

Uaktywnia debugowanie kilku wewnA.Xtrznych mechanizmA~Xw moduA°Xu. Informacje o tym, ktA~Xre czA.XA°Xci mogA.X byA.X debugowane, moA°Xna znaleA°XA.X w A°XrA~XdA°Xach.

no_wrap

Rozdzielona przecinkami lista A°Xrodowisk, ktA~Xre nie powinny byA.X powtA~Xrnie zawijane.

ProszA.X zauwaA°XyA.X, A°Xe A°Xrodowiska verbatim i no_wrap siA.X rA~XA°XniA.X. W blokach verbatim nie sA.X analizowane polecenia ani komentarze.

JeA°Xeli A°Xrodowisko nie byA°Xo wczeA°Xniej zarejestrowane, to po4a zaA°XoA°Xy, A°Xe to A°Xrodowisko nie potrzebuje A°Xadnych parametrA~Xw.

exclude_include

Rozdzielona dwukropkami lista plikA~Xw, ktA~Xre nie powinny byA.X wA°XA.Xczane przez \input i \include.

definicje

Nazwa pliku zawierajA.Xcego definicje dla po4a, jak to zdefiniowano w sekcji DOSTOSOWYWANIE ZA POMOCA.X OPCJI W PLIKU A°XRA~XDA°XOWYM. MoA°Xna uA°XyA.X tej opcji, jeA°Xli nie jest moA°Xliwe umieszczenie definicja w tA°Xumaczonym dokumencie.

verbatim

Rozdzielona przecinkami lista A°Xrodowisk, ktA~Xre powinny byA.X przetwarzane tak, jak zostaA°Xy podane.

JeA°Xeli A°Xrodowisko nie byA°Xo wczeA°Xniej zarejestrowane, to po4a zaA°XoA°Xy, A°Xe to A°Xrodowisko nie potrzebuje A°Xadnych parametrA~Xw.

UA°Xycie tych opcji pozwala zmieniA.X zachowanie poleceA°X zdefiniowanych w domyA°Xlnych listach.

DOSTOSOWYWANIE ZA POMOCA.X OPCJI W PLIKU A°XRA~XDA°XOWYM

DziaA°Xanie moduA°Xu TeX moA°Xe byA.X zmieniane za pomocA.X linii zaczynajA.Xcych siA.X od ``% po4a:'', ktA~Xre sA.X interpretowane jako polecenia parsera. Rozpoznawane sA.X nastA.XpujA.Xce polecenia:

% po4a: command polecenie1 alias polecenie2

MA~Xwi, A°Xe argumenty polecenia polecenie1 powinny byA.X traktowane jako argumenty polecenia polecenie2.

% po4a: polecenie polecenie1 parametry

Pozwala szczegA~XA°Xowo opisaA.X parametry polecenia polecenie1. Ta informacja zostanie uA°Xyta do sprawdzenia liczby i typA~Xw parametrA~Xw.

Polecenie polecenie1 moA°Xe byA.X poprzedzone przez nastA.XpujA.Xce znaki:

gwiazdka (*)

po4a wyciA.Xgnie to polecenie z akapitA~Xw (jeA°Xli jest umieszczone na poczA.Xtku lub na koA°Xcu akapitu). TA°Xumacze bA.XdA.X musieli wtedy przetA°XumaczyA.X te parametry, ktA~Xre sA.X oznaczone jako odpowiednie do tA°Xumaczenia.

plus (+)

Tak jak w przypadku gwiazdki, to polecenie bA.Xdzie wyodrA.Xbnione, jeA°Xeli pojawi siA.X na koA°Xcu bloku, ale jego parametry nie zostanA.X oddzielnie przetA°Xumaczone. TA°Xumacz bA.Xdzie musiaA°X przetA°XumaczyA.X polecenie poA°XA.Xczone ze wszystkimi jego parametrami. Pozwala to zachowaA.X wiA.Xcej kontekstu i jest uA°Xyteczne dla wszystkich poleceA°X, przyjmujA.Xcych jako parametr krA~Xtkie sA°Xowo, ktA~Xre moA°Xe mieA.X wiele znaczeA°X (i tA°XumaczeA°X).

Uwaga: w tym przypadku nie trzeba okreA°XlaA.X, ktA~Xre parametry naleA°Xy tA°XumaczyA.X, ale po4a musi znaA.X typ i liczbA.X parametrA~Xw.

minus (-)

W takim wypadku, polecenie nie zostanie wydobyte z A°Xadnego bloku. Ale jeA°Xeli pojawi siA.X samodzielnie w bloku, to tA°Xumaczowi zostanA.X pokazane tylko te parametry, ktA~Xre zostaA°Xy zaznaczone jako moA°Xliwe do przetA°Xumaczenia. Polecenia te zazwyczaj nie powinny byA.X wydzielane z ich akapitA~Xw (aby zachowaA.X kontekst), ale nie ma A°Xadnego powodu, A°Xeby mA.XczyA.X tA°Xumacza nimi, jeA°Xli caA°Xy komunikat jest zawarty w takim poleceniu.

Argument parameters jest zbiorem nawiasA~Xw [] (okreA°XlajA.Xcych argumenty opcjonalne) lub {} (okreA°XlajA.Xcych argumenty wymagane). Aby wskazaA.X, A°Xe parametr ma zostaA.X przetA°Xumaczony, moA°Xna pomiA.Xdzy tymi nawiasami umieA°XciA.X znak podkreA°Xlenia (_). Na przykA°Xad:
 % po4a: command *chapter [_]{_}
To wskazuje, A°Xe polecenie chapter ma dwa parametry: opcjonalny (krA~Xtki tytuA°X) i obowiA.Xzkowy, oba muszA.X byA.X przetA°Xumaczone. Aby okreA°XliA.X, A°Xe polecenie href ma dwa wymagane parametry, oraz A°Xe pierwszy z nich (URL) ma nie byA.X przetA°Xumaczony, oraz A°Xe polecenie to ma nie byA.X oddzielone od otaczajA.Xcego go akapitu (co pozwala tA°Xumaczowi zmieniA.X pozycjA.X linku w zdaniu), moA°Xna uA°XyA.X:
 % po4a: command -href {}{_}
W tym wypadku informacja wskazujA.Xca, ktA~Xre argumenty muszA.X byA.X przetA°Xumaczone jest uA°Xywana tylko wtedy, gdy akapit jest utworzony tylko z tej komendy href.

% po4a: environment A°Xrodowisko parametery

Pozwala to zdefiniowaA.X parametry akceptowane przez A°Xrodowisko A°Xrodowisko. Ta informacja pA~XA°Xniej zostanie uA°Xyta do sprawdzenia liczby parametrA~Xw polecenia \begin oraz pozwala okreA°XliA.X, ktA~Xre z nich majA.X byA.X przetA°Xumaczone. SkA°Xadnia argumentu parametry jest taka sama, jak dla poleceA°X. Pierwszy parametr polecenia \begin jest nazwA.X A°Xrodowiska. Lista parametrA~Xw nie moA°Xe go zawieraA.X. Kilka przykA°XadA~Xw:
 % po4a: environment multicols {}
 % po4a: environment equation

Tak jak dla poleceA°X A°Xrodowisko moA°Xe byA.X poprzedzone plusem (+), aby wskazaA.X, A°Xe polecenie \begin musi byA.X przetA°Xumaczone wraz ze wszystkimi jego argumentami.

% po4a: separator A°Xrodowisko "wyraA°Xenie_regularne"

Wskazuje, A°Xe A°Xrodowisko powinno byA.X podzielone zgodnie z podanym wyraA°Xeniem regularnym.

WyraA°Xenie regularne jest ograniczone cudzysA°Xowami. Nie powinno tworzyA.X A°Xadnej wstecznych referencji. JeA°Xli potrzeba pogrupowaA.X, to naleA°Xy uA°XyA.X (?:). MoA°Xe takA°Xe wymagaA.X kilku znakA~Xw cytowania.

Na przykA°Xad moduA°X LaTeX uA°Xywa wyraA°Xenia regularnego ``(?:&|\\\\)'' , aby osobno przetA°XumaczyA.X kaA°XdA.X komA~XrkA.X tabeli (linie sA.X rozdzielone przez '\\' a komA~Xrki przez '&').

A°Xrodowisko jest rozszerzane do typu wyA°Xwietlanego pliku PO. MoA°Xna tego uA°XyA.X, aby pierwszy wymagany argument polecenia title podzieliA.X na ``\\\\''. W tym przypadku A°Xrodowiskiem jest title{#1}.

% po4a: verbatim environment A°Xrodowisko

OkreA°Xla, A°Xe A°Xrodowisko jest A°Xrodowiskiem dosA°Xownym,tj. takim, w ktA~Xrym wszelkie komentarze i polecenia sA.X ignorowane.

JeA°Xeli A°Xrodowisko nie byA°Xo wczeA°Xniej zarejestrowane, to po4a zaA°XoA°Xy, A°Xe to A°Xrodowisko nie potrzebuje A°Xadnych parametrA~Xw.

PRACA Z MODUA°XAMI POCHODNYMI

pre_trans

post_trans

translate

Funkcje opakowujA.Xce translate TransTractora filtrami uruchamianymi przed przetwarzaniem i po nim.

Komentarze akapitu sA.X wstawiane jako komentarz PO dla pierwszego tA°Xumaczonego komunikatu dla tego akapitu.

get_leading_command($buffer)

Funkcja zwraca:

NazwA.X polecenia

JeA°Xeli na poczA.Xtku podanego bufora nie znaleziono A°Xadnego polecenia, tekst bA.Xdzie pusty. SA.X brane pod uwagA.X tylko te polecenia, ktA~Xre moA°Xna rozdzieliA.X. Hash %separated_command zawiera ich listA.X.

Wariant

OkreA°Xla uA°Xyty wariant. Na przykA°Xad gwiazdka (*) moA°Xe byA.X dodana na koA°Xcu sekcji poleceA°X, aby okreA°XliA.X A°Xe nie powinny byA.X numerowane. W tym przypadku pole to bA.Xdzie zawieraA.X ``*''. JeA°Xli wariant nie istnieje, pole bA.Xdzie pustym A°XaA°Xcuchem znakA~Xw.

TablicA.X par (typ argumentu, argument)

Typem argumentu moA°Xe byA.X albo ``{'' (dla argumentA~Xw wymaganych), albo ``['' (dla argumentA~Xw opcjonalnych).

PozostaA°Xy bufor

Reszta bufora po usuniA.Xciu poczA.Xtkowego polecenia i jego argumentA~Xw. JeA°Xli nie znaleziono polecenia, oryginalny bufor jest zwracany niezmieniony w tym polu.

get_trailing_command($buffer)

To samo co, get_leading_command, ale dla poleceA°X z koA°Xca bufora.

translate_buffer

Rekurencyjnie tA°Xumaczy bufor, wydzielajA.Xc z niego poczA.Xtkowe i koA°Xcowe polecenia (ktA~Xre powinny byA.X tA°Xumaczone oddzielnie).

JeA°Xeli w bieA°XA.Xcym A°Xrodowisku zmienna %translate_buffer_env zawiera definicjA.X funkcji, to ta funkcja zostanie uA°Xyta zamiast translate_buffer() do przetA°Xumaczenia zawartoA°Xci bufora.

read

PrzeA°Xadowanie funkcji read TransTractora

read_file

Rekurencyjnie czyta plik, dodajA.Xc te pliki wA°XA.Xczane, ktA~Xre nie sA.X wymienione w tablicy @exclude_include. Plik wA°XA.Xczane sA.X wyszukiwane w katalogu dokumentu A°XrA~XdA°Xowego lub w katalogu okreA°Xlonym przez zmiennA.X A°XrodowiskowA.X TEXINPUTS.

Poza czA.XA°XciA.X wA°XA.Xczania plikA~Xw, jest to przekopiowane z funkcji read TransTractora.

parse_definition_file

Procedura parsowania pliku zawierajA.Xcego dyrektywA.X po4a (definicje nowych poleceA°X).

parse_definition_line

Przetwarza liniA.X definicji w formacie ``% po4a: ''.

Dalsze informacje moA°Xna znaleA°XA.X w sekcji DOSTOSOWYWANIE ZA POMOCA.X OPCJI W PLIKU A°XRA~XDA°XOWYM.

is_closed

docheader

FUNKCJE WEWNA.XTRZNE, uA°Xywane do pisania parserA~Xw

Funkcje poleceA°X i A°Xrodowiska pobierajA.X nastA.XpujA.Xce argumenty (oraz dodatkowo obiekt $self):

NazwA.X polecenia

Wariant

Tablica krotek (typ, argument)

BieA°XA.Xce A°Xrodowisko

Pierwsze 3 argumenty sA.X wyodrA.Xbniane przez get_leading_command lub get_trailing_command.

Funkcje poleceA°X i A°Xrodowiska zwracajA.X tA°Xumaczenia poleceA°X z jego argumentami i nowe A°Xrodowisko.

Funkcje A°Xrodowiska sA.X wywoA°Xywane, jeA°Xli znaleziono polecenie \begin. SA.X one wywoA°Xywane z poleceniem \begin i jego argumentami.

ModuA°X TeX proponuje tylko jednA.X funkcjA.X poleceA°X i jednA.X funkcjA.X A°Xrodowiska: generic_command i generic_environment.

generic_command uA°Xywa informacji podanych przez register_generic_command albo przez dodanie definicji w pliku TeX:
 % po4a: command polecenie1 parametry

generic_environment uA°Xywa informacji podanych przez register_generic_environment albo przez dodanie definicji w pliku TeX:
 % po4a: environment A°Xrodowisko parametery

Obie funkcje tylko przetA°XumaczA.X parametry, ktA~Xre byA°Xy okreA°Xlone jako moA°Xliwe do tA°Xumaczenie (z ""). generic_environment doda nazwA.X A°Xrodowiska do stosu A°Xrodowiska, a generic_command doda nazwA.X polecenia, po ktA~Xrej nastA.Xpi identyfikator parametru (jak {#7} lub [#2]).

STATUS MODUA°XU

ModuA°X powinien byA.X bardziej przetestowany.

ByA°Xo testowany na ksiA.XA°Xce z dokumentacjA.X Pythona.

LISTA RZECZY DO ZROBIENIA

Automatyczne wykrywanie nowych poleceA°X

ModuA°X TeX mA~XgA°Xby sparsowaA.X argumenty nowego polecenia i sprA~XbowaA.X odgadnA.XA.X liczbA.X i typy argumentA~Xw oraz czy powinny byA.X tA°Xumaczone, czy teA°X nie.

TA°Xumaczenie separatora A°Xrodowiska

Kiedy jako separatora A°Xrodowiska uA°Xyje siA.X \item, to jego argument jest doA°XA.Xczany do nastA.XpujA.Xcego A°XaA°Xcucha znakA~Xw.

NiektA~Xre polecenia powinny byA.X dodane do stosu A°Xrodowiska.

Te polecenia powinny byA.X podawane w parach. UmoA°XliwiA°Xoby podawanie poleceA°X zaczynajA.Xcych lub koA°XczA.Xcych dosA°Xowne A°Xrodowisko.

Inne

RA~XA°Xne inne punkty sA.X oznaczone w A°XrA~XdA°Xach jako ``TODO'', czyli do zrobienia.

ZNANE BA°XA.XDY

RA~XA°Xne punkty sA.X oznaczone w A°XrA~XdA°Xach jako ``FIXME'', czyli do poprawienia.

ZOBACZ TAKA°XE

po4a(7), Locale::Po4a::TransTractor(3pm), Locale::Po4a::LaTeX(3pm).

AUTORZY

  Nicolas FranA~Xois <nicolas.francois@centraliens.net>
 
 

TA°XUMACZENIE

  Robert Luberda <robert@debian.org>
 
 

PRAWA AUTORSKIE I LICENCJA

Copyright 2004, 2005 by Nicolas FRANA~XOIS <nicolas.francois@centraliens.net>.

Program jest wolnym oprogramowaniem; moA°Xna go redystrybuowaA.X i/lub modyfikowaA.X zgodnie z warunkami licencji GPL (patrz plik COPYING).