Kapitola 6 Rejstřík, glosář a literatura

V této kapitole popíšeme přípravu rejstříku, glosáře a seznamu bibliografických citací.

6.1 Příprava rejstříku a glosáře

Kvalitní tištěné knihy obsahují na konci rejstřík nebo glosář (glossary, slovníček pojmů). Pomocí editoru můžeme tyto struktury snadno připravit. Rejstřík obvykle obsahuje abecední seznam hesel, s odkazy na stránky, kde jsou hesla definována nebo zmíněna. Glosář obsahuje seznam hesel opatřených krátkou definicí.

Pro vytvoření rejstříku musíme vytvořit seznam hesel, a tato hesla navázat na části textu obsažených v dokumentu. Definici jednoho hesla budeme nazývat položka rejstříku. Položka může být propojena s několika objekty nebo částmi textu v dokumentu, viz obr. 6.1. Položka také může být opatřena glosářovou definicí. Pro přípravu položek indexu zvolíme příkaz Rejstřík... Zobrazí se okno Editor rejstříku, viz obr. 6.2.

Okno obsahuje čtyři panely; panel Položky rejstříku zobrazuje abecední seznam všech definovaných položek, neboli hesel. V panelu Vybraná položka můžeme změnit text vybrané položky. Panel Glosářová definice umožňuje připojit k vybrané položce její definici. Panel Asociace zobrazuje seznam propojení vybrané položky rejstříku s částmi dokumentu.

Jak vidíme na obr. 6.2, heslo může být rozděleno do několika částí, vyjmenovaných od hlavní po doplňkové, například graf—spojitý. Některé položky mohou mít shodnou hlavní část, a lišit se jen v doplňkových částech (např. prohledávání—do šířky, prohledávání—do hloubky). Takové uspořádání ovlivní finální vzhled rejstříku obvyklým způsobem: společná část se objeví pouze jednou, a doplňkové části budou vyjmenovány pod společnou hlavní částí. V editoru rejstříku je však třeba u každé položky vyjmenovat všechny její části. Také si všimněme, že jedna položka rejstříku může definovat několik alternativních znění hesla, například graf—spojitý a spojitý graf. Taková položka se tedy objeví v rejstříku několikrát. Příklad konečného vzhledu rejstříku je zobrazen na obr. 6.3.

Novou položku přidáme do rejstříku stiskem tlačítka Přidat, a vyplněním textu položky v panelu Vybraná položka. Chceme-li definovat více alternativních hesel pro jednu položku, jednoduše umístíme každé znění na samostatný řádek. Chceme-li definovat heslo skládající se z několika částí, doplňkovou část uvedeme na další řádek, a použijeme pomlčku pro odsazení. Pro definici části třetí úrovně odsadíme pomocí dvou pomlček, atd. Takto lze definovat libovolné množství úrovní, nedoporučují se však hesla rozdělená na více než tři části.

Náš příklad také demonstruje, že pro definici hesel můžeme použít nejen text, ale i formátování, inline rovnice či grafiku, tedy jakýkoli materiál, který lze použít v běžném odstavci.

Jakmile vytvoříme položky rejstříku, je třeba je propojit s obsahem dokumentu. Můžeme je propojit například se sekcemi či odstavci, ale nejčastěji je propojíme s částmi odstavců, které přímo odpovídají citaci daného hesla. Položku rejstříku propojíme s částí dokumentu výběrem objektu nebo části textu v dokumentu, a stiskem tlačítka Propojit v editoru rejstříku. Pokud byl označen nějaký text, bude položka propojena s tímto textem. V opačném případě bude položka propojena s objektem, ve kterém je umístěn kurzor. Je-li takové určení objektu nejednoznačné, je třeba vybrat konkrétní objekt ve zobrazeném menu. Vytvořené propojení se pak objeví v seznamu Asociace.

Položky indexu lze definovat i opačně: nejprve označíme nějaký text v dokumentu, a potom stiskneme tlačítko

v nástrojové liště Odstavec (pod tlačítkem ). Vybereme-li například v dokumentu text “data structures” a stiskneme

, zobrazí se Editor rejstříku podobný tomu na obr. 6.4. Vidíme že do seznamu položek byla přidána položka odpovídající vybranému textu, která byla s tímto textem automaticky propojena, viz seznam Asociace. Pokud přesné znění vybraného textu není vhodné pro položku indexu, lze položku indexu opravit, na text dokumentu to nebude mít vliv.

Vybrané položky indexu lze sloučit do jediné položky. Více položek najednou vybereme kurzorovými klávesami a podržením klávesy Shift, nebo kliknutím a současným držením klávesy Ctrl. Poté stiskneme tlačítko Sloučit. Jednotlivá hesla vybraných položek budou sloučena, stejně jako asociace vybraných položek s textem dokumentu.

Asociaci položky zrušíme výběrem ze seznamu asociací, a stiskem klávesy Delete. Můžeme také zrušit celou položku včetně všech jejich asociací, výběrem položky v seznamu položek a stiskem Delete.

6.2 Příprava seznamu bibliografických citací

Pro vědecké, ale i jiné dokumenty, často potřebujeme na konec dokumentu připojit seznam citovaných zdrojů, na které se případně odkazujeme z hlavní části dokumentu. Proces přípravy seznamu citací lze rozdělit na tyto části:

6.2.1 Příprava databáze bibliografických záznamů

Prvním krokem při tvorbě seznamu citací je vytvoření databáze bibliografických záznamů. Jelikož se předpokládá, že jeden uživatel může použít jednu citaci v několika dokumentech, je tato databáze externí, tedy nezávislá na konkrétním dokumentu. Přípravu databáze zahájíme příkazem Literatura... z menu Nástroje. Zobrazí se seznam citací příslušejících k aktuálnímu dokumentu, který je zatím prázdný. Po stisknutí tlačítka Databáze se zobrazí okno editoru bibliografických záznamů, vše viz obr. 6.5.

V horní části okna vidíme hierarchický seznam bibliografických záznamů. Záznamy lze pořádat do skupin. Novou skupinu vytvoříme tlačítkem Nová skupina. Nový záznam přidáme do vybrané skupiny tlačítkem Nový záznam. Pokud v seznamu vybereme nějaký záznam, zobrazí se jeho údaje v dolní části okna.

Tabulka 6.1 Types of Bibliographical References

Type	Description
[`iP`] In Proceedings	An article in the proceedings of a conference.
[`pd`] Proceedings	The proceedings of a conference.
[`bk`] Book	A book with an explicit publisher.
[`iB`] In Book	A part of a book, which may be a chapter and/or a range of pages.
[`mt`] Master's Thesis	A Master's thesis.
[`pt`] PhD Thesis	A PhD thesis.
[`iC`] In Collection	A part of a book with its own title.
[`mn`] Manual	Technical documentation.
[`tr`] Technical Report	A report published by a school or other institution, usually numbered within a series.
[`bl`] Booklet	A work that is printed and bound, but without a named publisher or sponsoring institution.
[`jn`] Journal	A journal or magazine series, without particular issue.
[`ji`] Journal Issue	A journal or magazine issue.
[`at`] Article	An article from a journal or magazine.
[`up`] Unpublished	A document with an author and title, but not formally published.
[`ms`] Misc	Use this type when nothing else seems appropriate.
[`us`] Unstructured	A citation with no structure, defined by a markup text. Please do not use. Provided for compatibility with existing unstructured citations.

Nejprve je třeba zvolit typ záznamu ze seznamu uvedeného v tabulce 6.1. Po zvolení typu se příslušným způsobem upraví seznam ostatních údajů záznamu. Pole zobrazená tučně jsou povinná: pokud nejsou vyplněna, je tato chyba indikována jejich červenou barvou. Pole zobrazená normálním písmem jsou nepovinná a mohou tedy zůstat nevyplněna. Seznam všech polí pro jednotlivé typy publikací je v tabulce 6.2. Povinná pole jsou zde opět zobrazena tučně.

Každý záznam by měl mít explicitně nastavený jazyk. Údaje o publikaci by měly být vyplněny stejným jazykem jako je jazyk publikace. Pokud plánujeme citaci publikace z dokumentu v jazyce odlišném od jazyka publikace, můžeme některá pole záznamu, například název, přeložit do potřebných jazyků. Pokud například chceme citovat českou publikaci v z dokumentu v angličtině, měly by být údaje o publikaci vyplněny česky, ale můžeme přidat anglický název publikace. Při citaci publikace se potom použije pole v jazyce odpovídající danému kontextu, pokud je k dispozici.

Pole Autor a Editor mohou mít více než jednu hodnotu, pokud má publikace více autorů nebo editorů. V takovém případě můžeme buď tažením myši vytvořit potřebný počet řádků pro příslušné pole, nebo pro zadání nové hodnoty jednoduše stisknout čárku (‘,’). Nepotřebná pole mohou být vymazána jejich výběrem a stiskem Delete. V jednom řádku by však nikdy nemělo být zadáno více jak jedno jméno!

Tabulka 6.2 Fields of Bibliographical Records

Name	Description	Applies To
Address	Publisher's address. For major publishing houses, just the city is given. For small publishers, you can help the reader by giving the complete address.	Proceedings, Book, In Book, Master's Thesis, PhD Thesis, Manual, Technical Report, Booklet, Unpublished
Author	The name of the author.	In Proceedings, Book, In Book, Master's Thesis, PhD Thesis, In Collection, Manual, Technical Report, Booklet, Article, Unpublished, Misc
Chapter	A chapter number.	In Book
Edition	The edition of a book - for example, "second".	Book, In Book, Manual
Editor	Name of editor. If there are also "author" field(s), then the "editor" field gives the editor of the book or collection in which the reference appears.	Proceedings, Book
How Published	How something strange has been published.	Booklet, Misc
Institution	The institution that published the work.	Technical Report
Key	Used for alphabetizing and creating a label when the "author" and "editor" fields are missing. This field should not be confused with the Label field.	all
Language	Language of the publication.	*all*
Month	The month in which the work was published or, for an unpublished work, in which it was written.	Proceedings, Book, In Book, Master's Thesis, PhD Thesis, Manual, Technical Report, Booklet, Journal Issue, Misc
Note	Any additional information that can help the reader.	all
Number	The number of a journal, magazine, or technical report. An issue of a journal or magazine is usually identified by its volume and number; the organization that issues a technical report usually gives it a number.	Technical Report, Journal Issue
Organization	The organization sponsoring a conference.	Proceedings, Manual
Pages	A page number or range of numbers such as "42--111"; you may also have several of these, separating them with commas: "7,41,73--97".	In Proceedings, In Book, In Collection, Article
Publisher	The publisher's name.	Proceedings, Book, In Book
School	The name of the school where a thesis was written.	Master's Thesis, PhD Thesis
Series	The name of a series or set of books. When citing an entire book, the the "title" field gives its title and an optional "series" field gives the name of a series in which the book is published.	Book, In Book
Text	Unstructured description of the citation.	Unstructured
Title	The work's title.	In Proceedings, Proceedings, Book, In Book, Master's Thesis, PhD Thesis, In Collection, Manual, Technical Report, Booklet, Journal, Article, Unpublished, Misc
Type	The type of a technical report - for example, "Research Note".	Technical Report
Volume	The volume of a journal or multivolume book work.	Book, In Book, Journal Issue
Year	The year of publication or, for an unpublished work, the year it was written. This field's text should contain only numerals.	Proceedings, Book, In Book, Master's Thesis, PhD Thesis, In Collection, Manual, Technical Report, Booklet, Journal Issue, Unpublished, Misc

Informace o jedné publikaci může být rozprostřena do několika záznamů. Například článek publikovaný ve sborníku konference je popsán pomocí dvou záznamů: Záznam Ve sborníku popisuje detaily článku (název, autor apod.), zatímco záznam Sborník popisuje detaily samotného sborníku (editory, vydavatele, rok vydání). Pokud vytvoříme nový záznam typu Ve sborníku, poslední pole záznamu nese název ‘V’, kam je třeba vyplnit odkaz na nadřazený záznam typu Sborník. Po kliknutí na toto pole se zobrazí dvě možnosti: Nový..., pro vytvoření nového záznamu pro sborník, a Prohlížet..., pro vybrání existujícího záznamu. Po nalezení nebo vytvoření záznamu se přidají údaje o nadřazeném záznamu na konec seznamu, viz obr. 6.6.

6.2.2 Kompatibilita se systémem BibTeX

Jak jste si možná všimli, systém organizace bibliografických záznamů je podobný systému BibTeX. Editor disponuje nástrojem pro import záznamů ve formátu BibTeXu (souborů .bib). Nástroj automaticky provádí potřebné transformace, jako je dělení vícehodnotových polí na samostatná pole, či dělení složených záznamů na samostatné zřetězené záznamy. Nejsou však podporovány všechny funkce BibTeXu, např. textová makra.

6.2.3 O databázi

Databáze bibliografických záznamů je určena pro osobní použití. Je uložena v souboru ~/ksmsa/bibliography/.database, kde ~ označuje uživatelský adresář, ve Windows obvykle umístěný v adresáři c:\Documents and Settings\username. Pokud chceme tuto databázi používat z více počítačů, je třeba tento soubor ručně zkopírovat. Víceuživatelský systém pro správu bibliografických záznamů zatím není implementován.

Formát databáze se může mezi jednotlivými verzemi RichDoc frameworku měnit. Chcete-li instalovat novější verzi Frameworku, je třeba databázi vyexportovat do souboru ve formátu XML, a po instalaci naimportovat zpět.

6.2.4 Odkazy na bibliografické záznamy

Po naplnění databáze údaji je možné přidávat citace do seznamů citací jednotlivých dokumentů. Pro přidání vybraných záznamů do aktuálního dokumentu použijeme tlačítko Přidat záznam. Okno zobrazující databázi se zavře, a vybrané záznamy jsou přidány do seznamu citací aktuálního dokumentu, vizobr. 6.7.

Nyní můžeme do hlavní části dokumentu přidávat odkazy na seznam citací. Odkaz přidáme stiskem tlačítka Přidat odkaz, nebo dvojím kliknutím na položku v seznamu citací. Do dokumentu se na pozici kurzoru přidá text reprezentující odkaz na citaci, například “[10]”. Tento text je automaticky aktualizován pokud se pořadí citace v seznamu změní.