Chapter 2. Docbook

Table of Contents

Bevezetés
Modularizáció
Publikus azonosítók
Feltételes szövegrészek
XSL Formatting Objects (XSL FO)

Bevezetés

A DocBook projekt 1991-ben kezdődött, a HaL Computer Systems és az O'Reilly közös projektjeként. 1998-ban létrejött a Organization for the Advancement of Structured Information Standards (OASIS) is. Ezen belül működik a DocBook Technical Committee.

2002 után jött létre az v5.0 verzió, jelenleg az 5.05-ös verziónál tartanak. A verzióhoz létezik sémaleírás RELAX NG, W3C XML Schema és DTD formájában.

A DocBook egy XML domain, ezért természetesen vonatkoznak rá az általános XML szabályok.


<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V5.0//EN"
               "http://www.oasis-open.org/docbook/xml/5.0/docbook.dtd">

Azaz a gyökér elem book és a DTD ebben az esetben a hálózaton van tárolva.

A DocBook elemeket az alábbi kategóriákba lehet sorolni:

  • Csomagok (Sets)

  • Könyvek (Books)

  • Részek (Divisions), melyek a könyveket osztják fel.

  • Komponensek (Components), melyek a könyveket vagy részeket osztják fejezetekre.

  • Szekciók (Sections), melyek a komponenseket osztják fel.

  • Meta-információs elemek

  • Blokk elemek

  • Inline elemek

A set-eket két vagy több könyv alkotja. Ilyet használunk akkor, ha például több könyv szól azonos témáról, vagy valamilyen könyv-sorozatról van szó.

A könyv (book) a leggyakoribb gyökérelem egy dokumentumban. Maga a könyv sokféle lehet, customizálhatjuk. A könyv tartalmazhat dedication-t, amely mindig a könyv elején tűnik fel. Utána következnek az ún. navigációs komponensek. Ilyen a toc (Table of Contents), az ábrák, képek listája, és az index.

A divíziók a referenciákból és részekből áll. A részek a fejezet-szerű részek.

A komponens -ek a fejezet-szerű részek. Ilyenek az előszó, a fejezet, függelék, bibliográfia, és a többiek.

A szekciók-at többféle módon lehet megoldani. Az egyik módszer a sect1, sect2, ... sect5 sorozat, melyeket pontosan ebben a sorrendben kell egymásba ágyazni. Ezek a szekciók sorszámozottak. A másik módszer a section, ugyancsak számozott, amely rekurzívan egymásba ágyazható. A legalsó szint mindkét esetben lehet simplesect, amely már tovább nem tartalmazhat újabb szekciókat. A simplesect nem jelenik meg a tartalomjegyzékben.

A glossary, bibliography és index részek ugyancsak oszthatók a glossdiv, bibliodiv, index részekkel.

A meta-információs elemek extra információkat tartalmaznak. A szekciók, és fölöttük levő elemek tartalmaznak egy info nevű elemeket. Az info tartalmaz címet, a cím rövidítését, alcímet, absztraktot, (postai) címet, stb.

A blokk elemek közvetlenül a komponensek vagy fejezetek alatt fordulnak elő. Nagyjából a bekezdésnek felelnek meg. Listák, táblázatok, példák, és még sok más. A blokk elemeket típikusan előtte, mögötte üres sorral jelöljük.

Az inline elemek általában ilyen helykihagyás nélkül jelennek meg. Ilyen pl. a sor egy részének kiemelése, más fonttal való megjelenítése. Az inline elemek tartalmazhatnak más inline elemeket, de blokk elemeket nem.

A listák közül leggyakrabban az itemizedlist használatos: nem számozott lista. A számozott lista az orderedlist. Van még simplelist és mások.

Léteznek speciális figyelmeztető jelek (admonitions), mint a caution, important, note, tip, warning.

Néhány környezet megőrzi a whitespace és newline karaktereket a szövegben. Ezeket szokás sor-specifikus (line-specific) környezeteknek nevezni. Ilyenek pl. a programlisting, a screen és a screenshot.