PDF -icon
PDF
Font size:      

Tipps und Tricks zu Apache Forrest

Hier wäre Platz für einen 'Abstract' (siehe unten).

Gliederung

Forrest-XML können (müssen) gegliedert werden. Dazu dient die section. Das 'id'-Attribut ist optional. Sections müssen immer ein 'title'-Element haben, dieser title dient dann als Überschrift.

Kürzeste Section ist also:

            
      <section>
         <title>Ein Titel</title>
      </section>

Sections können keinen Text direkt enthalten, nur z.B. einen Paragraphen, der dann wiederum Text enthält:

            
      <section id="Test">
         <title>Ein Titel</title>
         <p>Das ist legaler Text.</p>
      </section>

Sections können geschachtelt werden - die zweite Ebene wird im Inhaltsverzeichnis eingerückt und die Überschrift etwas kleiner dargestellt.
Mindestens vier Ebenen sind erlaubt, aber ich würde maximal drei verwenden. 

            
      <section>
         <title>Section - oberste Ebene</title>
         <p>Das ist legaler Text.</p>
         <section>
            <title>Section - zweite Ebene</title>
            <p>Das ist legaler Text.</p>
         </section>
      </section>

Abstract

Die Zeile "Hier wäre Platz für einen 'Abstract'." entstand durch das Tag abstract im Header. Der sieht dann so aus: 

         
      <header>
         <title>Tipps und Tricks zu Apache Forrest</title>
         <abstract>Hier wäre Platz für einen 'Abstract'.</abstract>
      </header>

Hinweise und Warnungen

Kleine Frames für Hinweise und Warnungen können in den Text eingebaut werden. Dabei sollte das 'label'-Attribut verwendet werden, um englische Überschriften wie 'Note' zu vermeiden.

Kleiner Hinweis
Nicht vergessen beim XML-Schreiben: Hin und wieder forrest validate ausführen, dieser Check kann kleinlich sein!

wurde erzeugt mit:

            
         <note label="Kleiner Hinweis">
           Nicht vergessen beim XML-Schreiben: Hin und wieder <code>forrest validate </code>
            ausführen, dieser Check kann kleinlich sein!
         </note>

Analog eine Warnung:

Erinnerung
Backup nicht vergessen.
            
      <warning label="Erinnerung">Backup nicht vergessen.</warning>

Eine minimale Forrest-XML

Als Ausgangspunkt für eigene Seiten: 

               
      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
      <document>
         <header>
            <title>Überschrift</title>
         </header>
         <body>
            <section>
               <title>Absatzüberschrift</title>
               <p>
                  Der Text...
               </p>
            </section>
         </body>
      </document>

Code

Für Programmcode und nicht-proportionalen Text kann der code-Tag oder der source-Tag verwendet werden.

Aus
<code>Dieses ist Code.</code>
wird so
Dieses ist Code.

Zitat

Aus
<p class="quote">Dieses ist ein Zitat.</p>
wird so

Dieses ist ein Zitat.

Textauszeichnungen

Kursive Schrift durch
<em>Das ist kursiv.</em>
sieht so aus:
Das ist kursiv.

Fette Schrift durch
<strong>Das ist fett.</strong>
sieht so aus:
Das ist fett.