Dokumentacja (długie, ale przeczytajcie proszę)

Ziemek Borowski ziembor w FAQ-bot.ZiemBor.waw.pl
Wto, 2 Lis 1999, 16:14:01 CET


Przepraszam za formę ale nie subskrybuję (i na razie nie zamierzam) 
pld-list. A i foldery z archiwami znikneły z z ftp.pld i newsów też nie ma... 


>     * From: Tomasz Kłoczko <kloczek w rudy.mif.pg.gda.pl>
>     * cc: klakier w pg.gda.pl
>Z tego co pamietam to postać źródłowa i tak była w latexu.

Obaj źle pamiętamy: w wypadku samby jest to yodl. A w bindie 8.2.1 od razu
HTML, groff i co tam jeszcze (w źródłach nie ma śladów konwersji). 

>Jeżeli chcesz to zrobić w jednym podejściu owszem. Jeżeli wyznaczysz to
>jako kierunek w którym należy iść to juz jest to mniej obciązające.
>Pierwszrego podejścia nikt chyba o zdrowych zmysłach nie będzie
>poroponował.

Ale w wypadku gdy konfekcjonuje się cudze pakiety to to jako drugi 
czy n+1 krok też  nie ma sensu. 

>> Nb. decydując się na docbooka w grunice rzeczy nie musicie wybierać
>> SGMLa -- można od razu pisać w DocBook XML.
>
>Można. Jak uważasz, ze będzie łatwiej z jednoczesnym rozsądnym poziomem
>elestyczności ?

trudno powiedzieć. Automatyka jest prawie taka sama. 

>>   * przerzucić się z jade na openjade (ten przynajmniej jest rozwijany
>>    -- jade nie bo James Clark stawia wszystko na XMLa i XSLa).
>>   * zrobić pljadetex jak proponował to Piotrek Bolek na Bachotku (chyba
>>   że udało się wam zwalczyć pliterki inaczej). Nie zaszkodziłby też
>>   plpdfjadetex.
>
>Czy dałoby sie to potem zintegrować z openjade  przez podrzucenie
>maintainegom jakiś poprawek ?

Nie. W tym momencie byłyby to tylko operacje dla jednego charsetu. A
na to się nie zgodzą. Zresztą problem jest nie z openjade a jadetexem
(który jest oddzielnym pakietem zarządzanym przez Sebastana Rathza --
a Sebastian jest ciężko przekonywalny).

Alternatywą jest przejście w całości na UTF8 na wejściu.  Właśnie toto
testuję. Może coś wyjdzie.

>     * From: "Jacek Konieczny" <jajcus w zeus.polsl.gliwice.pl>
>     * Date: Mon, 1 Nov 1999 15:15:05 +0100
>       <Pine.LNX.4.10.9911010055510.1221-100000 w rudy.mif.pg.gda.pl>; from

>Mnie się ten pomysł wogóle nie podoba. A co przy uaktualnieniach
>dokumentacji? W końcu ludzie w PLD zajmowali by się tylko dokumentacją.

Oj tak. 

>A co do dokumentacji, którą musimy zrobić do PLD - tu trzeba określić
>standard i sie jego trzymać.
>Mnie osobiście na JWL'99 przekonano do PDF-a, choć ma on swoje wady
>(trudno przeszukiwać). Napewno SGML jest dobrym kierunkiem - ale co
>dalej to nie jestem pewien.

Rozróżnijmy to w czym tworzyć dokumentację od tego w czym ją dawać
użytkownikom. Do tego drugiego PDF się świetnie nadaje. 
Ale tworzenie? W tej chwili implikuje pratycznie tylko TeXa w różnych
odmianach. IMHO należy o tym zapomnieć (TeX i LaTeX ma mnóstwo zalet, 
i jedno podstawową wadę: jest potwornie bałaganiarski i hackerski). 

>     * From: Rafał Kleger-Rudomin <klakier w pg.gda.pl>

>Nie. Chodzi o to by w przyszłości przy budowaniu pakietu dokumentacja była
>przerabiana z texinfo i man (bo głównie o nie chodzi) _automatycznie_ na
>Docbook (w wersji SGML lub od razu XML)

A wiesz, że jest to możliwe? Masz jakeś zasady na podstawie których możesz toto 
parsować i przekształcać na SGMLa? (dać się da ale obawiam się że w 
dość ograniczonym zakresie). 

> i w
>takiej postaci trzymana w dystrybucji. Kiedy będą już w powszechnym użyciu
>przeglądarki XML będziemy do przodu.

A będą? Co do tworzenia zupełnie nowej dokumentacji: DocBook może być. 
Ale do konwersji formatów zastanych: MBSZ -- zapomnijcie. Mnóstwo 
praktycznie bezproduktywnej roboty. Z mimimalnym potencjalnym zyskiem. 



-- 
Ziemek Borowski ZB137-RIPE http://faq-bot.ziembor.waw.pl/zmb/ 



Więcej informacji o liście dyskusyjnej pld-devel-pl