<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<book id="kivitendo-documentation" lang="de">
- <title>kivitendo: Installation, Konfiguration, Entwicklung</title>
+ <title>kivitendo 3.0.0: Installation, Konfiguration, Entwicklung</title>
<chapter id="Aktuelle-Hinweise">
<title>Aktuelle Hinweise</title>
<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>
<para>Debian</para>
<itemizedlist>
<listitem>
- <para>6.0 Squeeze (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden)</para>
+ <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>
+ <para>7.0 "Wheezy"</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
- <para>Ubuntu 10.04 LTS Lucid Lynx bis 12.10 Oneiric Ocelot</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 16</para>
+ <para>Fedora 16 und 17</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="Pakete" xreflabel="Pakete">
- <title>Pakete</title>
+ <title>Benötigte Perl-Pakete installieren</title>
<para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
benötigt.</para>
- <para>Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die
- nicht Bestandteil einer Standard-Perl-Installation sind:</para>
+ <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>
+
+ <programlisting>./scripts/installation_check.pl</programlisting>
+
+ <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
<itemizedlist>
- <listitem><para><literal>parent</literal></para></listitem>
+ <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
<listitem><para><literal>Archive::Zip</literal></para></listitem>
<listitem><para><literal>Email::MIME</literal></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><literal>JSON</literal></para></listitem>
<listitem><para><literal>List::MoreUtils</literal></para></listitem>
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 libemail-mime-perl liblist-moreutils-perl libpdf-api2-perl \
- librose-object-perl librose-db-perl librose-db-object-perl \
- libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
- libxml-writer-perl libyaml-perl libconfig-std-perl \
- libparams-validate-perl libjson-perl libclass-accessor-perl \
- libnet-sslglue-perl libnet-smtp-ssl-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-Email-MIME 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 perl-Net-SSLGlue perl-Net-SMTP-SSL</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-Email-MIME 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 perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
+ <programlisting>yum install perl-CPAN
+cpan Config::Std</programlisting>
- <para>kivitendo enthält ein Script, mit dem überprüft werden kann, ob
- alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
- folgt:</para>
+ </sect3>
- <programlisting>./scripts/installation_check.pl</programlisting>
+ <sect3>
+ <title>openSUSE</title>
+
+ <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 kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird
- im Dokumentenverzeichnis des Webservers (z.B.
- <filename>/var/www/html/</filename>,
- <filename>/srv/www/htdocs</filename> oder
- <filename>/var/www/</filename>) entpackt:</para>
+ <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 kivitendo-erp-2.6.3.tgz</programlisting>
+tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
<para>Wechseln Sie in das entpackte Verzeichnis:</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>
+ 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>
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
+ <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>
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/kivitendo-server</filename>
</listitem>
<listitem>
- <para>OpenSuSE und Fedora Core:</para>
+ <para>Ältere OpenSUSE und ältere Fedora Core:</para>
<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/kivitendo-task-server
- start</command></para>
+ werden:</para>
+
+ <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
</sect3>
<sect3>
<literal>exec ....</literal>).</para>
<para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
- werden: <command>service kivitendo-task-server
- start</command></para>
+ 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>
<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>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>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 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>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><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>TODO: RPM-Pakete.</para>
- <para>kivitendo bringt 3 alternative Vorlagensätze mit:</para>
- <itemizedlist>
- <listitem>Standard</listitem>
- <listitem>f-tex</listitem>
- <listitem>RB</listitem>
- </itemizedlist>
+ <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>
<sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
<title>Vorlagenverzeichnis anlegen</title>
- <para>Bei einem neuen Benutzer/Mandanten lässt sich einer dieser Vorlagensätze
- als Basis für die zu druckenden Dokumente auswählen:</para>
+ <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>
- <para><programlisting>unter:
-Administration -> Benutzerverwaltung -> [ein Benutzer]
- Erzeuge Vorlagen, Name: [Name für das neue Vorlagenverzeichnis]
- Vorlagen auswählen: [Default, f-tex oder RB]
- -> Speichern
- </programlisting></para>
- <para>der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</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>
- <para><programlisting>/scripts/installation_check.pl -l</programlisting></para>
+
+ <programlisting>/scripts/installation_check.pl -l</programlisting>
</sect2>
- <sect2 id="Standard">
- <title>Default</title>
+ <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>
+ <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 stellt.</para>
+ <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
<sect3 id="f-tex-Feature-Übersicht">
- <title>f-tex Feature Übersicht</title>
+ <title>Feature-Übersicht</title>
<itemizedlist>
- <listitem>Keine Retundanz. Es wird ein und die selbe Latex-Vorlage für alle
- briefartigen Dokumente verwendet. Also Angebot, Rechnung,
- Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber
- etc.. </listitem>
- <listitem>Leichte Anpassung an das Firmen Layout durch verwendung eines Hintergrund-PDF
- dieses kann leicht mit dem eigenen Lieblingsprogramm erstellt werden
- (Openoffice, Inkscape, Gimp, Adobe*)
- </listitem>
- <listitem>Hintergrundpdf um schaltbar auf "nur erste Seite" (default) oder "alle Seiten"
- (option "bgPdfFirstPageOnly" in Datei letter.lco)
- </listitem>
- <listitem>Hintergrundpdf für Ausdruck auf bereits bedrucktem Briefpapier Abschaltbar,
- es wird dann nur bei per email versendeten Dokumenten eingebunden.
- (Option "bgPdfEmailOnly" in Datei letter.lco)
- </listitem>
- <listitem>Nutzung der Layout-Funktionen von Latex für Seitenumbruch,
- wiederholung von Kopfzeilen, Zwischensummen etc. (danke an Kai-Martin für
- die Vorarbeit)
- </listitem>
- <listitem>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des
- eigenen Unternehmens abweicht (also die Rechnung das Land verlässt).
- </listitem>
- <listitem>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle
- Übersetzungen in der Datei translatinos.tex.
- </listitem>
- <listitem>Auflistung von Bruttopreisen für Endverbraucher.
- </listitem>
+ <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>f-tex Die Installation</title>
+ <sect3 id="f-tex-Installation">
+ <title>Die Installation</title>
<itemizedlist>
- <listitem>Vorlagenverzeichnis mit Option f-tex anlegen, siehe:
- <xref linkend="Vorlagenverzeichnis-anlegen"/>
- Das Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen
- Beispiel Briefkopf
- </listitem>
- <listitem>
- Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
- <programlisting>./letter_head.pdf</programlisting>
- </listitem>
- <listitem>
- Editiere den Bereich "settings" in der datei letter.lco
- </listitem>
+ <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 sample.lco erstellt und diese nach letter.lco 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 sample.lco unverändert zu
- lassen. Die die Anpassung über eine *.lco Datei die letztlich auf letter.lco
- verlinkt ist ist aber auch möglich.
+ 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 sample_head.pdf mit ausgeliefert, diese wird nach
- letter_head.pdf verlinkt. Damit gibt es schon mal eine Funktionsfähige
- Vorlage. Schau Dir nach Abschluss der Installation die Datei sample_haed.pdf
- an und erstelle ein entsprechendes pdf passend zum Briefkopf Deiner Firma,
- diese dann im Template Verzeichniss ablegen und statt sample_head.pdf nach
- letter_head.pdf verlinken.
+ 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 ./letter_head.pdf auf das passende Hintergrundpdf verweisen,
- welches gewünschten Briefkopf enthält. Bei Updates oder nach erneutem
+ 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 mydata.tex.example ausgeliefert die nach mytdata.tex
- verlinkt ist. Bei verwendetem Hintergrundpdf 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).
+ 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 *.lco Datei erfolgen.
+ 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
- Latexvorlage verwendet, welche über Codeweichen die Besonderheiten
- der jeweiligen Dokumente Berücksichtigt
+ 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>Tabellen mit oder ohne Preis
- </listitem>
- <listitem>Sprache der Tabellenüberschriften etc.
- </listitem>
- <listitem>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
- Angebotsnummer)
- </listitem>
- <listitem>Darstellung von Brutto oder Netto-Preisen in der Auflistung
- (Endverbraucher versus Gewerblicher Kunde)
- </listitem>
+ <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 letter.tex
- 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 sample_head.pdf erstellen, und sich an der Form der dargestellten Tabellen
- wie sie ausgeliefert werden, erfreuen.
+ 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>Kleiner Tipp:
- Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche
- Schritte gehen.
+
+ <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>
- <para>Bruttopreise für Endvorbraucher</para>
- <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>
+ <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>
- 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>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>
- 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>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>
- die Entscheidung ob Netopreise ausgewiesen werden ist nicht mehr fix
- mit einer Preisliste Verbunden.
- </listitem>
- <listitem>
- die Default-Zahlart kann im Kundendatensatz hinterlegt werden und man
- muss nicht mehr daran denken "alle Preise Netto" auszuwählen.
- </listitem>
- <listitem>
- Die Entscheidung ob Netto/Oder Bruttopreise ausgewiesen werden kann direkt
- beim Drucken reviediert werden, ohne dass sich der Auftragswert ändert.
- </listitem>
- </itemizedlist>
+ 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>
- <para>Lieferadressen</para>
<itemizedlist>
- <listitem>
- in Lieferscheinen kommen shipto* -Variablen im Adressfeld zum Einsatz
- </listitem>
- <listitem>
- wenn die shipto*variable leer ist wird die entsprechende
- Adressvariable eingesetzt. Wenn Also die Lieferadresse in Strasse,
- 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.
- </listitem>
+ <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="RB">
+ <sect2 id="Vorlagen-RB">
<title>RB</title>
- <para>Vollständiger Dokumentensatz mit alternativen Design</para>
+ <para>Vollständiger Dokumentensatz mit alternativem Design</para>
</sect2>
- <sect2 id="Allgemeine Hinweise zu LaTeX">
+ <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
Pakete.</para>
</listitem>
<listitem>
- <para>! Package inputenc Error: Unicode char \u8:æ¡\9c not set up for
+ <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
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>
<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>
+ <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>
projects / kivitendo-erp.git / blobdiff