Dziś jest piątek, 22 sierpnia 2008 roku (z kalendarza...)

Dokumentujemy OPT

Icon

23.04.2005, 09:42

Webmaster

Komentarze (0)

Powrót

Dzisiaj przyszedł czas na ostateczne posprzątanie śmieci z tworzonej dokumentacji OPT. Ustaliłem ogólnie jej kształt, dopisałem kilka rozdziałów i teraz patrzę, ile jeszcze roboty przede mną. Całość przygotowuję w DocBook + DocBook XSL Stylesheet + PHP do składania wszystkiego do kupy.

System budowania dokumentacji wzorowałem na phpdoc używanym do tworzenia manuala PHP. Różnica jest taka, że tam skrypt budujący napisany jest w bashu, co wymusza użycie Linuxa. Ja tymczasem na co dzień robię pod Windowsem, dlatego swą wersję napisałem w PHP, a całość odpala się z linii komend: php -f build.php pl html-chunk. Zadaniem skryptu PHP jest połączenie porozrzucanej w setkach plików dokumentacji w jeden wielki dokument, odpalenie procesora XSL (tu: xsltproc) do przerobienia go na HTML, pokolrowanie składni w przykładach oraz posprzątanie śmieci po procesie budowania. Całość jest bardzo przydatna, bowiem ręczne wywoływanie każdego polecenia do najprzyjemniejszych nie należy. A tak podaję język dokumentacji i jej rodzaj (tu: HTML, wiele stron), a skrypcik automatycznie dobiera mi arkusz stylów, konfiguruje parser i w ogóle.

Jeśli chodzi o samą strukturę dokumentacji, to źle zrobiłem, opisując w sekcji "Dla programistów" metody i pola przy użyciu <refentry>. XSL generuje przez to beznadziejne menu, a ja muszę przerabiać ponad 60 plików...

Powrót

Skomentuj

NickInformacja
E-mailTylko do użytku wewnętrznego.
WWWNie zapomnij o http://
LayoutNapisz tu, czy widzisz dzienny czy nocny layout.
WpisFormatowanie wiki
Internauto, pamiętaj! Wolność to nie samowola - dbaj o kulturę wypowiedzi oraz dyskusji w sieci.

Na Zyxist.com panuje swoboda wyrażania opinii oraz krytyki pod dowolnym adresem. Jedyny warunek: musi być ona kulturalna i rzeczowa. Na chamstwo, prostactwo lub jawne obrażanie kogokolwiek nie ma tu miejsca i takie komentarze są bardzo szybko usuwane. Jeśli zamierzasz polemizować z treścią wpisu, wpierw uważnie ją przeczytaj.

© Tomasz "Zyx" Jędrzejewski 2005 - 2008 | Wykonanych zapytań: 1 | Serwer wirtualny zapewnia