Provided by:
po4a_0.40-1_all 
NAZWA
po4a-build.conf - plik konfiguracyjny do budowania przetumaczonej
dokumentacji
Wstp
po4a-build.conf opisuje sposb "po4a-build" budowania tumaczonej i
nietumaczonej dokumentacji ze zbioru nieprzetumaczonych dokumentw
rdowych i odpowiadajcych im plikw PO.
Wszystkie dostpne formaty i wszystkie dostpne kombinacje mona zawrze w
pojedynczym pliku konfiguracyjnym po4a-build.conf i w pojedynczym
wywoaniu programu "po4a-build". Jednake mona rwnie rozdzieli katalogi
po/ i uywa oddzielnego pliku konfiguracji dla kadego uruchomienia
(naley wtedy za kadym razem wywoa "po4a-build -f PLIK").
(Patrz take opis opcji KEEP poniej, eby dowiedzie si o ograniczeniach
czenia wikszej liczby plikw do jednego pliku POT w jednym uruchomieniu
"po4a-build".)
Prosz zauway, e chocia po4a-build umoliwia obsug tumacze komunikatw
wyjciowych skryptw powoki, to po4a-build.conf nie wspiera tego.
po4a-build.conf jest zwizany tylko z tumaczeniami statycznej zawartoci,
na przykad stron podrcznika ekranowego.
Prosz przeczyta po4a-runtime (7), aby dowiedzie si o wspieraniu przez
po4a-build tumacze komunikatw skryptw powoki.
Obsugiwane formaty
Obecnie "po4a-build" obsuguje nastpujce kombinacje:
Docbook XML dla sekcji 1 i 3
Zazwyczaj uywany przez strony podrcznika skryptw powoki lub innych
interpreterw, ktre nie maj wasnego formatu dokumentacji typu POD.
Odpowiedni XML mona wygenerowa bezporednio z istniejcej strony
podrcznika za pomoc "doclifter", a "po4a-build" wygeneruje wtedy
plik POT. Plik POT mona wtedy zaoferowa do przetumaczenia, a pliki
PO mona doda do odpowiedniego katalogu po/. "po4a-build" przygotuje
wtedy nie tylko nieprzetumaczon stron podrcznika uywajc
"doclifter", ale take wywoa "po4a" do przygotowania przetumaczonych
XML-i z plikw PO i wygenerowania z niego przetumaczonych stron
podrcznika.
Strony podrcznika s generowane przy uyciu domylnych ustawie
docbook-xsl. Uyty arkusz stylw mona zmieni za pomoc ustawienia
"XSLFILE" pliku konfiguracyjnego "po4a-build".
DocBook XML dla HTML
Arkusz stylw uywany do wygenerowania ostatecznego HTML-a mona
zmieni za pomoc ustawienia "XSLFILE" pliku konfiguracyjnego
"po4a-build"; mona te uy domylnego arkusza.
POD dla sekcji 1, 3, 5 oraz 7.
pod2man jest uywany do konwersji zawartoci POD dla kadej z
obsugiwanych sekcji.
Prosimy uy "PODFILE" dla sekcji 1, "PODMODULES" dla sekcji 3,
"POD5FILES" dla sekcji 5, "POD7FILES" dla sekcji 7.
W przypadku zawartoci sekcji 5 lub 7 (ktre zazwyczaj wymagaj nazwy
pliku uywanego rwnie w przypadku zawartoci sekcji 1), jeli czci
nazwy pliku jest 5 lub 7, to zostan one automatycznie usunite z
nazwy pliku (cznie z jakimkolwiek rozszerzeniem nazwy pliku).
Na przykad, aby przygotowa /usr/share/man/man7/po4a.7.gz :
# pliki POD dla sekcji 7
POD7FILES="doc/po4a.7.pod"
Zawarto pliku
Kolejno wystpowania zmiennych konfiguracji w pliku jest dowolna.
Jakakolwiek zawarto po znaku "#" jest ignorowana.
Wartoci, ktre zawsze bd puste, mona usun z pliku.
Niektre pola konfiguracji s wymagane - po4a-build moe nic nie zrobi,
jeli pola te nie bd wypenione.
CONFIG
Wymagany.
# nazwa i lokalizacja pliku konfiguracji
CONFIG="_build/po4a.config"
Nazwa i lokalizacja (tymczasowego) pliku konfiguracyjnego "po4a",
ktry "po4a-build" wygeneruje i ktrym bdzie zarzdza. Pliku tego nie
trzeba dodawa do systemu kontroli wersji i moe by czyszczony
podczas budowania pakietu.
PODIR
Wymagany.
# PODIR pkatalog po stron podrcznika/dokumentacji
PODIR="po/pod"
Katalog zawierajcy pliki PO WSZYSTKICH tumacze obsugiwany przez ten
plik konfiguracyjny. Wszystkie komunikaty bd poczone do jednego
pliku POT w tym katalogu, a wszystkie pliki PO poczone z tym
plikiem POT. Kady prg KEEP (patrz niej) bdzie stosowany do
wszystkich komunikatw ze wszystkich plikw wejciowych podanych w tym
pliku i do wszystkich plikw PO w tym katalogu. Katalog nie musi si
nazywa "po".
POTFILE
Wymagany.
cieka do pliku POT (wzgldna w stosunku do lokalizacji tego pliku
konfiguracyjnego), ktry bdzie generowany, zarzdzany i aktualizowany
przez "po4a-build".
# cieka do POTFILE
POTFILE="po/pod/po4a-pod.pot"
BASEDIR
Wymagany.
Katalog bazowy do zapisywania przetumaczonej zawartoci.
# katalog bazowy dla wygenerowanych plikw, np. plikw doc
BASEDIR="_build"
BINARIES
Wymagany.
Nawet jeli budowany jest tylko jeden pakiet, wymagane jest podanie
co najmniej jednej wartoci w tej zmiennej.
Warto tego pola moe by przypadkowa, ale zazwyczaj zawiera nazw
pakietu. Wygenerowane dokumenty pojawi si w podkatalogach
BASEDIR/BINARIES:
_build/po4a/man/man1/foo.1
Jeli pakiet buduje wicej ni jeden pakiet binarny (tj. jeden pakiet
rdowy i wiele plikw *.deb lub *.rpm), to to pole moe pomc w
rozdzielaniu zawartoci kadego pakietu, uatwiajc tym samym
automatyzacj procesu budowania.
acuchy znakw naley rozdziela spacjami.
# pakiety binarne, ktre bd zawiera wygenerowane strony podrcznika
BINARIES="po4a"
KEEP
Warto przekazywana bezporednio do "po4a -k" okrelajca procentowy
prg tumacze pozwalajcy zachowa tumaczenie (w przypadku
nieprzekroczenia progu wygenerowany przetumaczony dokument jest
usuwany). Prosz zostawi to pole puste lub usun go, aby uy wartoci
domylnej (80%), albo ustawi warto na zero, aby wymusi wczenie penej
zawartoci, nawet kompletnie nieprzetumaczonej.
Aby w peni kontrolowa to zachowanie, prosimy rozwanie przypisywa
pliki do odpowiednich zmiennych pliku konfiguracyjnego
po4a-build.conf. Kady plik wymieniony w jakimkolwiek pliku
po4a-build.conf bdzie uywany w wyliczeniu procentowej wartoci
przetumaczonych komunikatw. Jeden duy, ale w niewielkim stopniu
przetumaczony plik spowoduje wyrzucenie innych, mniejszych plikw z
budowanego pakietu, nawet jeli kady z tych mniejszych plikw jest
przetumaczony w 100%.
Z drugiej strony umieszczenie wielu plikw w jednym pliku POT moe by
wygodniejsze dla tumaczy, zwaszcza jeeli pliki te maj wsplne
akapity. Odwrotnie, pliki POT z tysicami komunikatw do
przetumaczenia zniechcaj tumaczy i prowadz do zamroenia komunikatw.
# minimalny procentowy prg tumacze pozwalajcy zapisa plik wynikowy
KEEP=
XMLMAN1
Nazwy plikw DocBook XML do wygenerowania w sekcji 1. Nazwy plikw
powinny by rozdzielone spacjami. Wszystkie pliki powinny si
znajdowa w katalogu XMLDIR.
Powszechn praktyk jest skadanie wielu plikw XML w jedn ksik w celu
dostarczenia spisu treci itp. Jeli ksika zawiera pliki podane rwnie
w XMLMAN3, tutaj naley poda tylko pliki nalece do sekcji 1, a nie
plik z nazw caej ksiki. Jeli ksika skada si tylko z tej sekcji,
naley poda plik z nazw caej ksiki.
# pliki DocBook XML do sekcji 1.
XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"
XMLMAN3
Nazwy plikw DocBook XML do wygenerowania w sekcji 3. Nazwy plikw
powinny by rozdzielone spacjami. Wszystkie pliki powinny si
znajdowa w katalogu XMLDIR.
Powszechn praktyk jest skadanie wielu plikw XML w jedn ksik w celu
dostarczenia spisu treci itp. Jeli ksika zawiera pliki podane rwnie
w XMLMAN1, tutaj naley poda tylko pliki nalece do sekcji 3, a nie
plik z nazw caej ksiki. Jeli ksika skada si tylko z tej sekcji,
naley poda plik z nazw caej ksiki.
# strony podrcznika Docbook XML do sekcji 3.
XMLMAN3=""
XMLDIR
Lokalizacja wszystkich plikw DocBook XML. Obecnie "po4a-build"
oczekuje, e bdzie w stanie znale wszystkie pliki wymienione w
XMLMAN1 i XMLMAN3, szukajc w tym katalogu plikw *.xml.
Musi by podane, jeli uywa si XMLMAN1 lub XMLMAN3. cieki s wzgldne w
stosunku do lokalizacji pliku konfiguracji.
# lokalizacja plikw XML
XMLDIR="share/doc/"
XMLPACKAGES
Ktre pakiety, z listy podanej w BINARIES, uywaj rdowego XML-a.
Jeli wypeniono XMLMAN1 lub XMLMAN3, naley wypeni rwnie t zmienn.
# pakiety binarne uywajce DocBook XML & xsltproc
XMLPACKAGES="po4a"
DOCBOOKDIR
Podobne do XMLDIR, ale uywane tylko do utworzenie przetumaczonych
plikw DocBook. Jeli Twj pakiet uywa plikw *.sgml, prosimy
przedyskutowa sposb jego budowania na licie e-mailowej po4a-devel.
# wzorzec wyszukiwania plikw .docbook
DOCBOOKDIR=""
XSLFILE
Arkusz stylw XSL uywany do przygotowania przetumaczonej i
nieprzetumaczonej zawartoci plikw DocBook XML.
# plik XSL uywany w Docbook XSL
XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
PODFILE
Plik(i) POD tworzce sekcj 1 stron podrcznika ekranowego. Nazwy
plikw POD powinny by rozdzielone spacjami. cieki, jeli s uywane,
powinny by wzgldne w stosunku do lokalizacji podanego pliku
konfiguracji.
# pliki POD dla man1
PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"
PODMODULES
Specjalne wsparcie moduw Perla zawierajcych zawarto POD - nazwa
moduu bdzie zbudowana ze cieki pliku (tak wic cieka powinna
odzwierciedla typowy ukad cieek Perla), a strony podrcznika bd
automatycznie umieszczone w sekcji 3.
# pliki POD dla man3/ - nazwy moduw utworzone ze cieki.
PODMODULES="lib/Locale/Po4a/*.pm"
POD5FILES
Dowolna zawarto POD tworzca strony podrcznika ekranowego w sekcji
5. cieki, jeli s uywane, powinny by wzgldne w stosunku do
lokalizacji podanego pliku konfiguracji.
W przypadku zawartoci sekcji 5 lub 7 (ktre zazwyczaj wymagaj nazwy
pliku uywanego rwnie w przypadku zawartoci sekcji 1), jeli czci
nazwy pliku jest 5 lub 7, to zostan one automatycznie usunite z
nazwy pliku (cznie z jakimkolwiek rozszerzeniem nazwy pliku).
# pliki POD dla sekcji 5
POD5FILES="doc/po4a-build.conf.5.pod"
POD7FILES
Dowolna zawarto POD tworzca strony podrcznika ekranowego w sekcji
7. cieki, jeli s uywane, powinny by wzgldne w stosunku do
lokalizacji podanego pliku konfiguracji.
W przypadku zawartoci sekcji 5 lub 7 (ktre zazwyczaj wymagaj nazwy
pliku uywanego rwnie w przypadku zawartoci sekcji 1), jeli czci
nazwy pliku jest 5 lub 7, to zostan one automatycznie usunite z
nazwy pliku (cznie z jakimkolwiek rozszerzeniem nazwy pliku).
# pliki POD dla sekcji 7
POD7FILES="doc/po4a.7.pod"
PODPACKAGES
Podobne do XMLPACKAGES - kady pakiet oczekujcy dokumentacji
zbudowanej z plikw POD powinien by wymieniony w PODPACKAGES. Pole
jest wymagane, jeli podano wartoci w PODFILE, PODMODULES, POD5FILES
lub POD7FILES.
# pakiety binarne uywajce POD
PODPACKAGES="po4a"
HTMLDIR
Podkatalog katalogu BASEDIR, w ktrym bd umieszczone wynikowe pliki
HTML, zarwno przetumaczone, jak i nieprzetumaczone.
# wyjcie HTML (podkatalog BASEDIR)
HTMLDIR=""
HTMLFILE
Plik DocBook jest konwertowany do HTML-a (moe by taki sam jak jeden
z plikw w XMLFILE). Sekcje nie maj znaczenia w przypadku wyjcia
HTML, wic mona uy tutaj pojedynczego pliku ksiki, tak eby mia spis
treci itp.
# plik DocBook HTML
HTMLFILE=""
HTMLXSL
Domylnie jest uywany jeden arkusz stylw XSL. Podanie wikszej liczby
arkuszy stylw dla jednego przebiegu generowania HTML-a nie jest
obecnie wspierane.
# plik XSL uywany z Docbook XSL
HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"
AUTORZY
Neil Williams <linux@codehelp.co.uk>