<?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="lx-office-documentation" lang="de">
- <title>Lx-Office: Installation, Konfiguration, Entwicklung</title>
+<book id="kivitendo-documentation" lang="de">
+ <title>kivitendo 3.0.0: 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>
- </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 kivitendo-Forum: <ulink
+ url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="config">
<title>Installation und Grundkonfiguration</title>
+ <sect1 id="Installation-Übersicht">
+ <title>Übersicht</title>
+
+ <para>
+ Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
+ Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
+ </para>
+
+ <orderedlist>
+ <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
+ Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
+ befindet sich hier.</para></listitem>
+
+ <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
+ linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
+ linkend="config.config-file"/>" erläutert.</para></listitem>
+
+ <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
+ linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
+ linkend="Apache-Konfiguration"/>"). </para></listitem>
+
+ <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
+ Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
+ linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
+
+ <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
+ linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
+
+ <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
+ linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
+ </orderedlist>
+
+ <para>
+ Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen
+ werden.
+ </para>
+ </sect1>
+
<sect1 id="Benötigte-Software-und-Pakete">
<title>Benötigte Software und Pakete</title>
<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 2012 sind das folgende Systeme, von denen bekannt ist, dass Lx-Office auf ihnen läuft:</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, 10.04 LTS Lucid Lynx bis 11.10 Oneiric Ocelot</para>
+ <para>Debian</para>
+ <itemizedlist>
+ <listitem>
+ <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden)</para>
+ </listitem>
+ <listitem>
+ <para>7.0 "Wheezy"</para>
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
- <para>Debian 5.0 Lenny und 6.0 Squeeze</para>
+ <para>Ubuntu 10.04 LTS "Lucid Lynx", 12.04 LTS "Precise Pangolin" und 12.10 "Oneiric Ocelot"`</para>
</listitem>
<listitem>
- <para>openSUSE 11.2 und 11.3</para>
+ <para>openSUSE 12.1 und 12.2</para>
</listitem>
<listitem>
</listitem>
<listitem>
- <para>Fedora 13 bis 15</para>
+ <para>Fedora 16 und 17</para>
</listitem>
</itemizedlist>
+ </sect2>
- <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>
+ <sect2 id="Pakete" xreflabel="Pakete">
+ <title>Benötigte Perl-Pakete installieren</title>
- <para>Zur Installation das Paket in das entpackte Lx-Office
- Verzeichnis entpacken:</para>
+ <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
+ Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
+ benötigt.</para>
- <programlisting>tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/</programlisting>
+ <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
+ überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
+ wird:</para>
- <para>Zusätzlich müssen dann noch die folgenden Pakete installiert
- weerden</para>
+ <programlisting>./scripts/installation_check.pl</programlisting>
- <programlisting>apt-get install libbit-vector-perl libsub-exporter-perl libclone-perl libclass-factory-util-perl</programlisting>
+ <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
- <para>Danach sollte der Installationscheck (siehe <xref
- linkend="Pakete"/>) die enthaltenen Pakete erkennen.</para>
- </sect2>
+ <itemizedlist>
+ <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
- <sect2 id="Pakete" xreflabel="Pakete">
- <title>Pakete</title>
+ <listitem><para><literal>Archive::Zip</literal></para></listitem>
- <para>Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist
- Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
- benötigt.</para>
+ <listitem><para><literal>Config::Std</literal></para></listitem>
- <para>Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die
- nicht Bestandteil einer Standard-Perl-Installation sind:</para>
+ <listitem><para><literal>DateTime</literal></para></listitem>
- <itemizedlist>
- <listitem>
- <para>parent</para>
- </listitem>
+ <listitem><para><literal>DBI</literal></para></listitem>
- <listitem>
- <para>Archive::Zip</para>
- </listitem>
+ <listitem><para><literal>DBD::Pg</literal></para></listitem>
- <listitem>
- <para>Config::Std</para>
- </listitem>
+ <listitem><para><literal>Email::Address</literal></para></listitem>
- <listitem>
- <para>DateTime</para>
- </listitem>
+ <listitem><para><literal>Email::MIME</literal></para></listitem>
- <listitem>
- <para>DBI</para>
- </listitem>
+ <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
- <listitem>
- <para>DBD::Pg</para>
- </listitem>
+ <listitem><para><literal>JSON</literal></para></listitem>
- <listitem>
- <para>Email::Address</para>
- </listitem>
+ <listitem><para><literal>List::MoreUtils</literal></para></listitem>
- <listitem>
- <para>JSON</para>
- </listitem>
+ <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
+ linkend="config.sending-email.smtp"/>")</para></listitem>
- <listitem>
- <para>List::MoreUtils</para>
- </listitem>
+ <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
+ linkend="config.sending-email.smtp"/>")</para></listitem>
- <listitem>
- <para>Params::Validate</para>
- </listitem>
+ <listitem><para><literal>Params::Validate</literal></para></listitem>
- <listitem>
- <para>PDF::API2</para>
- </listitem>
+ <listitem><para><literal>PDF::API2</literal></para></listitem>
- <listitem>
- <para>Rose::Object</para>
- </listitem>
+ <listitem><para><literal>Rose::Object</literal></para></listitem>
- <listitem>
- <para>Rose::DB</para>
- </listitem>
+ <listitem><para><literal>Rose::DB</literal></para></listitem>
- <listitem>
- <para>Rose::DB::Object</para>
- </listitem>
+ <listitem><para><literal>Rose::DB::Object</literal></para></listitem>
- <listitem>
- <para>Template</para>
- </listitem>
+ <listitem><para><literal>Template</literal></para></listitem>
- <listitem>
- <para>Text::CSV_XS</para>
- </listitem>
+ <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
- <listitem>
- <para>Text::Iconv</para>
- </listitem>
+ <listitem><para><literal>Text::Iconv</literal></para></listitem>
- <listitem>
- <para>URI</para>
- </listitem>
+ <listitem><para><literal>URI</literal></para></listitem>
- <listitem>
- <para>XML::Writer</para>
- </listitem>
+ <listitem><para><literal>XML::Writer</literal></para></listitem>
- <listitem>
- <para>YAML</para>
- </listitem>
+ <listitem><para><literal>YAML</literal></para></listitem>
</itemizedlist>
+ <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
+ <literal>Net::SSLGlue</literal>.</para>
+
<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
installieren.</para>
- <para>Die zu installierenden Pakete können in den verschiedenen
- Distributionen unterschiedlich heißen.</para>
-
- <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
+ <sect3>
+ <title>Debian und Ubuntu</title>
+
+ <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
+ installiert werden:</para>
+
+ <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
+ libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
+ libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
+ liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
+ libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
+ librose-db-perl librose-object-perl libsort-naturally-perl \
+ libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
+ libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
+ postgresql</programlisting>
+ </sect3>
- <programlisting>apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
- libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
- libemail-address-perl liblist-moreutils-perl libpdf-api2-perl \
- librose-object-perl librose-db-perl librose-db-object-perl \
- libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
- libxml-writer-perl libyaml-perl libconfig-std-perl \
- libparams-validate-perl libjson-perl</programlisting>
+ <sect3>
+ <title>Fedora Core</title>
- <para>Für Fedora Core benötigen Sie diese Pakete:</para>
+ <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden:</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 \
+ <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
+ perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
+ perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
+ perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
+ perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
- perl-XML-Writer perl-YAML</programlisting>
+ perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
- <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
+ <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</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>
+ <programlisting>yum install perl-CPAN
+cpan Config::Std</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>
+ </sect3>
- <para>Lx-Office enthält ein Script, mit dem überprüft werden kann, ob
- alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
- folgt:</para>
+ <sect3>
+ <title>openSUSE</title>
- <programlisting>./scripts/installation_check.pl</programlisting>
+ <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
+ installiert werden:</para>
+
+ <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
+ perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
+ perl-Email-MIME perl-FastCGI perl-JSON perl-List-MoreUtils \
+ perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
+ perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
+ perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
+
+ <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
+
+ <programlisting>yum install perl-CPAN
+cpan Rose::Db::Object</programlisting>
+
+ </sect3>
</sect2>
</sect1>
xreflabel="Manuelle Installation des Programmpaketes">
<title>Manuelle Installation des Programmpaketes</title>
- <para>Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.3.tgz) wird
- im Dokumentenverzeichnis des Webservers (z.B.
- <filename>/var/www/html/</filename>,
- <filename>/srv/www/htdocs</filename> oder
- <filename>/var/www/</filename>) entpackt:</para>
+ <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) 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-3.0.0.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>
- 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>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>
- Als Vorlage dient die Datei <filename>config/lx_office.conf.default</filename> (kurz: "die Default-Datei"):
- </para>
+ <para>Als Vorlage dient die Datei
+ <filename>config/kivitendo.conf.default</filename> (kurz: "die
+ Default-Datei"):</para>
- <programlisting>$ cp config/lx_office.conf.default config/lx_office.conf</programlisting>
+ <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
- <para>
- Die Default-Datei wird immer zuerst eingelesen. Werte, die in der Hauptkonfigurationsdatei stehen, überschreiben die
- Werte aus der Default-Datei. Die Hauptkonfigurationsdatei muss also nur die Abschintte und Werte
- enthalten, die von denen der Default-Datei abweichen.
- </para>
+ <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
+ der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
+ Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
+ Abschnitte und Werte enthalten, die von denen der Default-Datei
+ abweichen.</para>
- <para>
- Diese Hauptkonfigurationsdatei ist dann eine installationsspezifische Datei, d.h. sie enthält bspw. lokale Passwörter und wird auch
- nicht im Versionsmanagement (git) verwaltet.
- </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>
- Die Konfiguration ist ferner serverabhängig, d.h. für alle Mandaten, bzw. Datenbanken gleich.
- </para>
- </sect2>
+ <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>
- <sect2 id="config.config-file.sections-parameters">
- <title>Abschnitte und Parameter</title>
+ <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
+ Mandaten, bzw. Datenbanken gleich.</para>
+ </sect2>
- <para>
- Die Konfigurationsdatei besteht aus mehreren Teilen, die entsprechend kommentiert sind:
- </para>
+ <sect2 id="config.config-file.sections-parameters">
+ <title>Abschnitte und Parameter</title>
- <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 Konfigurationsdatei besteht aus mehreren Teilen, die
+ entsprechend kommentiert sind:</para>
- <para>
- Die üblicherweise wichtigsten Parameter, die am Anfang einzustellen oder zu kontrollieren sind, sind:
- </para>
+ <itemizedlist>
+ <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
+ linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</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> (siehe Kapitel "<xref linkend="features"/>")</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>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</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>
- <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 <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 wiederkehrende Rechnungen, kann man unter
+ <varname>[periodic_invoices]</varname> den Login eines Benutzers
+ angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
+ mit Informationen über die erstellten Rechnungen bekommt.</para>
- <para>
- Nutzt man den <link linkend="config.task-server">Taskserver</link> für <link
- linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>, muss unter <varname>[task_server]</varname> ein Login eines
- Benutzers angegeben werden, mit dem sich der Taskserver an Lx-Office bei der Datenbank anmeldet, die dem Benutzer zugewiesen ist.
- </para>
+ <para>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 Lx-Office Versionen gab es im Verzeichnis <filename>config</filename> die Dateien <filename>authentication.pl</filename>
- und <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es gab auch die Möglichkeit, eine lokale Version der
- Konfigurationsdatei zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab 2.6.3 nicht mehr möglich, aber auch nicht mehr
- nötig.
- </para>
+ <para>Für Entwickler finden sich unter <varname>[debug]</varname>
+ wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
+ </sect2>
- <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>
+ <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.2 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 diesbezüglich
+ unternehmen. Zum Testen:
- <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. für PostgreSQL 8.2 mit dem folgenden Befehl getan werden:</para>
+ <programlisting>su postgres
+echo '\l' | psql
+exit </programlisting>
+
+ Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
+ UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
+ Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
+ getan werden:</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>Die Datenbankversionsnummer muss an die tatsächlich verwendete
+ Versionsnummer angepasst werden.</para>
<para>Unter anderen Distributionen gibt es ähnliche Methoden.</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 <command>psql</command> mit <literal>\l</literal> geprüft werden.</para>
+ <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
+ <literal>\l</literal> geprüft werden.</para>
</sect2>
<sect2 id="Änderungen-an-Konfigurationsdateien">
<para>In der Datei <filename>postgresql.conf</filename>, die je nach
Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
<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
+ <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
+ dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
Parameter <varname>listen_address</varname> gesteuert. Laufen
- PostgreSQL und Lx-Office auf demselben Rechner, so kann dort der Wert
+ 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 <filename>pg_hba.conf</filename>, die im gleichen
- Verzeichnis wie die <filename>postgresql.conf</filename> zu finden sein
- sollte, müssen die Berichtigungen für den Zugriff geändert werden.
- Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale
- Verbindungen immer zuzulassen:</para>
-
- <programlisting>local all all trust
-host all all 127.0.0.1 255.0.0.0 trust</programlisting>
-
- <para>Besser ist es, für eine bestimmte Datenbank Zugriff nur per
- Passwort zuzulassen. Beispielsweise:</para>
-
- <programlisting>local all lxoffice password
-host all lxoffice 127.0.0.1 255.255.255.255 password</programlisting>
+ 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
+ Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
+ <programlisting>su - postgres
+psql template1</programlisting>
+
führen Sie die folgenden Kommandos aus:</para>
- <programlisting>create language 'plpgsql';</programlisting>
+ <programlisting>create language 'plpgsql';
+\q</programlisting>
</sect2>
<sect2 id="Datenbankbenutzer-anlegen">
anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
können:</para>
- <programlisting>su - postgres createuser -d -P lxoffice</programlisting>
+ <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
+ beantworten, genauso ist die Berechtigung neue User (Roles) zu
+ generieren nicht nötig.</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
wird:</para>
<programlisting>AddHandler cgi-script .pl
-Alias /lx-erp/ /var/www/lx-erp/
+Alias /kivitendo-erp/ /var/www/kiviteno-erp/
-<Directory /var/www/lx-erp>
- Options ExecCGI
- Includes FollowSymlinks
+<Directory /var/www/kivitendo-erp>
+ Options ExecCGI Includes FollowSymlinks
</Directory>
-<Directory /var/www/lx-erp/users>
+<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>
<note>
- <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein Plus ‘<literal>+</literal>’ gesetzt werden.</para>
+ <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
<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>
verwendet.</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
- Probleme mit Umlauten in Ihrere Installation gibt, muss auf die Vorgängerversion FCGI 0.68 ausgewichen werden.
- </para>
+ <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
+ bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
+ aber Version 0.72 und neuer eingesetzt werden.</para>
- <para>
- Mit CPAN lässt sie sich die Vorgängerversion wie folgt installieren:
- </para>
+ <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
+ installieren:</para>
<programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
</warning>
<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>/url/for/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 ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi
-Alias /url/for/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 ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
-Alias /url/for/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 /url/for/lx-office-erp /path/to/lx-office-erp
+Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
# Zugriff mit mod_fcgid:
-AliasMatch ^/url/for/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
-Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/</programlisting>
+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>/url/for/lx-office-erp/</filename> die normale Version erreichbar, und unter
- <constant>/url/for/lx-office-erp-fcgid/</constant> die FastCGI-Version.</para>
+ <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>
<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>
<variablelist>
- <varlistentry>
- <term><varname>login</varname></term>
- <listitem>
- <para>
- gültiger Lx-Office-Benutzername, der benutzt wird, um die zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss in
- der Administration angelegt werden. Diese Option muss angegeben werden.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><varname>login</varname></term>
- <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>
+ <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>
- <varlistentry>
- <term><varname>debug</varname></term>
- <listitem>
- <para>
- Schaltet Debug-Informationen an und aus.
- </para>
- </listitem>
- </varlistentry>
+ <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>
<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
anstelle eines symbolischen Links verwendet werden können.</para>
<sect3>
- <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
- Core)</title>
+ <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora 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>
- <programlisting>update-rc.d lx-office-task-server defaults
+ <programlisting>update-rc.d kivitendo-task-server defaults
# Nur bei Debian Squeeze und neuer:
-insserv lx-office-task-server</programlisting>
+insserv kivitendo-task-server</programlisting>
</listitem>
<listitem>
- <para>OpenSuSE und Fedora Core:</para>
+ <para>Ältere OpenSUSE und ältere Fedora Core:</para>
- <programlisting>chkconfig --add lx-office-task-server</programlisting>
+ <programlisting>chkconfig --add kivitendo-task-server</programlisting>
</listitem>
</itemizedlist>
- <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: <command>/etc/init.d/lx-office-task-server
- start</command></para>
+ <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
+ werden:</para>
+
+ <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
</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: <command>service lx-office-task-server
- start</command></para>
+ <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
+ werden:</para>
+
+ <programlisting>service kivitendo-task-server start</programlisting>
+ </sect3>
+
+ <sect3>
+ <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
+
+ <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
+ <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
+ <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
+ </para>
+
+ <para>Alle hierzu benötigten Befehle sehen so aus:</para>
+
+ <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
+ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
+
+ <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
+ werden:</para>
+
+ <programlisting>systemctl start kivitendo-task-server.service</programlisting>
</sect3>
</sect2>
</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>
<sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
<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>
<sect2 id="Administratorpasswort">
<title>Administratorpasswort</title>
- <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es
- kann auch nur dort und nicht mehr im Administrationsinterface selber geändert werden. Der Parameter dazu heißt
- <varname>admin_password</varname> im Abschnitt <varname>[authentication]</varname>.</para>
+ <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 <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 <varname>[authentication/database]</varname>
- konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
+ <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
+ Parametern in <varname>[authentication/database]</varname>
+ konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
<variablelist>
- <varlistentry>
- <term><literal>host</literal></term>
- <listitem>
- <para>Der Rechnername oder die IP-Adresse des Datenbankservers</para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><literal>host</literal></term>
- <varlistentry>
- <term><literal>port</literal></term>
- <listitem>
- <para>Die Portnummer des Datenbankservers, meist 5432</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Der Rechnername oder die IP-Adresse des
+ Datenbankservers</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><literal>db</literal></term>
- <listitem>
- <para>Der Name der Authentifizierungsdatenbank</para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><literal>port</literal></term>
- <varlistentry>
- <term><literal>user</literal></term>
- <listitem>
- <para>Der Benutzername, mit dem sich Lx-Office beim Datenbankserver anmeldet (z.B. "<literal>postgres</literal>")</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Die Portnummer des Datenbankservers, meist 5432</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><literal>password</literal></term>
- <listitem>
- <para>Das Passwort für den Datenbankbenutzer</para>
- </listitem>
- </varlistentry>
+ <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>
+
+ <varlistentry>
+ <term><literal>password</literal></term>
+
+ <listitem>
+ <para>Das Passwort für den Datenbankbenutzer</para>
+ </listitem>
+ </varlistentry>
</variablelist>
- <para>Die Datenbank muss noch nicht existieren. Lx-Office kann sie
+ <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 die Authentifizierungsdatenbank und gegen einen externen LDAP-
- oder Active-Directory-Server. Welche davon benutzt wird, regelt der Parameter <varname>module</varname> im Abschnitt
+ <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 <varname>module</varname> im Abschnitt
<varname>[authentication]</varname>.</para>
- <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank gespeichert werden, so muss der Parameter
- <varname>module</varname> den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl der Administrator als auch die
- Benutzer selber ihre Psaswörter in Lx-Office ändern.</para>
+ <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
+ 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 <varname>module</varname>
- auf <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen zusätzliche Informationen über den LDAP-Server im Abschnitt
+ <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
+ 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>
<variablelist>
- <varlistentry>
- <term><literal>host</literal></term>
- <listitem>
- <para>Der Rechnername oder die IP-Adresse des LDAP- oder Active-Directory-Servers. Diese Angabe ist zwingend
- erforderlich.</para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><literal>host</literal></term>
- <varlistentry>
- <term><literal>port</literal></term>
- <listitem>
- <para>Die Portnummer des LDAP-Servers; meist 389.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Der Rechnername oder die IP-Adresse des LDAP- oder
+ Active-Directory-Servers. Diese Angabe ist zwingend
+ erforderlich.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><literal>tls</literal></term>
- <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>
+ <varlistentry>
+ <term><literal>port</literal></term>
- <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>
+ <listitem>
+ <para>Die Portnummer des LDAP-Servers; meist 389.</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>tls</literal></term>
- <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>
+ <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>
- <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>
+ <varlistentry>
+ <term><literal>attribute</literal></term>
- <sect2 id="Name-des-Session-Cookies">
- <title>Name des Session-Cookies</title>
+ <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>
- <para>Sollen auf einem Server mehrere Lx-Office-Installationen aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
- Installationen unterschiedlich sein. Der Name des Cookies wird mit dem Parameter <varname>cookie_name</varname> im Abschnitt
- <varname>[authentication]</varname>gesetzt.</para>
+ <varlistentry>
+ <term><literal>base_dn</literal></term>
- <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
- Server existiert.</para>
- </sect2>
+ <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 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 <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>
+ </sect2>
<sect2 id="Anlegen-der-Authentifizierungsdatenbank">
<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="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
+ <title>E-Mail-Versand aus kivitendo heraus</title>
- <para>Das Drucksystem von Lx-Office 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>
+ <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
+ verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
+ unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
+ <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
+ eigenen Internet-Providers).</para>
- <para><literal>texlive-latex-base texlive-latex-extra
- texlive-fonts-recommended</literal></para>
+ <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
+ festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
- <para>Diese hinteren beiden enthalten Bibliotheken und Schriftarten die
- von den Standardvorlagen verwendet werden.</para>
+ <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
+ <title>Versand über lokalen E-Mail-Server</title>
- <para>TODO: rpm Pakete.</para>
+ <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
+ z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
- <para>In den allermeisten Installationen sollte drucken jetzt schon
- funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
- Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
- die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
- Beispiel:</para>
+ <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
+ gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
- <itemizedlist>
- <listitem>
- <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
- LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
- Vorlagen aus der Community auf. Installieren Sie die entsprechenden
- Pakete.</para>
- </listitem>
+ <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
+ ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
+ E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
- <listitem>
- <para>! Package inputenc Error: Unicode char \u8:æ¡\9c not set up for
- use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
- einer Standardinstallation exotische utf8 Zeichen zu drucken.
- TeXLive unterstützt von Haus nur romanische Schriften und muss mit
- diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
- Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
- </listitem>
+ <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
+ E-Mail-Servers verwiesen.</para>
+ </sect2>
+
+ <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
+ <title>Versand über einen SMTP-Server</title>
+
+ <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
+ konfiguriert ist.</para>
+
+ <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
+ Parameter dienen dabei der weiteren Konfiguration:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>hostname</varname></term>
+
+ <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>port</varname></term>
+
+ <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
+ none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
+ ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>security</varname></term>
+
+ <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
+ '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
+ eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
+ '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>login</varname> und <varname>password</varname></term>
+
+ <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
+ und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
+ Verschlüsselung aktiviert werden.</para></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
+
+ <itemizedlist>
+ <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
+ <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
+ <literal>perl-Net-SSLGlue</literal></para></listitem>
+
+ <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
+ <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
+ <literal>perl-Net-SMTP-SSL</literal></para></listitem>
+ </itemizedlist>
+ </sect2>
+ </sect1>
+
+ <sect1 id="Drucken-mit-kivitendo">
+ <title>Drucken mit kivitendo</title>
+
+ <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 installiert man
+ die Pakete mit:</para>
+
+ <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
+ texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
+
+ <para>TODO: RPM-Pakete.</para>
+
+ <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
+ <itemizedlist>
+ <listitem><para>Standard</para></listitem>
+ <listitem><para>f-tex</para></listitem>
+ <listitem><para>RB</para></listitem>
</itemizedlist>
- <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
- heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
- Prüfen Sie den Namen in der Konfiguration (Standard:
- <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
- (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
- darf.</para>
+ <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
+ <title>Vorlagenverzeichnis anlegen</title>
+ <para>Im Administrationsbereich lässt sich bei einem Benutzer/Mandanten einer dieser Vorlagensätze als Basis für die zu
+ druckenden Dokumente auswählen. Rufen Sie dazu die <guimenu>Benutzerverwaltung</guimenu> auf.</para>
+
+ <para>Wählen Sie dort einen Benutzer aus oder legen Sie einen neuen an. In der Benutzerbearbeiten-Maske müssen Sie zwei Dinge
+ angeben:</para>
+
+ <orderedlist>
+ <listitem><para><option>Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
+ Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
+ <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
+ (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
+ </orderedlist>
+
+ <para>Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</para>
+
+ <para>Die Abhängigkeiten kann man prüfen mit:</para>
+
+ <programlisting>/scripts/installation_check.pl -l</programlisting>
+
+ </sect2>
+ <sect2 id="Vorlagen-Standard">
+ <title>Standard</title>
+
+ <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
+ sehen.</para>
+
+ </sect2>
+
+ <sect2 id="f-tex">
+ <title>f-tex</title>
+
+ <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
+
+ <sect3 id="f-tex-Feature-Übersicht">
+ <title>Feature-Übersicht</title>
+ <itemizedlist>
+ <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
+ Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
+
+ <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
+ eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
+
+ <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
+ "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
+
+ <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
+ versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
+ <filename>letter.lco</filename>).</para></listitem>
+
+ <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
+ etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
+
+ <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
+ Rechnung das Land verlässt).</para></listitem>
+
+ <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
+ <filename>translatinos.tex</filename>.</para></listitem>
+
+ <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="f-tex-Installation">
+ <title>Die Installation</title>
+ <itemizedlist>
+ <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
+ Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
+
+ <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
+ <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
+ </itemizedlist>
+
+ <para>oder etwas Detaillierter:</para>
+
+ <para>
+ Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
+ ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
+ ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
+ vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
+ <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
+ </para>
+
+ <para>
+ Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
+ verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
+ <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
+ Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
+ verlinken.
+ </para>
+
+ <para>
+ letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
+ enthält. Bei Updates oder nach erneutem
+ </para>
+
+ <para>
+ Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
+ ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
+ werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
+ </para>
+ <para>
+ Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
+ <filename>*.lco</filename>-Datei erfolgen.
+ </para>
+ </sect3>
+
+ <sect3 id="f-tex-Funktionsübersicht">
+ <title>f-tex Funktionsübersicht</title>
+ <para>
+ Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
+ vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
+ bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
+ briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
+ Besonderheiten der jeweiligen Dokumente Berücksichtigt.
+ </para>
+
+ <itemizedlist>
+ <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
+ <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
+ <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
+ <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
+ Kunde)</para></listitem>
+ </itemizedlist>
+
+ <para>Nachteil:</para>
+
+ <para>
+ LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
+ diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
+ auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
+ schnell häftig in den Fuss schiessen.
+ </para>
+
+ <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
+ mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
+ ausgeliefert werden, erfreuen.
+ </para>
+
+ <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
+
+ </sect3>
+
+ <sect3 id="f-tex-Bruttopreise">
+ <title>Bruttopreise für Endverbraucher</title>
+
+ <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
+ Preise Brutto" auszuwählen, aber:</para>
+ <itemizedlist>
+ <listitem>
+ <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
+ Zuordung einer Default-Preisgruppe handhaben)</para>
+ </listitem>
+ <listitem>
+ <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
+ Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
+ verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
+ Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
+ an (einmal mit der Namensendung "_E"). Gewinn:</para>
+
+ <itemizedlist>
+ <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
+ <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
+ Netto" auszuwählen.</para></listitem>
+ <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
+ ohne dass sich der Auftragswert ändert.</para></listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="f-tex-lieferadressen">
+ <title>Lieferadressen</title>
+
+ <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
+ <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
+ Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
+ der Wert der Hauptadresse angezeigt.
+ </para>
+ </sect3>
+ </sect2>
+
+ <sect2 id="Vorlagen-RB">
+ <title>RB</title>
+
+ <para>Vollständiger Dokumentensatz mit alternativem Design</para>
+
+ </sect2>
+
+ <sect2 id="allgemeine-hinweise-zu-latex">
+ <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
+ <para>In den allermeisten Installationen sollte drucken jetzt schon
+ funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
+ Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
+ die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
+ Beispiel:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
+ LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
+ Vorlagen aus der Community auf. Installieren Sie die entsprechenden
+ Pakete.</para>
+ </listitem>
+ <listitem>
+ <para>! Package inputenc Error: Unicode char \u8:... set up for
+ use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
+ einer Standardinstallation exotische utf8 Zeichen zu drucken.
+ TeXLive unterstützt von Haus nur romanische Schriften und muss mit
+ diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
+ Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
+ heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
+ Prüfen Sie den Namen in der Konfiguration (Standard:
+ <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
+ (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
+ darf.</para>
+
+ <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
+ <itemizedlist>
+ <listitem>
+ <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_tmp_files" auf 1</para>
+ <para><programlisting>keep_temp_files = 1;</programlisting></para>
+ </listitem>
+ <listitem>
+ <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
+ </listitem>
+ <listitem>
+ <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
+ </listitem>
+ <listitem>
+ <para>wechsele in das users Verzeichnis von kivitendo</para>
+ <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
+ </listitem>
+ <listitem>
+ <para>LaTeX Suchpfad anpassen:</para>
+ <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
+ </listitem>
+ <listitem>
+ <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
+ <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
+ <para>Es sollte die letzte Datei ganz unten sein</para>
+ </listitem>
+ <listitem>
+ <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
+ <para><programlisting>pdflatex ./1*.tex</programlisting></para>
+ <para>in der *.tex datei nach dem Fehler suchen.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
</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
Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
sind.</para>
+ <note>
+ <para>
+ Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
+ dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
+ wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
+ festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
+ </para>
+
+ <para>
+ Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
+ z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
+ <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
+ leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
+ Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
+ </para>
+ </note>
+
<para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
<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="config.eur">
- <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR</title>
+ <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
+ EUR</title>
- <sect2 id="config.eur.introduction" xreflabel="Einführung in die Konfiguration zur EUR">
- <title>Einführung</title>
+ <sect2 id="config.eur.introduction"
+ xreflabel="Einführung in die Konfiguration zur EUR">
+ <title>Einführung</title>
- <para>
- Lx-Office besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
- Konfigurationsdatei <filename>config/lx_office.conf</filename> befindet. Somit galt er für alle Mandanten, die in dieser
- Installation benutzt wurden.
- </para>
+ <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
+ Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
+ befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</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>
+ <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>
- <sect2 id="config.eur.parameters" xreflabel="Konfigurationsparameter für EUR">
- <title>Konfigurationsparameter</title>
+ <sect2 id="config.eur.parameters"
+ xreflabel="Konfigurationsparameter für EUR">
+ <title>Konfigurationsparameter</title>
- <para>
- Es gibt drei Parameter, die die Gewinnermittlungsart, Versteuerungsart und die Warenbuchungsmethode regeln:
- </para>
+ <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
+ Versteuerungsart und die Warenbuchungsmethode regeln:</para>
- <variablelist>
- <varlistentry>
- <term><varname>profit_determination</varname></term>
- <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>
+ <variablelist>
+ <varlistentry>
+ <term><varname>profit_determination</varname></term>
- <varlistentry>
- <term><varname>accounting_method</varname></term>
- <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>
+ <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>
- <varlistentry>
- <term><varname>inventory_system</varname></term>
- <listitem>
- <para>
- Dieser Parameter legt die Warenbuchungsmethode fest. Er enthält entweder <literal>perpetual</literal> für die Bestandsmethode
- oder <literal>periodic</literal> für die Aufwandsmethode.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>
- Zum Vergleich der Funktionalität bis und nach 2.6.3: <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
- Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
- Bestandsmethode.
- </para>
-
- <para>
- Die Konfiguration "<varname>eur</varname>" unter <varname>[system]</varname> in der <link
- linkend="config.config-file">Konfigurationsdatei</link> <filename>config/lx_office.conf</filename> wird nun nicht mehr benötigt und
- kann entfernt werden. Dies muss manuell geschehen.
- </para>
+ <varlistentry>
+ <term><varname>accounting_method</varname></term>
+
+ <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>
+
+ <varlistentry>
+ <term><varname>inventory_system</varname></term>
+
+ <listitem>
+ <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
+ enthält entweder <literal>perpetual</literal> für die
+ Bestandsmethode oder <literal>periodic</literal> für die
+ Aufwandsmethode.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>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>
+ <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" (read-only)
+ angezeigt. Unter <guimenu>System</guimenu>
+ -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
+ die Einstellungen auch geändert werden. Dabei ist zu beachten,
+ dass eine Änderung vorhandene Daten so belässt und damit
+ evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
+ Warenbuchungsmethode (siehe auch
+ <link linkend="config.eur.inventory-system-perpetual">
+ Bemerkungen zu Bestandsmethode</link>).</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 Lx-Office aber nur unter bestimmten Bedingungen:
- Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt werden, und man beim Jahreswechsel nicht mit einer leeren
- Datenbank anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie der Einkaufswert der Ware nach dem FIFO-Prinzip aus
- den Einkaufsrechnungen berechnet wird.
- </para>
-
- <para>
- Die Bestandsmethode kann vom Prinzip her also nur funktioneren, wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
- im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode wechseln.
- </para>
+ <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>
+ <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>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>
+ <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
+ Optionen bewirken, z.B. mit zwei Standardfällen.</para>
</sect2>
</sect1>
- <sect1 id="Lx-Office-ERP-verwenden">
- <title>Lx-Office ERP verwenden</title>
+ <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="config.client">
+ <title>Einstellungen pro Mandant</title>
+
+ <para>Einige Einstellungen können von einem Benutzer mit dem
+ <link linkend="Zusammenhänge">Recht</link> "Administration
+ (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
+ gemacht werden. Diese Einstellungen sind dann für die aktuellen
+ Mandanten-Datenbank gültig. Die Einstellungen sind
+ unter <guimenu>System</guimenu>
+ -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
+
+ <para>Bitte beachten Sie die Hinweise zu den einzelnen
+ Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
+ im laufenden Betrieb geändert werden (siehe
+ auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
+ Bestandsmethode</link>).</para>
+
+ <para>Die Einstellungen <literal>show_bestbefore</literal>
+ und <literal>payments_changeable</literal> aus dem
+ Abschnitt <literal>features</literal> und die Einstellungen im
+ Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
+ der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
+ werden bei einem Datenbankupdate einer älteren Version automatisch
+ übernommen. Diese Einträge können danach aus der Konfigurationsdatei
+ entfernt werden.</para>
+ </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/lx-office-erp/login.pl">http://localhost/lx-office-erp/login.pl</ulink></para>
+ 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/lx-office-erp/admin.pl">http://localhost/lx-office-erp/admin.pl</ulink></para>
+ 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>
+ <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>
+ <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>
+ <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>
+ <sect2 id="features.periodic-invoices.configuration"
+ xreflabel="Konfiguration von wiederkehrenden Rechnungen">
+ <title>Konfiguration</title>
- <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>
- 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>
- <para>
- Folgende Parameter kann man konfigurieren:
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>Status</term>
- <variablelist>
- <varlistentry>
- <term>Status</term>
- <listitem>
- <para>
- Bei aktiven Rechnungen wird automatisch eine Rechnung erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines neuen
- Monats).
- </para>
+ <listitem>
+ <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
+ erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
+ neuen Monats).</para>
+
+ <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
+ wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
+ nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
+ nächsten Periodenwechsel für alle Perioden, seit der letzten
+ aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
+ verhindern, muss man vorher das Startdatum neu setzen.</para>
+
+ <para>Für gekündigte Aufträge werden nie mehr Rechnungen
+ erstellt. Man kann sich diese Aufträge aber gesondert in den
+ Berichten anzeigen lassen.</para>
+ </listitem>
+ </varlistentry>
- <para>
- 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>
+ <varlistentry>
+ <term>Periodizität</term>
- <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>
+ <listitem>
+ <para>Ob monatlich, quartalsweise oder jährlich auf neue
+ Rechnungen überprüft werden soll. Für jede Periode seit dem
+ Startdatum wird überprüft, ob für die Periode (beginnend immer
+ mit dem ersten Tag der Periode) schon eine Rechnung erstellt
+ wurde. Unter Umständen können bei einem Startdatum in der
+ Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>Periodizität</term>
- <listitem>
- <para>
- Ob monatlich, quartalsweise oder jährlich auf neue Rechnungen überprüft werden soll. Für jede Periode seit dem Startdatum wird
- überprüft, ob für die Periode (beginnend immer mit dem ersten Tag der Periode) schon eine Rechnung erstellt wurde. Unter Umständen
- können bei einem Startdatum in der Vergangenheit gleich mehrere Rechnungen erstellt werden.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>Buchen auf</term>
- <varlistentry>
- <term>Buchen auf</term>
- <listitem>
- <para>
- Das Forderungskonto, in der Regel "Forderungen aus Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen
- der betreffenden Waren.
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Das Forderungskonto, in der Regel "Forderungen aus
+ Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
+ Buchungsgruppen der betreffenden Waren.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>Startdatum</term>
- <listitem>
- <para>
- ab welchem Datum auf Rechnungserstellung geprüft werden soll
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>Startdatum</term>
- <varlistentry>
- <term>Enddatum</term>
- <listitem>
- <para>
- ab wann keine Rechnungen mehr erstellt werden sollen
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>ab welchem Datum auf Rechnungserstellung geprüft werden
+ soll</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>Automatische Verlängerung um x Monate</term>
- <listitem>
- <para>
- Sollen die wiederkehrenden Rechnungen bei Erreichen des eingetragenen Enddatums weiterhin erstellt werden, so kann man hier die
- Anzahl der Monate eingeben, um die das Enddatum automatisch nach hinten geschoben wird.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>Enddatum</term>
- <varlistentry>
- <term>Drucken</term>
- <listitem>
- <para>
- Sind Drucker konfiguriert, so kann man sich die erstellten Rechnungen auch gleich ausdrucken lassen.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <listitem>
+ <para>ab wann keine Rechnungen mehr erstellt werden
+ sollen</para>
+ </listitem>
+ </varlistentry>
- <para>
- Nach Erstellung der Rechnungen kann eine E-Mail mit Informationen zu den erstellten Rechnungen verschickt werden. Konfiguriert wird
- dies in der <link linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
- <filename>config/lx_office.conf</filename> im Abschnitt <varname>[periodic_invoices]</varname>.
- </para>
- </sect2>
+ <varlistentry>
+ <term>Automatische Verlängerung um x Monate</term>
- <sect2 id="features.periodic-invoices.reports">
- <title>Auflisten</title>
+ <listitem>
+ <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
+ eingetragenen Enddatums weiterhin erstellt werden, so kann man
+ hier die Anzahl der Monate eingeben, um die das Enddatum
+ automatisch nach hinten geschoben wird.</para>
+ </listitem>
+ </varlistentry>
- <para>
- 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>
+ <varlistentry>
+ <term>Drucken</term>
- <sect2 id="features.periodic-invoices.task-server">
- <title>Erzeugung der eigentlichen Rechnungen</title>
+ <listitem>
+ <para>Sind Drucker konfiguriert, so kann man sich die erstellten
+ Rechnungen auch gleich ausdrucken lassen.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <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>
+ <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 id="features.periodic-invoices.create-for-current-month">
- <title>Erste Rechnung für aktuellen Monat erstellen</title>
+ <sect2 id="features.periodic-invoices.reports">
+ <title>Auflisten</title>
- <para>
- Will man im laufenden Monat eine monatlich wiederkehrende Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum auf
- den Monatsanfang und wartet ein paar Minuten, bis der Taskserver den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
- generiert hat. Alternativ setzt man das Startdatum auf den Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
- manuell über den Workflow.
- </para>
- </sect2>
+ <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
+ Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
+ Rechnungen inaktiv", mit denen man sich einen Überglick über die
+ wiederkehrenden Rechnungen verschaffen kann.</para>
+ </sect2>
+
+ <sect2 id="features.periodic-invoices.task-server">
+ <title>Erzeugung der eigentlichen Rechnungen</title>
+
+ <para>Die zeitliche und periodische Überprüfung, ob eine
+ wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
+ durch den <link linkend="config.task-server">Taskserver</link>, einen
+ externen Dienst, der automatisch beim Start des Servers gestartet
+ werden sollte.</para>
+ </sect2>
+
+ <sect2 id="features.periodic-invoices.create-for-current-month">
+ <title>Erste Rechnung für aktuellen Monat erstellen</title>
+
+ <para>Will man im laufenden Monat eine monatlich wiederkehrende
+ Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
+ auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
+ den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
+ generiert hat. Alternativ setzt man das Startdatum auf den
+ Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
+ manuell über den Workflow.</para>
+ </sect2>
</sect1>
<sect1 id="dokumentenvorlagen-und-variablen">
<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>
+ 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
+ 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>
<programlisting>% config: tag-style=($ $)</programlisting>
- <para>Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen,
+ <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>
<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>
+ linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
</sect2>
<sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
dem Kürzel das im Dateinamen verwendetet wird.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.tmpfile</varname></term>
+
+ <listitem>
+ <para>Datei-Prefix für temporäre Dateien.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</sect3>
und dem "end" werden nur ausgegeben, wenn die Variable
<varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
+ <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
+ <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
+ enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
+ ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
+
+ <programlisting><%if payment%>
+Zahlungseingänge:
+ <%foreach payment%>
+ Am <%paymentdate%>: <%payment%> €
+ <%end foreach%>
+<%end if%></programlisting>
+
<para>Die Bedingung kann auch negiert werden, indem das Wort
<function>not</function> nach dem <filename>if</filename> verwendet
wird. Beispiel:</para>
Mittels <function>!=</function> anstelle von <function>==</function>
würde auf Ungleichheit getestet.</para>
- <programlisting>%if var1 == var2%></programlisting>
+ <programlisting><%if var1 == var2%></programlisting>
<para>Testet die Variable <varname>var1</varname> auf
übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
<title>Markup-Code zur Textformatierung innerhalb von
Formularen</title>
- <para>Wenn der Benutzer innhalb von Formularen in Lx-Office Text
+ <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
anders formatiert haben möchte, so ist dies begrenzt möglich.
- Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags.
+ 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
<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>
+ 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>
<sect2>
<title>Kanonische globale Variablen</title>
<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>
+ globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
+ vorgegebenen Eigenschaften, und alles andere sollte anderweitig
+ umhergereicht werden.</para>
<para>Diese Variablen sind im Moment die folgenden neun:</para>
</listitem>
</itemizedlist>
- <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im Folgenden
- eine kurze Erläuterung der bestimmten vorgegebenen Eigenschaften (Konventionen):</para>
+ <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
+ Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
+ Eigenschaften (Konventionen):</para>
<sect3>
<title>$::form</title>
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>
+ gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
+ <function>IS->retrieve_customer()</function> in Sicherheit
+ bringen.</para>
- <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>
+ <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>
<programlisting> my $saved_numberformat = $::myconfig{numberformat};
$::myconfig{numberformat} = $numberformat;
# (...) div Berechnungen
$::myconfig{numberformat} = $saved_numberformat;</programlisting>
- <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>
-
- <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>
+ <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>
+
+ <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>
<programlisting>[%- IF business %]
# (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
[%- END %]</programlisting>
- <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>
+ <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>
<programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
- <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>
+ <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}) {
# ...
</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>. 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>
+ <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>
<sect3>
</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
- (tmp/lx-office-debug.log) packen kann.
- </para>
+ <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>
- Beispielsweise so:
- </para>
+ <para>Beispielsweise so:</para>
<programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
<listitem>
<para>Repräsentation der
- <filename>config/lx_office.conf[.default]</filename>-Dateien</para>
+ <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
</listitem>
</itemizedlist>
<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>
+ und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
+ das Programm die Konfiguration ändern kann oder sollte.</para>
- <para>Beispielsweise ist über den Konfigurationseintrag [debug]
- die Debug- und Trace-Log-Datei wie folgt konfiguriert und verfügbar:</para>
+ <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
+ Debug- und Trace-Log-Datei wie folgt konfiguriert und
+ verfügbar:</para>
<programlisting>[debug]
-file = /tmp/lx-office-debug.log</programlisting>
+file = /tmp/kivitendo-debug.log</programlisting>
<para>ist der Key <varname>file</varname> im Programm als
<varname>$::lx_office_conf->{debug}{file}</varname>
<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
+ 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>
<itemizedlist>
<listitem>
- <para>Kommt es vom User, und soll unverändert wieder an den User? Dann <varname>$::form</varname>, steht da eh schon</para>
+ <para>Kommt es vom User, und soll unverändert wieder an den
+ User? Dann <varname>$::form</varname>, steht da eh schon</para>
</listitem>
<listitem>
- <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des Requests gebraucht werden? Dann
+ <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
+ Requests gebraucht werden? Dann
<varname>$::request</varname></para>
</listitem>
<listitem>
- <para>Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
+ <para>Muss ich von anderen Teilen des Programms lesend drauf
+ zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
Wrappermethode</para>
</listitem>
</itemizedlist>
<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>
+ <title>SQL-Upgradedateien</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>
-
- <para>
- Neu sind die Kontrollinformationen, die Abhängigkeiten und Prioritäten definieren können werden, sodass Datenbankscripte zwar in
- einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
- angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern mehr braucht.
- </para>
-
- <para>
- Lx-Office merkt sich dabei, welches der Upgradescripte in sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht erneut
- aus. Dazu dient die Tabelle "schema_info", die bei der Anmeldung automatisch angelegt wird.
- </para>
- </sect2>
+ <sect2 id="db-upgrade-files.introduction"
+ xreflabel="Einführung in die Datenbank-Upgradedateien">
+ <title>Einführung</title>
- <sect2 id="db-upgrade-files.format" xreflabel="Format der Upgradedateien">
- <title>Format der Kontrollinformationen</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 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>
- <para>
- Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
- hat dabei das folgende Format:
- </para>
+ <sect2 id="db-upgrade-files.format"
+ xreflabel="Format der Upgradedateien">
+ <title>Format der Kontrollinformationen</title>
- <para>
- Für SQL-Upgradedateien:
- </para>
+ <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
+ Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
+ hat dabei das folgende Format:</para>
- <programlisting>-- @key: value</programlisting>
+ <para>Für SQL-Upgradedateien:</para>
- <para>
- Für Perl-Upgradedateien:
- </para>
+ <programlisting>-- @key: value</programlisting>
- <programlisting># @key: value</programlisting>
+ <para>Für Perl-Upgradedateien:</para>
- <para>
- Leerzeichen vor "<varname>value</varname>" werden entfernt.
- </para>
+ <programlisting># @key: value</programlisting>
- <para>
- Die folgenden Schlüsselworte werden verarbeitet:
- </para>
+ <para>Leerzeichen vor "<varname>value</varname>" werden
+ entfernt.</para>
- <variablelist>
- <varlistentry>
- <term><varname>tag</varname></term>
- <listitem>
- <para>
- Wird zwingend benötigt. Dies ist der "Name" des Upgrades. Dieser "tag" kann von anderen Kontrolldateien in ihren Abhängigkeiten
- verwendet werden (Schlüsselwort "<varname>depends</varname>"). Der "tag" ist auch der Name, der in der Datenbank eingetragen wird.
- </para>
+ <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
- <para>
- Normalerweise sollte die Kontrolldatei genau so heißen wie der "tag", nur mit der Endung ".sql" bzw. "pl".
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><varname>tag</varname></term>
- <para>
- Ein Tag darf nur aus alphanumerischen Zeichen sowie den Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht erlaubt und
- sollten stattdessen mit Unterstrichen ersetzt werden.
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>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>
- <varlistentry>
- <term><varname>charset</varname></term>
- <listitem>
- <para>
- Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
- Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags der Zeichensatz "<literal>ISO-8859-15</literal>"
- angenommen.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><varname>charset</varname></term>
- <varlistentry>
- <term><varname>description</varname></term>
- <listitem>
- <para>
- Benötigt. Eine Beschreibung, was in diesem Update passiert. Diese wird dem Benutzer beim eigentlichen Datenbankupdate
- angezeigt. Während der Tag in englisch gehalten sein sollte, sollte die Beschreibung auf Deutsch erfolgen.
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
+ geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
+ Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
+ Abwesenheit des Tags der Zeichensatz
+ "<literal>ISO-8859-15</literal>" angenommen.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><varname>depends</varname></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>
+ <varlistentry>
+ <term><varname>description</varname></term>
- <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>
+ <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>
- Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu definieren (z.B. "a" -> "b",
- "b" -> "c" und "c" -> "a").
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term><varname>depends</varname></term>
- <varlistentry>
- <term><varname>priority</varname></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>
+ <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>
- <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>
- <varlistentry>
- <term><varname>ignore</varname></term>
- <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>
+ <varlistentry>
+ <term><varname>priority</varname></term>
- <sect2 id="db-upgrade-files.dbupgrade-tool" xreflabel="Hilfsscript dbupgrade2_tool.pl">
- <title>Hilfsscript dbupgrade2_tool.pl</title>
+ <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>
- <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>
+ <varlistentry>
+ <term><varname>ignore</varname></term>
- <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>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>
- <itemizedlist>
- <listitem>
- <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl --list</command>"</para>
+ <sect2 id="db-upgrade-files.dbupgrade-tool"
+ xreflabel="Hilfsscript dbupgrade2_tool.pl">
+ <title>Hilfsscript dbupgrade2_tool.pl</title>
- <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>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>
- <listitem>
- <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl --tree</command>"</para>
+ <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>
- <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>
+ <itemizedlist>
+ <listitem>
+ <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
+ --list</command>"</para>
- <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
- <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl --rtree</command>"</para>
+ <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>
- <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>
+ <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>
- <listitem>
- <para>Baumform mit Postscriptausgabe: "<command>./scripts/dbupgrade2_tool.pl --graphviz</command>"</para>
+ <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
+ <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
+ --rtree</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>
+ <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>
- <para>
- Scripte, von denen kein anderes Script abhängt: "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"
- </para>
+ <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>
- <para>
- Listet die Tags aller Scripte auf, von denen keine anderen Scripte abhängen.
- </para>
- </listitem>
- </itemizedlist>
- </sect2>
+ <listitem>
+ <para>Scripte, von denen kein anderes Script abhängt:
+ "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
+
+ <para>Listet die Tags aller Scripte auf, von denen keine anderen
+ Scripte abhängen.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
</sect1>
<sect1 id="translations-languages" xreflabel="Translations and languages">
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
</sect2>
</sect1>
- <sect1 id="devel.style-guide">
+ <sect1 id="devel.testsuite">
+ <title>Die kivitendo-Test-Suite</title>
+
+ <sect2 id="devel.testsuite.intro">
+ <title>Einführung</title>
+
+ <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
+
+ <para>Die grundlegenden Fakten sind:</para>
+
+ <itemizedlist>
+ <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
+
+ <listitem><para>Ein Script (bzw. ein Test) in <filename>f/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
+
+ <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
+
+ <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>f/</filename>, deren
+ Dateiname auf <literal>.t</literal> endet.</para></listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="devel.testsuite.prerequisites">
+ <title>Voraussetzungen</title>
+
+ <para>Für die Ausführung werden neben den für kivitendo eh schon benötigten Module noch weitere Perl-Module benötigt. Diese sind:</para>
+
+ <itemizedlist>
+ <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
+ <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
+ <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
+ Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
+ werden.</para></listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="devel.testsuite.execution">
+ <title>
+ Existierende Tests ausführen
+ </title>
+
+ <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder, man lässt alle Tests auf einmal ausführen, oder man führt
+ gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.sh</filename>.</para>
+
+ <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.sh</filename> ohne weitere Parameter aus
+ dem kivitendo-Basisverzeichnis heraus ausführen.</para>
+
+ <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.sh</filename>. Beispielsweise:</para>
+
+ <programlisting>t/test.sh t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
+ </sect2>
+
+
+ <sect2 id="devel.testsuite.meaning_of_scripts">
+ <title>
+ Bedeutung der verschiedenen Test-Scripte
+ </title>
+
+ <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
+ während der Entwicklung nützliche Tests sind:</para>
+
+ <itemizedlist>
+ <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
+ <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
+ <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
+ <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
+ <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
+ <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
+ </itemizedlist>
+
+ <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
+ </sect2>
+
+ <sect2 id="devel.testsuite.create_new">
+ <title>
+ Neue Test-Scripte erstellen
+ </title>
+
+ <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
+ Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
+
+ <sect3 id="devel.testsuite.ideas_for_non_function_tests">
+ <title>
+ Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
+ </title>
+
+ <para> Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden:</para>
+
+ <itemizedlist>
+ <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
+ <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
+ <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
+ <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
+ <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
+ <listitem><para>Test, ob alle Webseiten-Templates in <filename>templates/webpages</filename> mit vom Perl-Modul <literal>Template</literal> compiliert werden können</para></listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="devel.testsuite.directory_and_test_names">
+ <title>
+ Konvention für Verzeichnis- und Dateinamen
+ </title>
+
+ <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten und ihnen soweit es geht folgen:</para>
+
+ <itemizedlist>
+ <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
+
+ <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
+ <filename>bad_function_params.t</filename>).</para></listitem>
+
+ <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen
+ (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
+
+ <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
+ (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="devel.testsuite.minimal_example">
+ <title>
+ Minimales Skelett für eigene Scripte
+ </title>
+
+ <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
+
+ <programlisting>use Test::More tests => 0;
+
+use lib 't';
+
+use Support::TestSetup;
+
+Support::TestSetup::login();</programlisting>
+
+ <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
+ <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
+ <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
+ sein. Dieser wird für die Datenbankverbindung benötigt.</para>
+
+ <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
+ weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
+ </sect3>
+ </sect2>
+ </sect1>
+
+ <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>
- <listitem>
- <para>
- Es werden keine echten Tabs sondern Leerzeichen verwendet.
- </para>
- </listitem>
+ <listitem>
+ <para>Es werden keine echten Tabs sondern Leerzeichen
+ verwendet.</para>
+ </listitem>
- <listitem>
- <para>
- Die Einrückung beträgt zwei Leerzeichen. Beispiel:
- </para>
+ <listitem>
+ <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
}
$report->add($row);
}</programlisting>
- </listitem>
+ </listitem>
- <listitem>
- <para>Öffnende geschweifte Klammern befinden sich auf der gleichen Zeile wie der letzte Befehl. Beispiele:</para>
+ <listitem>
+ <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>
- <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>
- </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>
+ </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>
+ <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>
- <programlisting>if ($form->{sum} > 1000) {
+
<programlisting>if ($form->{sum} > 1000) {
...
} elsif ($form->{sum} > 0) {
...
do {
...
} until ($a > 0);</programlisting>
- </listitem>
+ </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>
+ <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>
- <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>
- <listitem>
- <para>
- Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:
- </para>
+ <listitem>
+ <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>
- </listitem>
+map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
+ </listitem>
- <listitem>
- <para>
- Mehrzeilige Befehle
- </para>
+ <listitem>
+ <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 = ?",
+ <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
$form->{some_col_value});</programlisting>
- </listitem>
+ </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>
+ </listitem>
+ </orderedlist>
+ </listitem>
- <listitem>
- <para>
- Kommentare
- </para>
+ <listitem>
+ <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;
$n = $i; # save $i
$i *= $const; # do something crazy
$i = $n; # recover $i</programlisting>
- </listitem>
- </orderedlist>
- </listitem>
+ </listitem>
+ </orderedlist>
+ </listitem>
- <listitem>
- <para>
- Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation gewünscht ist. Beispiel:
- </para>
+ <listitem>
+ <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 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>
- </listitem>
+ </listitem>
- <listitem>
- <para>
- Es wird kein <command>perltidy</command> verwendet.
- </para>
+ <listitem>
+ <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>
- <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>
+ <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>
+ </listitem>
- <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
+ <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
-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>
+ </listitem>
- <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><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>
+ <listitem>
+ <para>Alle neuen Module müssen use strict verwenden.</para>
- <para>
- <varname>$form</varname>, <varname>$auth</varname>, <varname>$locale</varname>, <varname>$lxdebug</varname> und
- <varname>%myconfig</varname> werden derzeit aus dem main package importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
- Konstrukte sollten lexikalisch lokal gehalten werden.
- </para>
- </listitem>
+ <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>
</sect1>
<sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
- <title>Dokumentation erstellen</title>
+ <title>Dokumentation erstellen</title>
- <sect2 id="devel.build-doc.introduction">
- <title>Einführung</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>
+ <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>
+ <sect2 id="devel.build-doc.required-software">
+ <title>Benötigte Software</title>
- <para>
- Bei <productname>DocBook</productname> ist Prinzip, dass ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden dann
- mit entsprechenden Stylesheets andere Formate wie PDF oder HTML erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script
- <command>scripts/build_doc.sh</command>.
- </para>
+ <para>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 Lx-Office-Betrieb nicht benötigt werden:
- </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>
+ <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 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>
+ <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>
+ <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>
+
<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>
+ <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
+
<programlisting>cd doc/build
unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
- </sect2>
+ </sect2>
- <sect2 id="devel.build-doc.build">
- <title>PDFs und HTML-Seiten erstellen</title>
+ <sect2 id="devel.build-doc.build">
+ <title>PDFs und HTML-Seiten erstellen</title>
- <para>
- Die eigentliche Konvertierung erfolgt nach Installation der benötigten Software mit einem einfachen Aufruf direkt aus dem
- Lx-Office-Installationsverzeichnis heraus:
- </para>
+ <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>
+
<programlisting>./scripts/build_doc.sh</programlisting>
+ </sect2>
- <sect2 id="devel.build-doc.repository">
- <title>Einchecken in das Git-Repository</title>
+ <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>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>
+ <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
+ symbolischen Links gehören hingegen nicht in das Repository.</para>
+ </sect2>
</sect1>
</chapter>
</book>
projects / kivitendo-erp.git / blobdiff