Next: kapitola 2  Základy editace Up: část I  Uživatelský návod Previous: část I  Uživatelský návod


Kapitola 1
Úvod

RichDoc Framework je komplexní systém, který slouží k tvorbě, údržbě, výměně a prezentaci dokumentů, s důrazem na vědeckotechnické dokumenty. Systém je zatím experimentální, a vznikl v rámci projektu KSMSA. Původním účelem systému bylo ověřit výsledky autorovy disertační práce “Knowledge Support for Modeling and Simulation”, byl však zveřejněn pod GNU licencí, aby mohl být užitečný i ostatním případným uživatelům. V kapitole 14 jsou shrnuta současná omezení systému. Rovněž jsou vítané jakékoli příspěvky do systému, viz kapitola 18.

1.1 Základní filozofie RichDoc Frameworku

Jaký je rozdíl mezi RichDoc frameworkem a podobnými systémy pro práci s dokumenty? Existují dva základní typy programů pro práci s dokumenty. Programy prvního typu, zvané též textové procesory, jsou založeny na principu WYSIWYG (What You See Is What You Get, co vidíš to dostaneš). Tento princip zajišťuje, že co uživatel vidí na obrazovce počítače při práci s dokumentem je velmi podobné, ne-li stejné, finálnímu výsledku po vytisknutí dokumentu. Důsledkem tohoto principu je ale také to, že textové procesory jsou prezentačně-orientované – soustřeďují pozornost uživatele na vzhled dokumentu, a poněkud zanedbávají péči o jeho strukturu. Na druhou stranu jsou však textové procesory velmi intuitivní, a proto s nimi mohou snadno pracovat i méně zkušení uživatelé.

Druhým typem programů jsou programy založené na tzv. značkovacích jazycích (markup languages), například LaTeX nebo HTML. Při práci s těmito programy obyčejně nevytváříme dokumenty vizuálně, ale pomocí textového editoru, kde zadáváme text dokumentu společně se speciálními značkami definujícími strukturální a vizuální aspekty dokumentu. Takové dokumenty jsou obvykle mnohem více strukturně-orientované – dokument primárně reprezentuje strukturu dokumentu, vizuální aspekty (typ a velikost písma, okraje atd.) je odvozen ze struktury dokumentu automaticky pomocí mechanismu, který je na dokumentu nezávislý. Takové oddělení umožňuje využití stejného dokumentu v různých kontextech, neboť struktura dokumentu je nezávislá na způsobu jeho prezentace. Jeden dokument tak může být například použit pro generování výstupu ve formátech HTML a PDF. Příprava značkovaných dokumentů je však poněkud méně pohodlná, a vyžaduje znalost některého ze značkovacích jazyků, jež bývají poměrně složité.

My jsme se pokusili tyto přístupy zkombinovat, a vytvořili jsme systém, který je WYSIWYG jen napůl. Systém je WYSIWYG v tom smyslu, že příprava dokumentu probíhá vizuálně, pomocí grafického uživatelského rozhraní. Systém však soustřeďuje pozornost uživatele především na strukturu dokumentu, nikoli na jeho vzhled. Jemné vizuální aspekty finální prezentace dokumentu mohou být nastaveny dodatečně, bez zásahu do původního dokumentu. Struktura takto připraveného dokumentu je tedy mnohem více podobná struktuře dokumentů připravených pomocí značkovacích jazyků. Ve skutečnosti je za uživatelským rozhraním systému značkovací jazyk, který je však navržen tak, aby výrazně podporoval vizuální způsob editace dokumentu.

RichDoc Framework tvoří kompaktní, přenositelnou softwarovou komponentu, která může být snadno integrována do složitějších softwarových systémů. Systém můžeme použít nejen pro tvorbu samostatných dokumentů jako jsou knihy či články, ale lze vytvářet i malé fragmenty dokumentace, které lze vkládat do nějakých nadřazených objektů, jako jsou záznamy v kalendáři, inženýrské soubory, či jakékoli objekty ke kterým je vhodné přidávat dokumentaci. To vše s podporou pokročilých funkcí jako je možnost vkládání seznamů, tabulek, matematických vzorců či grafiky.

1.2 Co RichDoc Framework není

RichDoc Framework může být úspěšně využíván při přípravě strukturně bohatých dokumentů, které však mají poměrně jednoduché mapování mezi strukturou dokumentu a jeho vizuální prezentací. Pokud například potřebujete často nastavovat vizuální vlastnosti částí dokumentu ad-hoc způsobem, může být použití RichDoc Frameworku pro tento účel příliš kostrbaté. Pokud vám uvedený scénář nevyhovuje, asi bude pro vás lepší použít některý z více vizuálně orientovaných textových procesorů, jako je například Microsoft Word. Systém také není vhodný pro přípravu dokumentů se složitým grafickým rozvržením částí dokumentu, např. při přípravě časopisů nebo novin.

1.3 Requirements and Installation

The RichDoc Framework is pure Java application. It means that it runs on any platform that supports Java technology, including Microsoft Windows, many versions of the Unix operating system, and others. It has been tested on Microsoft Windows XP and RedHat Linux 9.1, but it is expected to run on other Java-enabled platforms as well.

Prior installation of the RichDoc Framework, you need to install the Java Runtime Environment (JRE) from Sun. Just visit http://www.java.com and download the JRE. If you have a JRE installed already, make sure that it is version 1.5 or later. If not, you should install the latest version.

Second step is to download and install a binary distribution of the RichDoc Framework. Two binary distributions are provided: Windows Installer to be installed on Windows, and compressed archive to be installed under UNIX. Installation under Windows is quite straightforward: just run the installer, and follow the instructions. After installation, the start menu is populated with appropriate shortcuts to run RichDoc applications. To install under UNIX, you need to unpack the distribution archive to an appropriate directory, and add the bin subdirectory to your PATH. Also make sure you have set the JAVA_HOME environment variable to the directory of your JRE installation. Then you can run any of the RichDoc programs by typing either bookEditor, scratchPad, or ioTool.

1.4 Programy RichDoc Frameworku

[picture]
(b)
(a)
[end of picture]

Obr. 1.1 Dva programy RichDoc Frameworku: (a) BookEditor, (b) ScratchPad

RichDoc Framework obsahuje dva základní programy. BookEditor je program, který slouží pro přípravu kompaktních, samostatných dokumentů, jako jsou knihy nebo vědecké články. Druhým programem je program ScratchPad, užitečný nástroj pro tvorbu osobních poznámek. Oba programy se liší ve způsobu organizace dokumentů a jejich obsahu, základní postupy přípravy dokumentů jsou však stejné. V tomto návodu budeme popisovat především program BookEditor. Program ScratchPad je popsán v samostatné kapitole 13.

1.5 Začínáme

Při práci s BookEditorem musíme začít vytvořením nového dokumentu. To provedeme příkazem Soubor → Nový z hlavního menu, nebo stiskem Ctrl+N. Zobrazí se průvodce vytvořením nového dokumentu, viz obr. 1.2.

[picture]
[end of picture]

Obr. 1.2 Průvodce vytvořením nového dokumentu

V prvním kroku je třeba vybrat vhodnou třídu dokumentu, která určuje jeho celkový charakter. Dokument může být typu Kniha, a Kniha s částmi, Článek nebo Poznámka. Nastavení třídy ovlivní mnoho vlastností dokumentu, jako je jeho vizuální styl, nebo způsob číslování sekcí a obrázků. Lze vytvořit i novou třídu, což je však složitá operace nad rámec tohoto návodu.

V druhém kroku zadáme název, jazyk a soubor dokumentu. Jazyk dokumentu určuje hlavní jazyk použitý při psaní dokumentu. Můžeme buďto vybrat jazyk z připraveného seznamu, nebo po stisku klávesy Jiný vybrat ze seznamu všech jazyků. Přestože lze vybrat libovolný jazyk, vězte že pro mnoho jazyků může program poskytnout malou nebo vůbec žádnou podporu. V takovém případě se aplikují pravidla pro anglický jazyk. Více o jazykové podpoře v kapitole 9.

1.6 Správa struktury dokumentu

Pravá část hlavního okna programu zobrazuje vlastní text dokumentu. Levá část zobrazuje strukturu dokumentu, viz obr. 1.3.

[picture]
Panel editace
Globální struktura dokumentu
Lokální struktura dokumentu
[end of picture]

Obr. 1.3 Hlavní okno programu BookEditor

V tomto návodu budeme označovat strukturální části dokumentu, jako jsou části, kapitoly, nebo sekce, souhrnným názvem sekce dokumentu. Levá horní část hlavního okna zobrazuje panel globální struktury dokumentu, zobrazující celkovou strukturu dokumentu, tedy všechny jeho sekce, hierarchickým způsobem. Tento panel můžeme použít pro navigaci dokumentem, nebo pro změnu struktury dokumentu. Pro vytvoření nové sekce dokumentu klikneme pravým tlačítkem myši na nadřazenou sekci, např. část, a zvolíme příkaz Vytvořit sekci z nabídky, kde sekce označuje typ konkrétní sekce, tedy např. část, kapitola apod. Smazání sekce provedeme výběrem sekce pomocí myši a stiskem klávesy Delete. Sekce lze přesouvat jejich tažením myší.

Panel v pravé části hlavního okna zobrazuje tu část dokumentu, která je vybraná v panelu globální struktury dokumentu. Program vždy rozděluje dlouhé dokumenty, jako jsou knihy, na editovatelné části na úrovni kapitol. Panel editace tedy v každém okamžiku zobrazuje právě jednu kapitolu knihy. V případě že připravujeme článek, je zobrazen celý dokument najednou.

Panel lokální struktury dokumentu, zobrazený v levé dolní části hlavního okna, detailně zobrazuje strukturu právě připravované části dokumentu. Můžeme vybrat požadovanou rozlišovací úroveň pomocí tlačítek na liště: [inline] pro úroveň sekcí, [inline] pro úroveň odstavců, nebo [inline] pro úroveň slov. Tento panel můžeme rovněž použít jak pro navigaci, tak pro změnu struktury dokumentu. Objekty lze přesouvat tažením myši, či mazat stiskem klávesy Delete. Více v sekci 2.2.


Next: kapitola 2  Základy editace Up: část I  Uživatelský návod Previous: část I  Uživatelský návod