# GNOME Dokumentation-XSLT-Handbuch

The GNOME Documentation XSLT stylesheets were created to provide fast DocBook to HTML conversion for real-time document viewing in GNOME's help browser, Yelp.

2004 Shaun McCance
2009 Mario Blättermann (mariobl@gnome.org)
GNOME-Dokumentationsprojekt
Shaun McCance
GNOME-Dokumentationsprojekt
shaunm@gnome.org
Brent Smith
GNOME-Dokumentationsprojekt
gnome@nextreality.net
0.1
31. März 2004
0.2
11. Februar 2006

## Einführung

Die GNOME XSLT-Stilvorlagen werden verwendet, um HTML aus DocBook-Dateien zu erzeugen.

Einige der Ziele dieser Stilvorlagen sind:

- Bereitstellung einer Übertragung von DocBook in HTML in Echtzeit. Der GNOME Hilfebrowser Yelp verwendet diese Stilvorlagen zur Formatierung von Hilfedokumenten.

- Bereitstellung eines benutzerdefinierten Erscheinungsbildes für die Dokumentation von GNOME.

- Unterstützung für die Übersetzung der GNOME-Dokumentation.

## Verwendung der Stilvorlagen

Um die Stilvorlagen zu verwenden, sollten Sie mit der Anwendung xsltproc vertraut sein. Das erste Argument ist der Ort der `db2html.xsl`-Stilvorlage. Das zweite Argument ist die Basis-DocBook-Datei, aus welcher HTML erzeugt werden soll.

Erstellung von HTML aus einer DocBook-Datei

    $ xsltproc /usr/share/xml/gnome/xslt/docbook/html/db2html.xsl <docbook file>

Weitere Informationen über xsltproc und die libxslt-Bibliotheken finden Sie auf http://xmlsoft.org/.

XInclude-Verarbeitung

If you make use of XInclude to include other files in your document, then you must use the --xinclude parameter to generate the complete DocBook file before processing it with the `db2html.xsl` stylesheet(s).

## Angeben von Parametern

There are a number of parameters available in the stylesheets which you can set to customize the generated html. An exhaustive list is available in the following sections, but we will go over a few of the more commonly used ones in this section.

To specify a parameter to the stylesheets, use the --stringparam option of the xsltproc application.

db.chunk.chunk_top

  Set this parameter to `1` if you want the stylesheets to chunk

  Chunking refers to creating a separate output file for an element. For example, if there are three `<sect1>` elements within a document, (with no subsections) then there will be three files generated for each element. Incidentally, the name of the files will be the same as the element's `id` attribute.

  the top level element (`<article>` or `<book>`) into a file called `index.xhtml`.
db.chunk.max_depth

  Specifies the maximum depth of chunked elements specified in db.chunk.chunks parameter.

db.chunk.extension

  Set this parameter to `the extension` you would like for the chunked output files.

Example of specifying stylesheet parameters

    $ xsltproc \
       --stringparam db.chunk.chunk_top 1        \
       --stringparam db.chunk.max_depth 1        \
       --stringparam db.chunk.extension '.html'  \
       /usr/share/xml/gnome/xslt/docbook/html/db2html.xsl \
       <path to docbook file>

will chunk the top level element, chunk to a maximum depth of 1 and chunk the title page.

## Einschränkungen

Gegenwärtig erfordern die Stilvorlagen ein `id`-Attribut zu jedem enthaltenen Element.

## Referenz der Stilvorlagen