Image Shaker - Dokumentace

Koordinatori dokumentace projektu IS:

• Technicka dokumentace (jadro a spol.): Halva
• Filtry (technicka i uzivatelska dokumentace): Sovicka
• I/O formaty (technicka i uzivatelska dokumentace): Smola
• Uzivatelska dokumentace (vcetne ovladani): Smola

Kazdy bude samozrejme psat dokumentaci zejmena ke sve casti programu.

Osnova dokumentace

A. Uzivatelska prirucka:

Musi obsahovat vsechny informace pro uzivatele naseho programu (neumi programovat, nejaky prehled o zpracovani obrazu muzete predpokladat).

V prvni casti by mel byt obecny popis naseho systemu (filozofie, workspace, obrazky a filtry, masky, ..), instalacni poznamky, popis ovladani, seznam implementovanych grafickych formatu (ale bez vetsich technickych detailu). Priklady, ..

Dale by mel nasledovat seznam filtru. U kazdeho filtru musi byt napsano VSECHNO, co potrebuje znat uzivatel (popis funkce, popis parametru - vcetne pripustnych mezi!, jak pracuje s maskou, pripustne graficke formaty na vstupu/vystupu, ... viz dalsi oddily)

V priloze muze byt napr. popis formatu workspace, presny popis vsech konfiguracnich souboru.. (pokud chceme, aby se v tom uzivatel hrabal)

• Obecny uvod (Smola a spol.)
  • K cemu IS slouzi
  • Porovnani s jinymi systemy
  • Platformy
• Instalace programu (Smola)
  • X-Window (Linux)
  • M$ Windows
  • Konfiguracni soubory (Chrzanowski?)
• Ovladani programu (Smola)
  • Obrazky (formaty pixelu)
  • Filtry
  • Workspace
  • Vstupy a vystupy
  • Priklady
• Filtry (koordinator Sovicka)
  • Obecne charakteristiky
  • Tridy filtru
  • Dialogy (vyvolavane prikazem Properties)
  • Seznam vsech internich filtru (setridene podle trid?)
• I/O formaty (koordinator Smola):
  • Obecne charakteristiky
  • Dialogy (vyvolavane prikazem Properties)
  • Seznam vsech implementovanych I/O formatu (jen informace pro uzivatele)
    Priklady, obrazky, ..
• Prilohy (?):
  • Presna syntax a semantika konfiguracnich souboru
  • (? format WSF souboru ?)
  • Seznam vsech (chybovych) hlaseni systemu

B. Programatorska dokumentace:

Ta bude obsahovat VSECHNY technicke detaily urcene pro programatory pluginu a pro pripadne udrzovatele pristich verzi systemu. Osnova pana Halvy (pro jadro) se mi libi.

Obecne uvodni informace by se mely napsat i k grafickym formatum a filtrum. Do svych kapitol zahrnujte i diskusi - proc jsme to udelali takhle, jak by to slo jinak, co by se dalo jeste vylepsit..

Interni popis jednotlivych I/O formatu a filtru navrhuji seradit stejne jako v uzivatel. prirucce (kazdy filtr tedy bude mit svoji kapitolku v casti A i B). Pokud chcete k nejake skupine filtru napsat spolecny uvod (priklad - warping, barevne operace, prace s maskami), udelejte to. Stejne by tam ale potom mel byt oddil ke kazdemu jednotlivemu filtru/IOformatu.

Prilohy - zbyle formaty dat, ktere nebudou v casti A. (WSF, konfiguraky,..), kucharky?, seznamy uzitecnych rutinek pro programatora filtru a I/O formatu, DOC++ vypisy vsech (?) nasich headeru, ...

• Obecny uvod (Halva a spol.)
  • Platformy, prekladace a jine prostredky
  • Zakladni struktura systemu
• Jadro (Halva a Chrzanowski)
  • viz osnova kernel.txt
  • + budoucnost (thready, ..)
• GUI a hlavni program (Bakstein a Kristek)
  • Pouzite cizi prostredky (knihovny - MFC, Gtk, ..)
  • Koncepce dialogu
  • Jednotlive prvky dialogu, ..
  • Interakce filtru s uzivatelem (events, ..)
  • Struktura aplikace (+ Brezina)
    prikazy, okna, atd, ..
• Filtry (koordinator Sovicka)
  • Obecny uvod, tridy filtru
  • Seznam vsech internich filtru
    Vsechny technicke detaily, algoritmy, datove struktury, ..
• I/O Filtry (koordinator Smola)
  • Obecny uvod
  • Seznam vsech I/O formatu
    Dulezite technicke detaily, pouzite knihovny, odkazy na literaturu, ..
• Prilohy (?):
  • Presny popis formatu souboru (WSF, CFG, ... pokud uz nebyly jinde)
  • Pruvodce zdrojovymi soubory
  • DOC++ vypisy dulezitych hlavicek

A. Uzivatelsky popis filtru

• Jmeno (zadavane v listboxu)
• Trida
• Popis funkce filtru (treba i vcetne jednodussich vzorecku nebo odkazu na literaturu)
  • Prace s maskou
• Parametry (veliciny nastavovane v dialogu a ukladane ve WSF)
  • Pripustne hodnoty, ..
• Vstupni image (akceptovatelne formaty, velikosti, ..)
• Vystupni image (formaty, velikosti, ..)
• (Priklady)
  • Ukazka prefiltrovaneho obrazku, screenshot dialogu, ..

B. Technicky popis filtru

Vsechno z A (krome prikladu) +

• Kratke jmeno
• Autor
• Zdrojove soubory
• Presna syntax a semantika parametru (format ukladany ve WSF)
• Podrobny popis algoritmu, prip. omezeni
• Specialni pouzite datove struktury
• Presne (matematicke) vzorce (pokud nebyly uvedeny v A), prip. odkazy na literaturu

A. Uzivatelsky popis I/O filtru

• Jmeno (zadavane v listboxu)
• Jmeno grafickeho formatu (odkaz na jine prameny)
• Parametry (veliciny nastavovane v dialogu a ukladane ve WSF)
  • Pripustne hodnoty, ..
• Implementovane formaty/kompresni metody/rezimy, ..

B. Technicky popis I/O filtru

Vsechno z A +

• Kratke jmeno
• Autor (pouzita knihovna)
• Zdrojove soubory
• Presna syntax a semantika parametru (format ukladany ve WSF)
• Popis formatu souboru s obrazkem (nemusi byt uplne podrobny, ty nejvetsi detaily mohou byt vyreseny pomoci odkazu na jine prameny)
• Prip. omezeni
• Prevody internich formatu pixelu IS <-> graf. format (pro ruzne rezimy/subformaty)

5.2.1998, pepca.at.cgg.mff.cuni.cz