CIE¥:

Cieµom je navrhnú» systém spracovania TeXovských (LaTeXovských dokumentov) tak, aby:

vytvorenie nového dokumentu bolo triviálnou zále¾itos»ou a zvládol to aj zaèiatoèník, ktorý e¹te nemá veµké skúsenosti so sádzacím systémom TeX / LaTeX.
bola zaruèená prehladnos» a dobré spravovanie dokumentov s ohµadom na neskor¹ie roz¹irovanie stromovej ¹truktúry. Predpokladá sa preto spolupráca so systémom CVS
bolo mo¾né zostavi» dokument vo formáte PostScript a PDF a to napísaním príkazu 'make' v hlavnom adresári alebo v adresári, kde sa dokument nachádza
bolo mo¾né príkazom 'make' necha» spracova» viacero dokumentov naraz

NASTAVENIA

Staèí nakopírova» súbory (s dodr¾aním adresárovej ¹truktúry) a v¹etko by malo fungova». Samozrejme, k úspe¹nému vytvoreniu dokumentu je potrebná funkèná in¹talácia LaTeXu (v Linuxe balíky tetex-*, pod Win32 sa odporúèa TeX-Live (voµne prístupný) alebo MikTeX (komerèný?)). Odporúèa sa pou¾íva» platformu GNU/Linux. Pre iné platformy momentálne e¹te nie je zaruèená plná funkènos».

POPIS

Základný systém pozostáva z tejto základnej adresárovej ¹truktúry:

platos/

hlavný adresár

Tento adresár obsahuje tie najzákladnej¹ie súbory: README.sk (to je práve tento doument, ktorý èítate), Rules.make, Makefile apod.

README.sk - dokumentácia k systému v slovenskom jazyku

Makefile - základný makefile. Aj tento makefile includuje súbor

_templates/Rules.make

platos/_templates

základné súbory, ktoré sú potrebné k vytvoreniu nového dokumentu

Súbory z tohto adresára sú nakopírované skriptom _scripts/create-document do adresára s novovytvoreným dokumentom. Sú tým najnutnej¹ím základom.

.cvsignore - zoznam súborov, ktoré má CVS ignorova». Do tohto súboru

                   sa pridávajú dokumenty, ktoré sa generujú automaticky.
                   To je základný princíp. Sú samozrejme ale výnimky.
                   Jednu z nich tvorí PostScriptový súbor s logom
                   organizácie Platon SDG. Ten je mo¾né vygenerova» zo
                   súboru platon-logo.fig (XFig obrázok), ale ked¾e sa logo
                   pou¾íva v ka¾dom dokumente, je dobré, aby logo bolo v CVSku.

    Makefile     - súbor s pravidlami pre program 'make'. Umo¾òuje
                   vygenerovanie dokumentu bez toho, aby sa èlovek musel
                   stara» o veµa vecí

Rules.make - základné pravidlá, ktoré sa 'includujú' v súboroch

*/Makefile

platos/_stylesheets/

adresár s predefinovanými ¹týlmi. 1 adresár = 1 ¹týl.

platos/_stylesheets/platon/

¹tandardný ¹týl pou¾ívaný v dokumentoch organizácie Platon SDG

platon-core.sty

súbor základných makier pre LaTeX, ktoré nemô¾u by» definované v platon.sty

platon.sty - ¹týlový súbor pre LaTeX. Obsahuje makrá a základné

                   definície, ktoré dávajú dokumentom Platon SDG jednotný
                   výzor.

platon-logo.eps
platon-logo.fig
platon-logo.png

logo organizácie Platon SDG v rôznych formátoch

template.tex - ¹ablóna dokumentu. Pri vytvorení nového dokumentu sa

                   z nej vychádza. Robí sa pri tom substitúcia základych
                   makier, napr. FILENAME, STYLESHEET, DATE, YEAR, ...

platos/_stylesheets/vami_definovany_styl/

Vami definovaný ¹týl

platos/_scripts

pomocné programy, ktoré by mali uµahèi» spracovanie alebo vytvorenie dokumentu

platos/03-02-04-*

adresáre s dokumentami

Aby sa zachoval prehµad v tom, kedy a aké dokumenty boli napísané, odporúèa sa pou¾íva» nasledujúci systém:

dokument sa umiestòuje do zvlá¶tneho adresára
meno adresára sa zaèína dátumom v tvare '03-01-29', teda: 'rok-mesiac-den'
za dátumom nasleduje znak mínus '-'
za znak mínus sa pridáva struèný popis dokumentu

Príklad:

        03-02-04-first-test-document
            (prvy testovaci dokument)
        03-02-15-zalozenie-PSDG
            (dokument popisujuci zalozenie Platon SDG)
        03-02-20-vyhlasenie-zakon-el-podpis
            (vyhlasenie k zakonu o elektronickom podpise)
        ...

VYTVORENIE NOVÉHO DOKUMENTU:

Na vytvorenie nového dokumentu sa odporúèa pou¾i» skript z adresára platos/_scripts/ - platos/_scripts/create-document. Program sa spýta na meno nového dokumentu a vytvorí základnú ¹truktúru dokumentu. Takto vytvorený dokument by malo by» mo¾né ihneï vysádza». Tým si mô¾te otestova» funkènos» Va¹ej in¹talácie TeXu / LaTeXu. Na vytvorenie dokumentu mo¾no pou¾i» dva alternatívne príkazy:

./_scripts/create-document [meno-dokumentu]

alebo

make new

SÁDZANIE DOKUMENTU:

Súbor 'Makefile' v adresári s dokumentom by mal umo¾òova» vysádza» dokument (teda vytvori» PSko a PDFko) bez väè¹ích problémov. Preto základným príkazom na vysádzanie dokumentu je príkaz:

make

Tomuto príkazu mo¾no zada» e¹te ïal¹ie parametre:

make clean - zma¾e nepotrebné (automaticky vytvorené) súbory make dist - vytvorí *.tar.gz archív s dokumentom.

ChangeLog

[2005-09-18]

Vydaná verzia 0.3.1
Zlep¹ená podpora pre rôzne ¹týly dokumentov.
Zlep¹ené ofarbenie výstupu pri sádzaní dokumentov.
Detekcia chýbajúcich nástrojov potrebných pre vytváranie rôznych typov výstupov.

[2005-06-10]

Vydaná verzia 0.3
Aktualizácia dokumentácie.
Upravená podpora pre rôzne ¹týly dokumentov.

[2005-06-01]

Vymyslené nové meno projektu: PLaTos.

[2003-06-11]

Premenované scripts/ --> _scripts/, templates/ --> _templates/ .

[2003-02-23]

Súbor Rules.make presunutý do _templates/ .

[2003-02-04]

Tento dokument napísal ¥ubomír Host 'rajo' <rajo AT platon.sk> ako dokumentáciu k predbe¾nému návrhu ¹truktúry systému na spracovanie dokumentov pre Platon SDG.

# vim: ft=txt