Propozycja struktury

[Tomasz Rutkowski]

Krzysztof Królikowski wrote:

>On Sun, Dec 28, 2003 at 02:25:07PM +0100, Tomasz Rutkowski wrote:
>  
>
>>Eee Wiem że jestem troche upierdliwy ale dlaczego takie podział?
>>
>>    
>>
>Może podział nie był najszczęśliwszy, ale zawsze jakiś. Miał posłużyć
>wywołaniu jakiejś burzy mózgów ;P
>
>  
>
>>Czy można gdzieś znaleść dokładne założenia co ma być przygotowywane, 
>>gdzie ma się to znaleźć.
>>    
>>
>
>Szczerze mówiąc, myślałem nad wykorzystaniem materiałów z
>docs.pld-linux.org. Przetłumaczeniem tego, zmianą na naszego docbooka,
>no i sukcesywnym uzupełnianiu.
>
>  
>
>>Nie wiem czy dobrze rozumuje (patrz niżej).
>>Devel pewno miał by być na http://developer-doc.pld-linux.org/ i byłby 
>>tworzony w SVN.
>>Faq najlepiej jak by było na http://www.pld-linux.org/ gdzie wiki 
>>doskonale się do tego nadaje i uzupełniało działy które nie są jeszcze 
>>opisane.
>>    
>>
>
>Hm.. nie bardzo rozumiem, do czego zmierzasz Tomku ;) I co (kto) to jest
>wiki? :)
>  
>
Wydawało mi się że pld-linux.org działa na wiki, ale nie mam jak tego 
sprawdzić bo w tej chwili nie działa.
Chodziło mi o to że na http://www.pld-linux.org/ każdy kto jest 
zalogowany może dodawać materiał w faq.
Dlatego jest to odpowiedniesze miejsca na faq.
Żeby być ścisłym. Przez faq rozumiem taką formę:
P: Przeciołem sobie palec jak go opatrzyć ?
O: Naklej plaster ;)

>  
>
>>Jednak podział Desktop - Server wydaje mi się sztuczny. Skoro ma być to 
>>dokumentacja to będzie dotyczyła konkretnych pakietów lub zagadnień. 
>>Dlatego wydaje mi się że lepszy podiał byłby na rozdziały (duże) niż na 
>>Desktop - Server.
>>Nie wiem czy wyraziłem się dość jasno. Mam nadzieje że tak.
>>
>>Co o tym sądzicie.
>>
>>    
>>
>Dziękuję za komentarz :)
>Chciałbym jeszcze Cię prosić o jakąś rozsądniejszą propozycję podziału
>materiału. Może taki jak na docs.pld-linux.org? Czy może masz jakiś inny
>pomysł?
>Co do dokumentacji konkretnych pakietów to nie wiem, czy jest ot
>konieczne. Zazwyczaj programy posiadają już jakąś dokumentację.
>
>pozdr
>  
>
Nie dokładnie się wyraziłem jeśli chodzi o dokumentacjie pakietów.
Chodziło mi o coś takiego:
http://docs.pld-linux.org/restart-shutdown.html
lub polski odpowiednik
http://student.wsp.krakow.pl/~rennis/pld/c18.html#AEN22
Czyli przykładowe zastosowanie/możliwości na przykładach (osobiście 
takie do mnie najbardziej przemawiają jak coś czytam).

Co do podziału to ten na http://docs.pld-linux.org/ jest dobry tylko ma 
taką samą jak dla mnie wade co http://www.pld-linux.org/ .
Chodź nie wiem czy dla wszystkich to wada.

Jak jest krótki dział/temat to trzeba się dużo naklikać by coś znaleźć.
np. cały dział Network configuration 
http://docs.pld-linux.org/interfaces.html
(Nie wiem po co coś dodawać jak prawie tam nic nie ma).

Za to duża zaleta takiego podejścia jest że jak dział/temat jest spory
http://docs.pld-linux.org/subsystems.html
to jest bardzo przejrzysty.

Podsumowując.
Byłbym za układem z podziałem na kilka plików. Forma pezentacji jest dla 
mnie drugorzędna pod warunkiem, że można łatwo daną informacje znaleźć 
(podział na zagadnienia). Praca z kilkoma plikami jest łatwiejsza do 
śledzenia zmian i robienia poprawek.
Przykład:
http://student.wsp.krakow.pl/~rennis/pld/book.tar.bz2

Po rozkakowaniu i wywaleniu plików html: ls *

meta  pld_guide.docb  README  TODO
 
konfiguracja:
konfiguracja.sgm  pam.sgm  siec.sgm
 
podstawy:
podstawy.sgm
 
wstep_zakonczenie:
wstep.sgm  zespol.sgm
 
zarzadzanie:
zarzadzanie.sgm

Książke generuje się dla pliku pld_guide.docb ,który robie za nas czarną 
robotę scalając pliki rozdziałów.
Dodając nowy rozdział (duży) w osobnym pliku wystarczy dodać do pliku 
pld_guide.docb linijki
<!ENTITY zespol SYSTEM "wstep_zakonczenie/zespol.sgm">
oraz
&zespol;

Co według mnie jest małym nakładem pracy za czytelność.
Skrypt "meta" wywoływany był na końcu by ustawić w plikach html polskie 
kodowanie (inaczej nie udało się tego rozwiązać).

Pozdrawiam i mam nadzieje że nie przynudziłem za mocno i udało mi się 
wyrazić to o co mi chodziło.

-- 
"Głupota nie boli ludzi głupich za nich inni cierpią."
Tomasz Rutkowski - gg 1118937