<?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">
-<book id="ding.xml" lang="de">
+<book id="lx-office-documentation" lang="de">
<title>Lx-Office: Installation, Konfiguration, Entwicklung</title>
<chapter id="Aktuelle-Hinweise">
url="http://www.lx-office.org/forum/">http://www.lx-office.org/forum/</ulink></para>
</listitem>
</itemizedlist>
-
- <!-- -->
</chapter>
<chapter id="config">
ohne große Probleme auf den derzeit aktuellen verbreiteten
Distributionen läuft.</para>
- <para>Anfang 2011 sind das folgende Systeme:</para>
+ <para>Anfang 2012 sind das folgende Systeme, von denen bekannt ist,
+ dass Lx-Office auf ihnen läuft:</para>
<itemizedlist>
<listitem>
- <para>Ubuntu 8.04 LTS Hardy Heron</para>
- </listitem>
-
- <listitem>
- <para>Ubuntu 9.10 Karmic Koala</para>
- </listitem>
-
- <listitem>
- <para>Ubuntu 10.04 Lucid Lynx</para>
- </listitem>
-
- <listitem>
- <para>Ubuntu 10.10 Maverick Meerkat</para>
- </listitem>
-
- <listitem>
- <para>Debian 5.0 Lenny</para>
- </listitem>
-
- <listitem>
- <para>Debian 6.0 Squeeze</para>
+ <para>Ubuntu 8.04 LTS Hardy Heron, 10.04 LTS Lucid Lynx bis 11.10
+ Oneiric Ocelot</para>
</listitem>
<listitem>
- <para>openSUSE 11.2</para>
+ <para>Debian 5.0 Lenny und 6.0 Squeeze</para>
</listitem>
<listitem>
- <para>openSUSE 11.3</para>
+ <para>openSUSE 11.2 und 11.3</para>
</listitem>
<listitem>
</listitem>
<listitem>
- <para>Fedora 13</para>
- </listitem>
-
- <listitem>
- <para>Fedora 14</para>
+ <para>Fedora 13 bis 15</para>
</listitem>
</itemizedlist>
- <para>Für die debianoiden Betriebssysteme existiert ein .deb, das
- deutlich einfacher zu installieren ist.</para>
-
<para>Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die
Module im Archiv recht alt sind, und das viele der benötigten Module
nicht einfach zu installieren sind. Dafür sollte es kurz nach dem
<para>Alternativ dazu kann die normale Installation durchgeführt
werden (siehe <xref
- linkend="Manuelle-Installation-des-Programmpaketes"/>), wenn vorher
+ linkend="Manuelle-Installation-des-Programmpaketes" />), wenn vorher
ein Kompatibilitätspaket installiert wird, das die fehlenden Pakete
bereitstellt. Das Paket ist auf <ulink
url="https://sourceforge.net/projects/lx-office/files/Lx-Office%20ERP/2.6.2/">Sourceforge</ulink>
<para>Zur Installation das Paket in das entpackte Lx-Office
Verzeichnis entpacken:</para>
- <para><literal>tar xzf lx-erp-perl-libs-compat-v2.tar.gz
- /path/to/lx-office/</literal></para>
+ <programlisting>tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/</programlisting>
<para>Zusätzlich müssen dann noch die folgenden Pakete installiert
weerden</para>
- <para><literal>libbit-vector-perl libsub-exporter-perl libclone-perl
- libclass-factory-util-perl</literal></para>
+ <programlisting>apt-get install libbit-vector-perl libsub-exporter-perl libclone-perl libclass-factory-util-perl</programlisting>
<para>Danach sollte der Installationscheck (siehe <xref
- linkend="Pakete"/>) die enthaltenen Pakete erkennen.</para>
+ linkend="Pakete" />) die enthaltenen Pakete erkennen.</para>
</sect2>
<sect2 id="Pakete" xreflabel="Pakete">
<para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
- <para><literal>apache2 postgresql libparent-perl libarchive-zip-perl
- libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl
- libemail-address-perl liblist-moreutils-perl libpdf-api2-perl
- librose-object-perl librose-db-perl librose-db-object-perl
- libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl
- libxml-writer-perl libyaml-perl libconfig-std-perl
- libparams-validate-perl libjson-perl</literal></para>
+ <programlisting>apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
+ libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
+ libemail-address-perl liblist-moreutils-perl libpdf-api2-perl \
+ librose-object-perl librose-db-perl librose-db-object-perl \
+ libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
+ libxml-writer-perl libyaml-perl libconfig-std-perl \
+ libparams-validate-perl libjson-perl</programlisting>
<para>Für Fedora Core benötigen Sie diese Pakete:</para>
- <para><literal>httpd postgresql-server perl-parent perl-DateTime
- perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils
- perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object
- perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI
- perl-XML-Writer perl-YAML</literal></para>
+ <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
+ perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils \
+ perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
+ perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
+ perl-XML-Writer perl-YAML</programlisting>
<para>Für OpenSuSE benötigen Sie diese Pakete:</para>
- <para><literal>apache2 postgresql-server perl-Archive-Zip
- perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils
- perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv
- perl-URI perl-XML-Writer perl-YAML</literal></para>
+ <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
+ perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils \
+ perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
+ perl-URI perl-XML-Writer perl-YAML</programlisting>
<para>Bei openSuSE 11 ist <literal>parent</literal> bereits enthalten,
und braucht nicht nachinstalliert werden. Die
xreflabel="Manuelle Installation des Programmpaketes">
<title>Manuelle Installation des Programmpaketes</title>
- <para>Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.2.tgz) wird
+ <para>Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.3.tgz) wird
im Dokumentenverzeichnis des Webservers (z.B.
<filename>/var/www/html/</filename>,
<filename>/srv/www/htdocs</filename> oder
</sect1>
<sect1 id="config.config-file">
- <title>Lx-Office-Konfigurationsdatei</title>
+ <title>Lx-Office-Konfigurationsdatei</title>
- <sect2 id="config.config-file.introduction" xreflabel="Einführung in die Konfigurationsdatei">
- <title>Einführung</title>
+ <sect2 id="config.config-file.introduction"
+ xreflabel="Einführung in die Konfigurationsdatei">
+ <title>Einführung</title>
- <para>
- Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei die benötigt wird: <filename>config/lx_office.conf</filename> (kurz:
- "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von Lx-Office bzw. der Migration von älteren Versionen angelegt
- werden.
- </para>
+ <para>Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei
+ die benötigt wird: <filename>config/lx_office.conf</filename> (kurz:
+ "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
+ von Lx-Office bzw. der Migration von älteren Versionen angelegt
+ werden.</para>
- <para>
- Als Vorlage dient die Datei <filename>config/lx_office.conf.default</filename> (kurz: "die Default-Datei"):
- </para>
+ <para>Als Vorlage dient die Datei
+ <filename>config/lx_office.conf.default</filename> (kurz: "die
+ Default-Datei"):</para>
- <programlisting>$ cp config/lx_office.conf.default config/lx_office.conf</programlisting>
+
<programlisting>$ cp config/lx_office.conf.default config/lx_office.conf</programlisting>
- <para>
- Die Default-Datei wird immer zuerst eingelesen. Werte, die in der Hauptkonfigurationsdatei stehen, überschreiben die
- Werte aus der Default-Datei. Die Hauptkonfigurationsdatei muss also nur die Abschintte und Werte
- enthalten, die von denen der Default-Datei abweichen.
- </para>
+ <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
+ der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
+ Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
+ Abschintte 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) verwaltet.
- </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)
+ verwaltet.</para>
- <para>
- Die Konfiguration ist ferner serverabhängig, d.h. für alle Mandaten, bzw. Datenbanken gleich.
- </para>
- </sect2>
+ <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
+ Mandaten, bzw. Datenbanken gleich.</para>
+ </sect2>
- <sect2 id="config.config-file.sections-parameters">
- <title>Abschnitte und Parameter</title>
+ <sect2 id="config.config-file.sections-parameters">
+ <title>Abschnitte und Parameter</title>
- <para>
- Die Konfigurationsdatei besteht aus mehreren Teilen, die entsprechend kommentiert sind:
- </para>
+ <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
+ entsprechend kommentiert sind:</para>
- <itemizedlist>
- <listitem><para><literal>authentication</literal></para></listitem>
- <listitem><para><literal>authentication/database</literal></para></listitem>
- <listitem><para><literal>authentication/ldap</literal></para></listitem>
- <listitem><para><literal>system</literal></para></listitem>
- <listitem><para><literal>features</literal></para></listitem>
- <listitem><para><literal>paths</literal></para></listitem>
- <listitem><para><literal>applications</literal></para></listitem>
- <listitem><para><literal>environment</literal></para></listitem>
- <listitem><para><literal>print_templates</literal></para></listitem>
- <listitem><para><literal>task_server</literal></para></listitem>
- <listitem><para><literal>periodic_invoices</literal></para></listitem>
- <listitem><para><literal>console</literal></para></listitem>
- <listitem><para><literal>debug</literal></para></listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para><literal>authentication</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>authentication/database</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>authentication/ldap</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>system</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>features</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>paths</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>applications</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>environment</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>print_templates</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>task_server</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>periodic_invoices</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>console</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>debug</literal></para>
+ </listitem>
+ </itemizedlist>
- <para>
- Die üblicherweise wichtigsten Parameter, die am Anfang einzustellen oder zu kontrollieren sind, sind:
- </para>
+ <para>Die üblicherweise wichtigsten Parameter, die am Anfang
+ einzustellen oder zu kontrollieren sind, sind:</para>
- <programlisting>[authentication]
+
<programlisting>[authentication]
admin_password = geheim
[authentication/database]
eur = 1
dbcharset = UTF-8</programlisting>
- <para>
- Nutzt man wiederkehrende Rechnungen, kann man unter <literal>[periodic_invoices]</literal> den Login eines Benutzers angeben, der
- nach Erstellung der Rechnungen eine entsprechende E-Mail mit Informationen über die erstellten Rechnungen bekommt.
- </para>
-
- <para>
- Nutzt man den <link linkend="config.task-server">Taskserver</link> für <link
- linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>, muss unter <literal>[task_server]</literal> ein Login eines
- Benutzers angegeben werden, mit dem sich der Taskserver an Lx-Office bei der Datenbank anmeldet, die dem Benutzer zugewiesen ist.
- </para>
-
- <para>
- Für Entwickler finden sich unter <literal>[debug]</literal> wichtige Funktionen, um die Fehlersuche zu erleichtern.
- </para>
- </sect2>
-
- <sect2 id="config.config-file.prior-versions">
- <title>Versionen vor 2.6.3</title>
-
- <para>
- In älteren Lx-Office Versionen gab es im Verzeichnis <filename>config</filename> die Dateien <filename>authentication.pl</filename>
- und <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es gab auch die Möglichkeit, eine lokale Version der
- Konfigurationsdatei zu erstellen (<literal>lx-erp-local.conf</literal>). Dies ist ab 2.6.3 nicht mehr möglich, aber auch nicht mehr
- nötig.
- </para>
-
- <para>
- Beim Update von einer Lx-Office-Version vor 2.6.3 auf 2.6.3 oder jünger müssen die Einstellungen aus den alten Konfigurationsdateien
- manuell übertragen und die alten Konfigurationsdateien anschließend gelöscht oder verschoben werden. Ansonsten zeigt Lx-Office eine
- entsprechende Fehlermeldung an.
- </para>
- </sect2>
+ <para>Nutzt man wiederkehrende Rechnungen, kann man unter
+ <varname>[periodic_invoices]</varname> den Login eines Benutzers
+ angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
+ mit Informationen über die erstellten Rechnungen bekommt.</para>
+
+ <para>Nutzt man den <link
+ 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
+ angegeben werden, mit dem sich der Taskserver an Lx-Office bei der
+ Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
+
+ <para>Für Entwickler finden sich unter <varname>[debug]</varname>
+ wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
+ </sect2>
+
+ <sect2 id="config.config-file.prior-versions">
+ <title>Versionen vor 2.6.3</title>
+
+ <para>In älteren Lx-Office Versionen gab es im Verzeichnis
+ <filename>config</filename> die Dateien
+ <filename>authentication.pl</filename> und
+ <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
+ gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
+ 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>
+
+ <para>Beim Update von einer Lx-Office-Version vor 2.6.3 auf 2.6.3 oder
+ jünger müssen die Einstellungen aus den alten Konfigurationsdateien
+ manuell übertragen und die alten Konfigurationsdateien anschließend
+ gelöscht oder verschoben werden. Ansonsten zeigt Lx-Office eine
+ entsprechende Fehlermeldung an.</para>
+ </sect2>
</sect1>
<sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
<para>Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet
werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in
- Version 8.0 oder neuer benutzt werden, und der
+ Version 8.2 oder neuer benutzt werden, und der
PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale
angelegt worden sein.</para>
“template1” “UTF8”, so kann auch Lx-Office mit UTF-8 betrieben werden.
Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
- Ubuntu kann dies z.B. mit dem folgenden Befehl getan werden:</para>
+ Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
+ getan werden:</para>
- <para><literal>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8
- 8.2 clustername</literal></para>
+ <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
<para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
Versionsnummer angepasst werden.</para>
ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
Lx-Office mit ISO-8859-15 als Encoding betrieben werden.</para>
- <para>Das Encoding einer Datenbank kann in <literal>psql</literal> mit
+ <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
<literal>\l</literal> geprüft werden.</para>
</sect2>
<sect2 id="Änderungen-an-Konfigurationsdateien">
<title>Änderungen an Konfigurationsdateien</title>
- <para>In der Datei <literal>postgresql.conf</literal>, die je nach
+ <para>In der Datei <filename>postgresql.conf</filename>, die je nach
Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
- <literal>/var/lib/pgsql/data/</literal> oder
- <literal>/etc/postgresql/</literal>, muss sichergestellt werden, dass
- TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
- Parameter <literal>listen_address</literal> gesteuert. Laufen
+ <filename>/var/lib/pgsql/data/</filename> oder
+ <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
PostgreSQL und Lx-Office auf demselben Rechner, so kann dort der Wert
<literal>localhost</literal> verwendet werden. Andernfalls müssen
Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
- was mit dem Wert \<literal>*</literal> geschieht.</para>
+ was mit dem Wert <literal>*</literal> geschieht.</para>
- <para>In der Datei <literal>pg_hba.conf</literal>, die im gleichen
- Verzeichnis wie die <literal>postgresql.conf</literal> zu finden sein
- sollte, müssen die Berichtigungen für den Zugriff geändert werden.
- Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale
- Verbindungen immer zuzulassen</para>
+ <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
+ Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
+ sein sollte, müssen die Berichtigungen für den Zugriff geändert
+ werden. Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale
+ Verbindungen immer zuzulassen:</para>
- <para><literal>local all all trust host all all 127.0.0.1 255.0.0.0
- trust</literal></para>
+ <programlisting>local all all trust
+host all all 127.0.0.1 255.0.0.0 trust</programlisting>
<para>Besser ist es, für eine bestimmte Datenbank Zugriff nur per
Passwort zuzulassen. Beispielsweise:</para>
- <para><literal>local all lxoffice password host all lxoffice 127.0.0.1
- 255.255.255.255 password</literal></para>
-
- <!-- -->
+ <programlisting>local all lxoffice password
+host all lxoffice 127.0.0.1 255.255.255.255 password</programlisting>
</sect2>
<sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an, und
führen Sie die folgenden Kommandos aus:</para>
- <para><literal>create language 'plpgsql';</literal></para>
-
- <para>Achtung: In älteren Postgresversionen (vor 8.0) muss der Handler
- für die Sprache manuell anlelegt werden, diese Versionen werden aber
- nicht mehr offiziell von Lx-Office unterstützt. Dafür dann die
- folgenden Kommandos:</para>
-
- <para><literal>create function plpgsql_call_handler () returns opaque
- as '/usr/lib/pgsql/plpgsql.so' language 'c'; create language 'plpgsql'
- handler plpgsql_call_handler lancompiler 'pl/pgsql';</literal></para>
-
- <para>Bitte beachten Sie, dass der Pfad zur Datei
- <literal>plpgsql.so</literal> von Distribution zu Distribution
- verschiedlich sein kann. Bei Debian/Ubuntu befindet sie sich unter
- <literal>/usr/lib/postgresql/lib/plpgsql.so</literal>.</para>
-
- <!-- -->
+ <programlisting>create language 'plpgsql';</programlisting>
</sect2>
<sect2 id="Datenbankbenutzer-anlegen">
anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
können:</para>
- <para><literal>su - postgres createuser -d -P
- lxoffice</literal></para>
+ <programlisting>su - postgres createuser -d -P lxoffice</programlisting>
<para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
Sie den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” bzw.
den hier gewählten Benutzernamen.</para>
-
- <!-- -->
</sect2>
</sect1>
<note>
<para>Für einen deutlichen Performanceschub sorgt die Ausführung
mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
- <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
+ <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
</note>
<para>Der Zugriff auf das Programmverzeichnis muss in der Apache
anderen Datei hinzu, die beim Starten des Webservers eingelesen
wird:</para>
- <para><literal> AddHandler cgi-script .pl Alias /lx-erp/
- /var/www/lx-erp/ <Directory /var/www/lx-erp> Options ExecCGI
- Includes FollowSymlinks </Directory> <Directory
- /var/www/lx-erp/users> Order Deny,Allow Deny from All
- </Directory> </literal></para>
+ <programlisting>AddHandler cgi-script .pl
+Alias /lx-erp/ /var/www/lx-erp/
+
+<Directory /var/www/lx-erp>
+ Options ExecCGI
+ Includes FollowSymlinks
+</Directory>
+
+<Directory /var/www/lx-erp/users>
+ Order Deny,Allow
+ Deny from All
+</Directory></programlisting>
<para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
das Lx-Office-Archiv entpacket haben.</para>
- <para>Achtung: Vor den einzelnen Optionen muss bei einigen
- Distributionen ein Plus ‘<literal>+</literal>’ gesetzt werden.</para>
+ <note>
+ <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
+ Plus ‘<literal>+</literal>’ gesetzt werden.</para>
+ </note>
<para>Auf einigen Webservern werden manchmal die Grafiken und
Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
- <para><literal>EnableSendfile Off</literal></para>
+ <programlisting>EnableSendfile Off</programlisting>
</sect2>
<sect2 id="Apache-Konfiguration.FCGI"
Unicode, und verweigert bestimmte Eingaben von Lx-Office. Falls es
Probleme mit Umlauten in Ihrere Installation gibt, muss auf die
Vorgängerversion FCGI 0.68 ausgewichen werden.</para>
- </warning>
- <para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
- installieren:</para>
+
<para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
+ installieren:</para>
- <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
+ <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
+ </warning>
</sect3>
<sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
dem Installationspfad von Lx-Office im Dateisystem
("<filename>/path/to/lx-office-erp</filename>") und der URL
unterschieden, unter der Lx-Office im Webbrowser erreichbar ist
- ("<filename>/web/path/to/lx-office-erp</filename>").</para>
+ ("<filename>/url/for/lx-office-erp</filename>").</para>
<para>Folgender Konfigurationsschnipsel funktioniert mit
mod_fastcgi:</para>
- <programlisting>AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi
-Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/
+ <programlisting>AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi
+Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/
<Directory /path/to/lx-office-erp>
AllowOverride All
<para>Das ganze sollte dann so aussehen:</para>
<programlisting>AddHandler fcgid-script .fpl
-AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
-Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/
+AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
+Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/
FcgidMaxRequestLen 10485760
<Directory /path/to/lx-office-erp>
wie oben beschrieben, die URLs werden aber umgeleitet:</para>
<programlisting># Zugriff über CGI
-Alias /web/path/to/lx-office-erp /path/to/lx-office-erp
+Alias /url/for/lx-office-erp /path/to/lx-office-erp
# Zugriff mit mod_fcgid:
-AliasMatch ^/web/path/to/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
-Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/</programlisting>
+AliasMatch ^/url/for/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
+Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/</programlisting>
- <para>Dann ist unter
- <filename>/web/path/to/lx-office-erp/</filename> die normale Version
- erreichbar, und unter
- <constant>/web/path/to/lx-office-erp-fcgid/</constant> die
+ <para>Dann ist unter <filename>/url/for/lx-office-erp/</filename>
+ die normale Version erreichbar, und unter
+ <constant>/url/for/lx-office-erp-fcgid/</constant> die
FastCGI-Version.</para>
</sect3>
</sect2>
<filename>config/lx_office.conf</filename>. Die dort verfügbaren
Optionen sind:</para>
- <itemizedlist>
- <listitem>
- <para><literal>login</literal>: gültiger Lx-Office-Benutzername,
- der benutzt wird, um die zu verwendende Datenbankverbindung
- auszulesen. Der Benutzer muss in der Administration angelegt
- werden. Diese Option muss angegeben werden.</para>
- </listitem>
+ <variablelist>
+ <varlistentry>
+ <term><varname>login</varname></term>
- <listitem>
- <para><literal>run_as</literal>: Wird der Server vom
- Systembenutzer <literal>root</literal> gestartet, so wechselt er
- auf den mit <literal>run_as</literal> angegebenen Systembenutzer.
- Der Systembenutzer muss dieselben Lese- und Schreibrechte haben,
- wie auch der Webserverbenutzer (siehe see <xref
- linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher ist
- es sinnvoll, hier denselben Systembenutzer einzutragen, unter dem
- auch der Webserver läuft.</para>
- </listitem>
+ <listitem>
+ <para>gültiger Lx-Office-Benutzername, der benutzt wird, um die
+ zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
+ in der Administration angelegt werden. Diese Option muss
+ angegeben werden.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para><literal>debug</literal>: Schaltet Debug-Informationen an
- und aus.</para>
- </listitem>
- </itemizedlist>
+ <varlistentry>
+ <term><varname>run_as</varname></term>
+
+ <listitem>
+ <para>Wird der Server vom Systembenutzer <literal>root</literal>
+ gestartet, so wechselt er auf den mit <literal>run_as</literal>
+ angegebenen Systembenutzer. Der Systembenutzer muss dieselben
+ Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
+ (siehe see <xref
+ linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
+ ist es sinnvoll, hier denselben Systembenutzer einzutragen,
+ unter dem auch der Webserver läuft.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>debug</varname></term>
+
+ <listitem>
+ <para>Schaltet Debug-Informationen an und aus.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</sect2>
<sect2 id="Einbinden-in-den-Boot-Prozess">
<listitem>
<para>Debian-basierende Systeme:</para>
- <para><literal>update-rc.d lx-office-task-server defaults # Nur
- bei Debian Squeeze und neuer: insserv
- lx-office-task-server</literal></para>
+ <programlisting>update-rc.d lx-office-task-server defaults
+# Nur bei Debian Squeeze und neuer:
+insserv lx-office-task-server</programlisting>
</listitem>
<listitem>
<para>OpenSuSE und Fedora Core:</para>
- <para><literal>chkconfig --add
- lx-office-task-server</literal></para>
+ <programlisting>chkconfig --add lx-office-task-server</programlisting>
</listitem>
</itemizedlist>
<para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
- werden: <literal>/etc/init.d/lx-office-task-server
- start</literal></para>
+ werden: <command>/etc/init.d/lx-office-task-server
+ start</command></para>
</sect3>
<sect3>
<literal>exec ....</literal>).</para>
<para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
- werden: <literal>service lx-office-task-server
- start</literal></para>
+ werden: <command>service lx-office-task-server
+ start</command></para>
</sect3>
</sect2>
<para>Der Task-Server wird wie folgt kontrolliert:</para>
- <para><literal>./scripts/task_server.pl Befehl</literal></para>
+ <programlisting>./scripts/task_server.pl Befehl</programlisting>
<para><literal>Befehl</literal> ist dabei eine der folgenden
Optionen:</para>
<para>Dieselben Optionen können auch für die SystemV-basierenden
Runlevel-Scripte benutzt werden (siehe oben).</para>
-
- <!-- -->
</sect2>
</sect1>
<para>Informationen über die Einrichtung der Benutzerauthentifizierung,
über die Verwaltung von Gruppen und weitere Einstellungen</para>
- <!-- -->
-
<sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
<title>Grundlagen zur Benutzerauthentifizierung</title>
<para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
nur dort und nicht mehr im Administrationsinterface selber geändert
- werden. Der Parameter dazu heißt
- <literal>$self->{admin_password}</literal>.</para>
+ werden. Der Parameter dazu heißt <varname>admin_password</varname> im
+ Abschnitt <varname>[authentication]</varname>.</para>
</sect2>
<sect2 id="Authentifizierungsdatenbank">
<title>Authentifizierungsdatenbank</title>
<para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
- Parametern in <literal>$self->{DB_config}</literal> konfiguriert.
- Hier sind die folgenden Parameter anzugeben:</para>
+ Parametern in <varname>[authentication/database]</varname>
+ konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
- <itemizedlist>
- <listitem>
- <para>‘<literal>host</literal>’ – Der Rechnername oder die
- IP-Adresse des Datenbankservers</para>
- </listitem>
+ <variablelist>
+ <varlistentry>
+ <term><literal>host</literal></term>
- <listitem>
- <para>‘<literal>port</literal>’ – Die Portnummer des
- Datenbankservers, meist 5432</para>
- </listitem>
+ <listitem>
+ <para>Der Rechnername oder die IP-Adresse des
+ Datenbankservers</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>‘<literal>db</literal>’ – Der Name der
- Authentifizierungsdatenbank</para>
- </listitem>
+ <varlistentry>
+ <term><literal>port</literal></term>
- <listitem>
- <para>‘<literal>user</literal>’ – Der Benutzername, mit dem sich
- Lx-Office beim Datenbankserver anmeldet (z.B. “postgres”)</para>
- </listitem>
+ <listitem>
+ <para>Die Portnummer des Datenbankservers, meist 5432</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>‘<literal>password</literal>’ – Das Passwort für den
- Datenbankbenutzer</para>
- </listitem>
- </itemizedlist>
+ <varlistentry>
+ <term><literal>db</literal></term>
+
+ <listitem>
+ <para>Der Name der Authentifizierungsdatenbank</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>user</literal></term>
+
+ <listitem>
+ <para>Der Benutzername, mit dem sich Lx-Office beim
+ Datenbankserver anmeldet (z.B.
+ "<literal>postgres</literal>")</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>password</literal></term>
+
+ <listitem>
+ <para>Das Passwort für den Datenbankbenutzer</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<para>Die Datenbank muss noch nicht existieren. Lx-Office kann sie
automatisch anlegen (mehr dazu siehe unten).</para>
<para>Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen
die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
Active-Directory-Server. Welche davon benutzt wird, regelt der
- Parameter <literal>$self->{module}</literal>.</para>
+ Parameter <varname>module</varname> im Abschnitt
+ <varname>[authentication]</varname>.</para>
<para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
- gespeichert werden, so muss der Parameter
- <literal>$self->{module}</literal> den Wert ‘<literal>DB</literal>’
- enthalten. In diesem Fall können sowohl der Administrator als auch die
- Benutzer selber ihre Psaswörter in Lx-Office ändern.</para>
+ 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
+ Lx-Office ändern.</para>
<para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
- benutzt werden, so muss der Parameter
- <literal>$self->{module}</literal> auf ‘<literal>LDAP</literal>’
- gesetzt werden. In diesem Fall müssen zusätzliche Informationen über
- den LDAP-Server in <literal>$self->{LDAP_config}</literal>
- angegeben werden:</para>
+ benutzt werden, so muss der Parameter <varname>module</varname> auf
+ <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
+ zusätzliche Informationen über den LDAP-Server im Abschnitt
+ <literal>[authentication/ldap]</literal> angegeben werden:</para>
- <itemizedlist>
- <listitem>
- <para>‘<literal>host</literal>’ – Der Rechnername oder die
- IP-Adresse des LDAP- oder Active-Directory-Servers. Diese Angabe
- ist zwingend erforderlich.</para>
- </listitem>
+ <variablelist>
+ <varlistentry>
+ <term><literal>host</literal></term>
- <listitem>
- <para>‘<literal>port</literal>’ – Die Portnummer des LDAP-Servers;
- meist 389.</para>
- </listitem>
+ <listitem>
+ <para>Der Rechnername oder die IP-Adresse des LDAP- oder
+ Active-Directory-Servers. Diese Angabe ist zwingend
+ erforderlich.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>‘<literal>tls</literal>’ – Wenn Verbindungsverschlüsselung
- gewünscht ist, so diesen Wert auf ‘<literal>1</literal>’ setzen,
- andernfalls auf ‘<literal>0</literal>’ belassen</para>
- </listitem>
+ <varlistentry>
+ <term><literal>port</literal></term>
- <listitem>
- <para>‘<literal>attribute</literal>’ – Das LDAP-Attribut, in dem
- der Benutzername steht, den der Benutzer eingegeben hat. Für
- Active-Directory-Server ist dies meist
- ‘<literal>sAMAccountName</literal>’, für andere LDAP-Server
- hingegen ‘<literal>uid</literal>’. Diese Angabe ist zwingend
- erforderlich.</para>
- </listitem>
+ <listitem>
+ <para>Die Portnummer des LDAP-Servers; meist 389.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>‘<literal>base_dn</literal>’ – Der Abschnitt des
- LDAP-Baumes, der durchsucht werden soll. Diese Angabe ist zwingend
- erforderlich.</para>
- </listitem>
+ <varlistentry>
+ <term><literal>tls</literal></term>
- <listitem>
- <para>‘<literal>filter</literal>’ – Ein optionaler LDAP-Filter.
- Enthält dieser Filter das Wort <literal><%login%></literal>,
- so wird dieses durch den vom Benutzer eingegebenen Benutzernamen
- ersetzt. Andernfalls wird der LDAP-Baum nach einem Element
- durchsucht, bei dem das oben angegebene Attribut mit dem
- Benutzernamen identisch ist.</para>
- </listitem>
+ <listitem>
+ <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
+ Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
+ ‘<literal>0</literal>’ belassen</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>‘<literal>bind_dn</literal>’ und
- ‘<literal>bind_password</literal>’ – Wenn der LDAP-Server eine
- Anmeldung erfordert, bevor er durchsucht werden kann (z.B. ist
- dies bei Active-Directory-Servern der Fall), so kann diese hier
- angegeben werden. Für Active-Directory-Server kann als
- ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
- z.B. ‘<literal>cn=Martin
- Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der volle
- Name des Benutzers eingegeben werden; in diesem Beispiel also
- ‘<literal>Martin Mustermann</literal>’.</para>
- </listitem>
- </itemizedlist>
+ <varlistentry>
+ <term><literal>attribute</literal></term>
+
+ <listitem>
+ <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
+ Benutzer eingegeben hat. Für Active-Directory-Server ist dies
+ meist ‘<literal>sAMAccountName</literal>’, für andere
+ LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
+ zwingend erforderlich.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>base_dn</literal></term>
+
+ <listitem>
+ <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
+ Diese Angabe ist zwingend erforderlich.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>filter</literal></term>
+
+ <listitem>
+ <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
+ <literal><%login%></literal>, so wird dieses durch den vom
+ Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
+ der LDAP-Baum nach einem Element durchsucht, bei dem das oben
+ angegebene Attribut mit dem Benutzernamen identisch ist.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>bind_dn</literal> und
+ <literal>bind_password</literal></term>
+
+ <listitem>
+ <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
+ durchsucht werden kann (z.B. ist dies bei
+ Active-Directory-Servern der Fall), so kann diese hier angegeben
+ werden. Für Active-Directory-Server kann als
+ ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
+ z.B. ‘<literal>cn=Martin
+ Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
+ volle Name des Benutzers eingegeben werden; in diesem Beispiel
+ also ‘<literal>Martin Mustermann</literal>’.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</sect2>
<sect2 id="Name-des-Session-Cookies">
<para>Sollen auf einem Server mehrere Lx-Office-Installationen
aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
- Parameter <literal>$self->{cookie_name}</literal> gesetzt.</para>
+ Parameter <varname>cookie_name</varname> im Abschnitt
+ <varname>[authentication]</varname>gesetzt.</para>
<para>Diese Angabe ist optional, wenn nur eine Installation auf dem
Server existiert.</para>
<para><ulink
url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
-
- <!-- -->
</sect2>
</sect1>
Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis
Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
sich sofort wieder anmelden und mit dem System arbeiten.</para>
-
- <!-- -->
</sect2>
</sect1>
<literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
(oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
darf.</para>
-
- <!-- -->
</sect1>
<sect1 id="OpenDocument-Vorlagen">
<para>Dieses Verzeichnis, wie auch das komplette
<literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
sein. Dieses wurde bereits erledigt (siehe <xref
- linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
- überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
-
- <!-- -->
+ linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
+ erneut überprüft werden, wenn die Konvertierung nach PDF
+ fehlschlägt.</para>
</sect1>
- <sect1 id="Lx-Office-ERP-verwenden">
- <title>Lx-Office ERP verwenden</title>
+ <sect1 id="config.eur">
+ <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
+ EUR</title>
- <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
- folgender URL erreichbar:</para>
+ <sect2 id="config.eur.introduction"
+ xreflabel="Einführung in die Konfiguration zur EUR">
+ <title>Einführung</title>
- <para><ulink
- url="http://localhost/lx-office-erp/login.pl">http://localhost/lx-office-erp/login.pl</ulink></para>
+ <para>Lx-Office besaß bis inklusive Version 2.6.3 einen
+ Konfigurationsparameter namens <varname>eur</varname>, der sich in der
+ Konfigurationsdatei <filename>config/lx_office.conf</filename>
+ befindet. Somit galt er für alle Mandanten, die in dieser Installation
+ benutzt wurden.</para>
- <para>Die Administrationsseite erreichen Sie unter:</para>
+ <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
+ die Mandantendatenbank verschoben und dabei auch gleich in drei
+ Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
+ steuern lässt.</para>
+ </sect2>
- <para><ulink
- url="http://localhost/lx-office-erp/admin.pl">http://localhost/lx-office-erp/admin.pl</ulink></para>
- </sect1>
- </chapter>
+ <sect2 id="config.eur.parameters"
+ xreflabel="Konfigurationsparameter für EUR">
+ <title>Konfigurationsparameter</title>
- <chapter id="features" xreflabel="Features und Funktionen">
- <title>Features und Funktionen</title>
+ <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
+ Versteuerungsart und die Warenbuchungsmethode regeln:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>profit_determination</varname></term>
- <sect1 id="features.periodic-invoices" xreflabel="Wiedekehrende Rechnungen">
- <title>Wiederkehrende Rechnungen</title>
+ <listitem>
+ <para>Dieser Parameter legt die Berechnungsmethode für die
+ Gewinnermittlung fest. Er enthält entweder
+ <literal>balance</literal> für
+ Betriebsvermögensvergleich/Bilanzierung oder
+ <literal>income</literal> für die
+ Einnahmen-Überschuss-Rechnung.</para>
+ </listitem>
+ </varlistentry>
- <sect2 id="features.periodic-invoices.introduction" xreflabel="Einführung in wiederkehrende Rechnungen">
- <title>Einführung</title>
+ <varlistentry>
+ <term><varname>accounting_method</varname></term>
- <para>
- Wiederkehrende Rechnungen werden als normale Aufträge definiert und konfiguriert, mit allen dazugehörigen Kunden- und
- Artikelangaben. Die konfigurierten Aufträge werden später automatisch in Rechnungen umgewandelt, so als ob man den Workflow benutzen
- würde, und auch die Auftragsnummer wird übernommen, sodass alle wiederkehrenden Rechnungen, die aus einem Auftrag erstellt wurden,
- später leicht wiederzufinden sind.
- </para>
+ <listitem>
+ <para>Dieser Parameter steuert die Buchungs- und
+ Berechnungsmethoden für die Versteuerungsart. Er enthält
+ entweder <literal>accrual</literal> für die Soll-Versteuerung
+ oder <literal>cash</literal> für die Ist-Versteuerung.</para>
+ </listitem>
+ </varlistentry>
- </sect2>
+ <varlistentry>
+ <term><varname>inventory_system</varname></term>
- <sect2 id="features.periodic-invoices.configuration" xreflabel="Konfiguration von wiederkehrenden Rechnungen">
- <title>Konfiguration</title>
+ <listitem>
+ <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
+ enthält entweder <literal>perpetual</literal> für die
+ Bestandsmethode oder <literal>periodic</literal> für die
+ Aufwandsmethode.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <para>
- Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren, findet sich beim Bearbeiten des Auftrags ein neuer Knopf
- "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
- angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist oder nicht.
- </para>
+ <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
+ <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
+ Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
+ bedeutete hingegen Bilanzierung, Soll-Versteuerung und
+ Bestandsmethode.</para>
+
+ <para>Die Konfiguration "<varname>eur</varname>" unter
+ <varname>[system]</varname> in der <link
+ linkend="config.config-file">Konfigurationsdatei</link>
+ <filename>config/lx_office.conf</filename> wird nun nicht mehr
+ benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
+ </sect2>
- <para>
- Folgende Parameter kann man konfigurieren:
- </para>
+ <sect2 id="config.eur.setting-parameters">
+ <title>Festlegen der Parameter</title>
- <variablelist>
- <varlistentry>
- <term>Status</term>
- <listitem>
- <para>
- Bei aktiven Rechnungen wird automatisch eine Rechnung erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines neuen
- Monats).
- </para>
-
- <para>
- Ist ein Auftrag nicht aktiv, so werden für ihn auch keine wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
- nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim nächsten Periodenwechsel für alle Perioden, seit der letzten aktiven
- Periode, jeweils eine Rechnung erstellt. Möchte man dies verhindern, muss man vorher das Startdatum neu setzen.
- </para>
-
- <para>
- Für gekündigte Aufträge werden nie mehr Rechnungen erstellt. Man kann sich diese Aufträge aber gesondert in den Berichten anzeigen
- lassen.
- </para>
- </listitem>
- </varlistentry>
+ <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
+ der Admininstration können diese Optionen nun unabhängig voneinander
+ eingestellt werden.</para>
- <varlistentry>
- <term>Periodizität</term>
- <listitem>
- <para>
- Ob monatlich, quartalsweise oder jährlich auf neue Rechnungen überprüft werden soll. Für jede Periode seit dem Startdatum wird
- überprüft, ob für die Periode (beginnend immer mit dem ersten Tag der Periode) schon eine Rechnung erstellt wurde. Unter Umständen
- können bei einem Startdatum in der Vergangenheit gleich mehrere Rechnungen erstellt werden.
- </para>
- </listitem>
- </varlistentry>
+ <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
+ Variablen werden so gesetzt, daß sich an der Funktionalität nichts
+ ändert.</para>
- <varlistentry>
- <term>Buchen auf</term>
- <listitem>
- <para>
- Das Forderungskonto, in der Regel "Forderungen aus Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen
- der betreffenden Waren.
- </para>
- </listitem>
- </varlistentry>
+ <para>Die aktuelle Konfiguration wird unter Nummernkreise und
+ Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt
+ (read-only). Eine spätere Änderung ist für einen bestehenden Mandanten
+ nicht mehr möglich. Dies war auch vorher nicht möglich, bzw.
+ vorhandene Daten wurden so belassen und haben damit die Ergebnisse
+ verfälscht.</para>
+ </sect2>
- <varlistentry>
- <term>Startdatum</term>
- <listitem>
- <para>
- ab welchem Datum auf Rechnungserstellung geprüft werden soll
- </para>
- </listitem>
- </varlistentry>
+ <sect2 id="config.eur.inventory-system-perpetual">
+ <title>Bemerkungen zu Bestandsmethode</title>
+
+ <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
+ funktioniert in Lx-Office aber nur unter bestimmten Bedingungen:
+ 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
+ der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
+ Einkaufsrechnungen berechnet wird.</para>
+
+ <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
+ wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
+ im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
+ wechseln.</para>
+ </sect2>
- <varlistentry>
- <term>Enddatum</term>
- <listitem>
- <para>
- ab wann keine Rechnungen mehr erstellt werden sollen
- </para>
- </listitem>
- </varlistentry>
+ <sect2 id="config.eur.knonw-issues">
+ <title>Bekannte Probleme</title>
- <varlistentry>
- <term>Automatische Verlängerung um x Monate</term>
- <listitem>
- <para>
- Sollen die wiederkehrenden Rechnungen bei Erreichen des eingetragenen Enddatums weiterhin erstellt werden, so kann man hier die
- Anzahl der Monate eingeben, um die das Enddatum automatisch nach hinten geschoben wird.
- </para>
- </listitem>
- </varlistentry>
+ <para>Bei bestimmten Berichten kann man derzeit noch inviduell
+ einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
+ werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
+ Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
+ die Konfigurationsvariable
+ <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
+ wurde.</para>
- <varlistentry>
- <term>Drucken</term>
- <listitem>
- <para>
- Sind Drucker konfiguriert, so kann man sich die erstellten Rechnungen auch gleich ausdrucken lassen.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>
- Nach Erstellung der Rechnungen kann eine E-Mail mit Informationen zu den erstellten Rechnungen verschickt werden. Konfiguriert wird
- dies in der <link linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
- <filename>config/lx_office.conf</filename> im Abschnitt <varname>[periodic_invoices]</varname>.
- </para>
- </sect2>
-
- <sect2 id="features.periodic-invoices.reports">
- <title>Auflisten</title>
-
- <para>
- Unter Verkauf->Berichte->Aufträge finden sich zwei neue Checkboxen, "Wiederkehrende Rechnungen aktiv" und
- "Wiederkehrende Rechnungen inaktiv", mit denen man sich einen Überglick über die wiederkehrenden Rechnungen verschaffen
- kann.
- </para>
- </sect2>
-
- <sect2 id="features.periodic-invoices.task-server">
- <title>Erzeugung der eigentlichen Rechnungen</title>
-
- <para>
- Die zeitliche und periodische Überprüfung, ob eine wiederkehrende Rechnung automatisch erstellt werden soll, geschieht durch den
- <link linkend="config.task-server">Taskserver</link>, einen externen Dienst, der automatisch beim Start des Servers gestartet
- werden sollte.
- </para>
- </sect2>
-
- <sect2 id="features.periodic-invoices.create-for-current-month">
- <title>Erste Rechnung für aktuellen Monat erstellen</title>
-
- <para>
- Will man im laufenden Monat eine monatlich wiederkehrende Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum auf
- den Monatsanfang und wartet ein paar Minuten, bis der Taskserver den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
- generiert hat. Alternativ setzt man das Startdatum auf den Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
- manuell über den Workflow.
- </para>
- </sect2>
+ <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
+ Optionen bewirken, z.B. mit zwei Standardfällen.</para>
+ </sect2>
</sect1>
- </chapter>
- <chapter>
- <title>Entwicklerdokumentation</title>
+ <sect1 id="config.skr04-update-3804">
+ <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
- <sect1 id="devel.globals" xreflabel="Globale Variablen">
- <title>Globale Variablen</title>
+ <sect2 id="config.skr04-update-3804.introduction">
+ <title>Einführung</title>
- <sect2>
- <title>Wie sehen globale Variablen in Perl aus?</title>
+ <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
+ Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
+ Lx-Office beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
+ 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
+ Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
+ vielleicht schon selbst geholfen hat und mit seinen Änderungen
+ zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
+ ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
+ Screenshots dargestellt.</para>
+
+ <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
+ USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
+ dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
+ und diese Buchungen sollten entsprechend kontrolliert werden.</para>
+ </sect2>
- <para>Globale Variablen liegen in einem speziellen namespace namens
- "main", der von überall erreichbar ist. Darüber hinaus sind bareword
- globs global und die meisten speziellen Variablen sind...
- speziell.</para>
+ <sect2 id="config.skr04-update-3804.create-chart">
+ <title>Konto 3804 manuell anlegen</title>
- <para>Daraus ergeben sich folgende Formen:</para>
+ <para>Die folgenden Schritte sind notwendig, um das Konto manuell
+ anzulegen und zu konfigurieren. Zuerst wird in
+ <guimenu>System</guimenu> ->
+ <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
+ erfassen</guimenuitem> das Konto angelegt.</para>
+
+ <screenshot>
+ <screeninfo>Konto 3804 erfassen</screeninfo>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/konto3804.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
+ <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
+ wie im folgenden Screenshot angezeigt anpassen.
+ </para>
+
+ <screenshot>
+ <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
+ <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
+ </para>
+
+ <screenshot>
+ <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
+ Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
+ müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
+ anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
+ </para>
+
+ <screenshot>
+ <screeninfo>Konto 4315 anpassen</screeninfo>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/konto4315.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
+ <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
+ </para>
+
+ <screenshot>
+ <screeninfo>Steuerliste vergleichen</screeninfo>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </sect2>
+ </sect1>
+
+ <sect1 id="Lx-Office-ERP-verwenden">
+ <title>Lx-Office ERP verwenden</title>
+
+ <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
+ folgender URL erreichbar:</para>
+
+ <para><ulink
+ url="http://localhost/lx-office-erp/login.pl">http://localhost/lx-office-erp/login.pl</ulink></para>
+
+ <para>Die Administrationsseite erreichen Sie unter:</para>
+
+ <para><ulink
+ url="http://localhost/lx-office-erp/admin.pl">http://localhost/lx-office-erp/admin.pl</ulink></para>
+ </sect1>
+ </chapter>
+
+ <chapter id="features" xreflabel="Features und Funktionen">
+ <title>Features und Funktionen</title>
+
+ <sect1 id="features.periodic-invoices"
+ xreflabel="Wiedekehrende Rechnungen">
+ <title>Wiederkehrende Rechnungen</title>
+
+ <sect2 id="features.periodic-invoices.introduction"
+ xreflabel="Einführung in wiederkehrende Rechnungen">
+ <title>Einführung</title>
+
+ <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
+ und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
+ Die konfigurierten Aufträge werden später automatisch in Rechnungen
+ umgewandelt, so als ob man den Workflow benutzen würde, und auch die
+ Auftragsnummer wird übernommen, sodass alle wiederkehrenden
+ Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
+ wiederzufinden sind.</para>
+ </sect2>
+
+ <sect2 id="features.periodic-invoices.configuration"
+ xreflabel="Konfiguration von wiederkehrenden Rechnungen">
+ <title>Konfiguration</title>
+
+ <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
+ findet sich beim Bearbeiten des Auftrags ein neuer Knopf
+ "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
+ Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
+ angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
+ oder nicht.</para>
+
+ <para>Folgende Parameter kann man konfigurieren:</para>
<variablelist>
<varlistentry>
- <term>$main::form</term>
+ <term>Status</term>
<listitem>
- <para>expliziter Namespace "main"</para>
+ <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
+ erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
+ neuen Monats).</para>
+
+ <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
+ wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
+ nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
+ nächsten Periodenwechsel für alle Perioden, seit der letzten
+ aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
+ verhindern, muss man vorher das Startdatum neu setzen.</para>
+
+ <para>Für gekündigte Aufträge werden nie mehr Rechnungen
+ erstellt. Man kann sich diese Aufträge aber gesondert in den
+ Berichten anzeigen lassen.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>$::form</term>
+ <term>Periodizität</term>
<listitem>
- <para>impliziter Namespace "main"</para>
+ <para>Ob monatlich, quartalsweise oder jährlich auf neue
+ Rechnungen überprüft werden soll. Für jede Periode seit dem
+ Startdatum wird überprüft, ob für die Periode (beginnend immer
+ mit dem ersten Tag der Periode) schon eine Rechnung erstellt
+ wurde. Unter Umständen können bei einem Startdatum in der
+ Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>open FILE, "file.txt"</term>
+ <term>Buchen auf</term>
<listitem>
- <para><varname>FILE</varname> ist global</para>
+ <para>Das Forderungskonto, in der Regel "Forderungen aus
+ Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
+ Buchungsgruppen der betreffenden Waren.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>$_</term>
+ <term>Startdatum</term>
<listitem>
- <para>speziell</para>
+ <para>ab welchem Datum auf Rechnungserstellung geprüft werden
+ soll</para>
</listitem>
</varlistentry>
- </variablelist>
-
- <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
- Schlüsselwort wie "<function>global</function>", mit dem man
- importieren kann. <function>my</function>, <function>our</function>
- und <function>local</function> machen was anderes.</para>
- <variablelist>
<varlistentry>
- <term>my $form</term>
+ <term>Enddatum</term>
<listitem>
- <para>lexikalische Variable, gültig bis zum Ende des
- Scopes</para>
+ <para>ab wann keine Rechnungen mehr erstellt werden
+ sollen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>our $form</term>
+ <term>Automatische Verlängerung um x Monate</term>
<listitem>
- <para><varname>$form</varname> referenziert ab hier
- <varname>$PACKAGE::form</varname>.</para>
+ <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
+ eingetragenen Enddatums weiterhin erstellt werden, so kann man
+ hier die Anzahl der Monate eingeben, um die das Enddatum
+ automatisch nach hinten geschoben wird.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>local $form</term>
+ <term>Drucken</term>
<listitem>
- <para>Alle Änderungen an <varname>$form</varname> werden am Ende
- des scopes zurückgesetzt</para>
+ <para>Sind Drucker konfiguriert, so kann man sich die erstellten
+ Rechnungen auch gleich ausdrucken lassen.</para>
</listitem>
</varlistentry>
</variablelist>
+
+ <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
+ Informationen zu den erstellten Rechnungen verschickt werden.
+ Konfiguriert wird dies in der <link
+ linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
+ <filename>config/lx_office.conf</filename> im Abschnitt
+ <varname>[periodic_invoices]</varname>.</para>
</sect2>
- <sect2>
- <title>Warum sind globale Variablen ein Problem?</title>
+ <sect2 id="features.periodic-invoices.reports">
+ <title>Auflisten</title>
- <para>Das erste Problem ist <productname>FCGI</productname>.</para>
+ <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
+ Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
+ Rechnungen inaktiv", mit denen man sich einen Überglick über die
+ wiederkehrenden Rechnungen verschaffen kann.</para>
+ </sect2>
- <para><productname>SQL-Ledger</productname> hat fast alles im globalen
- namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
- Unter <productname>FCGI</productname> müssen diese Sachen auch wieder
- aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
- Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
- Datenbankverbindungen, weil die ne Ewigkeit zum initialisieren
- brauchen.</para>
+ <sect2 id="features.periodic-invoices.task-server">
+ <title>Erzeugung der eigentlichen Rechnungen</title>
- <para>Das zweite Problem ist <function>strict</function>. Unter
- <function>strict</function> werden alle Variablen die nicht explizit
- mit <function>Package</function>, <function>my</function> oder
- <function>our</function> angegeben werden als Tippfehler angemarkert,
- was einen vor so mancher Stunde suchen nach einem Bug erspart. Da
- globale Variablen aber implizit mit Package angegeben werden, werden
- die nicht geprüft, und ein Tippfehler da fällt niemandem auf.</para>
+ <para>Die zeitliche und periodische Überprüfung, ob eine
+ wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
+ durch den <link linkend="config.task-server">Taskserver</link>, einen
+ externen Dienst, der automatisch beim Start des Servers gestartet
+ werden sollte.</para>
</sect2>
- <sect2>
- <title>Kanonische globale Variablen</title>
+ <sect2 id="features.periodic-invoices.create-for-current-month">
+ <title>Erste Rechnung für aktuellen Monat erstellen</title>
- <para>Um dieses Problem im Griff zu halten gibt es einige wenige
- globale Variablen, die kanonisch sind, und alles andere sollte
- anderweitig umhergereicht werden.</para>
+ <para>Will man im laufenden Monat eine monatlich wiederkehrende
+ Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
+ auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
+ den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
+ generiert hat. Alternativ setzt man das Startdatum auf den
+ Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
+ manuell über den Workflow.</para>
+ </sect2>
+ </sect1>
- <para>Diese Variablen sind im Moment die folgenden neun:</para>
+ <sect1 id="dokumentenvorlagen-und-variablen">
+ <title>Dokumentenvorlagen und verfügbare Variablen</title>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.einführung">
+ <title>Einführung</title>
+
+ <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
+ aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
+ einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
+ <function><%variablenname%></function> verwendet wird. Für
+ LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
+ (siehe <xref
+ linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
+
+ <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
+ unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern es nicht
+ ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
+ alle Vorlagenarten.</para>
+
+ <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
+ verfügbar als hier aufgelistet werden. Die meisten davon können
+ allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
+ werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
+ diese wie folgt erhalten werden:</para>
<itemizedlist>
<listitem>
- <para><varname>$::form</varname></para>
+ <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
+ Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
</listitem>
<listitem>
- <para><varname>%::myconfig</varname></para>
+ <para>In <filename>Form.pm</filename> die Funktion
+ <function>parse_template</function> suchen und hier die Zeile
+ <command>print(STDERR Dumper($self));</command> einfügen.</para>
</listitem>
<listitem>
- <para><varname>$::locale</varname></para>
+ <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
+ ein PDF für eine Rechnung erzeugen.</para>
</listitem>
<listitem>
- <para><varname>$::lxdebug</varname></para>
+ <para>Im <filename>error.log</filename> Apache steht die Ausgabe
+ der Variablen <varname>$self</varname> in der Form <varname>'key'
+ => 'value',</varname>. Alle <varname>key</varname>s sind
+ verfügbar.</para>
</listitem>
+ </itemizedlist>
+ </sect2>
- <listitem>
- <para><varname>$::auth</varname></para>
- </listitem>
+ <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
+ <title>Variablen ausgeben</title>
- <listitem>
- <para><varname>$::lx_office_conf</varname></para>
- </listitem>
+ <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
+ Tags geschrieben werden, also z.B.
+ <varname><%variablenname%></varname>.</para>
- <listitem>
- <para><varname>$::instance_conf</varname></para>
- </listitem>
+ <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
+ die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
+ <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
+ werden die folgenden Flags unterstützt:</para>
+ <itemizedlist>
<listitem>
- <para><varname>$::dispatcher</varname></para>
+ <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
+ den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
+ mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
+ damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
</listitem>
<listitem>
- <para><varname>$::request</varname></para>
+ <para><option>NOESCAPE</option> unterdrückt das Escapen von
+ Sonderzeichen für die Vorlagensprache. Wenn also in einer
+ Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
+ auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
+ ist dieses Flag sinnvoll.</para>
</listitem>
</itemizedlist>
- <para>Damit diese nicht als Müllhalde misbrauch werden, im Folgenden
- eine kurze Erläuterung was man von denn erwarten kann.</para>
+ <para>Beispiel:</para>
- <sect3>
- <title>$::form</title>
+ <programlisting><%quototal NOFORMAT%></programlisting>
+ </sect2>
- <itemizedlist>
- <listitem>
- <para>Ist ein Objekt der Klasse
- "<classname>Form</classname>"</para>
- </listitem>
+ <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
+ <title>Verwendung in Druckbefehlen</title>
- <listitem>
- <para>Wird nach jedem Request gelöscht</para>
- </listitem>
+ <para>In der Admininstration können Drucker definiert werden. Auch im
+ dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
+ und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
+ den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
+ <function>`...`</function> nicht zu unerwünschtem Verhalten
+ führen.</para>
- <listitem>
- <para>Muss auch in Tests und Konsolenscripts vorhanden
- sein.</para>
- </listitem>
+ <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
+ für das die Telefonnummer eines Ansprechpartners als Teil der
+ Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
+ z.B. wie folgt aussehen:</para>
- <listitem>
- <para>Enthält am Anfang eines Requests die Requestparameter vom
- User</para>
- </listitem>
+ <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
+ </sect2>
- <listitem>
- <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
- cachen, das wird aber momentan absichtlich zerstört</para>
- </listitem>
- </itemizedlist>
+ <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
+ xreflabel="Anfang und Ende der Tags verändern">
+ <title>Anfang und Ende der Tags verändern</title>
- <para><varname>$::form</varname> wurde unter <productname>SQL
- Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
- alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
- heißt, alles was einem lieb ist, sollte man vor einem Aufruf von zum
- Beispiel <function>IS->retrieve_customer()</function> in
- Sicherheit bringen.</para>
+ <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
+ Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
+ Prozentzeichen und dem Größerzeichen endet, beispielsweise
+ <function><%customer%></function>. Da diese Form aber z.B. in
+ LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
+ Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
+ Stil umgestellt werden.</para>
- <para>Das Objekt der Klasse Form hat leider im Moment noch viele
- zentrale Funktionen Gdie vom internen Zustand abhängen, deshalb
- bitte nie einfach zerstören oder überschreiben. Es geht ziemlich
- sicher etwas kaputt.</para>
+ <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
+ Format gültigen Kommentarzeichen anfangen, dann
+ <function>config:</function> enthalten, die entsprechende Option
+ setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
+ enden. Beispiel für LaTeX:</para>
- <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
- in den <productname>Template::Toolkit</productname> Templates
- außerhalb der Controller: der Ausdruck <function>[% var
- %]</function> greift auf <varname>$::form->{var}</varname> zu.
- Unter Controllern ist der Standard Scope anders, da lautet der
- Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
- normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
- <function><%var%></function> zeigt auf
- <varname>$::form->{var}</varname>. Innerhalb von Schleifen wird
- <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
- bevorzugt, wenn vorhanden.</para>
- </sect3>
+ <programlisting>% config: tag-style=($ $)</programlisting>
- <sect3>
- <title>%::myconfig</title>
+ <para>Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen,
+ wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
+ äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
- <itemizedlist>
- <listitem>
- <para>Das einzige Hash unter den globalen Variablen</para>
- </listitem>
+ <programlisting><!-- config: tag-style=($ $) --></programlisting>
+ </sect2>
- <listitem>
- <para>Wird spätestens benötigt wenn auf die Datenbank
- zugegriffen wird</para>
- </listitem>
+ <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
+ <title>Zuordnung von den Dateinamen zu den Funktionen</title>
- <listitem>
- <para>Wird bei jedem Request neu erstellt.</para>
- </listitem>
+ <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
+ welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
+ "<filename>.ext</filename>" geeignet zu ersetzen:
+ "<filename>.tex</filename>" für LaTeX-Vorlagen und
+ "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
- <listitem>
- <para>Enthält die Userdaten des aktuellen Logins</para>
- </listitem>
+ <variablelist>
+ <varlistentry>
+ <term><filename>bin_list.ext</filename></term>
<listitem>
- <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
- extern serialisiert werden, weil da auch der Datenbankzugriff
- für diesenuser drinsteht.</para>
+ <para>Lagerliste</para>
</listitem>
+ </varlistentry>
- <listitem>
- <para>Enthält unter anderem Listenbegrenzung vclimit,
- Datumsformat dateformat und Nummernformat numberformat</para>
- </listitem>
+ <varlistentry>
+ <term><filename>check.ext</filename></term>
<listitem>
- <para>Enthält Datenbankzugriffinformationen</para>
+ <para>?</para>
</listitem>
- </itemizedlist>
-
- <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
- ein Userobjekt. Die meisten Funktionen, die etwas anhand des
- aktuellen Users entscheiden müssen, befragen
- <varname>%::myconfig</varname>.</para>
- </sect3>
+ </varlistentry>
- <sect3>
- <title>$::locale</title>
+ <varlistentry>
+ <term><filename>invoice.ext</filename></term>
- <itemizedlist>
<listitem>
- <para>Objekt der Klasse "Locale"</para>
+ <para>Rechnung</para>
</listitem>
+ </varlistentry>
- <listitem>
- <para>Wird pro Request erstellt</para>
- </listitem>
+ <varlistentry>
+ <term><filename>packing_list.ext</filename></term>
<listitem>
- <para>Muss auch für Tests und Scripte immer verfügbar
- sein.</para>
+ <para>Packliste</para>
</listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>pick_list.ext</filename></term>
<listitem>
- <para>Cached intern über Requestgrenzen hinweg benutzte
- Locales</para>
+ <para>Sammelliste</para>
</listitem>
- </itemizedlist>
-
- <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
- Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
- </sect3>
+ </varlistentry>
- <sect3>
- <title>$::lxdebug</title>
+ <varlistentry>
+ <term><filename>purchase_delivery_order.ext</filename></term>
- <itemizedlist>
<listitem>
- <para>Objekt der Klasse "LXDebug"</para>
+ <para>Lieferschein (Einkauf)</para>
</listitem>
+ </varlistentry>
- <listitem>
- <para>Wird global gecached</para>
- </listitem>
+ <varlistentry>
+ <term><filename>purcharse_order.ext</filename></term>
<listitem>
- <para>Muss immer verfügbar sein, in nahezu allen
- Funktionen</para>
+ <para>Bestellung an Lieferanten</para>
</listitem>
- </itemizedlist>
-
- <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
- bereit, wie "<function>enter_sub</function>" und
- "<function>leave_sub</function>", mit denen in den alten Modulen ein
- 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
- denen man flott Informationen ins Log packen kann.</para>
- </sect3>
+ </varlistentry>
- <sect3>
- <title>$::auth</title>
+ <varlistentry>
+ <term><filename>request_quotation.ext</filename></term>
- <itemizedlist>
<listitem>
- <para>Objekt der Klasse "SL::Auth"</para>
+ <para>Anfrage an Lieferanten</para>
</listitem>
+ </varlistentry>
- <listitem>
- <para>Wird global gecached</para>
- </listitem>
+ <varlistentry>
+ <term><filename>sales_delivery_order.ext</filename></term>
<listitem>
- <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
+ <para>Lieferschein (Verkauf)</para>
</listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>sales_order.ext</filename></term>
<listitem>
- <para>Wird nach jedem Request resettet.</para>
+ <para>Bestellung</para>
</listitem>
- </itemizedlist>
-
- <para><varname>$::auth</varname> stellt Funktionen bereit um die
- Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
- vom aktuellen User abhängen wird das Objekt aus
- Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
- Request kurz resettet.</para>
- </sect3>
+ </varlistentry>
- <sect3>
- <title>$::lx_office_conf</title>
+ <varlistentry>
+ <term><filename>sales_quotation.ext</filename></term>
- <itemizedlist>
<listitem>
- <para>Objekt der Klasse
- "<classname>SL::LxOfficeConf</classname>"</para>
+ <para>Angebot an Kunden</para>
</listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>zahlungserinnerung.ext</filename></term>
<listitem>
- <para>Global gecached</para>
+ <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
</listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>zahlungserinnerung_invoice.ext</filename></term>
<listitem>
- <para>Repräsentation der
- <filename>config/lx_office.conf[.default]</filename>-Dateien</para>
+ <para>Rechnung über Mahngebühren (Dateiname im Programm
+ konfigurierbar)</para>
</listitem>
- </itemizedlist>
+ </varlistentry>
+ </variablelist>
+ </sect2>
- <para>Globale Konfiguration. Configdateien werden zum Start gelesen,
- und nicht mehr angefasst. Es ist derzeit nicht geplant, dass das
- Programm die Konfiguration ändern kann oder sollte.</para>
+ <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
+ <title>Sprache, Drucker und E-Mail</title>
- <para>Für die folgende Konfigurationsdatei:</para>
+ <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
+ eingearbeitet. So wird aus der Vorlage
+ <filename>sales_order.ext</filename> bei Sprache
+ <function>de</function> und Druckerkürzel <function>lpr2</function>
+ der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
+ Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
+ bekommen dann noch das Kürzel <filename>_email</filename>, der
+ vollständige Vorlagenname wäre dann
+ <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
+ kann eine Standarddatei <filename>default.ext</filename> hinterlegt
+ werden. Diese wird verwendet, wenn keine der anderen Varianten
+ gefunden wird.</para>
- <programlisting>[debug]
- file = /tmp/lxoffice_debug_log.txt</programlisting>
+ <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
+ der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
+ verschickt wird, ist:</para>
- <para>ist der Key <varname>file</varname> im Programm als
- <varname>$::lx_office_conf->{debug}{file}</varname>
- erreichbar.</para>
+ <orderedlist>
+ <listitem>
+ <para><filename>sales_order_email_de_lpr2.tex</filename></para>
+ </listitem>
- <warning>
- <para>Zugriff auf die Konfiguration erfolgt im Moment über
- Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
- </warning>
- </sect3>
+ <listitem>
+ <para><filename>sales_order_de_lpr2.tex</filename></para>
+ </listitem>
- <sect3>
- <title>$::instance_conf</title>
+ <listitem>
+ <para><filename>sales_order.tex</filename></para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Objekt der Klasse
- "<classname>SL::InstanceConfiguration</classname>"</para>
- </listitem>
+ <listitem>
+ <para><filename>default.tex</filename></para>
+ </listitem>
+ </orderedlist>
- <listitem>
- <para>wird pro Request neu erstellt</para>
- </listitem>
- </itemizedlist>
+ <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
+ Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
+ siehe dazu <xref
+ linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
+ </sect2>
- <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
- speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
- ist hier eine Mandantendatenbank. Prominentestes Datum ist "eur",
- die Information ob Bilanz oder Einnahmenüberschussrechnung gemacht
- wird.</para>
- </sect3>
+ <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
+ <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
+ sind</title>
- <sect3>
- <title>$::dispatcher</title>
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
+ xreflabel="Metainformationen zur angeforderten Vorlage">
+ <title>Metainformationen zur angeforderten Vorlage</title>
- <itemizedlist>
- <listitem>
- <para>Objekt der Klasse
- "<varname>SL::Dispatcher</varname>"</para>
- </listitem>
+ <para>Diese Variablen liefern Informationen darüber welche Variante
+ einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
+ Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
+ Formulare einbinden möchten.</para>
- <listitem>
- <para>wird pro Serverprozess erstellt.</para>
- </listitem>
+ <variablelist>
+ <varlistentry>
+ <term><varname>template_meta.formname</varname></term>
- <listitem>
- <para>enthält Informationen über die technische Verbindung zum
- Server</para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>Basisname der Vorlage. Identisch mit der <link
+ linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
+ zu den Dateinamen</link> ohne die Erweiterung. Ein
+ Verkaufsauftrag enthält hier
+ <constant>sales_order</constant>.</para>
+ </listitem>
+ </varlistentry>
- <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
- global gespeichert wird. Wird vermutlich irgendwann in einem anderen
- Objekt untergebracht.</para>
- </sect3>
+ <varlistentry>
+ <term><varname>template_meta.language.description</varname></term>
- <sect3>
- <title>$::request</title>
+ <listitem>
+ <para>Beschreibung der verwendeten Sprache</para>
+ </listitem>
+ </varlistentry>
- <itemizedlist>
- <listitem>
- <para>Hashref (evtl später Objekt)</para>
- </listitem>
-
- <listitem>
- <para>Wird pro Request neu initialisiert.</para>
- </listitem>
-
- <listitem>
- <para>Keine Unterstruktur garantiert.</para>
- </listitem>
- </itemizedlist>
-
- <para><varname>$::request</varname> ist ein generischer Platz um
- Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
- at a distance benutzt werden, sondern um lokales memoizing zu
- ermöglichen, das garantiert am Ende des Requests zerstört
- wird.</para>
-
- <para>Vieles von dem, was im moment in <varname>$::form</varname>
- liegt, sollte eigentlich hier liegen. Die groben
- Differentialkriterien sind:</para>
-
- <itemizedlist>
- <listitem>
- <para>Kommt es vom User, und soll unverändert wieder an den
- User? Dann $::form, steht da eh schon</para>
- </listitem>
-
- <listitem>
- <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
- Requests gebraucht werden? Dann $::request</para>
- </listitem>
-
- <listitem>
- <para>Muss ich von anderen Teilen des Programms lesend drauf
- zugreifen? Dann $::request, aber Zugriff über
- Wrappermethode</para>
- </listitem>
- </itemizedlist>
- </sect3>
- </sect2>
-
- <sect2>
- <title>Ehemalige globale Variablen</title>
-
- <para>Die folgenden Variablen waren einmal im Programm, und wurden
- entfernt.</para>
-
- <sect3>
- <title>$::cgi</title>
-
- <itemizedlist>
- <listitem>
- <para>war nötig, weil cookie Methoden nicht als
- Klassenfunktionen funktionieren</para>
- </listitem>
-
- <listitem>
- <para>Aufruf als Klasse erzeugt Dummyobjekt was im
- Klassennamespace gehalten wird und über Requestgrenzen
- leaked</para>
- </listitem>
-
- <listitem>
- <para>liegt jetzt unter
- <varname>$::request->{cgi}</varname></para>
- </listitem>
- </itemizedlist>
- </sect3>
-
- <sect3>
- <title>$::all_units</title>
-
- <itemizedlist>
- <listitem>
- <para>war nötig, weil einige Funktionen in Schleifen zum Teil
- ein paar hundert mal pro Request eine Liste der Einheiten
- brauchen, und de als Parameter durch einen Riesenstack von
- Funktionen geschleift werden müssten.</para>
- </listitem>
-
- <listitem>
- <para>Liegt jetzt unter
- <varname>$::request->{cache}{all_units}</varname></para>
- </listitem>
-
- <listitem>
- <para>Wird nur in
- <function>AM->retrieve_all_units()</function> gesetzt oder
- gelesen.</para>
- </listitem>
- </itemizedlist>
- </sect3>
-
- <sect3>
- <title>%::called_subs</title>
-
- <itemizedlist>
- <listitem>
- <para>wurde benutzt um callsub deep recursions
- abzufangen.</para>
- </listitem>
-
- <listitem>
- <para>Wurde entfernt, weil callsub nur einen Bruchteil der
- möglichen Rekursioenen darstellt, und da nie welche
- auftreten.</para>
- </listitem>
-
- <listitem>
- <para>komplette recursion protection wurde entfernt.</para>
- </listitem>
- </itemizedlist>
- </sect3>
- </sect2>
- </sect1>
-
- <sect1 id="dokumentenvorlagen-und-variablen">
- <title>Dokumentenvorlagen und verfügbare Variablen</title>
-
- <sect2 id="dokumentenvorlagen-und-variablen.einführung">
- <title>Einführung</title>
-
- <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
- aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
- einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
- <function><%variablenname%></function> verwendet wird. Für
- LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
- (siehe <xref
- linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
-
- <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
- unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern es nicht
- ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
- alle Vorlagenarten.</para>
-
- <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
- verfügbar als hier aufgelistet werden. Die meisten davon können
- allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
- werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
- diese wie folgt erhalten werden:</para>
-
- <itemizedlist>
- <listitem>
- <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
- Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
- </listitem>
-
- <listitem>
- <para>In <filename>Form.pm</filename> die Funktion
- <function>parse_template</function> suchen und hier die Zeile
- <command>print(STDERR Dumper($self));</command> einfügen.</para>
- </listitem>
-
- <listitem>
- <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
- ein PDF für eine Rechnung erzeugen.</para>
- </listitem>
-
- <listitem>
- <para>Im <filename>error.log</filename> Apache steht die Ausgabe
- der Variablen <varname>$self</varname> in der Form <varname>'key'
- => 'value',</varname>. Alle <varname>key</varname>s sind
- verfügbar.</para>
- </listitem>
- </itemizedlist>
- </sect2>
-
- <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
- <title>Variablen ausgeben</title>
-
- <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
- Tags geschrieben werden, also z.B.
- <varname><%variablenname%></varname>.</para>
-
- <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
- die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
- <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
- werden die folgenden Flags unterstützt:</para>
-
- <itemizedlist>
- <listitem>
- <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
- den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
- mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
- damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
- </listitem>
-
- <listitem>
- <para><parameter>NOESCAPE</parameter> unterdrückt das Escapen von
- Sonderzeichen für die Vorlagensprache. Wenn also in einer
- Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
- auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
- ist dieses Flag sinnvoll.</para>
- </listitem>
- </itemizedlist>
-
- <para>Beispiel:</para>
-
- <programlisting><%quototal NOFORMAT%></programlisting>
- </sect2>
-
- <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
- <title>Verwendung in Druckbefehlen</title>
-
- <para>In der Admininstration können Drucker definiert werden. Auch im
- dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
- und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
- den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
- <function>`...`</function> nicht zu unerwünschtem Verhalten
- führen.</para>
-
- <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
- für das die Telefonnummer eines Ansprechpartners als Teil der
- Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
- z.B. wie folgt aussehen:</para>
-
- <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
- </sect2>
-
- <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
- xreflabel="Anfang und Ende der Tags verändern">
- <title>Anfang und Ende der Tags verändern</title>
-
- <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
- Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
- Prozentzeichen und dem Größerzeichen endet, beispielsweise
- <function><%customer%></function>. Da diese Form aber z.B. in
- LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
- Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
- Stil umgestellt werden.</para>
-
- <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
- Format gültigen Kommentarzeichen anfangen, dann
- <function>config:</function> enthalten, die entsprechende Option
- setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
- enden. Beispiel für LaTeX:</para>
-
- <programlisting>% config: tag-style=($ $)</programlisting>
-
- <para>Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen,
- wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
- äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
-
- <programlisting><!-- config: tag-style=($ $) --></programlisting>
- </sect2>
-
- <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
- <title>Zuordnung von den Dateinamen zu den Funktionen</title>
-
- <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
- welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
- "<filename>.ext</filename>" geeignet zu ersetzen:
- "<filename>.tex</filename>" für LaTeX-Vorlagen und
- "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
-
- <variablelist>
- <varlistentry>
- <term><filename>bin_list.ext</filename></term>
-
- <listitem>
- <para>Lagerliste</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>check.ext</filename></term>
-
- <listitem>
- <para>?</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>invoice.ext</filename></term>
-
- <listitem>
- <para>Rechnung</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>packing_list.ext</filename></term>
-
- <listitem>
- <para>Packliste</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>pick_list.ext</filename></term>
-
- <listitem>
- <para>Sammelliste</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>purchase_delivery_order.ext</filename></term>
-
- <listitem>
- <para>Lieferschein (Einkauf)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>purcharse_order.ext</filename></term>
-
- <listitem>
- <para>Bestellung an Lieferanten</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>request_quotation.ext</filename></term>
-
- <listitem>
- <para>Anfrage an Lieferanten</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>sales_delivery_order.ext</filename></term>
-
- <listitem>
- <para>Lieferschein (Verkauf)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>sales_order.ext</filename></term>
-
- <listitem>
- <para>Bestellung</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>sales_quotation.ext</filename></term>
-
- <listitem>
- <para>Angebot an Kunden</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>zahlungserinnerung.ext</filename></term>
-
- <listitem>
- <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>zahlungserinnerung_invoice.ext</filename></term>
-
- <listitem>
- <para>Rechnung über Mahngebühren (Dateiname im Programm
- konfigurierbar)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
- <title>Sprache, Drucker und E-Mail</title>
-
- <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
- eingearbeitet. So wird aus der Vorlage
- <filename>sales_order.ext</filename> bei Sprache
- <function>de</function> und Druckerkürzel <function>lpr2</function>
- der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
- Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
- bekommen dann noch das Kürzel <filename>_email</filename>, der
- vollständige Vorlagenname wäre dann
- <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
- kann eine Standarddatei <filename>default.ext</filename> hinterlegt
- werden. Diese wird verwendet, wenn keine der anderen Varianten
- gefunden wird.</para>
-
- <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
- der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
- verschickt wird, ist:</para>
-
- <orderedlist>
- <listitem>
- <para><filename>sales_order_email_de_lpr2.tex</filename></para>
- </listitem>
-
- <listitem>
- <para><filename>sales_order_de_lpr2.tex</filename></para>
- </listitem>
-
- <listitem>
- <para><filename>sales_order.tex</filename></para>
- </listitem>
-
- <listitem>
- <para><filename>default.tex</filename></para>
- </listitem>
- </orderedlist>
-
- <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
- Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
- siehe dazu <xref
- linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
- </sect2>
-
- <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
- <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
- sind</title>
-
- <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
- xreflabel="Metainformationen zur angeforderten Vorlage">
- <title>Metainformationen zur angeforderten Vorlage</title>
-
- <para>Diese Variablen liefern Informationen darüber welche Variante
- einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
- Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
- Formulare einbinden möchten.</para>
-
- <variablelist>
- <varlistentry>
- <term>template_meta.formname</term>
-
- <listitem>
- <para>Basisname der Vorlage. Identisch mit der <link
- linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
- zu den Dateinamen</link> ohne die Erweiterung. Ein
- Verkaufsauftrag enthält hier
- <constant>sales_order</constant>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>template_meta.language.description</term>
-
- <listitem>
- <para>Beschreibung der verwendeten Sprache</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>template_meta.language.template_code</term>
+ <varlistentry>
+ <term><varname>template_meta.language.template_code</varname></term>
<listitem>
<para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
</varlistentry>
<varlistentry>
- <term>template_meta.language.output_numberformat</term>
+ <term><varname>template_meta.language.output_numberformat</varname></term>
<listitem>
<para>Zahlenformat der verwendeten Sprache in der Form
</varlistentry>
<varlistentry>
- <term>template_meta.language.output_dateformat</term>
+ <term><varname>template_meta.language.output_dateformat</varname></term>
<listitem>
<para>Datumsformat der verwendeten Sprache in der Form
</varlistentry>
<varlistentry>
- <term>template_meta.format</term>
+ <term><varname>template_meta.format</varname></term>
<listitem>
<para>Das angeforderte Format. Kann im Moment die Werte
</varlistentry>
<varlistentry>
- <term>template_meta.extension</term>
+ <term><varname>template_meta.extension</varname></term>
<listitem>
<para>Dateierweiterung, wie im Dateinamen. Wird aus
</varlistentry>
<varlistentry>
- <term>template_meta.media</term>
+ <term><varname>template_meta.media</varname></term>
<listitem>
<para>Ausgabemedium. Kann zur Zeit die Werte
</varlistentry>
<varlistentry>
- <term>template_meta.printer.description</term>
+ <term><varname>template_meta.printer.description</varname></term>
<listitem>
<para>Beschreibung des ausgewählten Druckers</para>
</varlistentry>
<varlistentry>
- <term>template_meta.printer.template_code</term>
+ <term><varname>template_meta.printer.template_code</varname></term>
<listitem>
<para>Vorlagenürzel des ausgewählten Druckers, identisch mit
<variablelist>
<varlistentry>
- <term>account_number</term>
+ <term><varname>account_number</varname></term>
<listitem>
<para>Kontonummer</para>
</varlistentry>
<varlistentry>
- <term>bank</term>
+ <term><varname>bank</varname></term>
<listitem>
<para>Name der Bank</para>
</varlistentry>
<varlistentry>
- <term>bank_code</term>
+ <term><varname>bank_code</varname></term>
<listitem>
<para>Bankleitzahl</para>
</varlistentry>
<varlistentry>
- <term>bic</term>
+ <term><varname>bic</varname></term>
<listitem>
<para>Bank-Identifikations-Code (Bank Identifier Code,
</varlistentry>
<varlistentry>
- <term>business</term>
+ <term><varname>business</varname></term>
<listitem>
<para>Kunden-/Lieferantentyp</para>
</varlistentry>
<varlistentry>
- <term>city</term>
+ <term><varname>city</varname></term>
<listitem>
<para>Stadt</para>
</varlistentry>
<varlistentry>
- <term>contact</term>
+ <term><varname>contact</varname></term>
<listitem>
<para>Kontakt</para>
</varlistentry>
<varlistentry>
- <term>country</term>
+ <term><varname>country</varname></term>
<listitem>
<para>Land</para>
</varlistentry>
<varlistentry>
- <term>cp_email</term>
+ <term><varname>cp_email</varname></term>
<listitem>
<para>Email des Ansprechpartners</para>
</varlistentry>
<varlistentry>
- <term>cp_givenname</term>
+ <term><varname>cp_givenname</varname></term>
<listitem>
<para>Vorname des Ansprechpartners</para>
</varlistentry>
<varlistentry>
- <term>cp_greeting</term>
+ <term><varname>cp_greeting</varname></term>
<listitem>
<para>Anrede des Ansprechpartners</para>
</varlistentry>
<varlistentry>
- <term>cp_name</term>
+ <term><varname>cp_name</varname></term>
<listitem>
<para>Name des Ansprechpartners</para>
</varlistentry>
<varlistentry>
- <term>cp_phone1</term>
+ <term><varname>cp_phone1</varname></term>
<listitem>
<para>Telefonnummer 1 des Ansprechpartners</para>
</varlistentry>
<varlistentry>
- <term>cp_phone2</term>
+ <term><varname>cp_phone2</varname></term>
<listitem>
<para>Telefonnummer 2 des Ansprechpartners</para>
</varlistentry>
<varlistentry>
- <term>cp_title</term>
+ <term><varname>cp_title</varname></term>
<listitem>
<para>Titel des Ansprechpartners</para>
</varlistentry>
<varlistentry>
- <term>creditlimit</term>
+ <term><varname>creditlimit</varname></term>
<listitem>
<para>Kreditlimit</para>
</varlistentry>
<varlistentry>
- <term>customeremail</term>
+ <term><varname>customeremail</varname></term>
<listitem>
<para>Email des Kunden; nur für Kunden</para>
</varlistentry>
<varlistentry>
- <term>customerfax</term>
+ <term><varname>customerfax</varname></term>
<listitem>
<para>Faxnummer des Kunden; nur für Kunden</para>
</varlistentry>
<varlistentry>
- <term>customernotes</term>
+ <term><varname>customernotes</varname></term>
<listitem>
<para>Bemerkungen beim Kunden; nur für Kunden</para>
</varlistentry>
<varlistentry>
- <term>customernumber</term>
+ <term><varname>customernumber</varname></term>
<listitem>
<para>Kundennummer; nur für Kunden</para>
</varlistentry>
<varlistentry>
- <term>customerphone</term>
+ <term><varname>customerphone</varname></term>
<listitem>
<para>Telefonnummer des Kunden; nur für Kunden</para>
</varlistentry>
<varlistentry>
- <term>discount</term>
+ <term><varname>discount</varname></term>
<listitem>
<para>Rabatt</para>
</varlistentry>
<varlistentry>
- <term>email</term>
+ <term><varname>email</varname></term>
<listitem>
<para>Emailadresse</para>
</varlistentry>
<varlistentry>
- <term>fax</term>
+ <term><varname>fax</varname></term>
<listitem>
<para>Faxnummer</para>
</varlistentry>
<varlistentry>
- <term>homepage</term>
+ <term><varname>homepage</varname></term>
<listitem>
<para>Homepage</para>
</varlistentry>
<varlistentry>
- <term>iban</term>
+ <term><varname>iban</varname></term>
<listitem>
<para>Internationale Kontonummer (International Bank Account
</varlistentry>
<varlistentry>
- <term>language</term>
+ <term><varname>language</varname></term>
<listitem>
<para>Sprache</para>
</varlistentry>
<varlistentry>
- <term>name</term>
+ <term><varname>name</varname></term>
<listitem>
<para>Firmenname</para>
</varlistentry>
<varlistentry>
- <term>payment_description</term>
+ <term><varname>payment_description</varname></term>
<listitem>
<para>Name der Zahlart</para>
</varlistentry>
<varlistentry>
- <term>payment_terms</term>
+ <term><varname>payment_terms</varname></term>
<listitem>
<para>Zahlungskonditionen</para>
</varlistentry>
<varlistentry>
- <term>phone</term>
+ <term><varname>phone</varname></term>
<listitem>
<para>Telefonnummer</para>
</varlistentry>
<varlistentry>
- <term>shiptocity</term>
+ <term><varname>shiptocity</varname></term>
<listitem>
<para>Stadt (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptocontact</term>
+ <term><varname>shiptocontact</varname></term>
<listitem>
<para>Kontakt (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptocountry</term>
+ <term><varname>shiptocountry</varname></term>
<listitem>
<para>Land (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptodepartment1</term>
+ <term><varname>shiptodepartment1</varname></term>
<listitem>
<para>Abteilung 1 (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptodepartment2</term>
+ <term><varname>shiptodepartment2</varname></term>
<listitem>
<para>Abteilung 2 (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptoemail</term>
+ <term><varname>shiptoemail</varname></term>
<listitem>
<para>Email (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptofax</term>
+ <term><varname>shiptofax</varname></term>
<listitem>
<para>Fax (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptoname</term>
+ <term><varname>shiptoname</varname></term>
<listitem>
<para>Firmenname (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptophone</term>
+ <term><varname>shiptophone</varname></term>
<listitem>
<para>Telefonnummer (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptostreet</term>
+ <term><varname>shiptostreet</varname></term>
<listitem>
<para>Straße und Hausnummer (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>shiptozipcode</term>
+ <term><varname>shiptozipcode</varname></term>
<listitem>
<para>Postleitzahl (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term>street</term>
+ <term><varname>street</varname></term>
<listitem>
<para>Straße und Hausnummer</para>
</varlistentry>
<varlistentry>
- <term>taxnumber</term>
+ <term><varname>taxnumber</varname></term>
<listitem>
<para>Steuernummer</para>
</varlistentry>
<varlistentry>
- <term>ustid</term>
+ <term><varname>ustid</varname></term>
<listitem>
<para>Umsatzsteuer-Identifikationsnummer</para>
</varlistentry>
<varlistentry>
- <term>vendoremail</term>
+ <term><varname>vendoremail</varname></term>
<listitem>
<para>Email des Lieferanten; nur für Lieferanten</para>
</varlistentry>
<varlistentry>
- <term>vendorfax</term>
+ <term><varname>vendorfax</varname></term>
<listitem>
<para>Faxnummer des Lieferanten; nur für Lieferanten</para>
</varlistentry>
<varlistentry>
- <term>vendornotes</term>
+ <term><varname>vendornotes</varname></term>
<listitem>
<para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
</varlistentry>
<varlistentry>
- <term>vendornumber</term>
+ <term><varname>vendornumber</varname></term>
<listitem>
<para>Lieferantennummer; nur für Lieferanten</para>
</varlistentry>
<varlistentry>
- <term>vendorphone</term>
+ <term><varname>vendorphone</varname></term>
<listitem>
<para>Telefonnummer des Lieferanten; nur für
</varlistentry>
<varlistentry>
- <term>zipcode</term>
+ <term><varname>zipcode</varname></term>
<listitem>
<para>Postleitzahl</para>
<variablelist>
<varlistentry>
- <term>employee_address</term>
+ <term><varname>employee_address</varname></term>
<listitem>
<para>Adressfeld</para>
</varlistentry>
<varlistentry>
- <term>employee_businessnumber</term>
+ <term><varname>employee_businessnumber</varname></term>
<listitem>
<para>Firmennummer</para>
</varlistentry>
<varlistentry>
- <term>employee_company</term>
+ <term><varname>employee_company</varname></term>
<listitem>
<para>Firmenname</para>
</varlistentry>
<varlistentry>
- <term>employee_co_ustid</term>
+ <term><varname>employee_co_ustid</varname></term>
<listitem>
<para>Usatzsteuer-Identifikationsnummer</para>
</varlistentry>
<varlistentry>
- <term>employee_duns</term>
+ <term><varname>employee_duns</varname></term>
<listitem>
<para>DUNS-Nummer</para>
</varlistentry>
<varlistentry>
- <term>employee_email</term>
+ <term><varname>employee_email</varname></term>
<listitem>
<para>Email</para>
</varlistentry>
<varlistentry>
- <term>employee_fax</term>
+ <term><varname>employee_fax</varname></term>
<listitem>
<para>Fax</para>
</varlistentry>
<varlistentry>
- <term>employee_name</term>
+ <term><varname>employee_name</varname></term>
<listitem>
<para>voller Name</para>
</varlistentry>
<varlistentry>
- <term>employee_signature</term>
+ <term><varname>employee_signature</varname></term>
<listitem>
<para>Signatur</para>
</varlistentry>
<varlistentry>
- <term>employee_taxnumber</term>
+ <term><varname>employee_taxnumber</varname></term>
<listitem>
<para>Steuernummer</para>
</varlistentry>
<varlistentry>
- <term>employee_tel</term>
+ <term><varname>employee_tel</varname></term>
<listitem>
<para>Telefonnummer</para>
<variablelist>
<varlistentry>
- <term>salesman_address</term>
+ <term><varname>salesman_address</varname></term>
<listitem>
<para>Adressfeld</para>
</varlistentry>
<varlistentry>
- <term>salesman_businessnumber</term>
+ <term><varname>salesman_businessnumber</varname></term>
<listitem>
<para>Firmennummer</para>
</varlistentry>
<varlistentry>
- <term>salesman_company</term>
+ <term><varname>salesman_company</varname></term>
<listitem>
<para>Firmenname</para>
</varlistentry>
<varlistentry>
- <term>salesman_co_ustid</term>
+ <term><varname>salesman_co_ustid</varname></term>
<listitem>
<para>Usatzsteuer-Identifikationsnummer</para>
</varlistentry>
<varlistentry>
- <term>salesman_duns</term>
+ <term><varname>salesman_duns</varname></term>
<listitem>
<para>DUNS-Nummer</para>
</varlistentry>
<varlistentry>
- <term>salesman_email</term>
+ <term><varname>salesman_email</varname></term>
<listitem>
<para>Email</para>
</varlistentry>
<varlistentry>
- <term>salesman_fax</term>
+ <term><varname>salesman_fax</varname></term>
<listitem>
<para>Fax</para>
</varlistentry>
<varlistentry>
- <term>salesman_name</term>
+ <term><varname>salesman_name</varname></term>
<listitem>
<para>voller Name</para>
</varlistentry>
<varlistentry>
- <term>salesman_signature</term>
+ <term><varname>salesman_signature</varname></term>
<listitem>
<para>Signatur</para>
</varlistentry>
<varlistentry>
- <term>salesman_taxnumber</term>
+ <term><varname>salesman_taxnumber</varname></term>
<listitem>
<para>Steuernummer</para>
</varlistentry>
<varlistentry>
- <term>salesman_tel</term>
+ <term><varname>salesman_tel</varname></term>
<listitem>
<para>Telefonnummer</para>
<variablelist>
<varlistentry>
- <term>tax</term>
+ <term><varname>tax</varname></term>
<listitem>
<para>Steuer</para>
</varlistentry>
<varlistentry>
- <term>taxbase</term>
+ <term><varname>taxbase</varname></term>
<listitem>
<para>zu versteuernder Betrag</para>
</varlistentry>
<varlistentry>
- <term>taxdescription</term>
+ <term><varname>taxdescription</varname></term>
<listitem>
<para>Name der Steuer</para>
</varlistentry>
<varlistentry>
- <term>taxrate</term>
+ <term><varname>taxrate</varname></term>
<listitem>
<para>Steuersatz</para>
<variablelist>
<varlistentry>
- <term>creditremaining</term>
+ <term><varname>creditremaining</varname></term>
<listitem>
<para>Verbleibender Kredit</para>
</varlistentry>
<varlistentry>
- <term>currency</term>
+ <term><varname>currency</varname></term>
<listitem>
<para>Währung</para>
</varlistentry>
<varlistentry>
- <term>cusordnumber</term>
+ <term><varname>cusordnumber</varname></term>
<listitem>
<para>Bestellnummer beim Kunden</para>
</varlistentry>
<varlistentry>
- <term>deliverydate</term>
+ <term><varname>deliverydate</varname></term>
<listitem>
<para>Lieferdatum</para>
</varlistentry>
<varlistentry>
- <term>duedate</term>
+ <term><varname>duedate</varname></term>
<listitem>
<para>Fälligkeitsdatum</para>
</varlistentry>
<varlistentry>
- <term>globalprojectnumber</term>
+ <term><varname>globalprojectnumber</varname></term>
<listitem>
<para>Projektnummer des ganzen Beleges</para>
</varlistentry>
<varlistentry>
- <term>globalprojectdescription</term>
+ <term><varname>globalprojectdescription</varname></term>
<listitem>
<para>Projekbeschreibung des ganzen Beleges</para>
</varlistentry>
<varlistentry>
- <term>intnotes</term>
+ <term><varname>intnotes</varname></term>
<listitem>
<para>Interne Bemerkungen</para>
</varlistentry>
<varlistentry>
- <term>invdate</term>
+ <term><varname>invdate</varname></term>
<listitem>
<para>Rechnungsdatum</para>
</varlistentry>
<varlistentry>
- <term>invnumber</term>
+ <term><varname>invnumber</varname></term>
<listitem>
<para>Rechnungsnummer</para>
</varlistentry>
<varlistentry>
- <term>invtotal</term>
+ <term><varname>invtotal</varname></term>
<listitem>
<para>gesamter Rechnungsbetrag</para>
</varlistentry>
<varlistentry>
- <term>notes</term>
+ <term><varname>notes</varname></term>
<listitem>
<para>Bemerkungen der Rechnung</para>
</varlistentry>
<varlistentry>
- <term>orddate</term>
+ <term><varname>orddate</varname></term>
<listitem>
<para>Auftragsdatum</para>
</varlistentry>
<varlistentry>
- <term>ordnumber</term>
+ <term><varname>ordnumber</varname></term>
<listitem>
<para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
</varlistentry>
<varlistentry>
- <term>payment_description</term>
+ <term><varname>payment_description</varname></term>
<listitem>
<para>Name der Zahlart</para>
</varlistentry>
<varlistentry>
- <term>payment_terms</term>
+ <term><varname>payment_terms</varname></term>
<listitem>
<para>Zahlungskonditionen</para>
</varlistentry>
<varlistentry>
- <term>quodate</term>
+ <term><varname>quodate</varname></term>
<listitem>
<para>Angebotsdatum</para>
</varlistentry>
<varlistentry>
- <term>quonumber</term>
+ <term><varname>quonumber</varname></term>
<listitem>
<para>Angebotsnummer</para>
</varlistentry>
<varlistentry>
- <term>shippingpoint</term>
+ <term><varname>shippingpoint</varname></term>
<listitem>
<para>Versandort</para>
</varlistentry>
<varlistentry>
- <term>shipvia</term>
+ <term><varname>shipvia</varname></term>
<listitem>
<para>Transportmittel</para>
</varlistentry>
<varlistentry>
- <term>subtotal</term>
+ <term><varname>subtotal</varname></term>
<listitem>
<para>Zwischensumme aller Posten ohne Steuern</para>
</varlistentry>
<varlistentry>
- <term>total</term>
+ <term><varname>total</varname></term>
<listitem>
<para>Restsumme der Rechnung (Summe abzüglich bereits
</varlistentry>
<varlistentry>
- <term>transaction_description</term>
+ <term><varname>transaction_description</varname></term>
<listitem>
<para>Vorgangsbezeichnung</para>
</varlistentry>
<varlistentry>
- <term>transdate</term>
+ <term><varname>transdate</varname></term>
<listitem>
<para>Auftragsdatum wenn die Rechnung aus einem Auftrag
<variablelist>
<varlistentry>
- <term>bin</term>
+ <term><varname>bin</varname></term>
<listitem>
<para>Stellage</para>
</varlistentry>
<varlistentry>
- <term>description</term>
+ <term><varname>description</varname></term>
+
+ <listitem>
+ <para>Artikelbeschreibung</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>discount</varname></term>
+
+ <listitem>
+ <para>Rabatt als Betrag</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>discount_sub</varname></term>
+
+ <listitem>
+ <para>Zwischensumme mit Rabatt</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>drawing</varname></term>
+
+ <listitem>
+ <para>Zeichnung</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>ean</varname></term>
+
+ <listitem>
+ <para>EAN-Code</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>image</varname></term>
+
+ <listitem>
+ <para>Grafik</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>linetotal</varname></term>
+
+ <listitem>
+ <para>Zeilensumme (Anzahl * Einzelpreis)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>longdescription</varname></term>
+
+ <listitem>
+ <para>Langtext</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>microfiche</varname></term>
+
+ <listitem>
+ <para>Mikrofilm</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>netprice</varname></term>
+
+ <listitem>
+ <para>Nettopreis</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>nodiscount_linetotal</varname></term>
+
+ <listitem>
+ <para>Zeilensumme ohne Rabatt</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>nodiscount_sub</varname></term>
+
+ <listitem>
+ <para>Zwischensumme ohne Rabatt</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>number</varname></term>
+
+ <listitem>
+ <para>Artikelnummer</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>ordnumber_oe</varname></term>
+
+ <listitem>
+ <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
+ aus einem Sammelauftrag erstellt wurde</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>p_discount</varname></term>
+
+ <listitem>
+ <para>Rabatt in Prozent</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>partnotes</varname></term>
+
+ <listitem>
+ <para>Die beim Artikel gespeicherten Bemerkungen</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>partsgroup</varname></term>
+
+ <listitem>
+ <para>Warengruppe</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>price_factor</varname></term>
+
+ <listitem>
+ <para>Der Preisfaktor als Zahl, sofern einer eingestellt
+ ist</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>price_factor_name</varname></term>
+
+ <listitem>
+ <para>Der Name des Preisfaktors, sofern einer eingestellt
+ ist</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>projectnumber</varname></term>
+
+ <listitem>
+ <para>Projektnummer</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>projectdescription</varname></term>
+
+ <listitem>
+ <para>Projektbeschreibung</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>qty</varname></term>
+
+ <listitem>
+ <para>Anzahl</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>reqdate</varname></term>
+
+ <listitem>
+ <para>Lieferdatum</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>runningnumber</varname></term>
+
+ <listitem>
+ <para>Position auf der Rechnung (1, 2, 3...)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>sellprice</varname></term>
+
+ <listitem>
+ <para>Verkaufspreis</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>serialnumber</varname></term>
+
+ <listitem>
+ <para>Seriennummer</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>tax_rate</varname></term>
+
+ <listitem>
+ <para>Steuersatz</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>transdate_oe</varname></term>
+
+ <listitem>
+ <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
+ aus einem Sammelauftrag erstellt wurde</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>unit</varname></term>
+
+ <listitem>
+ <para>Einheit</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>weight</varname></term>
+
+ <listitem>
+ <para>Gewicht</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
+ über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
+ einer <function>foreach</function>-Schleife ausgegeben werden, da
+ für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
+ können. Die Variablen dafür lauten:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>make</varname></term>
+
+ <listitem>
+ <para>Lieferant</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>model</varname></term>
+
+ <listitem>
+ <para>Lieferantenartikelnummer</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
+ <title>Variablen für die einzelnen Zahlungseingänge</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>payment</varname></term>
+
+ <listitem>
+ <para>Betrag</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>paymentaccount</varname></term>
<listitem>
- <para>Artikelbeschreibung</para>
+ <para>Konto</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>discount</term>
+ <term><varname>paymentdate</varname></term>
<listitem>
- <para>Rabatt als Betrag</para>
+ <para>Datum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>discount_sub</term>
+ <term><varname>paymentmemo</varname></term>
<listitem>
- <para>Zwischensumme mit Rabatt</para>
+ <para>Memo</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>drawing</term>
+ <term><varname>paymentsource</varname></term>
<listitem>
- <para>Zeichnung</para>
+ <para>Beleg</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
+ <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
+
+ <para>Die vom Benutzer definierten Variablen für Kunden und
+ Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
+ ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
+ <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
+ Variablennamen zusammen.</para>
+
+ <para>Beispiel: Der Benutzer hat eine Variable namens
+ <varname>number_of_employees</varname> definiert, die die Anzahl der
+ Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
+ unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
+ Verfügung.</para>
+ </sect3>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.dunning">
+ <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
+ <title>Namen der Vorlagen</title>
+
+ <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
+ eingegeben. Wird für ein Mahnlevel die Option zur automatischen
+ Erstellung einer Rechnung über die Mahngebühren und Zinsen
+ aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
+ Vorlagenname für diese Mahnstufe mit dem Zusatz
+ <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
+ für die ausgewählte Sprache und den ausgewählten Drucker
+ angehängt.</para>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
+ <title>Allgemeine Variablen in Mahnungen</title>
+
+ <para>Die Variablen des Verkäufers stehen wie gewohnt als
+ <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
+ Kunden stehen als Variablen <varname>name</varname>,
+ <varname>street</varname>, <varname>zipcode</varname>,
+ <varname>city</varname>, <varname>country</varname>,
+ <varname>department_1</varname>, <varname>department_2</varname>,
+ und <varname>email</varname> zur Verfügung.</para>
+
+ <para>Weitere Variablen beinhalten:</para>
+ <variablelist>
<varlistentry>
- <term>ean</term>
+ <term><varname>dunning_date</varname></term>
<listitem>
- <para>EAN-Code</para>
+ <para>Datum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>image</term>
+ <term><varname>dunning_duedate</varname></term>
<listitem>
- <para>Grafik</para>
+ <para>Fälligkeitsdatum für diese Mahhnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>linetotal</term>
+ <term><varname>dunning_id</varname></term>
<listitem>
- <para>Zeilensumme (Anzahl * Einzelpreis)</para>
+ <para>Mahnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>longdescription</term>
+ <term><varname>fee</varname></term>
<listitem>
- <para>Langtext</para>
+ <para>Kummulative Mahngebühren</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>microfiche</term>
+ <term><varname>interest_rate</varname></term>
<listitem>
- <para>Mikrofilm</para>
+ <para>Zinssatz per anno in Prozent</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>netprice</term>
+ <term><varname>total_amount</varname></term>
<listitem>
- <para>Nettopreis</para>
+ <para>Gesamter noch zu zahlender Betrag als
+ <function>fee</function> + <function>total_interest</function>
+ + <function>total_open_amount</function></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>nodiscount_linetotal</term>
+ <term><varname>total_interest</varname></term>
<listitem>
- <para>Zeilensumme ohne Rabatt</para>
+ <para>Zinsen per anno über alle Rechnungen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>nodiscount_sub</term>
+ <term><varname>total_open_amount</varname></term>
<listitem>
- <para>Zwischensumme ohne Rabatt</para>
+ <para>Summe über alle offene Beträge der Rechnungen</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
+ <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
+ <variablelist>
<varlistentry>
- <term>number</term>
+ <term><varname>dn_amount</varname></term>
<listitem>
- <para>Artikelnummer</para>
+ <para>Rechnungssumme (brutto)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ordnumber_oe</term>
+ <term><varname>dn_duedate</varname></term>
<listitem>
- <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
- aus einem Sammelauftrag erstellt wurde</para>
+ <para>Originales Fälligkeitsdatum der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>p_discount</term>
+ <term><varname>dn_dunning_date</varname></term>
<listitem>
- <para>Rabatt in Prozent</para>
+ <para>Datum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>partnotes</term>
+ <term><varname>dn_dunning_duedate</varname></term>
<listitem>
- <para>Die beim Artikel gespeicherten Bemerkungen</para>
+ <para>Fälligkeitsdatum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>partsgroup</term>
+ <term><varname>dn_fee</varname></term>
<listitem>
- <para>Warengruppe</para>
+ <para>Kummulative Mahngebühr</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>price_factor</term>
+ <term><varname>dn_interest</varname></term>
<listitem>
- <para>Der Preisfaktor als Zahl, sofern einer eingestellt
- ist</para>
+ <para>Zinsen per anno für diese Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>price_factor_name</term>
+ <term><varname>dn_invnumber</varname></term>
<listitem>
- <para>Der Name des Preisfaktors, sofern einer eingestellt
- ist</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>projectnumber</term>
+ <term><varname>dn_linetotal</varname></term>
<listitem>
- <para>Projektnummer</para>
+ <para>Noch zu zahlender Betrag (ergibt sich aus
+ <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
+ + <varname>dn_interest</varname>)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>projectdescription</term>
+ <term><varname>dn_netamount</varname></term>
<listitem>
- <para>Projektbeschreibung</para>
+ <para>Rechnungssumme (netto)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>qty</term>
+ <term><varname>dn_open_amount</varname></term>
<listitem>
- <para>Anzahl</para>
+ <para>Offener Rechnungsbetrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>reqdate</term>
+ <term><varname>dn_ordnumber</varname></term>
<listitem>
- <para>Lieferdatum</para>
+ <para>Bestellnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>runningnumber</term>
+ <term><varname>dn_transdate</varname></term>
<listitem>
- <para>Position auf der Rechnung (1, 2, 3...)</para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>sellprice</term>
+ <term><varname>dn_curr</varname></term>
<listitem>
- <para>Verkaufspreis</para>
+ <para>Währung, in der die Rechnung erstellt wurde. (Die
+ Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
+ <title>Variablen in automatisch erzeugten Rechnungen über
+ Mahngebühren</title>
+
+ <para>Die Variablen des Verkäufers stehen wie gewohnt als
+ <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
+ Kunden stehen als Variablen <varname>name</varname>,
+ <varname>street</varname>, <varname>zipcode</varname>,
+ <varname>city</varname>, <varname>country</varname>,
+ <varname>department_1</varname>, <varname>department_2</varname>,
+ und <varname>email</varname> zur Verfügung.</para>
+ <para>Weitere Variablen beinhalten:</para>
+
+ <variablelist>
<varlistentry>
- <term>serialnumber</term>
+ <term><varname>duedate</varname></term>
<listitem>
- <para>Seriennummer</para>
+ <para>Fälligkeitsdatum der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>tax_rate</term>
+ <term><varname>dunning_id</varname></term>
<listitem>
- <para>Steuersatz</para>
+ <para>Mahnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>transdate_oe</term>
+ <term><varname>fee</varname></term>
<listitem>
- <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
- aus einem Sammelauftrag erstellt wurde</para>
+ <para>Mahngebühren</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>unit</term>
+ <term><varname>interest</varname></term>
<listitem>
- <para>Einheit</para>
+ <para>Zinsen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>weight</term>
+ <term><varname>invamount</varname></term>
<listitem>
- <para>Gewicht</para>
+ <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
+ <varname>interest</varname>)</para>
</listitem>
</varlistentry>
- </variablelist>
- <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
- über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
- einer <function>foreach</function>-Schleife ausgegeben werden, da
- für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
- können. Die Variablen dafür lauten:</para>
-
- <variablelist>
<varlistentry>
- <term>make</term>
+ <term><varname>invdate</varname></term>
<listitem>
- <para>Lieferant</para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>model</term>
+ <term><varname>invnumber</varname></term>
<listitem>
- <para>Lieferantenartikelnummer</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
+ </sect2>
- <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
- <title>Variablen für die einzelnen Zahlungseingänge</title>
+ <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
+ <title>Variablen in anderen Vorlagen</title>
+
+ <sect3>
+ <title>Einführung</title>
+
+ <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
+ Rechnung. Allerdings heißen die Variablen, die mit
+ <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
+ fangen sie mit <varname>quo</varname> für "quotation" an:
+ <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
+ wiederum fangen sie mit <varname>ord</varname> für "order" an:
+ <varname>ordnumber</varname> für Bestellnummer etc.</para>
+
+ <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
+ vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
+ sind Variablen, die vom Geschäftsablauf her in der entsprechenden
+ Vorlage keine Bedeutung haben oder noch nicht belegt sein
+ können.</para>
+
+ <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
+ in Rechnungen aufgeführt.</para>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
+ <title>Angebote und Preisanfragen</title>
<variablelist>
<varlistentry>
- <term>payment</term>
+ <term><varname>quonumber</varname></term>
<listitem>
- <para>Betrag</para>
+ <para>Angebots- bzw. Anfragenummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>paymentaccount</term>
+ <term><varname>reqdate</varname></term>
<listitem>
- <para>Konto</para>
+ <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
+ Preisanfragen)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>paymentdate</term>
+ <term><varname>transdate</varname></term>
<listitem>
- <para>Datum</para>
+ <para>Angebots- bzw. Anfragedatum</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
+ <title>Auftragsbestätigungen und Lieferantenaufträge</title>
+ <variablelist>
<varlistentry>
- <term>paymentmemo</term>
+ <term><varname>ordnumber</varname></term>
<listitem>
- <para>Memo</para>
+ <para>Auftragsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>paymentsource</term>
+ <term><varname>reqdate</varname></term>
<listitem>
- <para>Beleg</para>
+ <para>Lieferdatum</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
- <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
- <para>Die vom Benutzer definierten Variablen für Kunden und
- Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
- ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
- <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
- Variablennamen zusammen.</para>
+ <varlistentry>
+ <term><varname>transdate</varname></term>
- <para>Beispiel: Der Benutzer hat eine Variable namens
- <varname>number_of_employees</varname> definiert, die die Anzahl der
- Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
- unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
- Verfügung.</para>
+ <listitem>
+ <para>Auftragsdatum</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</sect3>
- </sect2>
- <sect2 id="dokumentenvorlagen-und-variablen.dunning">
- <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
+ <title>Lieferscheine (Verkauf und Einkauf)</title>
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
- <title>Namen der Vorlagen</title>
+ <variablelist>
+ <varlistentry>
+ <term><varname>cusordnumber</varname></term>
- <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
- eingegeben. Wird für ein Mahnlevel die Option zur automatischen
- Erstellung einer Rechnung über die Mahngebühren und Zinsen
- aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
- Vorlagenname für diese Mahnstufe mit dem Zusatz
- <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
- für die ausgewählte Sprache und den ausgewählten Drucker
- angehängt.</para>
- </sect3>
+ <listitem>
+ <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
+ des Lieferanten (im Einkauf)</para>
+ </listitem>
+ </varlistentry>
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
- <title>Allgemeine Variablen in Mahnungen</title>
+ <varlistentry>
+ <term><varname>donumber</varname></term>
- <para>Die Variablen des Verkäufers stehen wie gewohnt als
- <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
- Kunden stehen als Variablen <varname>name</varname>,
- <varname>street</varname>, <varname>zipcode</varname>,
- <varname>city</varname>, <varname>country</varname>,
- <varname>department_1</varname>, <varname>department_2</varname>,
- und <varname>email</varname> zur Verfügung.</para>
+ <listitem>
+ <para>Lieferscheinnummer</para>
+ </listitem>
+ </varlistentry>
- <para>Weitere Variablen beinhalten:</para>
+ <varlistentry>
+ <term><varname>transdate</varname></term>
+
+ <listitem>
+ <para>Lieferscheindatum</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
+ mit den Informationen darüber, von welchem Lager und Lagerplatz aus
+ die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
+ Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
+ <function>foreach</function>-Schleife ausgegeben werden. Diese
+ Variablen sind:</para>
<variablelist>
<varlistentry>
- <term>dunning_date</term>
+ <term><varname>si_bin</varname></term>
<listitem>
- <para>Datum der Mahnung</para>
+ <para>Lagerplatz</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dunning_duedate</term>
+ <term><varname>si_chargenumber</varname></term>
<listitem>
- <para>Fälligkeitsdatum für diese Mahhnung</para>
+ <para>Chargennummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dunning_id</term>
+ <term><varname>si_bestbefore</varname></term>
<listitem>
- <para>Mahnungsnummer</para>
+ <para>Mindesthaltbarkeit</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>fee</term>
+ <term><varname>si_number</varname></term>
<listitem>
- <para>Kummulative Mahngebühren</para>
+ <para>Artikelnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>interest_rate</term>
+ <term><varname>si_qty</varname></term>
<listitem>
- <para>Zinssatz per anno in Prozent</para>
+ <para>Anzahl bzw. Menge</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>total_amount</term>
+ <term><varname>si_runningnumber</varname></term>
<listitem>
- <para>Gesamter noch zu zahlender Betrag als
- <function>fee</function> + <function>total_interest</function>
- + <function>total_open_amount</function></para>
+ <para>Positionsnummer (1, 2, 3 etc)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>total_interest</term>
+ <term><varname>si_unit</varname></term>
<listitem>
- <para>Zinsen per anno über alle Rechnungen</para>
+ <para>Einheit</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>total_open_amount</term>
+ <term><varname>si_warehouse</varname></term>
<listitem>
- <para>Summe über alle offene Beträge der Rechnungen</para>
+ <para>Lager</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
- <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
+ <title>Variablen für Sammelrechnung</title>
<variablelist>
<varlistentry>
- <term>dn_amount</term>
+ <term><varname>c0total</varname></term>
<listitem>
- <para>Rechnungssumme (brutto)</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
+ Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_duedate</term>
+ <term><varname>c30total</varname></term>
<listitem>
- <para>Originales Fälligkeitsdatum der Rechnung</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
+ und < 60 Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_dunning_date</term>
+ <term><varname>c60total</varname></term>
<listitem>
- <para>Datum der Mahnung</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
+ und < 90 Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_dunning_duedate</term>
+ <term><varname>c90total</varname></term>
<listitem>
- <para>Fälligkeitsdatum der Mahnung</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
+ Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_fee</term>
+ <term><varname>total</varname></term>
<listitem>
- <para>Kummulative Mahngebühr</para>
+ <para>Gesamtbetrag aller Rechnungen</para>
</listitem>
</varlistentry>
+ </variablelist>
+
+ <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
+ <variablelist>
<varlistentry>
- <term>dn_interest</term>
+ <term><varname>invnumber</varname></term>
<listitem>
- <para>Zinsen per anno für diese Rechnung</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_invnumber</term>
+ <term><varname>invdate</varname></term>
<listitem>
- <para>Rechnungsnummer</para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_linetotal</term>
+ <term><varname>duedate</varname></term>
<listitem>
- <para>Noch zu zahlender Betrag (ergibt sich aus
- <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
- + <varname>dn_interest</varname>)</para>
+ <para>Fälligkeitsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_netamount</term>
+ <term><varname>amount</varname></term>
<listitem>
- <para>Rechnungssumme (netto)</para>
+ <para>Summe der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_open_amount</term>
+ <term><varname>open</varname></term>
<listitem>
- <para>Offener Rechnungsbetrag</para>
+ <para>Noch offener Betrag der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_ordnumber</term>
+ <term><varname>c0</varname></term>
<listitem>
- <para>Bestellnummer</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
+ Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_transdate</term>
+ <term><varname>c30</varname></term>
<listitem>
- <para>Rechnungsdatum</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
+ < 60 Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_curr</term>
+ <term><varname>c60</varname></term>
<listitem>
- <para>Währung, in der die Rechnung erstellt wurde. (Die
- Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
+ < 90 Tage</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>c90</varname></term>
+
+ <listitem>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
+ Tage</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
+ </sect2>
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
- <title>Variablen in automatisch erzeugten Rechnungen über
- Mahngebühren</title>
+ <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
+ <title>Blöcke, bedingte Anweisungen und Schleifen</title>
- <para>Die Variablen des Verkäufers stehen wie gewohnt als
- <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
- Kunden stehen als Variablen <varname>name</varname>,
- <varname>street</varname>, <varname>zipcode</varname>,
- <varname>city</varname>, <varname>country</varname>,
- <varname>department_1</varname>, <varname>department_2</varname>,
- und <varname>email</varname> zur Verfügung.</para>
+ <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
+ <title>Einfürhung</title>
- <para>Weitere Variablen beinhalten:</para>
+ <para>Der Parser kennt neben den Variablen einige weitere
+ Konstrukte, die gesondert behandelt werden. Diese sind wie
+ Variablennamen in spezieller Weise markiert:
+ <command><%anweisung%> ... <%end%></command></para>
- <variablelist>
- <varlistentry>
- <term>duedate</term>
+ <para>Anmerkung zum <command><%end%></command>: Der besseren
+ Verständlichkeit halber kann man nach dem <command>end</command>
+ noch beliebig weitere Wörter schreiben, um so zu markieren, welche
+ Anweisung (z.B. <command>if</command> oder
+ <command>foreach</command>) damit abgeschlossen wird.</para>
- <listitem>
- <para>Fälligkeitsdatum der Rechnung</para>
- </listitem>
- </varlistentry>
+ <para>Beispiel: Lautet der Beginn eines Blockes z.B.
+ <command><%if type == "sales_quotation"%></command>, so könnte
+ er mit <command><%end%></command> genauso abgeschlossen werden
+ wie mit <command><%end if%></command> oder auch
+ <command><%end type == "sales_quotation"%></command>.</para>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
+ <title>Der if-Block</title>
+
+ <programlisting><%if variablenname%>
+...
+<%end%></programlisting>
+
+ <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
+ und dem "end" werden nur ausgegeben, wenn die Variable
+ <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
+
+ <para>Die Bedingung kann auch negiert werden, indem das Wort
+ <function>not</function> nach dem <filename>if</filename> verwendet
+ wird. Beispiel:</para>
+
+ <programlisting><%if not cp_greeting%>
+...
+<%end%></programlisting>
+
+ <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
+ oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
+ einer Variablen mit einer festen Zeichenkette oder einer anderen
+ Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
+ oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
+ die rechte Seite des Vergleichsoperators in Anführungszeichen
+ gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
+ anderer Variablen). Zwei Beispiele, die beide Vergleiche
+ zeigen:</para>
+
+ <programlisting><%if var1 == "Wert"%></programlisting>
+
+ <para>Testet die Variable <varname>var1</varname> auf
+ übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
+ Mittels <function>!=</function> anstelle von <function>==</function>
+ würde auf Ungleichheit getestet.</para>
+
+ <programlisting>%if var1 == var2%></programlisting>
+
+ <para>Testet die Variable <varname>var1</varname> auf
+ übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
+ <function>!=</function> anstelle von <function>==</function> würde
+ auf Ungleichheit getestet.</para>
+
+ <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
+ auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
+ Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
+ dieselbe Syntax wie oben nur mit <function>=~</function> und
+ <function>!~</function> als Vergleichsoperatoren.</para>
+
+ <para>Beispiel für einen Test, ob die Variable
+ <varname>intnotes</varname> (interne Bemerkungen) das Wort
+ <constant>schwierig</constant> enthält:</para>
+
+ <programlisting><%if intnotes =~ "schwierig"%></programlisting>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
+ <title>Der foreach-Block</title>
+
+ <programlisting><%foreach variablenname%>
+...
+<%end%></programlisting>
+
+ <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
+ wie das Perl-Array der Variablen <varname>variablenname</varname>
+ Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
+ Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
+ benutzt. In jedem Durchlauf werden die <link
+ linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
+ Variablen</link> jeweils auf den Wert für die aktuelle Position
+ gesetzt.</para>
+
+ <para>Die Syntax sieht normalerweise wie folgt aus:</para>
+
+ <programlisting><%foreach number%>
+Position: <%runningnumber%>
+Anzahl: <%qty%>
+Artikelnummer: <%number%>
+Beschreibung: <%description%>
+...
+<%end%></programlisting>
+
+ <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
+ <function><%foreach%></function>-Block innerhalb einer
+ Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
+ wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
+ Inhalt zwischen <function><%foreach%></function> und
+ <function><%end%></function> wiederholt, nicht aber die
+ komplette Zeile, in der er steht.</para>
+ </sect3>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.markup">
+ <title>Markup-Code zur Textformatierung innerhalb von
+ Formularen</title>
+
+ <para>Wenn der Benutzer innhalb von Formularen in Lx-Office Text
+ anders formatiert haben möchte, so ist dies begrenzt möglich.
+ Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags.
+ 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
+ (HTML oder PDF über LaTeX) umgesetzt.</para>
+
+ <para>Die unterstützen Formatierungen sind:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><b>Text</b></term>
+
+ <listitem>
+ <para>Text wird in Fettdruck gesetzt.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><i>Text</i></term>
+
+ <listitem>
+ <para>Text wird kursiv gesetzt.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><u>Text</u></term>
+
+ <listitem>
+ <para>Text wird unterstrichen.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>dunning_id</term>
+ <varlistentry>
+ <term><s>Text</s></term>
- <listitem>
- <para>Mahnungsnummer</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Text wird durchgestrichen. Diese Formatierung ist nicht
+ bei der Ausgabe als PDF über LaTeX verfügbar.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>fee</term>
+ <varlistentry>
+ <term><bullet></term>
- <listitem>
- <para>Mahngebühren</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
+ unten).</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <varlistentry>
- <term>interest</term>
+ <para>Der Befehl <command><bullet></command> funktioniert
+ momentan auch nur in Latex-Vorlagen.</para>
+ </sect2>
+ </sect1>
- <listitem>
- <para>Zinsen</para>
- </listitem>
- </varlistentry>
+ <sect1 id="excel-templates">
+ <title>Excel-Vorlagen</title>
- <varlistentry>
- <term>invamount</term>
+ <sect2 id="excel-templates.summary">
+ <title>Zusammenfassung</title>
- <listitem>
- <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
- <varname>interest</varname>)</para>
- </listitem>
- </varlistentry>
+ <para>Dieses Dokument beschreibt den Mechanismus, mit dem
+ Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
+ einhergehen.</para>
+ </sect2>
- <varlistentry>
- <term>invdate</term>
+ <sect2 id="excel-templates.usage">
+ <title>Bedienung</title>
- <listitem>
- <para>Rechnungsdatum</para>
- </listitem>
- </varlistentry>
+ <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
+ werden. Die Konfigurationsoption heißt <varname>excel_templates =
+ 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
- <varlistentry>
- <term>invnumber</term>
+ <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
+ anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
+ werden. In den normalen Verkaufsmasken taucht nun
+ <constant>Excel</constant> als auswählbares Format auf und kann von da
+ an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
- <listitem>
- <para>Rechnungsnummer</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
+ eine Angebotsvorlage und wird unter dem internen Namen der Angebote
+ <filename>sales_quotation.xls</filename> gespeichert.</para>
</sect2>
- <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
- <title>Variablen in anderen Vorlagen</title>
+ <sect2 id="excel-templates.syntax">
+ <title>Variablensyntax</title>
- <sect3>
- <title>Einführung</title>
+ <para>Einfache Syntax:
+ <command><<varname>></command></para>
- <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
- Rechnung. Allerdings heißen die Variablen, die mit
- <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
- fangen sie mit <varname>quo</varname> für "quotation" an:
- <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
- wiederum fangen sie mit <varname>ord</varname> für "order" an:
- <varname>ordnumber</varname> für Bestellnummer etc.</para>
+ <para>Dabei sind <constant><<</constant> und
+ <constant>>></constant> die Delimiter. Da Excel auf festen
+ Breiten besteht, kann der Tag künstlich verlängert werden, indem
+ weitere <constant><</constant> oder <constant>></constant>
+ eingefügt werden. Der Tag muss nicht symmetrisch sein.
+ Beispiel:</para>
- <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
- vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
- sind Variablen, die vom Geschäftsablauf her in der entsprechenden
- Vorlage keine Bedeutung haben oder noch nicht belegt sein
- können.</para>
+ <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
- <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
- in Rechnungen aufgeführt.</para>
- </sect3>
+ <para>Um die Limitierung der festen Breite zu reduzieren, können
+ weitere Variablen in einem Block interpoliert werden. Whitespace wird
+ dazwishen dann erhalten. Beispiel:</para>
- <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
- <title>Angebote und Preisanfragen</title>
+ <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
- <variablelist>
- <varlistentry>
- <term>quonumber</term>
+ <para>Die Variablen werden interpoliert, und linksbündig mit
+ Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
+ lang, werden überzählige Zeichen abgeschnitten.</para>
- <listitem>
- <para>Angebots- bzw. Anfragenummer</para>
- </listitem>
- </varlistentry>
+ <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
+ der Block mit einem Leerzeichen anfängt. Beispiel:</para>
- <varlistentry>
- <term>reqdate</term>
+ <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
- <listitem>
- <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
- Preisanfragen)</para>
- </listitem>
- </varlistentry>
+ <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
+ Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
+ entfernt.</para>
+ </sect2>
- <varlistentry>
- <term>transdate</term>
+ <sect2 id="excel-templates.limitations">
+ <title>Einschränkungen</title>
- <listitem>
- <para>Angebots- bzw. Anfragedatum</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
+ mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
+ beschränkt sich daher darauf, Textstellen exakt durch einen anderen
+ Text zu ersetzen.</para>
- <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
- <title>Auftragsbestätigungen und Lieferantenaufträge</title>
+ <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
+ <command><%if%></command> und
+ <command><%foreach%></command> nicht vorhanden. Der Delimiter
+ <constant><% %></constant> kommt in den Headerinformationen
+ evtl. vor. Deshalb wurde auf den sichereren Delimiter
+ <constant><<</constant> und <constant>>></constant>
+ gewechselt.</para>
+ </sect2>
+ </sect1>
+ </chapter>
- <variablelist>
- <varlistentry>
- <term>ordnumber</term>
+ <chapter>
+ <title>Entwicklerdokumentation</title>
- <listitem>
- <para>Auftragsnummer</para>
- </listitem>
- </varlistentry>
+ <sect1 id="devel.globals" xreflabel="Globale Variablen">
+ <title>Globale Variablen</title>
- <varlistentry>
- <term>reqdate</term>
+ <sect2>
+ <title>Wie sehen globale Variablen in Perl aus?</title>
- <listitem>
- <para>Lieferdatum</para>
- </listitem>
- </varlistentry>
+ <para>Globale Variablen liegen in einem speziellen namespace namens
+ "main", der von überall erreichbar ist. Darüber hinaus sind bareword
+ globs global und die meisten speziellen Variablen sind...
+ speziell.</para>
- <varlistentry>
- <term>transdate</term>
+ <para>Daraus ergeben sich folgende Formen:</para>
- <listitem>
- <para>Auftragsdatum</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <variablelist>
+ <varlistentry>
+ <term><literal>$main::form</literal></term>
- <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
- <title>Lieferscheine (Verkauf und Einkauf)</title>
+ <listitem>
+ <para>expliziter Namespace "main"</para>
+ </listitem>
+ </varlistentry>
- <variablelist>
- <varlistentry>
- <term>cusordnumber</term>
+ <varlistentry>
+ <term><literal>$::form</literal></term>
- <listitem>
- <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
- des Lieferanten (im Einkauf)</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>impliziter Namespace "main"</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>donumber</term>
+ <varlistentry>
+ <term><literal>open FILE, "file.txt"</literal></term>
- <listitem>
- <para>Lieferscheinnummer</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para><varname>FILE</varname> ist global</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>transdate</term>
+ <varlistentry>
+ <term><literal>$_</literal></term>
- <listitem>
- <para>Lieferscheindatum</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <listitem>
+ <para>speziell</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
- mit den Informationen darüber, von welchem Lager und Lagerplatz aus
- die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
- Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
- <function>foreach</function>-Schleife ausgegeben werden. Diese
- Variablen sind:</para>
+ <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
+ Schlüsselwort wie "<function>global</function>", mit dem man
+ importieren kann. <function>my</function>, <function>our</function>
+ und <function>local</function> machen was anderes.</para>
- <variablelist>
- <varlistentry>
- <term>si_bin</term>
+ <variablelist>
+ <varlistentry>
+ <term><literal>my $form</literal></term>
- <listitem>
- <para>Lagerplatz</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>lexikalische Variable, gültig bis zum Ende des
+ Scopes</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>si_chargenumber</term>
+ <varlistentry>
+ <term><literal>our $form</literal></term>
+
+ <listitem>
+ <para><varname>$form</varname> referenziert ab hier
+ <varname>$PACKAGE::form</varname>.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Chargennummer</para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><literal>local $form</literal></term>
- <varlistentry>
- <term>si_bestbefore</term>
+ <listitem>
+ <para>Alle Änderungen an <varname>$form</varname> werden am Ende
+ des scopes zurückgesetzt</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
- <listitem>
- <para>Mindesthaltbarkeit</para>
- </listitem>
- </varlistentry>
+ <sect2>
+ <title>Warum sind globale Variablen ein Problem?</title>
- <varlistentry>
- <term>si_number</term>
+ <para>Das erste Problem ist <productname>FCGI</productname>.</para>
- <listitem>
- <para>Artikelnummer</para>
- </listitem>
- </varlistentry>
+ <para><productname>SQL-Ledger</productname> hat fast alles im globalen
+ namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
+ Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
+ aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
+ Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
+ Datenbankverbindungen, weil die sehr lange zum Initialisieren
+ brauchen.</para>
- <varlistentry>
- <term>si_qty</term>
+ <para>Das zweite Problem ist <function>strict</function>. Unter
+ <function>strict</function> werden alle Variablen die nicht explizit
+ mit <function>Package</function>, <function>my</function> oder
+ <function>our</function> angegeben werden als Tippfehler angemarkert,
+ dies hat, seit der Einführung, u.a. schon so manche langwierige
+ Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
+ angegeben werden, werden die nicht geprüft, und somit kann sich
+ schnell ein Tippfehler einschleichen.</para>
+ </sect2>
- <listitem>
- <para>Anzahl bzw. Menge</para>
- </listitem>
- </varlistentry>
+ <sect2>
+ <title>Kanonische globale Variablen</title>
- <varlistentry>
- <term>si_runningnumber</term>
+ <para>Um dieses Problem im Griff zu halten gibt es einige wenige
+ globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
+ vorgegebenen Eigenschaften, und alles andere sollte anderweitig
+ umhergereicht werden.</para>
- <listitem>
- <para>Positionsnummer (1, 2, 3 etc)</para>
- </listitem>
- </varlistentry>
+ <para>Diese Variablen sind im Moment die folgenden neun:</para>
- <varlistentry>
- <term>si_unit</term>
+ <itemizedlist>
+ <listitem>
+ <para><varname>$::form</varname></para>
+ </listitem>
- <listitem>
- <para>Einheit</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para><varname>%::myconfig</varname></para>
+ </listitem>
- <varlistentry>
- <term>si_warehouse</term>
+ <listitem>
+ <para><varname>$::locale</varname></para>
+ </listitem>
- <listitem>
- <para>Lager</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <listitem>
+ <para><varname>$::lxdebug</varname></para>
+ </listitem>
- <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
- <title>Variablen für Sammelrechnung</title>
+ <listitem>
+ <para><varname>$::auth</varname></para>
+ </listitem>
- <variablelist>
- <varlistentry>
- <term>c0total</term>
+ <listitem>
+ <para><varname>$::lx_office_conf</varname></para>
+ </listitem>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
- Tage</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para><varname>$::instance_conf</varname></para>
+ </listitem>
- <varlistentry>
- <term>c30total</term>
+ <listitem>
+ <para><varname>$::dispatcher</varname></para>
+ </listitem>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
- und < 60 Tage</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para><varname>$::request</varname></para>
+ </listitem>
+ </itemizedlist>
- <varlistentry>
- <term>c60total</term>
+ <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
+ Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
+ Eigenschaften (Konventionen):</para>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
- und < 90 Tage</para>
- </listitem>
- </varlistentry>
+ <sect3>
+ <title>$::form</title>
- <varlistentry>
- <term>c90total</term>
+ <itemizedlist>
+ <listitem>
+ <para>Ist ein Objekt der Klasse
+ "<classname>Form</classname>"</para>
+ </listitem>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
- Tage</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Wird nach jedem Request gelöscht</para>
+ </listitem>
- <varlistentry>
- <term>total</term>
+ <listitem>
+ <para>Muss auch in Tests und Konsolenscripts vorhanden
+ sein.</para>
+ </listitem>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <listitem>
+ <para>Enthält am Anfang eines Requests die Requestparameter vom
+ User</para>
+ </listitem>
- <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
+ <listitem>
+ <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
+ cachen, das wird aber momentan absichtlich zerstört</para>
+ </listitem>
+ </itemizedlist>
- <variablelist>
- <varlistentry>
- <term>invnumber</term>
+ <para><varname>$::form</varname> wurde unter <productname>SQL
+ Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
+ alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
+ heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
+ gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
+ <function>IS->retrieve_customer()</function> in Sicherheit
+ bringen.</para>
- <listitem>
- <para>Rechnungsnummer</para>
- </listitem>
- </varlistentry>
+ <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
+ Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
+ 3552, Stand version 2.7beta), um dies hinterher wieder auf den
+ richtigen Wert zu setzen:</para>
- <varlistentry>
- <term>invdate</term>
+ <programlisting> my $saved_numberformat = $::myconfig{numberformat};
+ $::myconfig{numberformat} = $numberformat;
+ # (...) div Berechnungen
+ $::myconfig{numberformat} = $saved_numberformat;</programlisting>
- <listitem>
- <para>Rechnungsdatum</para>
- </listitem>
- </varlistentry>
+ <para>Das Objekt der Klasse Form hat leider im Moment noch viele
+ zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
+ nie einfach zerstören oder überschreiben (zumindestens nicht kurz
+ vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
+ Es geht ziemlich sicher etwas kaputt.</para>
- <varlistentry>
- <term>duedate</term>
+ <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
+ in den <productname>Template::Toolkit</productname> Templates
+ außerhalb der Controller: der Ausdruck <function>[% var
+ %]</function> greift auf <varname>$::form->{var}</varname> zu.
+ Unter Controllern ist der Standard Scope anders, da lautet der
+ Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
+ normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
+ <function><%var%></function> zeigt auf
+ <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
+ erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
+ Konstrukte:</para>
- <listitem>
- <para>Fälligkeitsdatum</para>
- </listitem>
- </varlistentry>
+ <programlisting>[%- IF business %]
+# (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
+[%- END %]</programlisting>
- <varlistentry>
- <term>amount</term>
+ <para>Entweder wird hier dann $::form->{business} ausgewertet
+ oder aber der Funktion
+ <function>$form->parse_html_template</function> wird explizit
+ noch ein zusätzlicher Hash übergeben, der dann auch in den
+ (Web-)Templates zu Verfügung steht, bspw. so:</para>
- <listitem>
- <para>Summe der Rechnung</para>
- </listitem>
- </varlistentry>
+ <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
- <varlistentry>
- <term>open</term>
+ <para>Innerhalb von Schleifen wird
+ <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
+ bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
+ welches über alle Positionen eines Lieferscheins in Schleife
+ läuft:</para>
+
+ <programlisting>for $i (1 .. $form->{rowcount}) {
+ # ...
+ push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
+ push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
+ push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
+ # ...
+}</programlisting>
+ </sect3>
- <listitem>
- <para>Noch offener Betrag der Rechnung</para>
- </listitem>
- </varlistentry>
+ <sect3>
+ <title>%::myconfig</title>
- <varlistentry>
- <term>c0</term>
+ <itemizedlist>
+ <listitem>
+ <para>Das einzige Hash unter den globalen Variablen</para>
+ </listitem>
- <listitem>
- <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
- Tage</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Wird spätestens benötigt wenn auf die Datenbank
+ zugegriffen wird</para>
+ </listitem>
- <varlistentry>
- <term>c30</term>
+ <listitem>
+ <para>Wird bei jedem Request neu erstellt.</para>
+ </listitem>
- <listitem>
- <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
- < 60 Tage</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Enthält die Userdaten des aktuellen Logins</para>
+ </listitem>
- <varlistentry>
- <term>c60</term>
+ <listitem>
+ <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
+ extern serialisiert werden, weil da auch der Datenbankzugriff
+ für diesen user drinsteht.</para>
+ </listitem>
- <listitem>
- <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
- < 90 Tage</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Enthält unter anderem Listenbegrenzung vclimit,
+ Datumsformat dateformat und Nummernformat numberformat</para>
+ </listitem>
- <varlistentry>
- <term>c90</term>
+ <listitem>
+ <para>Enthält Datenbankzugriffinformationen</para>
+ </listitem>
+ </itemizedlist>
- <listitem>
- <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
- Tage</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
+ ein Userobjekt. Die meisten Funktionen, die etwas anhand des
+ aktuellen Users entscheiden müssen, befragen
+ <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
+ überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
+ -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
+ Informationen über den Benutzer die über die
+ Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
</sect3>
- </sect2>
- <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
- <title>Blöcke, bedingte Anweisungen und Schleifen</title>
+ <sect3>
+ <title>$::locale</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Objekt der Klasse "Locale"</para>
+ </listitem>
- <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
- <title>Einfürhung</title>
+ <listitem>
+ <para>Wird pro Request erstellt</para>
+ </listitem>
- <para>Der Parser kennt neben den Variablen einige weitere
- Konstrukte, die gesondert behandelt werden. Diese sind wie
- Variablennamen in spezieller Weise markiert:
- <command><%anweisung%> ... <%end%></command></para>
+ <listitem>
+ <para>Muss auch für Tests und Scripte immer verfügbar
+ sein.</para>
+ </listitem>
- <para>Anmerkung zum <command><%end%></command>: Der besseren
- Verständlichkeit halber kann man nach dem <command>end</command>
- noch beliebig weitere Wörter schreiben, um so zu markieren, welche
- Anweisung (z.B. <command>if</command> oder
- <command>foreach</command>) damit abgeschlossen wird.</para>
+ <listitem>
+ <para>Cached intern über Requestgrenzen hinweg benutzte
+ Locales</para>
+ </listitem>
+ </itemizedlist>
- <para>Beispiel: Lautet der Beginn eines Blockes z.B.
- <command><%if type == "sales_quotation"%></command>, so könnte
- er mit <command><%end%></command> genauso abgeschlossen werden
- wie mit <command><%end if%></command> oder auch
- <command><%end type == "sales_quotation"%></command>.</para>
+ <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
+ Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
</sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
- <title>Der if-Block</title>
+ <sect3>
+ <title>$::lxdebug</title>
- <programlisting><%if variablenname%>
-...
-<%end%></programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Objekt der Klasse "LXDebug"</para>
+ </listitem>
- <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
- und dem "end" werden nur ausgegeben, wenn die Variable
- <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
+ <listitem>
+ <para>Wird global gecached</para>
+ </listitem>
- <para>Die Bedingung kann auch negiert werden, indem das Wort
- <function>not</function> nach dem <filename>if</filename> verwendet
- wird. Beispiel:</para>
+ <listitem>
+ <para>Muss immer verfügbar sein, in nahezu allen
+ Funktionen</para>
+ </listitem>
+ </itemizedlist>
- <programlisting><%if not cp_greeting%>
-...
-<%end%></programlisting>
+ <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
+ bereit, wie "<function>enter_sub</function>" und
+ "<function>leave_sub</function>", mit denen in den alten Modulen ein
+ 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
+ denen man flott Informationen ins Log (tmp/lx-office-debug.log)
+ packen kann.</para>
- <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
- oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
- einer Variablen mit einer festen Zeichenkette oder einer anderen
- Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
- oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
- die rechte Seite des Vergleichsoperators in Anführungszeichen
- gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
- anderer Variablen). Zwei Beispiele, die beide Vergleiche
- zeigen:</para>
+ <para>Beispielsweise so:</para>
- <programlisting><%if var1 == "Wert"%></programlisting>
+ <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
+$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
+ </sect3>
- <para>Testet die Variable <varname>var1</varname> auf
- übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
- Mittels <function>!=</function> anstelle von <function>==</function>
- würde auf Ungleichheit getestet.</para>
+ <sect3>
+ <title>$::auth</title>
- <programlisting>%if var1 == var2%></programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Objekt der Klasse "SL::Auth"</para>
+ </listitem>
- <para>Testet die Variable <varname>var1</varname> auf
- übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
- <function>!=</function> anstelle von <function>==</function> würde
- auf Ungleichheit getestet.</para>
+ <listitem>
+ <para>Wird global gecached</para>
+ </listitem>
- <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
- auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
- Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
- dieselbe Syntax wie oben nur mit <function>=~</function> und
- <function>!~</function> als Vergleichsoperatoren.</para>
+ <listitem>
+ <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
+ </listitem>
- <para>Beispiel für einen Test, ob die Variable
- <varname>intnotes</varname> (interne Bemerkungen) das Wort
- <constant>schwierig</constant> enthält:</para>
+ <listitem>
+ <para>Wird nach jedem Request resettet.</para>
+ </listitem>
+ </itemizedlist>
- <programlisting><%if intnotes =~ "schwierig"%></programlisting>
+ <para><varname>$::auth</varname> stellt Funktionen bereit um die
+ Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
+ vom aktuellen User abhängen wird das Objekt aus
+ Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
+ Request kurz resettet.</para>
</sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
- <title>Der foreach-Block</title>
+ <sect3>
+ <title>$::lx_office_conf</title>
- <programlisting><%foreach variablenname%>
-...
-<%end%></programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Objekt der Klasse
+ "<classname>SL::LxOfficeConf</classname>"</para>
+ </listitem>
- <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
- wie das Perl-Array der Variablen <varname>variablenname</varname>
- Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
- Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
- benutzt. In jedem Durchlauf werden die <link
- linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
- Variablen</link> jeweils auf den Wert für die aktuelle Position
- gesetzt.</para>
+ <listitem>
+ <para>Global gecached</para>
+ </listitem>
- <para>Die Syntax sieht normalerweise wie folgt aus:</para>
+ <listitem>
+ <para>Repräsentation der
+ <filename>config/lx_office.conf[.default]</filename>-Dateien</para>
+ </listitem>
+ </itemizedlist>
- <programlisting><%foreach number%>
-Position: <%runningnumber%>
-Anzahl: <%qty%>
-Artikelnummer: <%number%>
-Beschreibung: <%description%>
-...
-<%end%></programlisting>
+ <para>Globale Konfiguration. Configdateien werden zum Start gelesen
+ und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
+ das Programm die Konfiguration ändern kann oder sollte.</para>
- <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
- <function><%foreach%></function>-Block innerhalb einer
- Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
- wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
- Inhalt zwischen <function><%foreach%></function> und
- <function><%end%></function> wiederholt, nicht aber die
- komplette Zeile, in der er steht.</para>
- </sect3>
- </sect2>
+ <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
+ Debug- und Trace-Log-Datei wie folgt konfiguriert und
+ verfügbar:</para>
- <sect2 id="dokumentenvorlagen-und-variablen.markup">
- <title>Markup-Code zur Textformatierung innerhalb von
- Formularen</title>
+ <programlisting>[debug]
+file = /tmp/lx-office-debug.log</programlisting>
- <para>Wenn der Benutzer innhalb von Formularen in Lx-Office Text
- anders formatiert haben möchte, so ist dies begrenzt möglich.
- Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags.
- 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
- (HTML oder PDF über LaTeX) umgesetzt.</para>
+ <para>ist der Key <varname>file</varname> im Programm als
+ <varname>$::lx_office_conf->{debug}{file}</varname>
+ erreichbar.</para>
- <para>Die unterstützen Formatierungen sind:</para>
+ <warning>
+ <para>Zugriff auf die Konfiguration erfolgt im Moment über
+ Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
+ </warning>
+ </sect3>
- <variablelist>
- <varlistentry>
- <term><b>Text</b></term>
+ <sect3>
+ <title>$::instance_conf</title>
+ <itemizedlist>
<listitem>
- <para>Text wird in Fettdruck gesetzt.</para>
+ <para>Objekt der Klasse
+ "<classname>SL::InstanceConfiguration</classname>"</para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term><i>Text</i></term>
<listitem>
- <para>Text wird kursiv gesetzt.</para>
+ <para>wird pro Request neu erstellt</para>
</listitem>
- </varlistentry>
+ </itemizedlist>
- <varlistentry>
- <term><u>Text</u></term>
+ <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
+ speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
+ ist hier eine Mandantendatenbank. Beispielsweise überprüft
+ <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
+ ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
+ </sect3>
+
+ <sect3>
+ <title>$::dispatcher</title>
+ <itemizedlist>
<listitem>
- <para>Text wird unterstrichen.</para>
+ <para>Objekt der Klasse
+ "<varname>SL::Dispatcher</varname>"</para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term><s>Text</s></term>
<listitem>
- <para>Text wird durchgestrichen. Diese Formatierung ist nicht
- bei der Ausgabe als PDF über LaTeX verfügbar.</para>
+ <para>wird pro Serverprozess erstellt.</para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term><bullet></term>
<listitem>
- <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
- unten).</para>
+ <para>enthält Informationen über die technische Verbindung zum
+ Server</para>
</listitem>
- </varlistentry>
- </variablelist>
+ </itemizedlist>
- <para>Der Befehl <command><bullet></command> funktioniert
- momentan auch nur in Latex-Vorlagen.</para>
- </sect2>
- </sect1>
+ <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
+ global gespeichert wird. Wird vermutlich irgendwann in einem anderen
+ Objekt untergebracht.</para>
+ </sect3>
- <sect1 id="excel-templates">
- <title>Excel-Vorlagen</title>
+ <sect3>
+ <title>$::request</title>
- <sect2 id="excel-templates.summary">
- <title>Zusammenfassung</title>
+ <itemizedlist>
+ <listitem>
+ <para>Hashref (evtl später Objekt)</para>
+ </listitem>
- <para>Dieses Dokument beschreibt den Mechanismus, mit dem
- Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
- einhergehen.</para>
- </sect2>
+ <listitem>
+ <para>Wird pro Request neu initialisiert.</para>
+ </listitem>
+
+ <listitem>
+ <para>Keine Unterstruktur garantiert.</para>
+ </listitem>
+ </itemizedlist>
- <sect2 id="excel-templates.usage">
- <title>Bedienung</title>
+ <para><varname>$::request</varname> ist ein generischer Platz um
+ Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
+ at a distance benutzt werden, sondern um lokales memoizing zu
+ ermöglichen, das garantiert am Ende des Requests zerstört
+ wird.</para>
- <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
- werden. Die Konfigurationsoption heißt <varname>excel_templates =
- 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
+ <para>Vieles von dem, was im moment in <varname>$::form</varname>
+ liegt, sollte eigentlich hier liegen. Die groben
+ Differentialkriterien sind:</para>
- <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
- anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
- werden. In den normalen Verkaufsmasken taucht nun
- <constant>Excel</constant> als auswählbares Format auf und kann von da
- an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Kommt es vom User, und soll unverändert wieder an den
+ User? Dann <varname>$::form</varname>, steht da eh schon</para>
+ </listitem>
- <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
- eine Angebotsvorlage und wird unter dem internen Namen der Angebote
- <filename>sales_quotation.xls</filename> gespeichert.</para>
+ <listitem>
+ <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
+ Requests gebraucht werden? Dann
+ <varname>$::request</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Muss ich von anderen Teilen des Programms lesend drauf
+ zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
+ Wrappermethode</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
</sect2>
- <sect2 id="excel-templates.syntax">
- <title>Variablensyntax</title>
+ <sect2>
+ <title>Ehemalige globale Variablen</title>
- <para>Einfache Syntax:
- <command><<varname>></command></para>
+ <para>Die folgenden Variablen waren einmal im Programm, und wurden
+ entfernt.</para>
- <para>Dabei sind <constant><<</constant> und
- <constant>>></constant> die Delimiter. Da Excel auf festen
- Breiten besteht, kann der Tag künstlich verlängert werden, indem
- weitere <constant><</constant> oder <constant>></constant>
- eingefügt werden. Der Tag muss nicht symmetrisch sein.
- Beispiel:</para>
+ <sect3>
+ <title>$::cgi</title>
- <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>war nötig, weil cookie Methoden nicht als
+ Klassenfunktionen funktionieren</para>
+ </listitem>
- <para>Um die Limitierung der festen Breite zu reduzieren, können
- weitere Variablen in einem Block interpoliert werden. Whitespace wird
- dazwishen dann erhalten. Beispiel:</para>
+ <listitem>
+ <para>Aufruf als Klasse erzeugt Dummyobjekt was im
+ Klassennamespace gehalten wird und über Requestgrenzen
+ leaked</para>
+ </listitem>
- <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
+ <listitem>
+ <para>liegt jetzt unter
+ <varname>$::request->{cgi}</varname></para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
- <para>Die Variablen werden interpoliert, und linksbündig mit
- Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
- lang, werden überzählige Zeichen abgeschnitten.</para>
+ <sect3>
+ <title>$::all_units</title>
- <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
- der Block mit einem Leerzeichen anfängt. Beispiel:</para>
+ <itemizedlist>
+ <listitem>
+ <para>war nötig, weil einige Funktionen in Schleifen zum Teil
+ ein paar hundert mal pro Request eine Liste der Einheiten
+ brauchen, und de als Parameter durch einen Riesenstack von
+ Funktionen geschleift werden müssten.</para>
+ </listitem>
- <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
+ <listitem>
+ <para>Liegt jetzt unter
+ <varname>$::request->{cache}{all_units}</varname></para>
+ </listitem>
- <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
- Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
- entfernt.</para>
- </sect2>
+ <listitem>
+ <para>Wird nur in
+ <function>AM->retrieve_all_units()</function> gesetzt oder
+ gelesen.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
- <sect2 id="excel-templates.limitations">
- <title>Einschränkungen</title>
+ <sect3>
+ <title>%::called_subs</title>
- <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
- mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
- beschränkt sich daher darauf, Textstellen exakt durch einen anderen
- Text zu ersetzen.</para>
+ <itemizedlist>
+ <listitem>
+ <para>wurde benutzt um callsub deep recursions
+ abzufangen.</para>
+ </listitem>
- <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
- <command><%if%></command> und
- <command><%foreach%></command> nicht vorhanden. Der Delimiter
- <constant><% %></constant> kommt in den Headerinformationen
- evtl. vor. Deshalb wurde auf den sichereren Delimiter
- <constant><<</constant> und <constant>>></constant>
- gewechselt.</para>
+ <listitem>
+ <para>Wurde entfernt, weil callsub nur einen Bruchteil der
+ möglichen Rekursioenen darstellt, und da nie welche
+ auftreten.</para>
+ </listitem>
+
+ <listitem>
+ <para>komplette recursion protection wurde entfernt.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
</sect2>
</sect1>
</sect1>
<sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
- <title>SQL-Upgradedateien</title>
+ <title>SQL-Upgradedateien</title>
- <sect2 id="db-upgrade-files.introduction" xreflabel="Einführung in die Datenbank-Upgradedateien">
- <title>Einführung</title>
+ <sect2 id="db-upgrade-files.introduction"
+ xreflabel="Einführung in die Datenbank-Upgradedateien">
+ <title>Einführung</title>
- <para>
- Der alte Mechanismus für SQL-Upgradescripte, der auf einer Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
- diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele Entwicklung im stable- und unstable-Baum betrifft.
- </para>
+ <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
+ Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
+ diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
+ Entwicklung im stable- und unstable-Baum betrifft.</para>
+
+ <para>Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert.
+ 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,
+ die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
+ Kontrollinformationen enthält.</para>
+
+ <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
+ Prioritäten definieren können werden, sodass Datenbankscripte zwar in
+ einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
+ TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
+ angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
+ keine Versionsnummern mehr braucht.</para>
+
+ <para>Lx-Office merkt sich dabei, welches der Upgradescripte in
+ 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>
+ </sect2>
- <para>
- Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert. 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, die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige Kontrollinformationen enthält.
- </para>
+ <sect2 id="db-upgrade-files.format"
+ xreflabel="Format der Upgradedateien">
+ <title>Format der Kontrollinformationen</title>
- <para>
- Neu sind die Kontrollinformationen, die Abhängigkeiten und Prioritäten definieren können werden, sodass Datenbankscripte zwar in
- einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
- angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern mehr braucht.
- </para>
+ <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
+ Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
+ hat dabei das folgende Format:</para>
- <para>
- Lx-Office merkt sich dabei, welches der Upgradescripte in 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>
- </sect2>
+ <para>Für SQL-Upgradedateien:</para>
- <sect2 id="db-upgrade-files.format" xreflabel="Format der Upgradedateien">
- <title>Format der Kontrollinformationen</title>
+ <programlisting>-- @key: value</programlisting>
- <para>
- Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
- hat dabei das folgende Format:
- </para>
+ <para>Für Perl-Upgradedateien:</para>
- <para>
- Für SQL-Upgradedateien:
- </para>
+ <programlisting># @key: value</programlisting>
- <programlisting>-- @key: value</programlisting>
+ <para>Leerzeichen vor "<varname>value</varname>" werden
+ entfernt.</para>
- <para>
- Für Perl-Upgradedateien:
- </para>
+ <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
- <programlisting># @key: value</programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><varname>tag</varname></term>
- <para>
- Leerzeichen vor "<varname>value</varname>" werden entfernt.
- </para>
+ <listitem>
+ <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
+ Dieser "tag" kann von anderen Kontrolldateien in ihren
+ Abhängigkeiten verwendet werden (Schlüsselwort
+ "<varname>depends</varname>"). Der "tag" ist auch der Name, der
+ in der Datenbank eingetragen wird.</para>
+
+ <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
+ der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
+
+ <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
+ Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
+ erlaubt und sollten stattdessen mit Unterstrichen ersetzt
+ werden.</para>
+ </listitem>
+ </varlistentry>
- <para>
- Die folgenden Schlüsselworte werden verarbeitet:
- </para>
+ <varlistentry>
+ <term><varname>charset</varname></term>
- <variablelist>
- <varlistentry>
- <term>tag</term>
- <listitem>
- <para>
- Wird zwingend benötigt. Dies ist der "Name" des Upgrades. Dieser "tag" kann von anderen Kontrolldateien in ihren Abhängigkeiten
- verwendet werden (Schlüsselwort "<varname>depends</varname>"). Der "tag" ist auch der Name, der in der Datenbank eingetragen wird.
- </para>
-
- <para>
- Normalerweise sollte die Kontrolldatei genau so heißen wie der "tag", nur mit der Endung ".sql" bzw. "pl".
- </para>
-
- <para>
- Ein Tag darf nur aus alphanumerischen Zeichen sowie den Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht erlaubt und
- sollten stattdessen mit Unterstrichen ersetzt werden.
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
+ geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
+ Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
+ Abwesenheit des Tags der Zeichensatz
+ "<literal>ISO-8859-15</literal>" angenommen.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>charset</term>
- <listitem>
- <para>
- Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
- Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags der Zeichensatz "<literal>ISO-8859-15</literal>"
- angenommen.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><varname>description</varname></term>
- <varlistentry>
- <term>description</term>
- <listitem>
- <para>
- Benötigt. Eine Beschreibung, was in diesem Update passiert. Diese wird dem Benutzer beim eigentlichen Datenbankupdate
- angezeigt. Während der Tag in englisch gehalten sein sollte, sollte die Beschreibung auf Deutsch erfolgen.
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Benötigt. Eine Beschreibung, was in diesem Update
+ passiert. Diese wird dem Benutzer beim eigentlichen
+ Datenbankupdate angezeigt. Während der Tag in englisch gehalten
+ sein sollte, sollte die Beschreibung auf Deutsch
+ erfolgen.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>depends</term>
- <listitem>
- <para>
- Optional. Eine mit Leerzeichen getrennte Liste von "tags", von denen dieses Upgradescript abhängt. Lx-Office stellt sicher, dass
- die in dieser Liste aufgeführten Scripte bereits durchgeführt wurden, bevor dieses Script ausgeführt wird.
- </para>
-
- <para>
- Abhängigkeiten werden rekursiv betrachtet. Wenn also ein Script "b" existiert, das von Änderungen in "a" abhängt, und eine neue
- Kontrolldatei für "c" erstellt wird, die von Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den Tag "b" als
- Abhängigkeit zu definieren.
- </para>
-
- <para>
- Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu definieren (z.B. "a" -> "b",
- "b" -> "c" und "c" -> "a").
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><varname>depends</varname></term>
- <varlistentry>
- <term>priority</term>
- <listitem>
- <para>
- Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in der Scripte ausgeführt werden, die die gleichen Abhängigkeitstiefen
- besitzen. Fehlt dieser Parameter, so wird der Wert 1000 benutzt.
- </para>
-
- <para>
- Dies ist reine Kosmetik. Für echte Reihenfolgen muss "depends" benutzt werden. Lx-Office sortiert die auszuführenden 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, dann "y", dann "z"), dann nach der Priorität und bei gleicher Priorität
- alphabetisch nach dem "tag".
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
+ <listitem>
+ <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
+ von denen dieses Upgradescript abhängt. Lx-Office stellt sicher,
+ dass die in dieser Liste aufgeführten Scripte bereits
+ durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
+
+ <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
+ Script "b" existiert, das von Änderungen in "a" abhängt, und
+ eine neue Kontrolldatei für "c" erstellt wird, die von
+ Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
+ Tag "b" als Abhängigkeit zu definieren.</para>
+
+ <para>Es ist nicht erlaubt, sich selbst referenzierende
+ Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
+ und "c" -> "a").</para>
+ </listitem>
+ </varlistentry>
- <sect2 id="db-upgrade-files.dbupgrade-tool" xreflabel="Hilfsscript dbupgrade2_tool.pl">
- <title>Hilfsscript dbupgrade2_tool.pl</title>
+ <varlistentry>
+ <term><varname>priority</varname></term>
- <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 Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses
- Tool liest alle Datenbankupgradescripte aus dem Verzeichnis <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die gleichen
- Methoden wie Lx-Office selber, sodass alle Fehlersituationen von der Kommandozeile überprüft werden können.
- </para>
+ <listitem>
+ <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
+ der Scripte ausgeführt werden, die die gleichen
+ Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
+ der Wert 1000 benutzt.</para>
+
+ <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
+ "depends" benutzt werden. Lx-Office sortiert die auszuführenden
+ 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,
+ dann "y", dann "z"), dann nach der Priorität und bei gleicher
+ Priorität alphabetisch nach dem "tag".</para>
+ </listitem>
+ </varlistentry>
- <para>
- Wird dem Script kein weiterer Parameter übergeben, so wird nur eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
- sich aber auch Informationen auf verschiedene Art ausgeben lassen:
- </para>
+ <varlistentry>
+ <term><varname>ignore</varname></term>
- <itemizedlist>
- <listitem>
- <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl --list</command>"</para>
+ <listitem>
+ <para>Optional. Falls der Wert auf 1 (true) steht, wird das
+ Skript bei der Anmeldung ignoriert und entsprechend nicht
+ ausgeführt.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
- <para>
- Gibt eine Liste aller Scripte aus. Die Liste ist in der Reihenfolge sortiert, in der Lx-Office die Scripte ausführen würde. Es
- werden neben der Listenposition der Tag, die Abhängigkeitstiefe und die Priorität ausgegeben.
- </para>
- </listitem>
+ <sect2 id="db-upgrade-files.dbupgrade-tool"
+ xreflabel="Hilfsscript dbupgrade2_tool.pl">
+ <title>Hilfsscript dbupgrade2_tool.pl</title>
- <listitem>
- <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl --tree</command>"</para>
+ <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
+ Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
+ liest alle Datenbankupgradescripte aus dem Verzeichnis
+ <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
+ gleichen Methoden wie Lx-Office selber, sodass alle Fehlersituationen
+ von der Kommandozeile überprüft werden können.</para>
- <para>
- Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von denen keine
- anderen abhängen. Die Unterknoten sind Scripte, die beim übergeordneten Script als Abhängigkeit eingetragen sind.
- </para>
- </listitem>
+ <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
+ eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
+ sich aber auch Informationen auf verschiedene Art ausgeben
+ lassen:</para>
- <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
- <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl --rtree</command>"</para>
+ <itemizedlist>
+ <listitem>
+ <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
+ --list</command>"</para>
- <para>
- Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit der geringsten
- Abhängigkeitstiefe. Die Unterknoten sind Scripte, die das übergeordnete Script als Abhängigkeit eingetragen haben.
- </para>
- </listitem>
+ <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
+ Reihenfolge sortiert, in der Lx-Office die Scripte ausführen
+ würde. Es werden neben der Listenposition der Tag, die
+ Abhängigkeitstiefe und die Priorität ausgegeben.</para>
+ </listitem>
- <listitem>
- <para>Baumform mit Postscriptausgabe: "<command>./scripts/dbupgrade2_tool.pl --graphviz</command>"</para>
+ <listitem>
+ <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
+ --tree</command>"</para>
+
+ <para>Listet alle Tags in Baumform basierend auf den
+ Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
+ denen keine anderen abhängen. Die Unterknoten sind Scripte, die
+ beim übergeordneten Script als Abhängigkeit eingetragen
+ sind.</para>
+ </listitem>
- <para>
- Benötigt das Tool "<command>graphviz</command>", um mit seiner Hilfe die <link
- linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte Baumform</link> in eine Postscriptdatei namens
- "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist vermutlich die übersichtlichste Form, weil hierbei jeder Knoten nur
- einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben werden.
- </para>
- </listitem>
+ <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
+ <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
+ --rtree</command>"</para>
- <listitem>
- <para>
- Scripte, von denen kein anderes Script abhängt: "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"
- </para>
+ <para>Listet alle Tags in Baumform basierend auf den
+ Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
+ der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
+ die das übergeordnete Script als Abhängigkeit eingetragen
+ haben.</para>
+ </listitem>
- <para>
- Listet die Tags aller Scripte auf, von denen keine anderen Scripte abhängen.
- </para>
- </listitem>
- </itemizedlist>
- </sect2>
+ <listitem>
+ <para>Baumform mit Postscriptausgabe:
+ "<command>./scripts/dbupgrade2_tool.pl
+ --graphviz</command>"</para>
+
+ <para>Benötigt das Tool "<command>graphviz</command>", um mit
+ seiner Hilfe die <link
+ linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
+ Baumform</link> in eine Postscriptdatei namens
+ "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
+ vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
+ nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
+ können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
+ werden.</para>
+ </listitem>
+
+ <listitem>
+ <para>Scripte, von denen kein anderes Script abhängt:
+ "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
+
+ <para>Listet die Tags aller Scripte auf, von denen keine anderen
+ Scripte abhängen.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
</sect1>
<sect1 id="translations-languages" xreflabel="Translations and languages">
</varlistentry>
</variablelist>
</sect2>
+ </sect1>
- <sect2 id="devel.style-guide">
- <title>Stil-Richtlinien</title>
+ <sect1 id="devel.style-guide">
+ <title>Stil-Richtlinien</title>
- <para>
- Die folgenden Regeln haben das Ziel, den Code möglichst gut les- und wartbar zu machen. Dazu gehört zum Einen, dass der Code
- einheitlich eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden wird (Stichworte "Klammern" oder "Hash-Keys").
- </para>
+ <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
+ und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
+ eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
+ wird (Stichworte "Klammern" oder "Hash-Keys").</para>
- <para>
- Diese Regeln sind keine Schikane sondern erleichtern allen das Leben!
- </para>
+ <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
+ Leben!</para>
- <para>
- Jeder, der einen Patch schickt, sollte seinen Code vorher überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
- nicht.
- </para>
+ <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
+ überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
+ nicht.</para>
- <orderedlist>
+ <orderedlist>
<listitem>
- <para>
- Es werden keine echten Tabs sondern Leerzeichen verwendet.
- </para>
+ <para>Es werden keine echten Tabs sondern Leerzeichen
+ verwendet.</para>
</listitem>
<listitem>
- <para>
- Die Einrückung beträgt zwei Leerzeichen. Beispiel:
- </para>
+ <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
- <programlisting>foreach my $row (@data) {
+
<programlisting>foreach my $row (@data) {
if ($flag) {
# do something with $row
}
</listitem>
<listitem>
- <para>Öffnende geschweifte Klammern befinden sich auf der gleichen Zeile wie der letzte Befehl. Beispiele:</para>
+ <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
+ Zeile wie der letzte Befehl. Beispiele:</para>
- <programlisting>sub debug {
+
<programlisting>sub debug {
...
}</programlisting>
- <para>oder</para>
- <programlisting>if ($form->{item_rows} > 0) {
+
<programlisting>if ($form->{item_rows} > 0) {
...
}</programlisting>
</listitem>
<listitem>
- <para>
- Schließende geschweifte Klammern sind so weit eingerückt wie der Befehl / die öffnende schließende Klammer, die den Block gestartet
- hat, und nicht auf der Ebene des Inhalts. Die gleichen Beispiele wie bei 3. gelten.
- </para>
+ <para>Schließende geschweifte Klammern sind so weit eingerückt wie
+ der Befehl / die öffnende schließende Klammer, die den Block
+ gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
+ Beispiele wie bei 3. gelten.</para>
</listitem>
<listitem>
- <para>
- Die Wörter "<function>else</function>", "<function>elsif</function>", "<function>while</function>" befinden sich auf der gleichen
- Zeile wie schließende geschweifte Klammern. Beispiele:
- </para>
+ <para>Die Wörter "<function>else</function>",
+ "<function>elsif</function>", "<function>while</function>" befinden
+ sich auf der gleichen Zeile wie schließende geschweifte Klammern.
+ Beispiele:</para>
- <programlisting>if ($form->{sum} > 1000) {
+
<programlisting>if ($form->{sum} > 1000) {
...
} elsif ($form->{sum} > 0) {
...
</listitem>
<listitem>
- <para>
- Parameter von Funktionsaufrufen müssen mit runden Klammern versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
- und grep-ähnliche Operatoren. Beispiel:
- </para>
+ <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
+ versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
+ und grep-ähnliche Operatoren. Beispiel:</para>
- <programlisting>$main::lxdebug->message("Could not find file.");
+ <programlisting>$main::lxdebug->message("Could not find file.");
%options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
</listitem>
<listitem>
- <para>
- Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:
- </para>
+ <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
- <para>
- Generell gilt: Hashkeys und Arrayindices sollten nicht durch Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
- Blöcke schon. Beispiel:
- </para>
+ <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
+ Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
+ Blöcke schon. Beispiel:</para>
- <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
+
<programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
...
}
$array[$i + 1] = 4;
-$form->{sum} += $form->{"row_$i"};
+$form->{sum} += $form->{"row_$i"};
$form->{ $form->{index} } += 1;
-map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
+map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
</listitem>
<listitem>
- <para>
- Mehrzeilige Befehle
- </para>
+ <para>Mehrzeilige Befehle</para>
- <orderedlist>
- <listitem>
- <para>
- Werden die Parameter eines Funktionsaufrufes auf mehrere Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
- werden, in der die ersten Funktionsparameter in der ersten Zeile stehen. Beispiel:
- </para>
+ <orderedlist>
+ <listitem>
+ <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
+ Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
+ werden, in der die ersten Funktionsparameter in der ersten Zeile
+ stehen. Beispiel:</para>
- <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
- $form->{some_col_value});</programlisting>
- </listitem>
+ <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
+ $form->{some_col_value});</programlisting>
+ </listitem>
- <listitem>
- <para>
- Ein Spezialfall ist der ternäre Oprator "?:", der am besten in einer übersichtlichen Tabellenstruktur organisiert
- wird. Beispiel:
- </para>
+ <listitem>
+ <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
+ besten in einer übersichtlichen Tabellenstruktur organisiert
+ wird. Beispiel:</para>
- <programlisting>my $rowcount = $form->{"row_$i"} ? $i
+ <programlisting>my $rowcount = $form->{"row_$i"} ? $i
: $form->{oldcount} ? $form->{oldcount} + 1
: $form->{rowcount} - $form->{rowbase};</programlisting>
- </listitem>
- </orderedlist>
+ </listitem>
+ </orderedlist>
</listitem>
<listitem>
- <para>
- Kommentare
- </para>
+ <para>Kommentare</para>
- <orderedlist>
- <listitem>
- <para>Kommentare, die alleine in einer Zeile stehen, sollten soweit wie der Code eingerückt sein.</para>
- </listitem>
+ <orderedlist>
+ <listitem>
+ <para>Kommentare, die alleine in einer Zeile stehen, sollten
+ soweit wie der Code eingerückt sein.</para>
+ </listitem>
- <listitem>
- <para>Seitliche hängende Kommentare sollten einheitlich formatiert werden.</para>
- </listitem>
+ <listitem>
+ <para>Seitliche hängende Kommentare sollten einheitlich
+ formatiert werden.</para>
+ </listitem>
- <listitem>
- <para>
- Sämtliche Kommentare und Sonstiges im Quellcode ist bitte auf Englisch zu verfassen. So wie ich keine Lust habe, französischen
- Quelltext zu lesen, sollte auch der Lx-Office Quelltext für nicht-Deutschsprachige lesbar sein. Beispiel:
- </para>
+ <listitem>
+ <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
+ auf Englisch zu verfassen. So wie ich keine Lust habe,
+ französischen Quelltext zu lesen, sollte auch der Lx-Office
+ Quelltext für nicht-Deutschsprachige lesbar sein.
+ Beispiel:</para>
- <programlisting>my $found = 0;
+
<programlisting>my $found = 0;
while (1) {
last if $found;
$found = 1 if //
}
-$i = 0 # initialize $i
-$n = $i; # save $i
+$i = 0 # initialize $i
+$n = $i; # save $i
$i *= $const; # do something crazy
-$i = $n; # recover $i</programlisting>
- </listitem>
- </orderedlist>
+$i = $n; # recover $i</programlisting>
+ </listitem>
+ </orderedlist>
</listitem>
<listitem>
- <para>
- Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation gewünscht ist. Beispiel:
- </para>
+ <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
+ Interpolation gewünscht ist. Beispiel:</para>
- <programlisting>$form->{sum} = 0;
-$form->{"row_$i"} = $form->{"row_$i"} - 5;
+
<programlisting>$form->{sum} = 0;
+$form->{"row_$i"} = $form->{"row_$i"} - 5;
$some_hash{42} = 54;</programlisting>
</listitem>
<listitem>
- <para>
- Die maximale Zeilenlänge ist nicht bescränkt. Zeilenlängen unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
- wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in grossen Tabellen), dann ist Lesbarkeit vorzuziehen.
- </para>
-
- <para>
- Als Beispiel sei die Funktion <function>print_options</function> aus <filename>bin/mozilla/io.pl</filename> angeführt.
- </para>
+ <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
+ unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
+ wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
+ grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
+
+ <para>Als Beispiel sei die Funktion
+ <function>print_options</function> aus
+ <filename>bin/mozilla/io.pl</filename> angeführt.</para>
</listitem>
<listitem>
- <para>
- Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die
- diffs verfälschen.
- </para>
-
- <para>
- Emacs und vim haben beide recht einfache Methoden zur Entfernung von trailing whitespace. Emacs kennt das Kommande
- <command>nuke-trailing-whitespace</command>, vim macht das gleiche manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
- BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern gebunden.
- </para>
+ <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
+ unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
+ verfälschen.</para>
+
+ <para>Emacs und vim haben beide recht einfache Methoden zur
+ Entfernung von trailing whitespace. Emacs kennt das Kommande
+ <command>nuke-trailing-whitespace</command>, vim macht das gleiche
+ manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
+ BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
+ gebunden.</para>
</listitem>
<listitem>
- <para>
- Es wird kein <command>perltidy</command> verwendet.
- </para>
-
- <para>
- In der Vergangenheit wurde versucht, <command>perltidy</command> zu verwenden, um einen einheitlichen Stil zu erlangen. Es hat
- sich aber gezeigt, dass <command>perltidy</command>s sehr eigenwilliges Verhalten, was Zeilenumbrüche angeht, oftmals gut
- formatierten Code zerstört. Für den Interessierten sind hier die <command>perltidy</command>-Optionen, die grob den
- beschriebenen Richtlinien entsprechen:
- </para>
-
- <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
+ <para>Es wird kein <command>perltidy</command> verwendet.</para>
+
+ <para>In der Vergangenheit wurde versucht,
+ <command>perltidy</command> zu verwenden, um einen einheitlichen
+ Stil zu erlangen. Es hat sich aber gezeigt, dass
+ <command>perltidy</command>s sehr eigenwilliges Verhalten, was
+ Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
+ den Interessierten sind hier die
+ <command>perltidy</command>-Optionen, die grob den beschriebenen
+ Richtlinien entsprechen:</para>
+
+
<programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
-aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
-lp -vt=1 -vtc=1</programlisting>
</listitem>
<listitem>
- <para>
- <varname>STDERR</varname> ist tabu. Unkonditionale Debugmeldungen auch.
- </para>
-
- <para>
- Lx-Office bietet mit dem Modul <classname>LXDebug</classname> einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
- Grund, nach <varname>STDERR</varname> zu schreiben.
- </para>
-
- <para>
- Die <classname>LXDebug</classname>-Methode "<function>message</function>" nimmt als ersten Paramter außerdem eine Flagmaske, für
- die die Meldung angezeigt wird, wobei "0" immer angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden und werden in
- den meisten Fällen auch vom Repository zurückgewiesen.
- </para>
+ <para><varname>STDERR</varname> ist tabu. Unkonditionale
+ Debugmeldungen auch.</para>
+
+ <para>Lx-Office bietet mit dem Modul <classname>LXDebug</classname>
+ einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
+ Grund, nach <varname>STDERR</varname> zu schreiben.</para>
+
+ <para>Die <classname>LXDebug</classname>-Methode
+ "<function>message</function>" nimmt als ersten Paramter außerdem
+ eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
+ angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
+ und werden in den meisten Fällen auch vom Repository
+ zurückgewiesen.</para>
</listitem>
<listitem>
- <para>
- Alle neuen Module müssen use strict verwenden.
- </para>
-
- <para>
- <varname>$form</varname>, <varname>$auth</varname>, <varname>$locale</varname>, <varname>$lxdebug</varname> und
- <varname>%myconfig</varname> werden derzeit aus dem main package importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
- Konstrukte sollten lexikalisch lokal gehalten werden.
- </para>
+ <para>Alle neuen Module müssen use strict verwenden.</para>
+
+ <para><varname>$form</varname>, <varname>$auth</varname>,
+ <varname>$locale</varname>, <varname>$lxdebug</varname> und
+ <varname>%myconfig</varname> werden derzeit aus dem main package
+ importiert (siehe <xref linkend="devel.globals" />. Alle anderen
+ Konstrukte sollten lexikalisch lokal gehalten werden.</para>
</listitem>
- </orderedlist>
+ </orderedlist>
+ </sect1>
+
+ <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
+ <title>Dokumentation erstellen</title>
+
+ <sect2 id="devel.build-doc.introduction">
+ <title>Einführung</title>
+
+ <para>Diese Dokumentation ist in <productname>DocBook</productname>
+ 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
+ <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
+ <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
+ Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
+ ist.</para>
+ </sect2>
+
+ <sect2 id="devel.build-doc.required-software">
+ <title>Benötigte Software</title>
+
+ <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
+ erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script
+ <command>scripts/build_doc.sh</command>.</para>
+
+ <para>Das Script benötigt zur Konvertierung verschiedene
+ Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht benötigt
+ werden:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><ulink
+ url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
+ in einer halbwegs aktuellen Version</para>
+ </listitem>
+
+ <listitem>
+ <para>Das Java-Build-System <ulink
+ url="http://ant.apache.org/">Apache Ant</ulink></para>
+ </listitem>
+
+ <listitem>
+ <para>Das Dokumentations-System Dobudish für
+ <productname>DocBook</productname> 4.5, eine Zusammenstellung
+ diverser Stylesheets und Grafiken zur Konvertierung von
+ <productname>DocBook</productname> XML in andere Formate. Das
+ Paket, das benötigt wird, ist zum Zeitpunkt der
+ Dokumentationserstellung
+ <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
+ url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
+ bereitsteht.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
+ sind auf allen gängigen Plattformen verfügbar. Beispiel für
+ Debian/Ubuntu:</para>
+
+ <programlisting>apt-get install ant openjdk-7-jre</programlisting>
+
+ <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
+ <filename>doc/build</filename> entpackt werden. Beispiel unter der
+ Annahme, das <productname>Dobudish</productname> in
+ <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
+
+ <programlisting>cd doc/build
+unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
+ </sect2>
+
+ <sect2 id="devel.build-doc.build">
+ <title>PDFs und HTML-Seiten erstellen</title>
+
+ <para>Die eigentliche Konvertierung erfolgt nach Installation der
+ benötigten Software mit einem einfachen Aufruf direkt aus dem
+ Lx-Office-Installationsverzeichnis heraus:</para>
+
+ <programlisting>./scripts/build_doc.sh</programlisting>
+ </sect2>
+
+ <sect2 id="devel.build-doc.repository">
+ <title>Einchecken in das Git-Repository</title>
+
+ <para>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.</para>
+
+ <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
+ symbolischen Links gehören hingegen nicht in das Repository.</para>
</sect2>
</sect1>
</chapter>
projects / kivitendo-erp.git / blobdiff