10.3. Elementy

Elementy rozlišujeme na blokové a inline. Jednotlivé elementy mohou také obsahovat atributy. Atributy jsou buď obecné, které lze použít u všech elementů a speciální, které se vztahují vždy k danému elementu.

Výčet obecných atributů nalezneme spolu s jejich významem v dokumentaci jako „Common attributes“, speciální atributy jsou v dokumentaci uvedeny v tabulce u každé značky ke které náleží.

10.3.1. Blokové elementy

Blokové elementy dělí text na blokové úseky, což jsou odstavce, různé výpisy, obrázky, tabulky apod. Před blokovým elementem i za ním je zalomená řádka, tvoří tak proto vždy samostatný odstavec a text je formátován do bloku.

Základním blokovým elementem je odstavec, jenž se uzavírá do elementu para. Odstavec je zřejmě nejpoužívanější značka a vyskytuje se na různých místech, např. v položkách seznamů apod. Element para může v sobě obsahovat další blokové elementy. Odstavec má ještě dvě varianty - simpara, který již nemůže obsahovat další blokové elementy. Druhou variantou je formalpara, což je odstavec s titulkem.

ikona
<formalpara>
 <title>Titulek odstavce</title>
 <para>Text odstavce...</para>
</formalpara>
<para>Další odstavec...</para>

Další důležité blokové elementy jsou seznamy a multimediální objekty (obrázky, animace), o kterých si povíme později v samostatné kapitole.

Zvýrazněné oblasti

V textu můžeme zvýrazňovat odstavce se speciálním významem. Máme k dispozici několik značek. Konkrétně jsou to značky warning, note, tip, caution a warning. Jejich význam vystihuje název, způsob formátování je ponechán na nás.

ikona
<important><para>Věnujte zvýšenou pozornost této problematice!</para></important>

Elementy zachovávající řádkování

Tyto blokové elementy zachovávají konce řádků tak, jak je to uvedené ve zdrojovém souboru. To se hodí nejen pro vkládání výpisu programů. DocBook totiž neobsahuje značku pro zalomení řádku (ekvivalent br z HTML).

address

Element pro vložení poštovní adresy. Adresu uvozujeme pomocí dalších elementů k tomu určených.

ikona
<address>
John Smith
<street>100 Pine Blvd</street>
<city>Anytown</city>, <state>NY</state> <postcode>12345</postcode>
<country>USA</country>
<phone>914.555.1212</phone>
<fax>914.555.1212</fax>
</address>
programlistings

Typický pro vkládání výpisů programů. Text je zobrazen neproporcionálním písmem.

blockquote

Citace.

highlights

Shrnutí hlavních bodů knihy nebo komponenty.

literallayout

Zachovává konce řádků, ale text zobrazí normálním písmem.

screen

Text, který uživatel vidí na obrazovce monitoru.

sidebar

Poznámka na okraji stránky. Bohužel s použitím současných stylů a procesorů nefunguje tento element zcela správně.

Další blokové elementy pouze vyjmenujeme, jejich význam si můžete snadno dohledat v dokumentaci: classsynopsis, cmdsynopsis, constructorsynopsis, destructorsynopsis, epigraph, funcsynopsis, methodsynopsis, msgset, procedure, screenshot, screenco, synopsis, task .

10.3.2. Inline elementy

Inline elementy neovlivňují řádkování. Přiřazují jednotlivým částem textu nějaký význam. Obalují taková slova v textu, která mají být logicky oddělena od ostatního textu a zpravidla jsou vysázena i jinak než běžný text. Přiřazovat slovům (např. prvkům programovacího jazyka) v textu jejich pravý význam je užitečná věc, která se pak může hodit při generování různých seznamů těchto prvků.

Obecné a značkovací elementy

abbrev

Zkrácené slovo.

acronym

Důležité slovo.

application

Název počítačového programu.

code

Fragment počítačového programu.

command

Jméno spustitelného programu nebo jiného příkazu.

computeroutput

Data generovaná počítačem (zprávy, výsledky apod.).

database

Název databáze nebo její části.

email

Emailová adresa.

emphasis

Zvýraznění textu. Standardně je text zvýrazněn kurzívou, pokud chceme tučný text, uvedeme atribut role, tj. <emphasis role="bold">text</emphasis>. Rolí je možno použít více, jejich kompletní výčet nalezneme v dokumentaci.

envar

Proměnná prostředí.

filename

Název souboru. Touto značkou označujeme i adresář pomocí atributu class, např. <filename class="directory">C:\DocBook\<filename>

.
footnote

Poznámka pod čarou

foreignphrase

Fráze v cizím jazyce.

hardware

Fyzická část počítače.

literal

Literál, data převzatá v přesném znění z počítačového systému.

markup

Text, který má být zobrazen přesně tak jak je zapsán.

medialabel

Název média.

option

Parametr příkazu.

optional

Nepovinná informace.

phrase

Nemá žádný speciální význam, ale dovoluje označit text a přiřadit mu nějakou vlastnost. Různé vlastnosti přiřazujeme atributem role.

prompt

Označuje počáteční řetězec příkazového řádku.

quote

Text v uvozovkách. Místo toho, abychom text do uvozovek museli psát pomocí entit &bdquo;text&ldquo;, stačí jej zkráceně psát <quote>text</quote>.

remark

Poznámka která se má zobrazovat v pracovních verzích dokumentu.

replaceable

Informační text, který má uživatel nahradit konkrétní hodnotou s uvedeným významem.

sgmltag

Slouží pro zápis SGML/XML elementů.

systemitem

Položka nebo pojem svázaný se systémem. Pomocí atributu class lze specifikovat o jakou položku přesně jde (služba, uživatel, událost aj.).

trademark

Obchodní značka. DocBook již obsahuje element copyright, ale ten je určen pro metainformace. Pokud chceme reprezentovat copyright v běžném textu, uvádíme jej jako <trademark class="copyright">text</trademark>. Do atributu class můžeme uvést obecně tyto typy značek: copyright, registered, service, trade.

userinput

Text zadaný uživatelem.

wordasword

Zvýrazněné slovo, které má v daném kontextu speciálni význam.

ikona
<para>Tento text bude <emphasis>kurzívou</emphasis>
a tento <emphasis role="bold">tučně</emphasis>.</para>

Programové konstrukce

DocBook disponuje celou řadou konstrukcí označujících části programovacího jazyka. Uvedeme pouze jejich výčet, jejich názvy jsou dostatečně vysvětlující a další informace lze snadno dohledat v dokumentaci.

action, classname, constant, errorcode, errortype, exceptionname, function, interface, interfacename, methodname, msgtext, ooclass, ooexception, oointerface, parameter, returnvalue, structfield structname, symbol, token, type, varname

Prvky uživatelského rozhraní

I pro prvky uživatelského rozhraní existují samostatné elementy, které je přesně charakterizují.

accel, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, keycap, keycode, keycombo, keysym, menuchoice, mousebutton, shortcut

ikona
Příklad 10.3: Popis menu
<menuchoice>
  <guimenu>DocBook</guimenu>
  <guisubmenu>Convert document</guisubmenu>
  <guimenuitem>PDF...</guimenuitem>
</menuchoice>

Jak je patrné, inline elementů je celá řada a jsou velice úzce zaměřeny. Při psaní dokumentů je proto vhodné si rozmyslet, jaké všechny objekty budeme v textu popisovat a zvážit které elementy jim přiřadíme. Přílišné dělení do značek zpomaluje tvorbu dokumentů, pokud značky naopak nepoužíváme, dokument není tak přehledný a přicházíme o silnou část DocBooku která spočívá v přesné identifikaci jednotlivých objektů. Je třeba najít vhodnou rovnováhu.