X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fhtml%2Fch04s06.html;h=e99f3e0d18c09264e6143d9ac8d5caa6ea49d96f;hb=8d771986641efbc83911b0ba007e6c240daea550;hp=4fe859e9aeef82f37b3ff5cd8f33fd8f5e1b6619;hpb=06cb6b127be7185927c6a3b32d16295d55e162ea;p=kivitendo-erp.git diff --git a/doc/html/ch04s06.html b/doc/html/ch04s06.html index 4fe859e9a..e99f3e0d1 100644 --- a/doc/html/ch04s06.html +++ b/doc/html/ch04s06.html @@ -1,6 +1,6 @@ - 4.6. Dokumentation erstellen

4.6. Dokumentation erstellen

4.6.1. Einführung

Diese Dokumentation ist in DocBook™ + 4.6. Dokumentation erstellen

4.6. Dokumentation erstellen

4.6.1. Einführung

Diese Dokumentation ist in DocBook™ XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor. Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen Editor nutzt, der spezielle Unterstützung für @@ -10,9 +10,9 @@ ist.

4.6.2. Benötigte Software

Bei DocBook™ ist Prinzip, dass ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML - erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script + erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script scripts/build_doc.sh.

Das Script benötigt zur Konvertierung verschiedene - Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht benötigt + Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt werden:

  • Java in einer halbwegs aktuellen Version

  • Das Java-Build-System Apache Ant @@ -31,7 +31,7 @@ $HOME/Downloads heruntergeladen wurde:

    cd doc/build
     unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip

4.6.3. PDFs und HTML-Seiten erstellen

Die eigentliche Konvertierung erfolgt nach Installation der benötigten Software mit einem einfachen Aufruf direkt aus dem - Lx-Office-Installationsverzeichnis heraus:

./scripts/build_doc.sh

4.6.4. Einchecken in das Git-Repository

Sowohl die XML-Datei als auch die erzeugten PDF- und + kivitendo-Installationsverzeichnis heraus:

./scripts/build_doc.sh

4.6.4. Einchecken in das Git-Repository

Sowohl die XML-Datei als auch die erzeugten PDF- und HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut und alles zusammen in einem Commit eingecheckt werden sollten.

Die "dobudish"-Verzeichnisse bzw.