Samotný xmltex je již nějakou dobu standardní součástí texových distribucí jako je TeXLive nebo tetex. Pro první pokusy s ním tedy není potřeba nic složitě instalovat. Pokud xmltex není součástí vaší texové instalace, můžete si jej stáhnout z CTAN archivu nebo z adresy http://www.dcarlisle.demon.co.uk/xmltex/ a nainstalovat podle přiložených instrukcí.

Jediným problémem standardně nainstalovaného xmltexu je chybějící podpora českého (a slovenského) dělení slov. Poměrně snadno ji však můžeme doplnit. Postup je popsán dále. Chcete-li si však jen vyzkoušet možnosti xmltexu a prozatím oželíte správné dělení slov, můžete zbytek této části článku přeskočit.

Formát xmltexu je odvozen z formátu LaTeXu, který používá pro lokalizaci babel (používá se tedy jiná metoda počeštění než je CSLaTeX). Pro správné dělení slov v naší mateřštině proto musíme do LaTeXu zahrnout české vzory dělení slov, přegenerovat formát LaTeXu a následně i formát xmltexu.

Nejprve musíme definovat, jaké vzory dělení slov ze zahrnou do formátu LaTeXu. Definice je uložena v souboru language.dat, který se typicky nachází v adresáři texmf/tex/generic/config. V souboru musíme odkomentovat řádku, která se stará o načtení českých vzorů dělení slov:

czech           czhyph2e.tex

Nyní musíme přegenerovat formát LaTeXu a xmltexu. Nejjednodušší je použít příkaz fmtutil --all, který se postará o přegenerování všech formátů. Ve windowsové verzi TeXLive je příkaz dostupný i v menu TeXLive->Maintenance->Create all format files.

TeXLive tímto způsobem rovnou přegeneruje i formát pro xmltex, distribuci tetex o to musíme požádat ručně:

fmtutil --cnffile /usr/share/texmf/tex/xmltex/xmltexfmtutil.cnf --all

Od této chvíle by měly být programy xmltex a pdfxmltex schopné používat české dělení slov.

V okamžiku, kdy xmltexu předáme dokument XML ke zpracování, snaží se xmltex najít definiční soubor, popisující mapování XML na texové sekvence. Tyto soubory mají obvykle příponu .xmt. Vazba jednotlivých druhů dokumentů XML na xmt-soubory je definována v katalogu. Vždy se prohledává globální katalog, který musí mít jméno xmltex.cfg, a lokální, který se jmenuje stejně jako dokument XML, ale má příponu .cfg.

Asi nejspolehlivější způsob svázání XML dokumentů s xmt-souborem je pomocí jmenného prostoru, který lze využít v případě, že zpracovávaný dokument používá jmenné prostory. Dejme tomu, že máme v XML uložený článek a používáme i jmenné prostory.

<clanek xmlns="urn:x-kosek:schemas:clanek:v1.0">
 ...
</clanek>

Uložíme-li pak definiční soubor popisující převod elementů článku na texové sekvence například do souboru clanek.xmt, musíme do katalogu přidat následující řádku:

\NAMESPACE{urn:x-kosek:schemas:clanek:v1.0}{clanek.xmt}

Bohužel v mnoha jednodušších případech se jmenné prostory nepoužívají a jednotlivé typy dokumentů XML nelze jednoznačně identifikovat. V těchto případech pak můžeme vazbu na xmt-soubor vytvořit na základě jména kořenového elementu:

\NAME{clanek}{clanek.xmt}

Musíme být však opatrní, zvláště při použití této deklarace v globálním katalogu, protože se může stát, že budeme mít dva různé druhy dokumentů se stejným kořenovým elementem. xmltex pak nebude mít možnost, jak je správně rozlišit.

Nyní se dostáváme k nejdůležitější části xmltexu, a to je vazba mezi elementy XML a TeXem. V xmt-souboru můžeme pro každý element definovat kód, kterým se nahradí výskyt počátečního a koncového tagu. Základní kostra definice je velmi jednoduchá:

\XMLelement{název elementu}
  {zachycení atributů}
  {kód pro začátek elementu}
  {kód pro konec elementu}

Ukažme si konkrétní použití na jednoduchém dokumentu XML s článkem. Předpokládejme, že obsah souboru dokument.xml je

<?xml version="1.0" encoding="iso-8859-2"?>
<clanek>
  <zahlavi>
    <rubrika>Aktuality</rubrika>
    <nazev>Státní správa bude používat TeX místo Wordu</nazev>
    <autor email="wild@duck.cz">Jan Novák</autor>
  </zahlavi>
  <perex>... text perexu ...</perex>
  <para>... text odstavce ...</para>
  <para>... text odstavce ...
        ... <em>zvýrazněný text</em> ...
        ... </para>
  <para>... text odstavce ...</para>
</clanek>

Vysázet tento článek v LaTeXu je velmi jednoduché:

\documentclass{article}
\usepackage[czech]{babel}
\gdef\email#1{\\{\small\ttfamily#1}\par}
\begin{document}

\title{Státní správa bude používat TeX místo Wordu}
\author{Jan Novák \email{wild@duck.cz}}
\date{}
\maketitle

\noindent{\bf ... text perexu ...}\par

... text odstavce ...

... text odstavce ...
... {\it zvýrazněný text\/} ...
... 

... text odstavce ...

\end{document}

V našem případě si dokument XML s latexovým kódem téměř odpovídá, proto je popsání definice mapování elementů XML velmi jednoduché.

Začneme povinnou kostrou dokumentu s latexovou preambulí. Ta se musí objevit v každém dokumentu. Nejpohodlněji ji vygenerujeme v definici pro kořenový element clanek:

\XMLelement{clanek}{}
        {\documentclass{article}
         \usepackage[czech]{babel}
         \gdef\email##1{\\{\small\ttfamily##1}\par}
         \begin{document}}
        {\end{document}}

Při nalezení počátečního tagu se vygeneruje preambule, po nalezení koncového se naopak ukončí dokument. Protože je \XMLelement makro, musíme uvnitř něj při definici vlastních maker s parametry zdvojit #. Element clanek nemá žádné atributy, a proto jsme druhý parametr makra ponechali prázdný.

Nejjednodušší obsluhu budou mít elementy jako para. Na jejich začátku nemusíme dělat nic, a na konci stačí ukončit odstavec pomocí \par.

\XMLelement{para}{}{}{\par}

Podobně můžeme obsloužit i element em používaný pro zvýraznění. Na začátku elementu aktivujeme kurzívu (\it) a na konec vložíme italickou korekci.

\XMLelement{em}{}{\it}{\/}

xmltex automaticky vše uzavře do skupiny, takže se nemusíme bát, že od tohoto místa bude kurzívou vysázen i celý zbytek dokumentu.

V definici obsluhy začátku elementu můžeme použít i speciální makro \xmlgrab. To načte celý obsah elementu do parametru #1 a zpřístupní jej v obsluze koncového tagu. Obsluhu elementu em proto můžeme alternativně zapsat i jako:

\XMLelement{em}{}{\xmlgrab}{\it #1\/}

\xmlgrab můžeme využít i v případech, kdy chceme obsah nějakého elementu ignorovat. Jestliže nechceme, aby se ve vysázeném výsledku objevil název rubriky, zkrátka jej necháme „sníst“ tím, že v obsluze koncového tagu nepoužijeme obsah nastřádaný v #1:

\XMLelement{rubrika}{}{\xmlgrab}{}

Chceme-li u nějakého elementu zpracovat atributy, musíme si definovat jaké atributy nám mají být dostupné. Slouží k tomu makro \XMLattribute se třemi parametry. První udává jméno atributu v dokumentu XML, druhý texový název, pod nímž bude hodnota atributu dostupná v TeXu a třetí parametr může určit hodnotu, která se má použít v případě nepřítomnosti atributu:

\XMLelement{autor}
        {\XMLattribute{email}{\emailAutora}{}}
        {E-mail je: \emailAutora}
        {}

V našem konkrétním případě je situace složitější, protože chceme mailovou adresu předat dovnitř makra \autor, které si pak LaTeX volá později pro vysázení nadpisu článku. V tom okamžiku však již nebude dočasně nadefinované makro \emailAutora platné. Musíme si jej proto uložit do globálního makra (\gEmailAutora), které se při definici rovnou expanduje.

\XMLelement{autor}
        {\XMLattribute{email}{\emailAutora}{\relax}}
        {\xmlgrab}
        {\xdef\gEmailAutora{\emailAutora}
         \author{#1 
           \ifx\gEmailAutora\relax
           \else
             \email{\gEmailAutora}
           \fi
           }}

Zároveň ještě testujeme, zda je atribut vůbec v dokumentu nastaven, abychom zbytečně nesázeli prázdnou e-mailovou adresu.

Chceme-li si vše vyzkoušet, můžeme definice obsluhy elementů uložit do souboru clanek.xmt a vytvořit si jednoduchý katalog dokument.cfg:

\NAME{clanek}{clanek.xmt}

Příkazem

pdfxmltex dokument.xml

tak získáme vysázenou podobu našeho článku v XML. A nebo ne? Na první pohled je vše v pořádku, ale při bližším ohledání zjistíme, že vypadla některá písmena s diakritikou – třeba `ž', `ř' a `č'. Problém je v tom, že XML jako znakovou sadu používá Unicode. xmltex však umí standardně na výstup korektně zapsat jen znaky, které spadají do kódování ISO Latin 1 (tedy znaky západoevropských jazyků).

Naštěstí není nijak složité přidat podporu pro chybějící znaky. Do katalogu (soubor s příponou .cfg) můžeme dodefinovat chybějící znaky pomocí makra \UnicodeCharacter. Makro má dva parametry – prvním je unicodový kód znaku a druhým sekvence texových příkazů, kterými se znak nahradí. Chybějící písmeno `ž' (s kódem 382 decimálně) tak můžeme dodefinovat pomocí:

\UnicodeCharacter{382}{\v{z}}

Pokud nám hrozí, že písmeno použijeme i v matematickém režimu, je bezpečnější definice ve tvaru:

\UnicodeCharacter{382}{\ifmmode \check{z}\else \v{z}\fi}

Pro lenochy jako já je tu ještě druhá možnost. Součástí PassiveTeXu jsou již připravené definice pokrývající slušnou podmnožinu celého Unicode. Načítají se však až přímo do dokumentu, nevkládají se do katalogu. Do preambule dokumentu stačí přidat:

\RequirePackage{unicode}
\RequirePackage{ucharacters}

Pro ilustraci se nyní podívejme na celý definiční soubor pro náš článek.

\XMLelement{clanek}{}
        {\documentclass{article}
         \usepackage[czech]{babel}
         \RequirePackage{unicode}
         \RequirePackage{ucharacters}
         \usepackage{palatino}
         \gdef\email##1{\\{\small\ttfamily##1}\par}
         \begin{document}}
        {\end{document}}

\XMLelement{zahlavi}{}{}{\date{}\maketitle}

\XMLelement{nazev}{}{\xmlgrab}{\title{#1}}

\XMLelement{autor}
        {\XMLattribute{email}{\emailAutora}{\relax}}
        {\xmlgrab}
        {\xdef\gEmailAutora{\emailAutora}
         \author{#1 
           \ifx\gEmailAutora\relax
           \else
             \email{\gEmailAutora}
           \fi
           }}

\XMLelement{rubrika}{}{\xmlgrab}{}

\XMLelement{para}{}{}{\par}

\XMLelement{perex}{}{\noindent\bf}{\par}

\XMLelement{em}{}{\it}{\/}

Již toho známe dost, abychom mohli pomocí xmltexu formátovat jednoduché dokumenty XML. V následujících odstavcích se podíváme ještě na pár drobností, které xmltex umí, a které se nám mohou v některých případech hodit.

Během formátování dokumentu vypisuje xmltex do logu informace o struktuře zpracovávaného dokumentu. Zejména u delších dokumentů to může být docela rušivé.

<0:clanek (./clanek.xmt)  >
 <0:zahlavi  > 
  <0:rubrika  > 
  </0:rubrika> 
  Grabbed content 
  End Grabbed content 
  <0:nazev  > 
  </0:nazev> 
  Grabbed content 
  End Grabbed content 
  <0:autor 
      0:email = "wild@duck.cz"  > 
  </0:autor> 
  Grabbed content 
  End Grabbed content 
 </0:zahlavi>
 <0:perex  > 
 </0:perex> 
 <0:para  > 
  <0:em  > 
  </0:em> 
 </0:para> 
 <0:para  > 
 </0:para> 
 <0:para  > 
 </0:para> 
</0:clanek>

Chceme-li se hlášení zbavit, stačí do katalogu přidat \xmltraceoff.

Ve výpisech je také vidět, že před názvy všech elementů je ještě uvedeno 0:. Tím nám xmltex dává najevo, že element nepatří do žádného jmenného prostoru. Pokud však jmenné prostory používáme, musíme si pro ně v definičním souboru definovat zástupný prefix, kterým se pak dále identifikují elementy a atributy patřící do daného jmenného prostoru. Např.:

\DeclareNamespace{m}{http://www.w3.org/1998/Math/MathML}
\XMLelement{m:math}{...}
\XMLelement{m:mi}{...}

Poněkud v rozporu s XML specifikací, za to velmi užitečně, umožňuje xmltex předefinování entit uvedených v lokálních deklaracích XML dokumentu. Ukažme si vše na malém příkladě. Dejme tomu, že se v textu píše často o TeXu a my si proto pro něj deklarujeme interní textovou entitu:

<!DOCTYPE clanek [
<!ENTITY TeX "TeX">
]>
<clanek>
  <zahlavi>
    <nazev>Státní správa bude používat &TeX; místo Wordu</nazev>
  ...
</clanek>

Při zpracování dokumentu nahradí parser odkaz na entitu &TeX; řetězcem „TeX“. To je většině případů žádoucí, protože kromě TeXu neumí jiné systémy logo správně zobrazit (například webový prohlížeč). Pro účely zpracování xmltexem si však můžeme do definičního souboru přidat předefinování entity. Ta nyní bude volat makro pro správné vysázení názvu našeho oblíbeného typografického systému:

\XMLentity{TeX}{\TeX{}}

Odkazy na entitu se nyní nahradí za „TeX“ a dostaneme tak požadovaný výstup.

Sám autor xmltexu o něm tvrdí, že to není procesor XML, který by 100% odpovídal standardu. Jedním z problémů je chybějící podpora načítání dokumentů kódovaných v UTF-16. V praxi to naštěstí příliš limitující není, protože toto kódování není moc používané. Standardně jsou podporována kódování UTF-8 a ISO Latin 1. Novější verze jsou distribuovány i s podporou středoevropských kódování ISO Latin 2 a windows-1250. Není problém přidat podporu dalších osmibitových kódování. Stačí vytvořit soubor jméno kódování.xmt a definovat v něm překódovací tabulku ve tvaru:

\InputCharacter{kód}{kód Unicode}

V článku jsem se pokusil shrnout a popsat základní principy přímé sazby dokumentů XML pomocí parseru napsaného čistě v TeXu. Je to přístup vhodný zejména pro jednodušší dokumenty, které již obsahují text víceméně v tom pořadí, jak se má objevit vysázený na výstupu. V případech, kdy je potřeba před zpracováním dokumentu provést jeho složitější transformace, je vhodnější ke konverzi XML do TeXu použít specializované nástroje, například XSLT transformaci.