PLDmanual?

[Tomasz Kłoczko]

On Tue, 28 Sep 1999, Artur Frysiak wrote:

> 
> SGML DocBook.
> Można konwertować na html, man, info, ps, pdf, tex i jeszcze więcej
> formatów.
> Narzędzia do SGML: jade, sp są ok. Coś jeszcze potrzeba ?
> Co dokładnie nie działą ?

Artur chyba dobrze będzie zacząć szerzej mówić o tym o czy mwczoraj sobie
gadaliśmy na ircu.

Ab ovo jak mawiali rzymianie .. (łać. od jajka, od początku).

Stan obecny wygląda tak, że e dokumnetacja wpada nam do %{_mandir},
%{_infodir} i %{_defaultdocdir}.

Chodzi o to żeby zacząć lepiej gospodarować dokumentacja jako taką.
Generalnie z różnymi pakietami dokumentacja przychodzi w kilku postaciach:
 - ascii,
 - html,
 - sgml,
 - ps,
 - pdf,
 - dvi,
 - man,
 - info.

Z info nie ma dużego kłopotu. W tej chwili polityka jest jasna. Każda
strona ma mieć @direntry i ma być w odpowiedniej grupie posiadając wpis
typu @directory przydzielajacy dana strone do danej grupy.
Zasoby w obecnej postaci nei dają sie indeksować ale info daje sobie
ładnie radę z wyszukowaniem informacji w tych zasobach (pinfo ma tu
jeszcze nadal braki).

Z manami też nie ma kłopotu. Jest whatis jest też man2html-cgi, który poz
zainstalowaniu serwera http umożliwia przegląfdanie manów i ich
przeszukiwanie poprzez serwer http. Nie wiem co prawda jak wygląda w tej
chwili zachowanie man2html-cgi przy zainstalwoanych polskich manach.
Przypuszczam, że jest tu zima i jeżeli ktoś miałby chęć to mógłby się
zając tematem tdostosowania tego skryptudo potrzeb systemu z
zainstalowanymi wielojęzycznymi manami.
Zasoby wystawiane poprzez man2html-cgi można próbować nawet jakoś
indeksować np. z użyciem freeWAIS czy ht://dig.

Z reszta można robić w ten sposób, że rejestrować je we wspólnej
meta-bazie która mając hierarchię drzewiasta tematów umożliwiałaby w
poszczególnych punkach takiej herarhii posiadanie dokumentu
html/sgml/xml w których byłyby rejestrowane wszystkie inne dokumenty (pdf,
dvi, ps, htm, sgml). Taka hierarhia dokumentów mogłaby być serwowana przez
serwer www pracujący lokalnie. Do poprawnego tych wszystkich typów
dokumentów trzebby tylko zadbać, żeby np. szkapa czy też inne przeglądarki
miały poinstalowane odpowiednie wtyczki które umożliwiałyby przeglądanie
z poziomu przegladarki tych typów dokumentów (a są takie).

Do zrealizowania tej koncepcji trzebaby tylko skompletować odpowiednie
narzędzia którymi możnaby zarządzać taką bazą dokumentów. O ile byłoby to
możliwe to dobrze byłoby unikać pchanai sie w perla czy pythona (zapewn są
juz inne prostrze nazre dzia które tylko wystarczyłoby namierzyć takowe).
następnie trzebaby sformalizować odpowiednie regóły posługiwania sie
takimi i dalej jakąś hierarchię dokumentów w którą wkłądałoby sie wszelką
dokumentację (mogłaby być moze ona nawet tożsama z hierarhią jaką tworzą
pola Group w pakietach).

W przypadku man, sgml/html/xml da sie troche jeszcze bardziej ujednoliciś.
Otóż są narzędzia (gotowe) służące do renderingu sgml to groff więc w
jakieś prerspektywie (jednak) bedzie mozaliwe zrobienie mana który będzie
w stanei czytać dokumenty sgml a wypluwać *roff output (jest to
docbook-to-man-ans). Załatwić by trzeba tylko jakoś jeszcze w miarę
automatyczną konwersje groff to sgml/xml.

Wszystko to po to żeby całą dosepna dokumentację zainstalowaną w systemie
moąna było przeglądać jednym narzędziem, wyszukiwać w tym wszystkim
potrzebne informacje po zindeksowaniu.

W tym tym samym kierunku od jakiegoś czasu idzie zdaje sie Debian z
dhelpem. Czy moze ktoś bliżej przyglądał sie temu narzędziu i regułom
traktowania dokumentacji w psczegółnych pakietach jak jest ostatnio
uskuteczniana w Debianie ?

Jeszcze jedno. Otóż w tej chwili regółą jest to, że pakujemy dokumentację
ascii gzipem. W tej chwili jeżeli chcieć zacząć te dokumenty serwować
przez serwer http to nie ma wiekszego kłopotu. Oóż wmamy pakiet
apache-mod_gunzip, który umożliwia serwowanie dokumentów, które są po
stronie serwera skompresowane. Swoja drogą .. apache-mod_gunzip jest
kolejnym pakietem wyznaczającym nowy/prawidłowy kierunek. Otóż pakiet ten
zawiera procedurę automatycznego {de}rejestrowania modułów apache w
httpd.conf. Jeże komukolwiek przyjdzie brać sie za jakiś pakiet z modułem
do apache to proszę zacząć od przyjrzenia się temu pakietowi. Swoja drogą
aż dziw bierze, że w żadnej dystrybucji jak dotąd z pakietami z modułami
nikt tego nie zrealizowano dokładnie w ten sposób. W Debianie w kilku
pakietach z modułami są używane jakieś chore narzędzia w perlu i nikt
jakoś nie potrafił zauważyć, że stosowne narzędzie przychodzi z samym
apache :>
Wszystko rozbija się o programik apxs :)
Tak czy inaczej za tym który ten sposób znalazł niemal pod nogami
odpowiedzialny jest Artur :-)

kloczek
-- 
-----------------------------------------------------------
*Ludzie nie mają problemów, tylko sobie sami je stwarzają*
-----------------------------------------------------------
Tomasz Kłoczko, sys adm @zie.pg.gda.pl|*e-mail: kloczek w rudy.mif.pg.gda.pl*