<?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">
- <title>Lx-Office: Installation, Konfiguration, Entwicklung</title>
+<book id="kivitendo-documentation" lang="de">
+ <title>kivitendo: Installation, Konfiguration, Entwicklung</title>
<chapter id="Aktuelle-Hinweise">
<title>Aktuelle Hinweise</title>
<itemizedlist>
<listitem>
- <para>
auf der Lx-Office-Homepage unter <ulink
- url="http://lx-office.org/index.php?id=dokumentation">http://lx-office.org/index.php?id=dokumentation</ulink></para>
+ <para>
im kivitendo-Forum: <ulink
+ url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
</listitem>
<listitem>
- <para>im Lx-Office-Wiki unter Dokumentation (<ulink
- url="http://wiki.lx-office.org/index.php/Lx-Office_ERP">http://wiki.lx-office.org/index.php/Lx-Office_ERP</ulink>)</para>
- </listitem>
-
- <listitem>
- <para>im Lx-Office-Forum: <ulink
- url="http://www.lx-office.org/forum/">http://www.lx-office.org/forum/</ulink></para>
+ <para>im alten Lx-Office-Wiki unter Dokumentation (<ulink
+ url="http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP">http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP</ulink>)</para>
</listitem>
</itemizedlist>
-
- <!-- -->
</chapter>
- <chapter>
+ <chapter id="config">
<title>Installation und Grundkonfiguration</title>
<sect1 id="Benötigte-Software-und-Pakete">
<sect2 id="Betriebssystem">
<title>Betriebssystem</title>
- <para>Lx-Office ist für Linux konzipiert, und sollte auf jedem
+ <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
ohne große Probleme auf den derzeit aktuellen verbreiteten
Distributionen läuft.</para>
- <para>Anfang 2011 sind das folgende Systeme:</para>
+ <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
+ dass kivitendo 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 10.04 LTS Lucid Lynx bis 12.04 Precise Pangolin</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 16</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
- Release ein eigenes .deb geben.</para>
-
- <para>Alternativ dazu kann die normale Installation durchgeführt
- werden (siehe <xref
- 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>
- unter dem Namen <filename>lx-erp-perl-libs-compat-v2.tar.gz</filename>
- hinterlegt.</para>
-
- <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>
-
- <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>
-
- <para>Danach sollte der Installationscheck (siehe <xref
- linkend="Pakete"/>) die enthaltenen Pakete erkennen.</para>
</sect2>
<sect2 id="Pakete" xreflabel="Pakete">
<title>Pakete</title>
- <para>Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist
+ <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
benötigt.</para>
- <para>Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die
+ <para>Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die
nicht Bestandteil einer Standard-Perl-Installation sind:</para>
<itemizedlist>
<para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
hinzugekommen, <literal>URI</literal> und
- <literal>XML::Writer</literal> sind notwendig. Ohne startet Lx-Office
+ <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
nicht.</para>
<para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
<para><literal>Email::Address</literal> und
<literal>List::MoreUtils</literal> sind schon länger feste
- Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide
+ Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
zukünftigen Version aber aus dem Paket entfernt werden. Es wird
empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
<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 libclass-accessor-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
<literal>Rose::*</literal> Pakete sind derzeit nicht für SuSE gepackt,
und müssen anderweitig nachinstalliert werden.</para>
- <para>Lx-Office enthält ein Script, mit dem überprüft werden kann, ob
+ <para>kivitendo enthält ein Script, mit dem überprüft werden kann, ob
alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
folgt:</para>
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 kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird
im Dokumentenverzeichnis des Webservers (z.B.
<filename>/var/www/html/</filename>,
<filename>/srv/www/htdocs</filename> oder
<filename>/var/www/</filename>) entpackt:</para>
- <programlisting>cd /var/www tar xvzf
-lxoffice-erp-2.6.2.tgz</programlisting>
+ <programlisting>cd /var/www
+tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
- <para>Verändern Sie evtl. noch den Namen des Verzeichnisses mit</para>
+ <para>Wechseln Sie in das entpackte Verzeichnis:</para>
- <programlisting>mv lxoffice-erp/ lx-erp/</programlisting>
+ <programlisting>cd kivitendo-erp</programlisting>
<para>Alternativ können Sie auch einen Alias in der
Webserverkonfiguration benutzen, um auf das tatsächliche
Installationsverzeichnis zu verweisen.</para>
- <para>Die Verzeichnisse <filename>users</filename>,
- <filename>spool</filename> und <filename>webdav</filename> müssen für
- den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
- restlichen Dateien müssen für diesen Benutzer lesbar sein. Der
- Benutzername ist bei verschiedenen Distributionen unterschiedlich (z.B.
- bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora core
- <constant>apache</constant> oder bei OpenSuSE
- <constant>wwwrun</constant>).</para>
+ <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
+ beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
+ Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
+ core <constant>apache</constant> oder bei OpenSuSE <constant>wwwrun</constant>).</para>
<para>Der folgende Befehl ändert den Besitzer für die oben genannten
Verzeichnisse auf einem Debian/Ubuntu-System:</para>
- <programlisting>chown -R www-data lx-office-erp/users lx-office-erp/spool lx-office-erp/webdav</programlisting>
+ <programlisting>chown -R www-data users spool webdav</programlisting>
- <para>Weiterhin muss der Webserver-Benutzer im Verzeichnis
- <filename>templates</filename> Verzeichnisse für jeden neuen Benutzer,
- der in lx-office angelegt wird, anlegen dürfen:</para>
+ <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
+ Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
- <programlisting>chgrp www-data lx-office-erp/templates
-chmod g+w lx-office-erp/templates</programlisting>
+ <programlisting>chown www-data templates users</programlisting>
</sect1>
<sect1 id="config.config-file">
- <title>Lx-Office-Konfigurationsdatei</title>
+ <title>kivitendo-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>In kivitendo gibt es nur noch eine Konfigurationsdatei,
+ die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
+ "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
+ von kivitendo 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/kivitendo.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/kivitendo.conf.default config/kivitendo.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
+ Abschnitte 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>
+ <note>
+ <para>
+ Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
+ wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
+ </para>
+ </note>
- <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]
host = localhost
port = 5432
-db = lxerp_auth
+db = kivitendo_auth
user = postgres
password =
[system]
-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 Taskserver für wiederkehrende Rechnungen, 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 kivitendo 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 kivitendo 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 kivitendo-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 kivitendo eine
+ entsprechende Fehlermeldung an.</para>
+ </sect2>
</sect1>
<sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
<sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
<title>Zeichensätze/die Verwendung von UTF-8</title>
- <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
- PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale
- angelegt worden sein.</para>
+ <para>Bei aktuellen Serverinstallationen braucht man hier meist nicht
+ eingreifen</para>
+
+ <para>Dieses kann überprüft werden: ist das Encoding der Datenbank
+ “template1” “UTF8”, so braucht man nichts weiteres diesbezueglich
+ unternehmen. Zum Testen:
+
+ <programlisting>su postgres
+echo '\l' | psql
+exit </programlisting>
- <para>Dieses ist kann überprüft werden: ist das Encoding der Datenbank
- “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>
<para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
- Lx-Office mit ISO-8859-15 als Encoding betrieben werden.</para>
+ kivitendo 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
- PostgreSQL und Lx-Office auf demselben Rechner, so kann dort der Wert
+ <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 kivitendo 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>
-
- <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><literal>local all all trust host all all 127.0.0.1 255.0.0.0
- trust</literal></para>
-
- <para>Besser ist es, für eine bestimmte Datenbank Zugriff nur per
- Passwort zuzulassen. Beispielsweise:</para>
+ was mit dem Wert <literal>*</literal> geschieht.</para>
- <para><literal>local all lxoffice password host all lxoffice 127.0.0.1
- 255.255.255.255 password</literal></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. sinnvoll ist es nur die
+ nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
+ Datenbank zum Beispiel:</para>
- <!-- -->
+ <programlisting>local all kivitendo password
+host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
</sect2>
<sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
<para>In der Datenbank <literal>template1</literal> muss die
Unterstützung für servergespeicherte Prozeduren eingerichet werden.
- 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>
+ Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
+ <programlisting>su - postgres
+psql template1</programlisting>
- <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>
+ führen Sie die folgenden Kommandos aus:</para>
- <!-- -->
+ <programlisting>create language 'plpgsql';
+\q</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 kivitendo
+exit</programlisting>
<para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
- Sie den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” bzw.
+ Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” 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 /kivitendo-erp/ /var/www/kiviteno-erp/
+
+<Directory /var/www/kivitendo-erp>
+ Options ExecCGI Includes FollowSymlinks
+</Directory>
+
+<Directory /var/www/kivitendo-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>
+ das kivitendo-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"
<sect3 id="Apache-Konfiguration.FCGI.Warum">
<title>Warum FastCGI?</title>
- <para>Perl Programme (wie Lx-Office eines ist) werden nicht statisch
+ <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
kompiliert. Stattdessen werden die Quelldateien bei jedem Start
übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
- müssen, ist die Funktionalität von Lx-Office soweit gewachsen, dass
+ müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
- führt dazu dass ein Lx-Office Aufruf der Kernmasken mittlerweile
+ führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
deutlich länger dauert als früher, und dass davon 90% für das Laden
der Module verwendet wird.</para>
<warning>
<para>FCGI 0.69 und höher ist extrem strict in der Behandlung von
- Unicode, und verweigert bestimmte Eingaben von Lx-Office. Falls es
+ Unicode, und verweigert bestimmte Eingaben von kivitendo. 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">
<title>Konfiguration des Webservers</title>
- <para>Bevor Sie versuchen, eine Lx-Office Installation unter FCGI
+ <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
laufen zu lassen, empfliehlt es sich die Installation ersteinmal
unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
debuggen die beim ersten aufsetzen auftreten können. Sollte die
<programlisting>a2enmod fcgid</programlisting>
- <para>Die Konfiguration für die Verwendung von Lx-Office mit FastCGI
+ <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
und <function>Directory</function>-Direktiven. Dabei wird zwischen
- 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>
+ dem Installationspfad von kivitendo im Dateisystem
+ ("<filename>/path/to/kivitendo-erp</filename>") und der URL
+ unterschieden, unter der kivitendo im Webbrowser erreichbar ist
+ ("<filename>/url/for/kivitendo-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/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
+Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
-<Directory /path/to/lx-office-erp>
+<Directory /path/to/kivitendo-erp>
AllowOverride All
Options ExecCGI Includes FollowSymlinks
Order Allow,Deny
Allow from All
</Directory>
-<DirectoryMatch /path/to/lx-office-erp/users>
+<DirectoryMatch /path/to/kivitendo-erp/users>
Order Deny,Allow
Deny from All
</DirectoryMatch></programlisting>
<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/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
+Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
FcgidMaxRequestLen 10485760
-<Directory /path/to/lx-office-erp>
+<Directory /path/to/kivitendo-erp>
AllowOverride All
Options ExecCGI Includes FollowSymlinks
Order Allow,Deny
Allow from All
</Directory>
-<DirectoryMatch /path/to/lx-office-erp/users>
+<DirectoryMatch /path/to/kivitendo-erp/users>
Order Deny,Allow
Deny from All
</DirectoryMatch></programlisting>
Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
gibt es hier kleine Performance-Einbußen.</para>
- <para>Es ist möglich, die gleiche Lx-Office Version parallel unter
+ <para>Es ist möglich, die gleiche kivitendo Version parallel unter
CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
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/kivitendo-erp /path/to/kivitendo-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/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
+Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-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/kivitendo-erp/</filename>
+ die normale Version erreichbar, und unter
+ <constant>/url/for/kivitendo-erp-fcgid/</constant> die
FastCGI-Version.</para>
</sect3>
</sect2>
</sect1>
- <sect1 id="Der-Task-Server">
+ <sect1 id="config.task-server">
<title>Der Task-Server</title>
<para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
<para>Die Konfiguration erfolgt über den Abschnitt
<literal>[task_server]</literal> in der Datei
- <filename>config/lx_office.conf</filename>. Die dort verfügbaren
+ <filename>config/kivitendo.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 kivitendo-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">
<para>Der Task-Server verhält sich von seinen Optionen her wie ein
reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
- Starten automatisch in das Lx-Office-Installationsverzeichnis.</para>
+ Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
<para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
Core)</title>
<para>Kopieren Sie die Datei
- <filename>scripts/boot/system-v/lx-office-task-server</filename>
- nach <filename>/etc/init.d/lx-office-task-server</filename>. Passen
+ <filename>scripts/boot/system-v/kivitendo-server</filename>
+ nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
<literal>DAEMON=....</literal>). Binden Sie das Script in den
Boot-Prozess ein. Dies ist distributionsabhängig:</para>
<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 kivitendo-task-server defaults
+# Nur bei Debian Squeeze und neuer:
+insserv kivitendo-task-server</programlisting>
</listitem>
<listitem>
<para>OpenSuSE und Fedora Core:</para>
- <para><literal>chkconfig --add
- lx-office-task-server</literal></para>
+ <programlisting>chkconfig --add kivitendo-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/kivitendo-task-server
+ start</command></para>
</sect3>
<sect3>
<title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
<para>Kopieren Sie die Datei
- <filename>scripts/boot/upstart/lx-office-task-server.conf</filename>
- nach <filename>/etc/init/lx-office-task-server.conf</filename>.
+ <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
+ nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
<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 kivitendo-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>
</itemizedlist>
<para>Der Task-Server wechselt beim Starten automatisch in das
- Lx-Office-Installationsverzeichnis.</para>
+ kivitendo-Installationsverzeichnis.</para>
<para>Dieselben Optionen können auch für die SystemV-basierenden
Runlevel-Scripte benutzt werden (siehe oben).</para>
+ </sect2>
+ <sect2 id="Prozesskontrolle2">
+ <title>Task-Server mit mehreren Mandanten</title>
+
+ <para>Beim Task-Server wird der Login-Name des Benutzers, unter dem der
+ Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat
+ man mehrere Mandanten muß man auch mehrere Konfigurationsdateien
+ anlegen.</para>
- <!-- -->
+ <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf,
+ wo in der Kategorie [task_server] der gewünschte "login" steht.</para>
+
+ <para>Der alternative Task-Server wird dann mit folgendem Befehl
+ gestartet:</para>
+
+ <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
</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>Lx-Office verwaltet die Benutzerinformationen in einer
+ <para>kivitendo verwaltet die Benutzerinformationen in einer
Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
können, müssen aber nicht unterschiedlich sein.</para>
- <para>Im einfachsten Fall gibt es für Lx-Office nur eine einzige
+ <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
abgelegt werden.</para>
- <para>Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter
+ <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
entweder gegen die Authentifizierungsdatenbank oder gegen einen
LDAP-Server überprüft werden.</para>
- <para>Welche Art der Passwortüberprüfung Lx-Office benutzt und wie
- Lx-Office die Authentifizierungsdatenbank erreichen kann, wird in der
- Konfigurationsdatei <filename>config/lx_office.conf</filename>
+ <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
+ kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
+ Konfigurationsdatei <filename>config/kivitendo.conf</filename>
festgelegt. Diese muss bei der Installation und bei einem Upgrade von
einer Version vor v2.6.0 angelegt werden. Eine
Beispielkonfigurationsdatei
- <filename>config/lx_office.conf.default</filename> existiert, die als
+ <filename>config/kivitendo.conf.default</filename> existiert, die als
Vorlage benutzt werden kann.</para>
</sect2>
<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 kivitendo beim
+ Datenbankserver anmeldet (z.B.
+ "<literal>postgres</literal>")</para>
+ </listitem>
+ </varlistentry>
- <para>Die Datenbank muss noch nicht existieren. Lx-Office kann sie
+ <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. kivitendo kann sie
automatisch anlegen (mehr dazu siehe unten).</para>
</sect2>
<sect2 id="Passwortüberprüfung">
<title>Passwortüberprüfung</title>
- <para>Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen
+ <para>kivitendo 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
+ kivitendo ä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">
<title>Name des Session-Cookies</title>
- <para>Sollen auf einem Server mehrere Lx-Office-Installationen
+ <para>Sollen auf einem Server mehrere kivitendo-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>
<title>Anlegen der Authentifizierungsdatenbank</title>
<para>Nachdem alle Einstellungen in
- <filename>config/lx_office.conf</filename> vorgenommen wurden, muss
- Lx-Office die Authentifizierungsdatenbank anlegen. Dieses geschieht
+ <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
+ kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
der folgenden URL erreichbar sein sollte:</para>
<para><ulink
- url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
-
- <!-- -->
+ url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
</sect2>
</sect1>
folgender URL finden:</para>
<para><ulink
- url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
+ url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
<para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
- <filename>config/lx_office.conf</filename> eingetragen haben.</para>
+ <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
<sect2 id="Zusammenhänge">
<title>Zusammenhänge</title>
- <para>Lx-Office verwendet eine Datenbank zum Speichern all seiner
+ <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
- mit Lx-Office arbeiten zu können, muss eine Person einen
+ mit kivitendo arbeiten zu können, muss eine Person einen
Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
möglich und normal, dass mehreren Benutzern die selbe Datenbank
eingegeben werden können, werden in einer zweiten Datenbank
gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
- Pro Lx-Office-Installation gibt es nur eine
+ Pro kivitendo-Installation gibt es nur eine
Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
Firmendaten.</para>
- <para>Lx-Office kann seinen Benutzern Zugriff auf bestimmte
+ <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
gestattet, so werden der entsprechenden Menüpunkte auch nicht
angezeigt. Diese Rechte werden ebenfalls in der
Authentifizierungsdatenbank gespeichert.</para>
- <para>Um Rechte verteilen zu können, verwendet Lx-Office ein
+ <para>Um Rechte verteilen zu können, verwendet kivitendo ein
Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
<para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
- Beispielen ist dies ‘<literal>lxoffice</literal>’).</para>
+ Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
- <para>Wenn Sie für die Lx-Office-Installation nicht den europäischen
- Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so
- müssen Sie vor dem Anlegen der Datenbank in der Datei
- <filename>config/lx_office.conf</filename> die Variable
- <literal>dbcharset</literal> im Abschnitt <literal>system</literal>
- auf den Wert ‘<literal>UTF-8</literal>’ setzen. Zusätzlich muss beim
- Anlegen der Datenbank ‘<literal>UTF-8 Unicode</literal>’ als
- Schriftsatz ausgewählt werden.</para>
+ <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
+ wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
+ <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
<para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
- verwenden müssen, da diese Einstellungen momentan global in Lx-Office
+ verwenden müssen, da diese Einstellungen momentan global in kivitendo
vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
angelegt worden sein.</para>
<sect2 id="Migration-alter-Installationen">
<title>Migration alter Installationen</title>
- <para>Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird,
+ <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
in der die Benutzerdaten noch im Dateisystem im Verzeichnis
- <literal>users</literal> verwaltet wurden, so bietet Lx-Office die
+ <literal>users</literal> verwaltet wurden, so bietet kivitendo die
Möglichkeit, diese Benutzerdaten automatisch in die
Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
sich nach dem Update der Installation das erste Mal im
- Administrationsbereich anmeldet. Findet Lx-Office die Datei
+ Administrationsbereich anmeldet. Findet kivitendo die Datei
<literal>users/members</literal>, so wird der Migrationsprozess
gestartet.</para>
<para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
- Lx-Office noch die Möglichkeit an, dass automatisch eine
+ kivitendo noch die Möglichkeit an, dass automatisch eine
Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
- Funktionen von Lx-Office gewährt. Alle migrierten Benutzern werden
- Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis
+ Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
+ Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
sich sofort wieder anmelden und mit dem System arbeiten.</para>
-
- <!-- -->
</sect2>
</sect1>
- <sect1 id="Drucken-mit-Lx-Office">
- <title>Drucken mit Lx-Office</title>
+ <sect1 id="Drucken-mit-kivitendo">
+ <title>Drucken mit kivitendo</title>
- <para>Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen.
+ <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX Vorlagen.
Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
Debianoiden Betriebssystemen sind das die Pakete:</para>
<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">
<title>OpenDocument-Vorlagen</title>
- <para>Lx-Office unterstützt die Verwendung von Vorlagen im
+ <para>kivitendo unterstützt die Verwendung von Vorlagen im
OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
- Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus
+ kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
OpenDocument-Vorlagen zu aktivieren muss in der Datei
- <filename>config/lx_office.conf</filename> die Variable
+ <filename>config/kivitendo.conf</filename> die Variable
<literal>opendocument</literal> im Abschnitt
<literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
Dieses ist die Standardeinstellung.</para>
<para>Weiterhin muss in der Datei
- <filename>config/lx_office.conf</filename> die Variable
+ <filename>config/kivitendo.conf</filename> die Variable
<literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
Andere Distributionen enthalten ihn in anderen Paketen.</para>
<para>Nach der Installation müssen in der Datei
- <filename>config/lx_config.conf</filename> zwei weitere Variablen
+ <filename>config/kivitendo.conf</filename> zwei weitere Variablen
angepasst werden: <literal>openofficeorg_writer</literal> muss den
vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
<literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
enthalten. Beide stehen im Abschnitt
<literal>applications</literal>.</para>
- <para>Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit
+ <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
<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>kivitendo besaß bis inklusive Version 2.6.3 einen
+ Konfigurationsparameter namens <varname>eur</varname>, der sich in der
+ Konfigurationsdatei <filename>config/lx_office.conf</filename>
+ befand. 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>
- <title>Entwicklerdokumentation</title>
+ <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
+ Versteuerungsart und die Warenbuchungsmethode regeln:</para>
- <sect1 id="devel.globals" xreflabel="Globale Variablen">
- <title>Globale Variablen</title>
+ <variablelist>
+ <varlistentry>
+ <term><varname>profit_determination</varname></term>
- <sect2>
- <title>Wie sehen globale Variablen in Perl aus?</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>
- <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><varname>accounting_method</varname></term>
- <para>Daraus ergeben sich folgende Formen:</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>
- <variablelist>
<varlistentry>
- <term>$main::form</term>
+ <term><varname>inventory_system</varname></term>
<listitem>
- <para>expliziter Namespace "main"</para>
+ <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>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/kivitendo.conf</filename> wird nun nicht mehr
+ benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
+ </sect2>
+
+ <sect2 id="config.eur.setting-parameters">
+ <title>Festlegen der Parameter</title>
+
+ <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
+ der Admininstration können diese Optionen nun unabhängig voneinander
+ eingestellt werden.</para>
+
+ <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
+ Variablen werden so gesetzt, daß sich an der Funktionalität nichts
+ ändert.</para>
+
+ <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>
+
+ <sect2 id="config.eur.inventory-system-perpetual">
+ <title>Bemerkungen zu Bestandsmethode</title>
+
+ <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
+ funktioniert in kivitendo 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>
+
+ <sect2 id="config.eur.knonw-issues">
+ <title>Bekannte Probleme</title>
+
+ <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>
+
+ <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
+ Optionen bewirken, z.B. mit zwei Standardfällen.</para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="config.skr04-update-3804">
+ <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
+
+ <sect2 id="config.skr04-update-3804.introduction">
+ <title>Einführung</title>
+
+ <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
+ Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
+ kivitendo 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>
+
+ <sect2 id="config.skr04-update-3804.create-chart">
+ <title>Konto 3804 manuell anlegen</title>
+
+ <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="kivitendo-ERP-verwenden">
+ <title>kivitendo ERP verwenden</title>
+
+ <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
+ folgender URL erreichbar:</para>
+
+ <para><ulink
+ url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
+
+ <para>Die Administrationsseite erreichen Sie unter:</para>
+
+ <para><ulink
+ url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-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>$::form</term>
+ <term>Status</term>
<listitem>
- <para>impliziter 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>open FILE, "file.txt"</term>
+ <term>Periodizität</term>
<listitem>
- <para><varname>FILE</varname> ist global</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>$_</term>
+ <term>Buchen auf</term>
<listitem>
- <para>speziell</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>
- </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>
+ <varlistentry>
+ <term>Startdatum</term>
+
+ <listitem>
+ <para>ab welchem Datum auf Rechnungserstellung geprüft werden
+ soll</para>
+ </listitem>
+ </varlistentry>
- <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/kivitendo.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 kivitendo 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 kivitendo 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>
-
- <sect3>
- <title>$::request</title>
-
- <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>
+ <varlistentry>
+ <term><varname>template_meta.language.description</varname></term>
- <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>
+ <listitem>
+ <para>Beschreibung der verwendeten Sprache</para>
+ </listitem>
+ </varlistentry>
- <para>Vieles von dem, was im moment in <varname>$::form</varname>
- liegt, sollte eigentlich hier liegen. Die groben
- Differentialkriterien sind:</para>
+ <varlistentry>
+ <term><varname>template_meta.language.template_code</varname></term>
- <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>Vorlagenürzel der verwendeten Sprache, identisch mit dem
+ Kürzel das im Dateinamen verwendetet wird.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
- Requests gebraucht werden? Dann $::request</para>
- </listitem>
+ <varlistentry>
+ <term><varname>template_meta.language.output_numberformat</varname></term>
- <listitem>
- <para>Muss ich von anderen Teilen des Programms lesend drauf
- zugreifen? Dann $::request, aber Zugriff über
- Wrappermethode</para>
- </listitem>
- </itemizedlist>
- </sect3>
- </sect2>
+ <listitem>
+ <para>Zahlenformat der verwendeten Sprache in der Form
+ "<constant>1.000,00</constant>". Experimentell! Nur
+ interessant für Vorlagen die mit unformatierten Werten
+ arbeiten.</para>
+ </listitem>
+ </varlistentry>
- <sect2>
- <title>Ehemalige globale Variablen</title>
+ <varlistentry>
+ <term><varname>template_meta.language.output_dateformat</varname></term>
- <para>Die folgenden Variablen waren einmal im Programm, und wurden
- entfernt.</para>
+ <listitem>
+ <para>Datumsformat der verwendeten Sprache in der Form
+ "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
+ interessant für Vorlagen die mit unformatierten Werten
+ arbeiten.</para>
+ </listitem>
+ </varlistentry>
- <sect3>
- <title>$::cgi</title>
+ <varlistentry>
+ <term><varname>template_meta.format</varname></term>
- <itemizedlist>
- <listitem>
- <para>war nötig, weil cookie Methoden nicht als
- Klassenfunktionen funktionieren</para>
- </listitem>
+ <listitem>
+ <para>Das angeforderte Format. Kann im Moment die Werte
+ <constant>pdf</constant>, <constant>postscript</constant>,
+ <constant>html</constant>, <constant>opendocument</constant>,
+ <constant>opendocument_pdf</constant> und
+ <constant>excel</constant> enthalten.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Aufruf als Klasse erzeugt Dummyobjekt was im
- Klassennamespace gehalten wird und über Requestgrenzen
- leaked</para>
- </listitem>
+ <varlistentry>
+ <term><varname>template_meta.extension</varname></term>
- <listitem>
- <para>liegt jetzt unter
- <varname>$::request->{cgi}</varname></para>
- </listitem>
- </itemizedlist>
- </sect3>
+ <listitem>
+ <para>Dateierweiterung, wie im Dateinamen. Wird aus
+ <constant>format</constant> entschieden.</para>
+ </listitem>
+ </varlistentry>
- <sect3>
- <title>$::all_units</title>
+ <varlistentry>
+ <term><varname>template_meta.media</varname></term>
- <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>Ausgabemedium. Kann zur Zeit die Werte
+ <constant>screen</constant> für Bildschirm,
+ <constant>email</constant> für E-Mmail (triggert das
+ <constant>_email</constant> Kürzel im Dateinamen),
+ <constant>printer</constant> für Drucker, und
+ <constant>queue</constant> für Warteschlange enthalten.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Liegt jetzt unter
- <varname>$::request->{cache}{all_units}</varname></para>
- </listitem>
+ <varlistentry>
+ <term><varname>template_meta.printer.description</varname></term>
- <listitem>
- <para>Wird nur in
- <function>AM->retrieve_all_units()</function> gesetzt oder
- gelesen.</para>
- </listitem>
- </itemizedlist>
- </sect3>
+ <listitem>
+ <para>Beschreibung des ausgewählten Druckers</para>
+ </listitem>
+ </varlistentry>
- <sect3>
- <title>%::called_subs</title>
+ <varlistentry>
+ <term><varname>template_meta.printer.template_code</varname></term>
- <itemizedlist>
- <listitem>
- <para>wurde benutzt um callsub deep recursions
- abzufangen.</para>
- </listitem>
+ <listitem>
+ <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
+ dem Kürzel das im Dateinamen verwendetet wird.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>Wurde entfernt, weil callsub nur einen Bruchteil der
- möglichen Rekursioenen darstellt, und da nie welche
- auftreten.</para>
- </listitem>
+ <varlistentry>
+ <term><varname>template_meta.tmpfile</varname></term>
- <listitem>
- <para>komplette recursion protection wurde entfernt.</para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>Datei-Prefix für temporäre Dateien.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</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>
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
+ <title>Stammdaten von Kunden und Lieferanten</title>
- <para>Beispiel:</para>
+ <variablelist>
+ <varlistentry>
+ <term><varname>account_number</varname></term>
- <programlisting><%quototal NOFORMAT%></programlisting>
- </sect2>
+ <listitem>
+ <para>Kontonummer</para>
+ </listitem>
+ </varlistentry>
- <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
- <title>Verwendung in Druckbefehlen</title>
+ <varlistentry>
+ <term><varname>bank</varname></term>
- <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>Name der Bank</para>
+ </listitem>
+ </varlistentry>
- <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>
+ <varlistentry>
+ <term><varname>bank_code</varname></term>
- <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
- </sect2>
+ <listitem>
+ <para>Bankleitzahl</para>
+ </listitem>
+ </varlistentry>
- <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
- xreflabel="Anfang und Ende der Tags verändern">
- <title>Anfang und Ende der Tags verändern</title>
+ <varlistentry>
+ <term><varname>bic</varname></term>
- <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>
+ <listitem>
+ <para>Bank-Identifikations-Code (Bank Identifier Code,
+ BIC)</para>
+ </listitem>
+ </varlistentry>
- <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>
+ <varlistentry>
+ <term><varname>business</varname></term>
- <programlisting>% config: tag-style=($ $)</programlisting>
+ <listitem>
+ <para>Kunden-/Lieferantentyp</para>
+ </listitem>
+ </varlistentry>
- <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>
+ <varlistentry>
+ <term><varname>city</varname></term>
- <programlisting><!-- config: tag-style=($ $) --></programlisting>
- </sect2>
+ <listitem>
+ <para>Stadt</para>
+ </listitem>
+ </varlistentry>
- <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
- <title>Zuordnung von den Dateinamen zu den Funktionen</title>
+ <varlistentry>
+ <term><varname>contact</varname></term>
- <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>Kontakt</para>
+ </listitem>
+ </varlistentry>
- <variablelist>
- <varlistentry>
- <term><filename>bin_list.ext</filename></term>
+ <varlistentry>
+ <term><varname>country</varname></term>
- <listitem>
- <para>Lagerliste</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Land</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>check.ext</filename></term>
+ <varlistentry>
+ <term><varname>cp_email</varname></term>
- <listitem>
- <para>?</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Email des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>invoice.ext</filename></term>
+ <varlistentry>
+ <term><varname>cp_givenname</varname></term>
- <listitem>
- <para>Rechnung</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Vorname des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>packing_list.ext</filename></term>
+ <varlistentry>
+ <term><varname>cp_greeting</varname></term>
- <listitem>
- <para>Packliste</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Anrede des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>pick_list.ext</filename></term>
+ <varlistentry>
+ <term><varname>cp_name</varname></term>
- <listitem>
- <para>Sammelliste</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Name des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>purchase_delivery_order.ext</filename></term>
+ <varlistentry>
+ <term><varname>cp_phone1</varname></term>
- <listitem>
- <para>Lieferschein (Einkauf)</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Telefonnummer 1 des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>purcharse_order.ext</filename></term>
+ <varlistentry>
+ <term><varname>cp_phone2</varname></term>
- <listitem>
- <para>Bestellung an Lieferanten</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Telefonnummer 2 des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>request_quotation.ext</filename></term>
+ <varlistentry>
+ <term><varname>cp_title</varname></term>
- <listitem>
- <para>Anfrage an Lieferanten</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Titel des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>sales_delivery_order.ext</filename></term>
+ <varlistentry>
+ <term><varname>creditlimit</varname></term>
- <listitem>
- <para>Lieferschein (Verkauf)</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Kreditlimit</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>sales_order.ext</filename></term>
+ <varlistentry>
+ <term><varname>customeremail</varname></term>
- <listitem>
- <para>Bestellung</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Email des Kunden; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>sales_quotation.ext</filename></term>
+ <varlistentry>
+ <term><varname>customerfax</varname></term>
- <listitem>
- <para>Angebot an Kunden</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Faxnummer des Kunden; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>zahlungserinnerung.ext</filename></term>
+ <varlistentry>
+ <term><varname>customernotes</varname></term>
- <listitem>
- <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Bemerkungen beim Kunden; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><filename>zahlungserinnerung_invoice.ext</filename></term>
+ <varlistentry>
+ <term><varname>customernumber</varname></term>
- <listitem>
- <para>Rechnung über Mahngebühren (Dateiname im Programm
- konfigurierbar)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
+ <listitem>
+ <para>Kundennummer; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
- <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
- <title>Sprache, Drucker und E-Mail</title>
+ <varlistentry>
+ <term><varname>customerphone</varname></term>
- <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>
+ <listitem>
+ <para>Telefonnummer des Kunden; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
- <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>
+ <varlistentry>
+ <term><varname>discount</varname></term>
- <orderedlist>
- <listitem>
- <para><filename>sales_order_email_de_lpr2.tex</filename></para>
- </listitem>
+ <listitem>
+ <para>Rabatt</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para><filename>sales_order_de_lpr2.tex</filename></para>
- </listitem>
+ <varlistentry>
+ <term><varname>email</varname></term>
- <listitem>
- <para><filename>sales_order.tex</filename></para>
- </listitem>
+ <listitem>
+ <para>Emailadresse</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para><filename>default.tex</filename></para>
- </listitem>
- </orderedlist>
+ <varlistentry>
+ <term><varname>fax</varname></term>
- <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>
+ <listitem>
+ <para>Faxnummer</para>
+ </listitem>
+ </varlistentry>
- <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
- <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
- sind</title>
+ <varlistentry>
+ <term><varname>homepage</varname></term>
- <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
- xreflabel="Metainformationen zur angeforderten Vorlage">
- <title>Metainformationen zur angeforderten Vorlage</title>
+ <listitem>
+ <para>Homepage</para>
+ </listitem>
+ </varlistentry>
- <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>
+ <varlistentry>
+ <term><varname>iban</varname></term>
+
+ <listitem>
+ <para>Internationale Kontonummer (International Bank Account
+ Number, IBAN)</para>
+ </listitem>
+ </varlistentry>
- <variablelist>
<varlistentry>
- <term>template_meta.formname</term>
+ <term><varname>language</varname></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>
+ <para>Sprache</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.language.description</term>
+ <term><varname>name</varname></term>
<listitem>
- <para>Beschreibung der verwendeten Sprache</para>
+ <para>Firmenname</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.language.template_code</term>
+ <term><varname>payment_description</varname></term>
<listitem>
- <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
- Kürzel das im Dateinamen verwendetet wird.</para>
+ <para>Name der Zahlart</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.language.output_numberformat</term>
+ <term><varname>payment_terms</varname></term>
<listitem>
- <para>Zahlenformat der verwendeten Sprache in der Form
- "<constant>1.000,00</constant>". Experimentell! Nur
- interessant für Vorlagen die mit unformatierten Werten
- arbeiten.</para>
+ <para>Zahlungskonditionen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.language.output_dateformat</term>
+ <term><varname>phone</varname></term>
<listitem>
- <para>Datumsformat der verwendeten Sprache in der Form
- "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
- interessant für Vorlagen die mit unformatierten Werten
- arbeiten.</para>
+ <para>Telefonnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.format</term>
+ <term><varname>shiptocity</varname></term>
<listitem>
- <para>Das angeforderte Format. Kann im Moment die Werte
- <constant>pdf</constant>, <constant>postscript</constant>,
- <constant>html</constant>, <constant>opendocument</constant>,
- <constant>opendocument_pdf</constant> und
- <constant>excel</constant> enthalten.</para>
+ <para>Stadt (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.extension</term>
+ <term><varname>shiptocontact</varname></term>
<listitem>
- <para>Dateierweiterung, wie im Dateinamen. Wird aus
- <constant>format</constant> entschieden.</para>
+ <para>Kontakt (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.media</term>
+ <term><varname>shiptocountry</varname></term>
<listitem>
- <para>Ausgabemedium. Kann zur Zeit die Werte
- <constant>screen</constant> für Bildschirm,
- <constant>email</constant> für E-Mmail (triggert das
- <constant>_email</constant> Kürzel im Dateinamen),
- <constant>printer</constant> für Drucker, und
- <constant>queue</constant> für Warteschlange enthalten.</para>
+ <para>Land (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.printer.description</term>
+ <term><varname>shiptodepartment1</varname></term>
<listitem>
- <para>Beschreibung des ausgewählten Druckers</para>
+ <para>Abteilung 1 (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>template_meta.printer.template_code</term>
+ <term><varname>shiptodepartment2</varname></term>
<listitem>
- <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
- dem Kürzel das im Dateinamen verwendetet wird.</para>
+ <para>Abteilung 2 (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
- <title>Stammdaten von Kunden und Lieferanten</title>
+ <varlistentry>
+ <term><varname>shiptoemail</varname></term>
+
+ <listitem>
+ <para>Email (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ </listitem>
+ </varlistentry>
- <variablelist>
<varlistentry>
- <term>account_number</term>
+ <term><varname>shiptofax</varname></term>
<listitem>
- <para>Kontonummer</para>
+ <para>Fax (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>bank</term>
+ <term><varname>shiptoname</varname></term>
<listitem>
- <para>Name der Bank</para>
+ <para>Firmenname (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>bank_code</term>
+ <term><varname>shiptophone</varname></term>
<listitem>
- <para>Bankleitzahl</para>
+ <para>Telefonnummer (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>bic</term>
+ <term><varname>shiptostreet</varname></term>
<listitem>
- <para>Bank-Identifikations-Code (Bank Identifier Code,
- BIC)</para>
+ <para>Straße und Hausnummer (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>business</term>
+ <term><varname>shiptozipcode</varname></term>
<listitem>
- <para>Kunden-/Lieferantentyp</para>
+ <para>Postleitzahl (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>city</term>
+ <term><varname>street</varname></term>
<listitem>
- <para>Stadt</para>
+ <para>Straße und Hausnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>contact</term>
+ <term><varname>taxnumber</varname></term>
<listitem>
- <para>Kontakt</para>
+ <para>Steuernummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>country</term>
+ <term><varname>ustid</varname></term>
<listitem>
- <para>Land</para>
+ <para>Umsatzsteuer-Identifikationsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>cp_email</term>
+ <term><varname>vendoremail</varname></term>
<listitem>
- <para>Email des Ansprechpartners</para>
+ <para>Email des Lieferanten; nur für Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>cp_givenname</term>
+ <term><varname>vendorfax</varname></term>
<listitem>
- <para>Vorname des Ansprechpartners</para>
+ <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>cp_greeting</term>
+ <term><varname>vendornotes</varname></term>
<listitem>
- <para>Anrede des Ansprechpartners</para>
+ <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>cp_name</term>
+ <term><varname>vendornumber</varname></term>
<listitem>
- <para>Name des Ansprechpartners</para>
+ <para>Lieferantennummer; nur für Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>cp_phone1</term>
+ <term><varname>vendorphone</varname></term>
<listitem>
- <para>Telefonnummer 1 des Ansprechpartners</para>
+ <para>Telefonnummer des Lieferanten; nur für
+ Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>cp_phone2</term>
+ <term><varname>zipcode</varname></term>
<listitem>
- <para>Telefonnummer 2 des Ansprechpartners</para>
+ <para>Postleitzahl</para>
</listitem>
</varlistentry>
+ </variablelist>
+
+ <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
+ <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
+ Stammdaten nicht eingetragen, so haben die Variablen
+ <varname>shipto*</varname> den gleichen Wert wie die die
+ entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
+ einige <varname>shipto*</varname>-Variablen so nicht in den
+ Stammdaten wiederfinden sondern schlicht Kopien der
+ Lieferdatenvariablen sind (z.B.
+ <varname>shiptocontact</varname>).</para>
+ </note>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
+ <title>Informationen über den Bearbeiter</title>
+ <variablelist>
<varlistentry>
- <term>cp_title</term>
+ <term><varname>employee_address</varname></term>
<listitem>
- <para>Titel des Ansprechpartners</para>
+ <para>Adressfeld</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>creditlimit</term>
+ <term><varname>employee_businessnumber</varname></term>
<listitem>
- <para>Kreditlimit</para>
+ <para>Firmennummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>customeremail</term>
+ <term><varname>employee_company</varname></term>
<listitem>
- <para>Email des Kunden; nur für Kunden</para>
+ <para>Firmenname</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>customerfax</term>
+ <term><varname>employee_co_ustid</varname></term>
<listitem>
- <para>Faxnummer des Kunden; nur für Kunden</para>
+ <para>Usatzsteuer-Identifikationsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>customernotes</term>
+ <term><varname>employee_duns</varname></term>
<listitem>
- <para>Bemerkungen beim Kunden; nur für Kunden</para>
+ <para>DUNS-Nummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>customernumber</term>
+ <term><varname>employee_email</varname></term>
<listitem>
- <para>Kundennummer; nur für Kunden</para>
+ <para>Email</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>customerphone</term>
+ <term><varname>employee_fax</varname></term>
<listitem>
- <para>Telefonnummer des Kunden; nur für Kunden</para>
+ <para>Fax</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>discount</term>
+ <term><varname>employee_name</varname></term>
<listitem>
- <para>Rabatt</para>
+ <para>voller Name</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>email</term>
+ <term><varname>employee_signature</varname></term>
<listitem>
- <para>Emailadresse</para>
+ <para>Signatur</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>fax</term>
+ <term><varname>employee_taxnumber</varname></term>
<listitem>
- <para>Faxnummer</para>
+ <para>Steuernummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>homepage</term>
+ <term><varname>employee_tel</varname></term>
<listitem>
- <para>Homepage</para>
+ <para>Telefonnummer</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
+ <title>Informationen über den Bearbeiter</title>
+ <variablelist>
<varlistentry>
- <term>iban</term>
+ <term><varname>salesman_address</varname></term>
<listitem>
- <para>Internationale Kontonummer (International Bank Account
- Number, IBAN)</para>
+ <para>Adressfeld</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>language</term>
+ <term><varname>salesman_businessnumber</varname></term>
<listitem>
- <para>Sprache</para>
+ <para>Firmennummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>name</term>
+ <term><varname>salesman_company</varname></term>
<listitem>
<para>Firmenname</para>
</varlistentry>
<varlistentry>
- <term>payment_description</term>
+ <term><varname>salesman_co_ustid</varname></term>
<listitem>
- <para>Name der Zahlart</para>
+ <para>Usatzsteuer-Identifikationsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>payment_terms</term>
+ <term><varname>salesman_duns</varname></term>
<listitem>
- <para>Zahlungskonditionen</para>
+ <para>DUNS-Nummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>phone</term>
+ <term><varname>salesman_email</varname></term>
<listitem>
- <para>Telefonnummer</para>
+ <para>Email</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptocity</term>
+ <term><varname>salesman_fax</varname></term>
<listitem>
- <para>Stadt (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Fax</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptocontact</term>
+ <term><varname>salesman_name</varname></term>
<listitem>
- <para>Kontakt (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>voller Name</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptocountry</term>
+ <term><varname>salesman_signature</varname></term>
<listitem>
- <para>Land (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Signatur</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptodepartment1</term>
+ <term><varname>salesman_taxnumber</varname></term>
<listitem>
- <para>Abteilung 1 (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Steuernummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptodepartment2</term>
+ <term><varname>salesman_tel</varname></term>
<listitem>
- <para>Abteilung 2 (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Telefonnummer</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
+ <title>Variablen für die einzelnen Steuern</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>tax</varname></term>
+
+ <listitem>
+ <para>Steuer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptoemail</term>
+ <term><varname>taxbase</varname></term>
<listitem>
- <para>Email (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>zu versteuernder Betrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptofax</term>
+ <term><varname>taxdescription</varname></term>
<listitem>
- <para>Fax (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Name der Steuer</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>taxrate</varname></term>
+
+ <listitem>
+ <para>Steuersatz</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.invoice">
+ <title>Variablen in Rechnungen</title>
+ <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
+ <title>Allgemeine Variablen</title>
+
+ <variablelist>
<varlistentry>
- <term>shiptoname</term>
+ <term><varname>creditremaining</varname></term>
<listitem>
- <para>Firmenname (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Verbleibender Kredit</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptophone</term>
+ <term><varname>currency</varname></term>
<listitem>
- <para>Telefonnummer (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Währung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptostreet</term>
+ <term><varname>cusordnumber</varname></term>
<listitem>
- <para>Straße und Hausnummer (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Bestellnummer beim Kunden</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shiptozipcode</term>
+ <term><varname>deliverydate</varname></term>
<listitem>
- <para>Postleitzahl (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Lieferdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>street</term>
+ <term><varname>duedate</varname></term>
<listitem>
- <para>Straße und Hausnummer</para>
+ <para>Fälligkeitsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>taxnumber</term>
+ <term><varname>globalprojectnumber</varname></term>
<listitem>
- <para>Steuernummer</para>
+ <para>Projektnummer des ganzen Beleges</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ustid</term>
+ <term><varname>globalprojectdescription</varname></term>
<listitem>
- <para>Umsatzsteuer-Identifikationsnummer</para>
+ <para>Projekbeschreibung des ganzen Beleges</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>vendoremail</term>
+ <term><varname>intnotes</varname></term>
<listitem>
- <para>Email des Lieferanten; nur für Lieferanten</para>
+ <para>Interne Bemerkungen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>vendorfax</term>
+ <term><varname>invdate</varname></term>
<listitem>
- <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>vendornotes</term>
+ <term><varname>invnumber</varname></term>
<listitem>
- <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>vendornumber</term>
+ <term><varname>invtotal</varname></term>
<listitem>
- <para>Lieferantennummer; nur für Lieferanten</para>
+ <para>gesamter Rechnungsbetrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>vendorphone</term>
+ <term><varname>notes</varname></term>
<listitem>
- <para>Telefonnummer des Lieferanten; nur für
- Lieferanten</para>
+ <para>Bemerkungen der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>zipcode</term>
+ <term><varname>orddate</varname></term>
<listitem>
- <para>Postleitzahl</para>
+ <para>Auftragsdatum</para>
</listitem>
</varlistentry>
- </variablelist>
- <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
- <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
- Stammdaten nicht eingetragen, so haben die Variablen
- <varname>shipto*</varname> den gleichen Wert wie die die
- entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
- einige <varname>shipto*</varname>-Variablen so nicht in den
- Stammdaten wiederfinden sondern schlicht Kopien der
- Lieferdatenvariablen sind (z.B.
- <varname>shiptocontact</varname>).</para>
- </note>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
- <title>Informationen über den Bearbeiter</title>
-
- <variablelist>
<varlistentry>
- <term>employee_address</term>
+ <term><varname>ordnumber</varname></term>
<listitem>
- <para>Adressfeld</para>
+ <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
+ erstellt wurde</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_businessnumber</term>
+ <term><varname>payment_description</varname></term>
<listitem>
- <para>Firmennummer</para>
+ <para>Name der Zahlart</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_company</term>
+ <term><varname>payment_terms</varname></term>
<listitem>
- <para>Firmenname</para>
+ <para>Zahlungskonditionen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_co_ustid</term>
+ <term><varname>quodate</varname></term>
<listitem>
- <para>Usatzsteuer-Identifikationsnummer</para>
+ <para>Angebotsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_duns</term>
+ <term><varname>quonumber</varname></term>
<listitem>
- <para>DUNS-Nummer</para>
+ <para>Angebotsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_email</term>
+ <term><varname>shippingpoint</varname></term>
<listitem>
- <para>Email</para>
+ <para>Versandort</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_fax</term>
+ <term><varname>shipvia</varname></term>
<listitem>
- <para>Fax</para>
+ <para>Transportmittel</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_name</term>
+ <term><varname>subtotal</varname></term>
<listitem>
- <para>voller Name</para>
+ <para>Zwischensumme aller Posten ohne Steuern</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_signature</term>
+ <term><varname>total</varname></term>
<listitem>
- <para>Signatur</para>
+ <para>Restsumme der Rechnung (Summe abzüglich bereits
+ bezahlter Posten)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_taxnumber</term>
+ <term><varname>transaction_description</varname></term>
<listitem>
- <para>Steuernummer</para>
+ <para>Vorgangsbezeichnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>employee_tel</term>
+ <term><varname>transdate</varname></term>
<listitem>
- <para>Telefonnummer</para>
+ <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
+ erstellt wurde</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
- <title>Informationen über den Bearbeiter</title>
+ <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
+ <title>Variablen für jeden Posten auf der Rechnung</title>
<variablelist>
<varlistentry>
- <term>salesman_address</term>
+ <term><varname>bin</varname></term>
<listitem>
- <para>Adressfeld</para>
+ <para>Stellage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_businessnumber</term>
+ <term><varname>description</varname></term>
<listitem>
- <para>Firmennummer</para>
+ <para>Artikelbeschreibung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_company</term>
+ <term><varname>discount</varname></term>
<listitem>
- <para>Firmenname</para>
+ <para>Rabatt als Betrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_co_ustid</term>
+ <term><varname>discount_sub</varname></term>
<listitem>
- <para>Usatzsteuer-Identifikationsnummer</para>
+ <para>Zwischensumme mit Rabatt</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_duns</term>
+ <term><varname>drawing</varname></term>
<listitem>
- <para>DUNS-Nummer</para>
+ <para>Zeichnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_email</term>
+ <term><varname>ean</varname></term>
<listitem>
- <para>Email</para>
+ <para>EAN-Code</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_fax</term>
+ <term><varname>image</varname></term>
<listitem>
- <para>Fax</para>
+ <para>Grafik</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_name</term>
+ <term><varname>linetotal</varname></term>
<listitem>
- <para>voller Name</para>
+ <para>Zeilensumme (Anzahl * Einzelpreis)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_signature</term>
+ <term><varname>longdescription</varname></term>
<listitem>
- <para>Signatur</para>
+ <para>Langtext</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_taxnumber</term>
+ <term><varname>microfiche</varname></term>
<listitem>
- <para>Steuernummer</para>
+ <para>Mikrofilm</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>salesman_tel</term>
+ <term><varname>netprice</varname></term>
<listitem>
- <para>Telefonnummer</para>
+ <para>Nettopreis</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
- <title>Variablen für die einzelnen Steuern</title>
- <variablelist>
<varlistentry>
- <term>tax</term>
+ <term><varname>nodiscount_linetotal</varname></term>
<listitem>
- <para>Steuer</para>
+ <para>Zeilensumme ohne Rabatt</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>taxbase</term>
+ <term><varname>nodiscount_sub</varname></term>
<listitem>
- <para>zu versteuernder Betrag</para>
+ <para>Zwischensumme ohne Rabatt</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>taxdescription</term>
+ <term><varname>number</varname></term>
<listitem>
- <para>Name der Steuer</para>
+ <para>Artikelnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>taxrate</term>
+ <term><varname>ordnumber_oe</varname></term>
<listitem>
- <para>Steuersatz</para>
+ <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
+ aus einem Sammelauftrag erstellt wurde</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
- </sect2>
-
- <sect2 id="dokumentenvorlagen-und-variablen.invoice">
- <title>Variablen in Rechnungen</title>
- <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
- <title>Allgemeine Variablen</title>
-
- <variablelist>
<varlistentry>
- <term>creditremaining</term>
+ <term><varname>p_discount</varname></term>
<listitem>
- <para>Verbleibender Kredit</para>
+ <para>Rabatt in Prozent</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>currency</term>
+ <term><varname>partnotes</varname></term>
<listitem>
- <para>Währung</para>
+ <para>Die beim Artikel gespeicherten Bemerkungen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>cusordnumber</term>
+ <term><varname>partsgroup</varname></term>
<listitem>
- <para>Bestellnummer beim Kunden</para>
+ <para>Warengruppe</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>deliverydate</term>
+ <term><varname>price_factor</varname></term>
<listitem>
- <para>Lieferdatum</para>
+ <para>Der Preisfaktor als Zahl, sofern einer eingestellt
+ ist</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>duedate</term>
+ <term><varname>price_factor_name</varname></term>
<listitem>
- <para>Fälligkeitsdatum</para>
+ <para>Der Name des Preisfaktors, sofern einer eingestellt
+ ist</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>globalprojectnumber</term>
+ <term><varname>projectnumber</varname></term>
<listitem>
- <para>Projektnummer des ganzen Beleges</para>
+ <para>Projektnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>globalprojectdescription</term>
+ <term><varname>projectdescription</varname></term>
<listitem>
- <para>Projekbeschreibung des ganzen Beleges</para>
+ <para>Projektbeschreibung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>intnotes</term>
+ <term><varname>qty</varname></term>
<listitem>
- <para>Interne Bemerkungen</para>
+ <para>Anzahl</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>invdate</term>
+ <term><varname>reqdate</varname></term>
<listitem>
- <para>Rechnungsdatum</para>
+ <para>Lieferdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>invnumber</term>
+ <term><varname>runningnumber</varname></term>
<listitem>
- <para>Rechnungsnummer</para>
+ <para>Position auf der Rechnung (1, 2, 3...)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>invtotal</term>
+ <term><varname>sellprice</varname></term>
<listitem>
- <para>gesamter Rechnungsbetrag</para>
+ <para>Verkaufspreis</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>notes</term>
+ <term><varname>serialnumber</varname></term>
<listitem>
- <para>Bemerkungen der Rechnung</para>
+ <para>Seriennummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>orddate</term>
+ <term><varname>tax_rate</varname></term>
<listitem>
- <para>Auftragsdatum</para>
+ <para>Steuersatz</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ordnumber</term>
+ <term><varname>transdate_oe</varname></term>
<listitem>
- <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
- erstellt wurde</para>
+ <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
+ aus einem Sammelauftrag erstellt wurde</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>payment_description</term>
+ <term><varname>unit</varname></term>
<listitem>
- <para>Name der Zahlart</para>
+ <para>Einheit</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>payment_terms</term>
+ <term><varname>weight</varname></term>
<listitem>
- <para>Zahlungskonditionen</para>
+ <para>Gewicht</para>
</listitem>
</varlistentry>
+ </variablelist>
- <varlistentry>
- <term>quodate</term>
-
- <listitem>
- <para>Angebotsdatum</para>
- </listitem>
- </varlistentry>
+ <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>quonumber</term>
+ <term><varname>make</varname></term>
<listitem>
- <para>Angebotsnummer</para>
+ <para>Lieferant</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>shippingpoint</term>
+ <term><varname>model</varname></term>
<listitem>
- <para>Versandort</para>
+ <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>shipvia</term>
+ <term><varname>payment</varname></term>
<listitem>
- <para>Transportmittel</para>
+ <para>Betrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>subtotal</term>
+ <term><varname>paymentaccount</varname></term>
<listitem>
- <para>Zwischensumme aller Posten ohne Steuern</para>
+ <para>Konto</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>total</term>
+ <term><varname>paymentdate</varname></term>
<listitem>
- <para>Restsumme der Rechnung (Summe abzüglich bereits
- bezahlter Posten)</para>
+ <para>Datum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>transaction_description</term>
+ <term><varname>paymentmemo</varname></term>
<listitem>
- <para>Vorgangsbezeichnung</para>
+ <para>Memo</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>transdate</term>
+ <term><varname>paymentsource</varname></term>
<listitem>
- <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
- erstellt wurde</para>
+ <para>Beleg</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
- <title>Variablen für jeden Posten auf der Rechnung</title>
+ <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
+ <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
- <variablelist>
- <varlistentry>
- <term>bin</term>
+ <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>
- <listitem>
- <para>Stellage</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term>description</term>
+ <sect2 id="dokumentenvorlagen-und-variablen.dunning">
+ <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
- <listitem>
- <para>Artikelbeschreibung</para>
- </listitem>
- </varlistentry>
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
+ <title>Namen der Vorlagen</title>
- <varlistentry>
- <term>discount</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>Rabatt als Betrag</para>
- </listitem>
- </varlistentry>
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
+ <title>Allgemeine Variablen in Mahnungen</title>
- <varlistentry>
- <term>discount_sub</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>Zwischensumme mit Rabatt</para>
- </listitem>
- </varlistentry>
+ <para>Weitere Variablen beinhalten:</para>
+ <variablelist>
<varlistentry>
- <term>drawing</term>
+ <term><varname>dunning_date</varname></term>
<listitem>
- <para>Zeichnung</para>
+ <para>Datum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ean</term>
+ <term><varname>dunning_duedate</varname></term>
<listitem>
- <para>EAN-Code</para>
+ <para>Fälligkeitsdatum für diese Mahhnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>image</term>
+ <term><varname>dunning_id</varname></term>
<listitem>
- <para>Grafik</para>
+ <para>Mahnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>linetotal</term>
+ <term><varname>fee</varname></term>
<listitem>
- <para>Zeilensumme (Anzahl * Einzelpreis)</para>
+ <para>Kummulative Mahngebühren</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>longdescription</term>
+ <term><varname>interest_rate</varname></term>
<listitem>
- <para>Langtext</para>
+ <para>Zinssatz per anno in Prozent</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>microfiche</term>
+ <term><varname>total_amount</varname></term>
<listitem>
- <para>Mikrofilm</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>netprice</term>
+ <term><varname>total_interest</varname></term>
<listitem>
- <para>Nettopreis</para>
+ <para>Zinsen per anno über alle Rechnungen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>nodiscount_linetotal</term>
+ <term><varname>total_open_amount</varname></term>
<listitem>
- <para>Zeilensumme 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>nodiscount_sub</term>
+ <term><varname>dn_amount</varname></term>
<listitem>
- <para>Zwischensumme ohne Rabatt</para>
+ <para>Rechnungssumme (brutto)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>number</term>
+ <term><varname>dn_duedate</varname></term>
<listitem>
- <para>Artikelnummer</para>
+ <para>Originales Fälligkeitsdatum der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ordnumber_oe</term>
+ <term><varname>dn_dunning_date</varname></term>
<listitem>
- <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
- aus einem Sammelauftrag erstellt wurde</para>
+ <para>Datum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>p_discount</term>
+ <term><varname>dn_dunning_duedate</varname></term>
<listitem>
- <para>Rabatt in Prozent</para>
+ <para>Fälligkeitsdatum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>partnotes</term>
+ <term><varname>dn_fee</varname></term>
<listitem>
- <para>Die beim Artikel gespeicherten Bemerkungen</para>
+ <para>Kummulative Mahngebühr</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>partsgroup</term>
+ <term><varname>dn_interest</varname></term>
<listitem>
- <para>Warengruppe</para>
+ <para>Zinsen per anno für diese Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>price_factor</term>
+ <term><varname>dn_invnumber</varname></term>
<listitem>
- <para>Der Preisfaktor als Zahl, sofern einer eingestellt
- ist</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>price_factor_name</term>
+ <term><varname>dn_linetotal</varname></term>
<listitem>
- <para>Der Name des Preisfaktors, sofern einer eingestellt
- ist</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>projectnumber</term>
+ <term><varname>dn_netamount</varname></term>
<listitem>
- <para>Projektnummer</para>
+ <para>Rechnungssumme (netto)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>projectdescription</term>
+ <term><varname>dn_open_amount</varname></term>
<listitem>
- <para>Projektbeschreibung</para>
+ <para>Offener Rechnungsbetrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>qty</term>
+ <term><varname>dn_ordnumber</varname></term>
<listitem>
- <para>Anzahl</para>
+ <para>Bestellnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>reqdate</term>
+ <term><varname>dn_transdate</varname></term>
<listitem>
- <para>Lieferdatum</para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>runningnumber</term>
+ <term><varname>dn_curr</varname></term>
<listitem>
- <para>Position auf der Rechnung (1, 2, 3...)</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>
- <varlistentry>
- <term>sellprice</term>
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
+ <title>Variablen in automatisch erzeugten Rechnungen über
+ Mahngebühren</title>
- <listitem>
- <para>Verkaufspreis</para>
- </listitem>
- </varlistentry>
+ <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>
- <variablelist>
- <varlistentry>
- <term>payment</term>
+ <sect3>
+ <title>Einführung</title>
- <listitem>
- <para>Betrag</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term>paymentaccount</term>
+ <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>
- <listitem>
- <para>Konto</para>
- </listitem>
- </varlistentry>
+ <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>paymentdate</term>
+ <term><varname>quonumber</varname></term>
<listitem>
- <para>Datum</para>
+ <para>Angebots- bzw. Anfragenummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>paymentmemo</term>
+ <term><varname>reqdate</varname></term>
<listitem>
- <para>Memo</para>
+ <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
+ Preisanfragen)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>paymentsource</term>
+ <term><varname>transdate</varname></term>
<listitem>
- <para>Beleg</para>
+ <para>Angebots- bzw. Anfragedatum</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>
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
+ <title>Auftragsbestätigungen und Lieferantenaufträge</title>
<variablelist>
<varlistentry>
- <term>dunning_date</term>
+ <term><varname>ordnumber</varname></term>
<listitem>
- <para>Datum der Mahnung</para>
+ <para>Auftragsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dunning_duedate</term>
+ <term><varname>reqdate</varname></term>
<listitem>
- <para>Fälligkeitsdatum für diese Mahhnung</para>
+ <para>Lieferdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dunning_id</term>
+ <term><varname>transdate</varname></term>
<listitem>
- <para>Mahnungsnummer</para>
+ <para>Auftragsdatum</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
+ <title>Lieferscheine (Verkauf und Einkauf)</title>
+ <variablelist>
<varlistentry>
- <term>fee</term>
+ <term><varname>cusordnumber</varname></term>
<listitem>
- <para>Kummulative Mahngebühren</para>
+ <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
+ des Lieferanten (im Einkauf)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>interest_rate</term>
+ <term><varname>donumber</varname></term>
<listitem>
- <para>Zinssatz per anno in Prozent</para>
+ <para>Lieferscheinnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>total_amount</term>
+ <term><varname>transdate</varname></term>
<listitem>
- <para>Gesamter noch zu zahlender Betrag als
- <function>fee</function> + <function>total_interest</function>
- + <function>total_open_amount</function></para>
+ <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>total_interest</term>
+ <term><varname>si_bin</varname></term>
<listitem>
- <para>Zinsen per anno über alle Rechnungen</para>
+ <para>Lagerplatz</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>total_open_amount</term>
+ <term><varname>si_chargenumber</varname></term>
<listitem>
- <para>Summe über alle offene Beträge der Rechnungen</para>
+ <para>Chargennummer</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
- <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
+ <varlistentry>
+ <term><varname>si_bestbefore</varname></term>
+
+ <listitem>
+ <para>Mindesthaltbarkeit</para>
+ </listitem>
+ </varlistentry>
- <variablelist>
<varlistentry>
- <term>dn_amount</term>
+ <term><varname>si_number</varname></term>
<listitem>
- <para>Rechnungssumme (brutto)</para>
+ <para>Artikelnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_duedate</term>
+ <term><varname>si_qty</varname></term>
<listitem>
- <para>Originales Fälligkeitsdatum der Rechnung</para>
+ <para>Anzahl bzw. Menge</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_dunning_date</term>
+ <term><varname>si_runningnumber</varname></term>
<listitem>
- <para>Datum der Mahnung</para>
+ <para>Positionsnummer (1, 2, 3 etc)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_dunning_duedate</term>
+ <term><varname>si_unit</varname></term>
<listitem>
- <para>Fälligkeitsdatum der Mahnung</para>
+ <para>Einheit</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_fee</term>
+ <term><varname>si_warehouse</varname></term>
<listitem>
- <para>Kummulative Mahngebühr</para>
+ <para>Lager</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
+ <title>Variablen für Sammelrechnung</title>
+
+ <variablelist>
<varlistentry>
- <term>dn_interest</term>
+ <term><varname>c0total</varname></term>
<listitem>
- <para>Zinsen per anno für diese Rechnung</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
+ Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_invnumber</term>
+ <term><varname>c30total</varname></term>
<listitem>
- <para>Rechnungsnummer</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
+ und < 60 Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_linetotal</term>
+ <term><varname>c60total</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>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
+ und < 90 Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_netamount</term>
+ <term><varname>c90total</varname></term>
<listitem>
- <para>Rechnungssumme (netto)</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
+ Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_open_amount</term>
+ <term><varname>total</varname></term>
<listitem>
- <para>Offener Rechnungsbetrag</para>
+ <para>Gesamtbetrag aller Rechnungen</para>
</listitem>
</varlistentry>
+ </variablelist>
+
+ <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
+ <variablelist>
<varlistentry>
- <term>dn_ordnumber</term>
+ <term><varname>invnumber</varname></term>
<listitem>
- <para>Bestellnummer</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dn_transdate</term>
+ <term><varname>invdate</varname></term>
<listitem>
<para>Rechnungsdatum</para>
</varlistentry>
<varlistentry>
- <term>dn_curr</term>
+ <term><varname>duedate</varname></term>
<listitem>
- <para>Währung, in der die Rechnung erstellt wurde. (Die
- Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
+ <para>Fälligkeitsdatum</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>duedate</term>
+ <term><varname>amount</varname></term>
<listitem>
- <para>Fälligkeitsdatum der Rechnung</para>
+ <para>Summe der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>dunning_id</term>
+ <term><varname>open</varname></term>
<listitem>
- <para>Mahnungsnummer</para>
+ <para>Noch offener Betrag der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>fee</term>
+ <term><varname>c0</varname></term>
<listitem>
- <para>Mahngebühren</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
+ Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>interest</term>
+ <term><varname>c30</varname></term>
<listitem>
- <para>Zinsen</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
+ < 60 Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>invamount</term>
+ <term><varname>c60</varname></term>
<listitem>
- <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
- <varname>interest</varname>)</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
+ < 90 Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>invdate</term>
+ <term><varname>c90</varname></term>
<listitem>
- <para>Rechnungsdatum</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
+ Tage</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
- <varlistentry>
- <term>invnumber</term>
+ <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
+ <title>Blöcke, bedingte Anweisungen und Schleifen</title>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
+ <title>Einfürhung</title>
+
+ <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>
+
+ <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>
+
+ <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 kivitendo Text
+ anders formatiert haben möchte, so ist dies begrenzt möglich.
+ kivitendo 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><s>Text</s></term>
+
+ <listitem>
+ <para>Text wird durchgestrichen. Diese Formatierung ist nicht
+ bei der Ausgabe als PDF über LaTeX verfügbar.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><bullet></term>
+
+ <listitem>
+ <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
+ unten).</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Der Befehl <command><bullet></command> funktioniert
+ momentan auch nur in Latex-Vorlagen.</para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="excel-templates">
+ <title>Excel-Vorlagen</title>
+
+ <sect2 id="excel-templates.summary">
+ <title>Zusammenfassung</title>
+
+ <para>Dieses Dokument beschreibt den Mechanismus, mit dem
+ Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
+ einhergehen.</para>
+ </sect2>
+
+ <sect2 id="excel-templates.usage">
+ <title>Bedienung</title>
+
+ <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>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>Chargennummer</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para><varname>$form</varname> referenziert ab hier
+ <varname>$PACKAGE::form</varname>.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>si_bestbefore</term>
+ <varlistentry>
+ <term><literal>local $form</literal></term>
- <listitem>
- <para>Mindesthaltbarkeit</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Alle Änderungen an <varname>$form</varname> werden am Ende
+ des scopes zurückgesetzt</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
- <varlistentry>
- <term>si_number</term>
+ <sect2>
+ <title>Warum sind globale Variablen ein Problem?</title>
- <listitem>
- <para>Artikelnummer</para>
- </listitem>
- </varlistentry>
+ <para>Das erste Problem ist <productname>FCGI</productname>.</para>
- <varlistentry>
- <term>si_qty</term>
+ <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>
- <listitem>
- <para>Anzahl bzw. Menge</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term>si_runningnumber</term>
+ <sect2>
+ <title>Kanonische globale Variablen</title>
- <listitem>
- <para>Positionsnummer (1, 2, 3 etc)</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term>si_unit</term>
+ <para>Diese Variablen sind im Moment die folgenden neun:</para>
- <listitem>
- <para>Einheit</para>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para><varname>$::form</varname></para>
+ </listitem>
+
+ <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>
- <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
- <title>Einfürhung</title>
+ <itemizedlist>
+ <listitem>
+ <para>Objekt der Klasse "Locale"</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>Wird pro Request erstellt</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>Muss auch für Tests und Scripte immer verfügbar
+ sein.</para>
+ </listitem>
- <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>
+ <listitem>
+ <para>Cached intern über Requestgrenzen hinweg benutzte
+ Locales</para>
+ </listitem>
+ </itemizedlist>
+
+ <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/kivitendo-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/kivitendo.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/kivitendo-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>wird pro Serverprozess erstellt.</para>
+ </listitem>
<listitem>
- <para>Text wird durchgestrichen. Diese Formatierung ist nicht
- bei der Ausgabe als PDF über LaTeX verfügbar.</para>
+ <para>enthält Informationen über die technische Verbindung zum
+ Server</para>
</listitem>
- </varlistentry>
+ </itemizedlist>
- <varlistentry>
- <term><bullet></term>
+ <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>
+ <sect3>
+ <title>$::request</title>
+
+ <itemizedlist>
<listitem>
- <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
- unten).</para>
+ <para>Hashref (evtl später Objekt)</para>
</listitem>
- </varlistentry>
- </variablelist>
-
- <para>Der Befehl <command><bullet></command> funktioniert
- momentan auch nur in Latex-Vorlagen.</para>
- </sect2>
- </sect1>
- <sect1 id="excel-templates">
- <title>Excel-Vorlagen</title>
+ <listitem>
+ <para>Wird pro Request neu initialisiert.</para>
+ </listitem>
- <sect2 id="excel-templates.summary">
- <title>Zusammenfassung</title>
+ <listitem>
+ <para>Keine Unterstruktur garantiert.</para>
+ </listitem>
+ </itemizedlist>
- <para>Dieses Dokument beschreibt den Mechanismus, mit dem
- Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
- einhergehen.</para>
- </sect2>
+ <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>
- <sect2 id="excel-templates.usage">
- <title>Bedienung</title>
+ <para>Vieles von dem, was im moment in <varname>$::form</varname>
+ liegt, sollte eigentlich hier liegen. Die groben
+ Differentialkriterien sind:</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>
+ <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>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>Sind es Daten aus der Datenbank, die nur bis zum Ende des
+ Requests gebraucht werden? Dann
+ <varname>$::request</varname></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>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>
+
+ <listitem>
+ <para>liegt jetzt unter
+ <varname>$::request->{cgi}</varname></para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
- <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
+ <sect3>
+ <title>$::all_units</title>
- <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>
+ <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>
- <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
- der Block mit einem Leerzeichen anfängt. Beispiel:</para>
+ <listitem>
+ <para>Liegt jetzt unter
+ <varname>$::request->{cache}{all_units}</varname></para>
+ </listitem>
- <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
+ <listitem>
+ <para>Wird nur in
+ <function>AM->retrieve_all_units()</function> gesetzt oder
+ gelesen.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
- <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
- Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
- entfernt.</para>
- </sect2>
+ <sect3>
+ <title>%::called_subs</title>
- <sect2 id="excel-templates.limitations">
- <title>Einschränkungen</title>
+ <itemizedlist>
+ <listitem>
+ <para>wurde benutzt um callsub deep recursions
+ abzufangen.</para>
+ </listitem>
- <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>
+ <listitem>
+ <para>Wurde entfernt, weil callsub nur einen Bruchteil der
+ möglichen Rekursioenen darstellt, und da nie welche
+ auftreten.</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>komplette recursion protection wurde entfernt.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
</sect2>
</sect1>
<sect2 id="devel.fcgi.general">
<title>Allgemeines</title>
- <para>Wenn Änderungen in der Konfiguration von Lx-Office gemacht
+ <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
werden, muss der Webserver neu gestartet werden.</para>
<para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
am Laufen zu halten. Man kann mit <function>die</function>,
<function>confess</function> oder <function>carp</function> Fehler
- ausgeben, die dann vom Dispatcher angezeigt werden. Die Lx-Office
+ ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
eigene <function>$::form-</function>error()> tut im Prinzip das
Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
<function>exit</function> hingegen werden nicht abgefangen.
<function>warn</function> wird direkt nach STDERR, also in Server Log
eine Nachricht schreiben (sofern in der Konfiguration nicht die
- Warnungen in das Lx-Office Log umgeleitet wurden), und
+ Warnungen in das kivitendo Log umgeleitet wurden), und
<function>exit</function> wird die Ausführung beenden.</para>
<para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
<para>Die kritischen Pfade des Programms sind die Belegmasken, und
unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
- Rechnungsmaske in Lx-Office 2.4.3 stable dauert auf einem Core2duo mit
+ Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
sind es je nach Menge der definierten Variablen 1-2s. Ab der
Moose/Rose::DB Version sind es 5-6s.</para>
</sect1>
<sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
- <title>SQL-Upgradedateien</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>
- 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>
+ <title>SQL-Upgradedateien</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>
+ <sect2 id="db-upgrade-files.introduction"
+ xreflabel="Einführung in die Datenbank-Upgradedateien">
+ <title>Einführung</title>
- <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>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 kivitendo 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>kivitendo 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>
- <sect2 id="db-upgrade-files.format" xreflabel="Format der Upgradedateien">
- <title>Format der Kontrollinformationen</title>
+ <sect2 id="db-upgrade-files.format"
+ xreflabel="Format der Upgradedateien">
+ <title>Format der Kontrollinformationen</title>
- <para>
- Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
- hat dabei das folgende Format:
- </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>
- Für SQL-Upgradedateien:
- </para>
+ <para>Für SQL-Upgradedateien:</para>
- <programlisting>-- @key: value</programlisting>
+
<programlisting>-- @key: value</programlisting>
- <para>
- Für Perl-Upgradedateien:
- </para>
+ <para>Für Perl-Upgradedateien:</para>
- <programlisting># @key: value</programlisting>
+
<programlisting># @key: value</programlisting>
- <para>
- Leerzeichen vor "<varname>value</varname>" werden entfernt.
- </para>
+ <para>Leerzeichen vor "<varname>value</varname>" werden
+ entfernt.</para>
- <para>
- Die folgenden Schlüsselworte werden verarbeitet:
- </para>
+ <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
- <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>
+ <variablelist>
+ <varlistentry>
+ <term><varname>tag</varname></term>
- <para>
- Normalerweise sollte die Kontrolldatei genau so heißen wie der "tag", nur mit der Endung ".sql" bzw. "pl".
- </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>
- 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>
+ <varlistentry>
+ <term><varname>charset</varname></term>
- <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>
+ <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>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>
+ <varlistentry>
+ <term><varname>description</varname></term>
- <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>
+ <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>
- <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>
+ <varlistentry>
+ <term><varname>depends</varname></term>
- <para>
- Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu definieren (z.B. "a" -> "b",
- "b" -> "c" und "c" -> "a").
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
+ von denen dieses Upgradescript abhängt. kivitendo 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>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>
+ <varlistentry>
+ <term><varname>priority</varname></term>
- <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. 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. kivitendo 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>
- <sect2 id="db-upgrade-files.dbupgrade-tool" xreflabel="Hilfsscript dbupgrade2_tool.pl">
- <title>Hilfsscript dbupgrade2_tool.pl</title>
+ <varlistentry>
+ <term><varname>ignore</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. 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>
- 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>
+ <sect2 id="db-upgrade-files.dbupgrade-tool"
+ xreflabel="Hilfsscript dbupgrade2_tool.pl">
+ <title>Hilfsscript dbupgrade2_tool.pl</title>
- <itemizedlist>
- <listitem>
- <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl --list</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
+ kivitendo-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 kivitendo selber, sodass alle Fehlersituationen
+ von der Kommandozeile überprüft werden können.</para>
- <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>
+ <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>
- <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl --tree</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, von denen keine
- anderen abhängen. Die Unterknoten sind Scripte, die beim übergeordneten Script als Abhängigkeit eingetragen sind.
- </para>
- </listitem>
+ <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
+ Reihenfolge sortiert, in der kivitendo die Scripte ausführen
+ würde. Es werden neben der Listenposition der Tag, die
+ Abhängigkeitstiefe und die Priorität ausgegeben.</para>
+ </listitem>
- <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
- <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl --rtree</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>
- 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>
+ <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
+ <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
+ --rtree</command>"</para>
- <listitem>
- <para>Baumform mit Postscriptausgabe: "<command>./scripts/dbupgrade2_tool.pl --graphviz</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>
- 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>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>
+ <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>
+ <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">
internationalen Übersetzern die Arbeit zu erleichtern.</para>
</note>
- <para>This section describes how localization packages in Lx-Office
+ <para>This section describes how localization packages in kivitendo
are built. Currently the only language fully supported is German, and
since most of the internal messages are held in English the English
version is usable too.</para>
xreflabel="File structure">
<title>File structure</title>
- <para>The structure of locales in Lx-Office is:</para>
+ <para>The structure of locales in kivitendo is:</para>
- <programlisting>lx-office/locale/<langcode>/</programlisting>
+ <programlisting>kivitendo/locale/<langcode>/</programlisting>
<para>where <langcode> stands for an abbreviation of the
language package. The builtin packages use two letter <ulink
<term>special_chars</term>
<listitem>
- <para>Lx-Office comes with a lot of interfaces to different
+ <para>kivitendo comes with a lot of interfaces to different
formats, some of which are rather picky with their accepted
charset. The <filename>special_chars</filename> file contains a
listing of chars not suited for different file format and
</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 kivitendo
+ 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>kivitendo 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>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><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 kivitendo ü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 kivitendo-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
+ kivitendo-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