ARCWAY Cockpit

DocBook Referenz

Hier finden Sie eine Auflistung und Beschreibung der XML Elemente, die für die Strukturierung von generierten Dokumenten verwendet werden können.

  1. Verwendbare Elemente
  2. Beispiel
  3. XML-Elemente
  4. Kodierung der Sonderzeichen in XML

Verwendbare Elemente

Die Dokumentengenerierung in ARCWAY Cockpit beschränkt sich auf folgende Elemente des DocBook XML-Sprachumfangs:

Beispiel

Der folgende XML-Abschnitt zeigt mit einem einfachen Beispiel die wichtigsten Strukturierungselemente, die von der Dokumentengenerierung des ARCWAY Cockpit unterstützt werden.

<book>
   <title>Titel des Buches</title>
   <subtitle>Untertitel des Buches</subtitle>
   <chapter>
     <title>Titel des Kapitels</title>
     <section>
       <title>Titel des Abschnitts</title>
       <para>
         Dies ist ein Absatz ....
       </para>
       <para>
         <table>
           <tgroup cols="2">
             <colspec colwidth="35mm"/>
             <colspec colwidth="70mm"/>
             <thead>
               <row>
               <entry>Spalte 1</entry><entry>Spalte 2</entry>
               </row>
             </thead>
             <tbody>
               <row>
               <entry>Feld 1.1</entry><entry>Feld 1.2</entry>
               </row>
               <row>
               <entry>Feld 2.1</entry><entry>Feld 2.2</entry>
               </row>
             </tbody>
           </tgroup>
         </table>
       </para>
       <para>
         Dies ist ein Absatz mit einer Liste
         <simplelist type="inline">
           <member>Listenelement 1</member>
           <member>Listenelement 2</member>
           <member>Listenelement 3</member>
         </simplelist>
       </para>
     </section>
   </chapter>
</book>

XML Elemente

<book>

Wurzelelement einer Berichtsvorlage

Unterknoten

Oberknoten

Attribute

keine

<chapter>

Kapitel eines Berichtes

Unterknoten

Oberknoten

Attribute

keine

<section>

Abschnitt eines Berichtes

Unterknoten

Oberknoten

Attribute

keine

<para>

Paragraph innerhalb eines Kapitel oder Abschnitts

Unterknoten

Oberknoten

Attribute

<table>

Tabelle

Unterknoten

Oberknoten

Attribute

Beispiel

<table>
   <tgroup cols="2">
     <colspec colwidth="35mm"/>
     <colspec colwidth="70mm"/>
     <thead>
       <row>
         <entry>Spalte 1</entry><entry>Spalte 2</entry>
       </row>
     </thead>
     <tbody>
       <row>
         <entry>Feld 1.1</entry><entry>Feld 1.2</entry>
       </row>
       <row>
         <entry>Feld 2.1</entry><entry>Feld 2.2</entry>
       </row>
     </tbody>
   </tgroup>
</table>

<tgroup>

Gruppiert Tabelleninhalt

Unterknoten

Oberknoten

Attribute

cols: Anzahl der Spalten der Tabelle

<colspec>

Definition einer Tabellenspalte

Unterknoten

keine

Oberknoten

Attribute

colwidth: Breite der Tabellenspalte. Absolut wie z.B. 10 mm oder relativ wie z.B. 3*.

Beispiel

<colspec colwidth="35mm"/>

<thead>

Tabellenkopf, kann aus mehreren Zeilen bestehen.

Beim Word Ausgabeformat wird der Tabellenkopf automatisch fett ausgegeben.

Unterknoten

Oberknoten

Attribute

keine

Beispiel

<thead>
  <row>
    <entry>Tabellenfeld Spalte 1</entry>
    <entry>Tabellenfeld Spalte 2</entry>
    <entry>Tabellenfeld Spalte 3</entry>
  </row>
</thead>

<tbody>

Tabelleninhalt, besteht in der Regel aus mehreren Zeilen.

Unterknoten

Oberknoten

Attribute

keine

Beispiel

<tbody>
  <row>
    <entry>Tabellenfeld Spalte 1</entry>
    <entry>Tabellenfeld Spalte 2</entry>
    <entry>Tabellenfeld Spalte 3</entry>
  </row>
</tbody>

<tfoot>

Tabellenfuß, kann aus mehreren Zeilen bestehen.

Unterknoten

Oberknoten

Attribute

keine

Beispiel

<tfoot>
  <row>
    <entry>Tabellenfeld Spalte 1</entry>
    <entry>Tabellenfeld Spalte 2</entry>
    <entry>Tabellenfeld Spalte 3</entry>
  </row>
</tfoot>

<row>

Tabellenzeile.

Unterknoten

Oberknoten

Attribute

keine

Beispiel

<row>
  <entry>Tabellenfeld Spalte 1</entry>
  <entry>Tabellenfeld Spalte 2</entry>
  <entry>Tabellenfeld Spalte 3</entry>
</row>

<entry>

Tabellenfeld.

Unterknoten

Oberknoten

Attribute

Beispiel

<entry>Dies ist ein Tabellenfeld</entry>

<simplelist>

Einfache Liste

Unterknoten

Oberknoten

Attribute

type: zur Zeit wird nur der Wert inline unterstützt. Dieser bewirkt, dass die Elemente der Liste hintereinander, durch Kommata getrennt aufgelistet werden.

Beispiel

<simplelist type="inline">
  <member>Listenelement 1</member>
  <member>Listenelement 2</member>
</simplelist>

<member>

Element einer Liste

Unterknoten

Oberknoten

Attribute

keine

Beispiel

<member>Dies ist ein Listenelement</member>

<title>

Titel eines Kapitels, Abschnitts

Unterknoten

Oberknoten

Attribute

keine

Beispiel

<title>Dies ist ein Titel</title>

Untertitel eines Kapitels, Abschnitts.

Unterknoten

Oberknoten

Attribute

keine

Beispiel

<subtitle>Dies ist ein Untertitel</subtitle>

<link>

Hyperlink zu einer Datei oder einer Webseite

Unterknoten

Oberknoten

Attribute

linkend: URL des Zielpunktes

Beispiel

<link linked="http://www.arcway.com">Homepage der ARCWAY AG</link>

<ulink>

Ein Link der sein Ziel über eine URL (Uniform Resource Locator) adressiert.

Unterknoten

Oberknoten

Attribute

url: Spezifiziert den Uniform Resource Locator, der Ziel des ULinks ist.

Beispiel

<ulink url="http://www.arcway.com">Homepage der ARCWAY AG</ulink>

<anchor>

Eine bestimmte Stelle im Dokument. Mit Hilfe der ID des Anchors kann diese Stelle zum Beispiel mit Hilfe eines Links angesprungen werden.

Unterknoten

keine

Oberknoten

Attribute

linkend: URL des Zielpunktes

Beispiel

Das anchor-Element <anchor id="example.anchor.1"/> ist leer und steuert inhaltlich nichts zum Dokument bei. Es dient lediglich als Ziel.

Kodierung der Sonderzeichen in XML

Wenn Sie selbst eine eigene Berichtsvorlage schreiben möchten, dann beachten Sie bitte, dass bestimmte Sonderzeichen kodiert werden müssen.
Benutzen Sie den Berichtsvorlagen-Header, um die Zeichenkodierung, die Ihr Texteditor verwendet anzugeben. Dadurch entfällt die manuelle Kodierung aller Sonderzeichen, die Ihr Editor unterstützt.
Sonderzeichen, die von Ihrem Editor nicht unterstützt werden, können durch Steuersequenzen kodiert werden.

Verwandte Themen:
Der Berichtsvorlagen-Header

Siehe auch:
Zeichenreferenz auf SELFHTML