Die Files
Das kleinstmöglichste Projekt, das Sie erstellen können, besteht in
etwa aus diesen Elementen:
<project>
<file="dateiname.xml"/>
</project>
Beachten Sie, dass die Reihenfolge in der Sie hier die Files eingeben,
die Reihenfolge bestimmt, in der die Dateien als nächste/vorherige-Link
bzw. im listtoc-Link angezeigt werden.
Daher sollten auch alle Dateien (Artikel) ein file-Tag haben.
Variablen in der Projektdatei
Wichtig an der Projektdatei ist, dass hier auch alle Einstellungen für
das Projekt definiert werden. Insofern ist obiges Beispiel ohne Angabe
z.B. eines Projektnamens sinnlos. Folgende Variablen sollten
in einem variables-Bereich hinterlegt werden. In runden Klammer stehen
die Attribute, in eckigen Klammern die optionalen Tags.
- author (value)
- title (value)
- version (value)
- upmost (value, href)
- [licenselink (href)]
- copyrightlink (value, year, href)
- logo (src,alt)
- download (href)
- keyword (value)
(siehe
Beispiel)
|
Tag mit Attribut
|
Beschreibung
|
|
author (value)
|
Der Name des Autors
|
|
title (value)
|
Der Titel des Artikels
|
|
version (value)
|
Plain-Text der Versionsnummer
|
|
upmost (value, href)
|
Die Bezeichnung (value) und der Link (href) zur übergeordneten Seite.
Angezeigt wird es in der Navigation "übergeordnet" zu der Indexseite
des Projekts
|
|
[licenselink (href)]
|
Einen Linkziel (href), der Text copyright (c) wird mit diesem Link ggf. unterlegt
|
|
copyrightlink (value, year, href)
|
Einen Linkziel (href), der Linktext (value) und das Copyrightjahr (year)
|
|
logo (src,alt)
|
Das Logo (src) und die Beschreibung für das Logobild
|
|
download (href)
|
Der Downloadlink zur gepackten Version des Projekts
|
|
keyword (value)
|
Beliebig viele dieser Tags werden in die Meta-Angabe des Dokuments übernommen
|
Settings
Settings verändern sich mit den Möglichkeiten des Mediums, für das Sie
kompilieren, z.B. für eine Druckversion.
Genau genommen ändern Sie die settings um eine andere Ausgabe zu generieren,
die aber alle als XHTML-Dateien gespeichert werden. Vorgesehen ist
eine online, offline und Druckversion.
<settings>
<set online="true"/>
<set print="false"/>
</settings>
(siehe ebenfalls Beispiel)
News
Sie können in der Projektdatei im Tags "news" "items" angeben. Stellen Sie eine neue Version
Ihrer Dokumentation ins Netz kann zum Beispiel jedes item eine Beschreibung einer
Sache sein, die Sie hinzugefügt oder verbessert haben. Diese News können Sie dann in beliebig
vielen Dateien (
Artikeln) zeigen (diesmal mit einem leeren <news/>-Tag). Sinnvoll ist das zum Beispiel in der index.xml.
Beispiel in der Projektdatei:
<news>
<item version="1.0">Version 1.0 von DocuML nutzte noch keine XSL-Style-Sheets und wurde durch
ein proprietäres Java-Programm eingebunden</item>
<item version="2.0">Ab Version 2.0 wurden SAXON als XSLT-Prozessor eingesetzt, das
komplette XHTML 1.1 wird gekapselt und kann in den Dokumenten verwendet werden</item>
<item version="3.0">Version 3.0 lagerte alle Angaben zum Projekt aus der XSL-Datei
in die bereits für Einstelungen benutzte Project.xml aus. Dadurch wird die XSL-Datei
unabhängig vom übersetzten Dokument. Zusätzlich wurden erste Interaktionen eingeführt
(<a href="artikel.html#uebungen">Multiple-Choice</a> und <a href="artikel.html#lueckentext">Lückentext</a>)</item>
<item date="20.9.2003" version="3.1">In Version 3.1 schließlich wurden inline-examples und
news eingeführt.</item>
</news>
Beachten Sie bitte, dass Sie, um in der Projektdatei Umlaute angeben zu können, diese
grundsätzlich den Zeichensatz ISO-8859-1 geben sollten.
Beispiel in der index.xml:
<news/>
News-Items können die folgenden Attribute haben:
|
header
|
Die Überschrift des News-Eintrags
|
|
version
|
Die Version, in der das beschriebene Element eingefügt wurde
|
|
date
|
Das Datum, an dem das beschriebene Element eingefügt wurde
|
Zeichensatz der Projektdatei
Umlaute können Sie in XML generell als Unicode-Zeichen maskieren.
Möchten Sie Umlaute jedoch direkt in Ihre XML-Datei schreiben können geben Sie die Zeile
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
am Anfang der XML-Datei an.
Beispiel einer kompletten Projektdatei
Beachten Sie, dass Sie zwar ein
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
Verwenden können, aber in der project.xml bitte auf
die Angabe des Style-Sheets verzichten sollten
(<?xml-stylesheet href="documl.xsl" type="text/xsl"?>).
<project>
<settings>
<set online="true"/>
<set print="false"/>
</settings>
<files>
<file id="index" name="index.xml"/>
<file id="artikel" name="artikel.xml"/>
<file id="kompilieren" name="kompilieren.xml"/>
<file id="projectdesc" name="projectdesc.xml"/>
<file id="fdl" name="fdl.xml"/>
<file id="referenz" name="referenz.xml"/>
</files>
<variables>
<author value="Jochen Staerk"/>
<title value="docuML"/>
<up value="usegroup"/>
<version value="0.7, 30.1.2003"/>
<upmost value="usegroup" href="http://www.usegroup.de/"/>
<licenselink value="usegroup" href="http://www.usegroup.de/"/>
<copyrightlink year="2003" value="usegroup" href="http://www.usegroup.de/"/>
<logo src="./img/logo.png" alt="docuML Logo"/>
<download href="http://www.usegroup.de/software/documl/documl.zip"/>
<keyword value="documl"/>
</variables>
<news>
<item version="1.0">Version 1.0 von DocuML nutzte noch keine XSL-Style-Sheets und wurde durch
ein proprietäres Java-Programm eingebunden</item>
<item version="2.0">Ab Version 2.0 wurden SAXON als XSLT-Prozessor eingesetzt, das
komplette XHTML 1.1 wird gekapselt und kann in den Dokumenten verwendet werden</item>
<item version="3.0">Version 3.0 lagerte alle Angaben zum Projekt aus der XSL-Datei
in die bereits für Einstelungen benutzte Project.xml aus. Dadurch wird die XSL-Datei
unabhängig vom übersetzten Dokument. Zusätzlich wurden erste Interaktionen eingeführt
(<a href="artikel.html#uebungen">Multiple-Choice</a> und <a href="artikel.html#lueckentext">Lückentext</a>)</item>
<item date="20.9.2003" version="3.1">In Version 3.1 schließlich wurden inline-examples und
news eingeführt.</item>
</news>
</project>
usegroup
Kompilieren von docuML-Artikeln
