projekt kivitendo

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

  <chapter id="Aktuelle-Hinweise">

    <title>Aktuelle Hinweise</title>

    <itemizedlist>

      <listitem>

      </listitem>

      <listitem>

      </listitem>

    </itemizedlist>

  </chapter>

      <sect2 id="Betriebssystem">

        <title>Betriebssystem</title>

        unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist

        diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde

        bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es

        ohne große Probleme auf den derzeit aktuellen verbreiteten

        Distributionen läuft.</para>

        <itemizedlist>

          <listitem>

          </listitem>

          <listitem>

          </listitem>

          <listitem>

          </listitem>

        </itemizedlist>

      </sect2>

      <sect2 id="Pakete" xreflabel="Pakete">

        <title>Pakete</title>

        Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)

        benötigt.</para>

        nicht Bestandteil einer Standard-Perl-Installation sind:</para>

        <itemizedlist>

        <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete

        hinzugekommen, <literal>URI</literal> und

        nicht.</para>

        <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,

        <para><literal>Email::Address</literal> und

        <literal>List::MoreUtils</literal> sind schon länger feste

        sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer

        zukünftigen Version aber aus dem Paket entfernt werden. Es wird

        empfohlen diese Module zusammen mit den anderen als Bibliotheken zu

        <literal>Rose::*</literal> Pakete sind derzeit nicht für SuSE gepackt,

        und müssen anderweitig nachinstalliert werden.</para>

        alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie

        folgt:</para>

           xreflabel="Manuelle Installation des Programmpaketes">

      <title>Manuelle Installation des Programmpaketes</title>

      im Dokumentenverzeichnis des Webservers (z.B.

      <filename>/var/www/html/</filename>,

      <filename>/srv/www/htdocs</filename> oder

      <filename>/var/www/</filename>) entpackt:</para>

      <para>Alternativ können Sie auch einen Alias in der

      Webserverkonfiguration benutzen, um auf das tatsächliche

      <programlisting>chown -R www-data users spool webdav</programlisting>

      <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>

      <programlisting>chown www-data templates users</programlisting>

    </sect1>

    <sect1 id="config.config-file">

      <sect2 id="config.config-file.introduction"

             xreflabel="Einführung in die Konfigurationsdatei">

        <title>Einführung</title>

        "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation

        werden.</para>

        <para>Als Vorlage dient die Datei

        Default-Datei"):</para>

        <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in

        der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der

        Abschnitte und Werte enthalten, die von denen der Default-Datei

        abweichen.</para>

        <para>Diese Hauptkonfigurationsdatei ist dann eine

        installationsspezifische Datei, d.h. sie enthält bspw. lokale

        Passwörter und wird auch nicht im Versionsmanagement (git)

[authentication/database]

host     = localhost

port     = 5432

user     = postgres

password =

        linkend="config.task-server">Taskserver</link> für <link

        linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,

        muss unter <varname>[task_server]</varname> ein Login eines Benutzers

        Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>

        <para>Für Entwickler finden sich unter <varname>[debug]</varname>

      <sect2 id="config.config-file.prior-versions">

        <title>Versionen vor 2.6.3</title>

        <filename>config</filename> die Dateien

        <filename>authentication.pl</filename> und

        <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es

        zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab

        2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>

        jünger müssen die Einstellungen aus den alten Konfigurationsdateien

        manuell übertragen und die alten Konfigurationsdateien anschließend

        entsprechende Fehlermeldung an.</para>

      </sect2>

    </sect1>

      <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">

        <title>Zeichensätze/die Verwendung von UTF-8</title>

        werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in

        Version 8.2 oder neuer benutzt werden, und der

        PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale

        angelegt worden sein.</para>

        <para>Dieses ist kann überprüft werden: ist das Encoding der Datenbank

        Andernfalls ist es notwendig, einen neuen Datenbankcluster mit

        UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und

        Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl

        <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und

        ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann

        <para>Das Encoding einer Datenbank kann in <command>psql</command> mit

        <literal>\l</literal> geprüft werden.</para>

        <filename>/etc/postgresql/</filename>, muss sichergestellt werden,

        dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den

        Parameter <varname>listen_address</varname> gesteuert. Laufen

        <literal>localhost</literal> verwendet werden. Andernfalls müssen

        Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,

        was mit dem Wert <literal>*</literal> geschieht.</para>

        <para>Besser ist es, für eine bestimmte Datenbank Zugriff nur per

        Passwort zuzulassen. Beispielsweise:</para>

      </sect2>

      <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">

        anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen

        können:</para>

        <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern

        den hier gewählten Benutzernamen.</para>

      </sect2>

    </sect1>

        wird:</para>

        <programlisting>AddHandler cgi-script .pl

 Options ExecCGI Includes FollowSymlinks

</Directory>

 Order Deny,Allow

 Deny from All

&lt;/Directory&gt;</programlisting>

        <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher

        <note>

          <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein

        <sect3 id="Apache-Konfiguration.FCGI.Warum">

          <title>Warum FastCGI?</title>

          kompiliert. Stattdessen werden die Quelldateien bei jedem Start

          übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit

          ausmacht. Während SQL Ledger einen Großteil der Funktionalität in

          einzelne Module kapselt, um immer nur einen kleinen Teil laden zu

          immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich

          benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber

          entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies

          deutlich länger dauert als früher, und dass davon 90% für das Laden

          der Module verwendet wird.</para>

          <warning>

            <para>FCGI 0.69 und höher ist extrem strict in der Behandlung von

            Probleme mit Umlauten in Ihrere Installation gibt, muss auf die

            Vorgängerversion FCGI 0.68 ausgewichen werden.</para>

        <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">

          <title>Konfiguration des Webservers</title>

          laufen zu lassen, empfliehlt es sich die Installation ersteinmal

          unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu

          debuggen die beim ersten aufsetzen auftreten können. Sollte die

          <programlisting>a2enmod fcgid</programlisting>

          erfolgt durch Anpassung der vorhandenen <function>Alias</function>-

          und <function>Directory</function>-Direktiven. Dabei wird zwischen

          <para>Folgender Konfigurationsschnipsel funktioniert mit

          mod_fastcgi:</para>

  AllowOverride All

  Options ExecCGI Includes FollowSymlinks

  Order Allow,Deny

  Allow from All

</Directory>

  Order Deny,Allow

  Deny from All

&lt;/DirectoryMatch&gt;</programlisting>

          <para>Das ganze sollte dann so aussehen:</para>

          <programlisting>AddHandler fcgid-script .fpl

FcgidMaxRequestLen 10485760

  AllowOverride All

  Options ExecCGI Includes FollowSymlinks

  Order Allow,Deny

  Allow from All

</Directory>

  Order Deny,Allow

  Deny from All

&lt;/DirectoryMatch&gt;</programlisting>

          Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,

          gibt es hier kleine Performance-Einbußen.</para>

          CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven

          wie oben beschrieben, die URLs werden aber umgeleitet:</para>

          <programlisting># Zugriff über CGI

# Zugriff mit mod_fcgid:

          die normale Version erreichbar, und unter

          FastCGI-Version.</para>

        </sect3>

      </sect2>

        <para>Die Konfiguration erfolgt über den Abschnitt

        <literal>[task_server]</literal> in der Datei

        Optionen sind:</para>

        <variablelist>

            <term><varname>login</varname></term>

            <listitem>

              zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss

              in der Administration angelegt werden. Diese Option muss

              angegeben werden.</para>

        <para>Der Task-Server verhält sich von seinen Optionen her wie ein

        reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim

        <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen

        Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess

        </itemizedlist>

        <para>Der Task-Server wechselt beim Starten automatisch in das

        <para>Dieselben Optionen können auch für die SystemV-basierenden

        Runlevel-Scripte benutzt werden (siehe oben).</para>

      <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">

        <title>Grundlagen zur Benutzerauthentifizierung</title>

        Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt

        wird. Für jeden Benutzer kann dort eine eigene Datenbank für die

        eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken

        können, müssen aber nicht unterschiedlich sein.</para>

        Datenbank, in der sowohl die Benutzerinformationen als auch die Daten

        abgelegt werden.</para>

        entweder gegen die Authentifizierungsdatenbank oder gegen einen

        LDAP-Server überprüft werden.</para>

        festgelegt. Diese muss bei der Installation und bei einem Upgrade von

        einer Version vor v2.6.0 angelegt werden. Eine

        Beispielkonfigurationsdatei

        Vorlage benutzt werden kann.</para>

      </sect2>

            <term><literal>user</literal></term>

            <listitem>

              Datenbankserver anmeldet (z.B.

              "<literal>postgres</literal>")</para>

            </listitem>

          </varlistentry>

        </variablelist>

        automatisch anlegen (mehr dazu siehe unten).</para>

      </sect2>

      <sect2 id="Passwortüberprüfung">

        <title>Passwortüberprüfung</title>

        die Authentifizierungsdatenbank und gegen einen externen LDAP- oder

        Active-Directory-Server. Welche davon benutzt wird, regelt der

        Parameter <varname>module</varname> im Abschnitt

        gespeichert werden, so muss der Parameter <varname>module</varname>

        den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl

        der Administrator als auch die Benutzer selber ihre Psaswörter in

        <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server

        benutzt werden, so muss der Parameter <varname>module</varname> auf

      <sect2 id="Name-des-Session-Cookies">

        <title>Name des Session-Cookies</title>

        aufgesetzt werden, so müssen die Namen der Session-Cookies für alle

        Installationen unterschiedlich sein. Der Name des Cookies wird mit dem

        Parameter <varname>cookie_name</varname> im Abschnitt

        <title>Anlegen der Authentifizierungsdatenbank</title>

        <para>Nachdem alle Einstellungen in

        automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter

        der folgenden URL erreichbar sein sollte:</para>

        <para><ulink

      </sect2>

    </sect1>

      folgender URL finden:</para>

      <para><ulink

      <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei

      <sect2 id="Zusammenhänge">

        <title>Zusammenhänge</title>

        Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um

        Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine

        Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist

        möglich und normal, dass mehreren Benutzern die selbe Datenbank

        eingegeben werden können, werden in einer zweiten Datenbank

        gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese

        ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.

        Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit

        Firmendaten.</para>

        Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht

        gestattet, so werden der entsprechenden Menüpunkte auch nicht

        angezeigt. Diese Rechte werden ebenfalls in der

        Authentifizierungsdatenbank gespeichert.</para>

        Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche

        erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder

        mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen

        <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für

        den Datenbankzugriff den vorhin angelegten Benutzer (in unseren

        <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz

        vorgenommen wird und nicht nach Datenbank unterschieden werden kann.

        Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz

        angelegt worden sein.</para>

      <sect2 id="Migration-alter-Installationen">

        <title>Migration alter Installationen</title>

        in der die Benutzerdaten noch im Dateisystem im Verzeichnis

        Möglichkeit, diese Benutzerdaten automatisch in die

        Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man

        sich nach dem Update der Installation das erste Mal im

        <literal>users/members</literal>, so wird der Migrationsprozess

        gestartet.</para>

        <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle

        Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet

        Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle

        Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können

        sich sofort wieder anmelden und mit dem System arbeiten.</para>

      </sect2>

    </sect1>

      Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am

      einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter

      Debianoiden Betriebssystemen sind das die Pakete:</para>

    <sect1 id="OpenDocument-Vorlagen">

      <title>OpenDocument-Vorlagen</title>

      OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.

      diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von

      OpenDocument-Vorlagen zu aktivieren muss in der Datei

      <literal>opendocument</literal> im Abschnitt

      <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.

      Dieses ist die Standardeinstellung.</para>

      <para>Weiterhin muss in der Datei

      <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf

      die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der

      Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen

      Andere Distributionen enthalten ihn in anderen Paketen.</para>

      <para>Nach der Installation müssen in der Datei

      angepasst werden: <literal>openofficeorg_writer</literal> muss den

      vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.

      <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”

      enthalten. Beide stehen im Abschnitt

      <literal>applications</literal>.</para>

      OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die

      Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet

      ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet

             xreflabel="Einführung in die Konfiguration zur EUR">

        <title>Einführung</title>

        Konfigurationsparameter namens <varname>eur</varname>, der sich in der

        Konfigurationsdatei <filename>config/lx_office.conf</filename>

        benutzt wurden.</para>

        <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in

        <para>Die Konfiguration "<varname>eur</varname>" unter

        <varname>[system]</varname> in der <link

        linkend="config.config-file">Konfigurationsdatei</link>

        benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>

      </sect2>

        <title>Bemerkungen zu Bestandsmethode</title>

        <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,

        Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt

        werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank

        anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie

        <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die

        Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.

        erstellt und die Steuereinstellungen korrekt einstellt. Hat der

        Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon

        Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das

      </sect2>

    </sect1>

      <para>Nach erfolgreicher Installation ist der Loginbildschirm unter

      folgender URL erreichbar:</para>

      <para><ulink

      <para>Die Administrationsseite erreichen Sie unter:</para>

      <para><ulink

    </sect1>

  </chapter>

        Informationen zu den erstellten Rechnungen verschickt werden.

        Konfiguriert wird dies in der <link

        linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>

        <varname>[periodic_invoices]</varname>.</para>

      </sect2>

        linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>

        <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen

        ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für

        alle Vorlagenarten.</para>

        <programlisting>% config: tag-style=($ $)</programlisting>

        wenn sie wie folgt aussehen: <function>($customer$)</function>. Das

        äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>

        <title>Markup-Code zur Textformatierung innerhalb von

        Formularen</title>

        anders formatiert haben möchte, so ist dies begrenzt möglich.

        Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung

        Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird

        dann automatisch in Anweisungen für das ausgewählte Vorlagenformat

          brauchbares Tracing gebaut ist, "<function>log_time</function>", mit

          der man die Wallclockzeit seit Requeststart loggen kann, sowie

          "<function>message</function>" und "<function>dump</function>" mit

          packen kann.</para>

          <para>Beispielsweise so:</para>

            <listitem>

              <para>Repräsentation der

            </listitem>

          </itemizedlist>

          verfügbar:</para>

          <programlisting>[debug]

          <para>ist der Key <varname>file</varname> im Programm als

          <varname>$::lx_office_conf-&gt;{debug}{file}</varname>

      <sect2 id="devel.fcgi.general">

        <title>Allgemeines</title>

        werden, muss der Webserver neu gestartet werden.</para>

        <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu

        Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm

        am Laufen zu halten. Man kann mit <function>die</function>,

        <function>confess</function> oder <function>carp</function> Fehler

        eigene <function>$::form-</function>error()&gt; tut im Prinzip das

        Gleiche, mit ein paar Extraoptionen. <function>warn</function> und

        <function>exit</function> hingegen werden nicht abgefangen.

        <function>warn</function> wird direkt nach STDERR, also in Server Log

        eine Nachricht schreiben (sofern in der Konfiguration nicht die

        <function>exit</function> wird die Ausführung beenden.</para>

        <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess

        <para>Die kritischen Pfade des Programms sind die Belegmasken, und

        unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der

        4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0

        sind es je nach Menge der definierten Variablen 1-2s. Ab der

        Moose/Rose::DB Version sind es 5-6s.</para>

        diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele

        Entwicklung im stable- und unstable-Baum betrifft.</para>

        Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.

        Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In

        diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,

        angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man

        keine Versionsnummern mehr braucht.</para>

        sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht

        erneut aus. Dazu dient die Tabelle "schema_info", die bei der

        Anmeldung automatisch angelegt wird.</para>

            <listitem>

              <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",

              dass die in dieser Liste aufgeführten Scripte bereits

              durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>

              der Wert 1000 benutzt.</para>

              <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss

              Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"

              abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von

              2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,

        <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,

        existiert ein Hilfsscript namens

        "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem

        liest alle Datenbankupgradescripte aus dem Verzeichnis

        <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die

        von der Kommandozeile überprüft werden können.</para>

        <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur

            --list</command>"</para>

            <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der

            würde. Es werden neben der Listenposition der Tag, die

            Abhängigkeitstiefe und die Priorität ausgegeben.</para>

          </listitem>

          internationalen Übersetzern die Arbeit zu erleichtern.</para>

        </note>

        are built. Currently the only language fully supported is German, and

        since most of the internal messages are held in English the English

        version is usable too.</para>

             xreflabel="File structure">

        <title>File structure</title>

        <para>where &lt;langcode&gt; stands for an abbreviation of the

        language package. The builtin packages use two letter <ulink

            <term>special_chars</term>

            <listitem>

              formats, some of which are rather picky with their accepted

              charset. The <filename>special_chars</filename> file contains a

              listing of chars not suited for different file format and

            <listitem>

              <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte

              auf Englisch zu verfassen. So wie ich keine Lust habe,

              Quelltext für nicht-Deutschsprachige lesbar sein.

              Beispiel:</para>

          <para><varname>STDERR</varname> ist tabu. Unkonditionale

          Debugmeldungen auch.</para>

          einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen

          Grund, nach <varname>STDERR</varname> zu schreiben.</para>

        <para>Bei <productname>DocBook</productname> ist Prinzip, dass

        ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden

        dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML

        <command>scripts/build_doc.sh</command>.</para>

        <para>Das Script benötigt zur Konvertierung verschiedene

        werden:</para>

        <itemizedlist>

        <para>Die eigentliche Konvertierung erfolgt nach Installation der

        benötigten Software mit einem einfachen Aufruf direkt aus dem

        <programlisting>./scripts/build_doc.sh</programlisting>

      </sect2>