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