1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
21 <title>Installation und Grundkonfiguration</title>
23 <sect1 id="Installation-Übersicht">
24 <title>Übersicht</title>
27 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
28 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
32 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
33 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
34 befindet sich hier.</para></listitem>
36 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
37 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
38 linkend="config.config-file"/>" erläutert.</para></listitem>
40 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
41 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
42 linkend="Apache-Konfiguration"/>"). </para></listitem>
44 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
45 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
46 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
48 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
49 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
51 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
52 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
56 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen
61 <sect1 id="Benötigte-Software-und-Pakete">
62 <title>Benötigte Software und Pakete</title>
64 <sect2 id="Betriebssystem">
65 <title>Betriebssystem</title>
67 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
68 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
69 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
70 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
71 ohne große Probleme auf den derzeit aktuellen verbreiteten
72 Distributionen läuft.</para>
74 <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
75 dass kivitendo auf ihnen läuft:</para>
83 <para>6.0 Squeeze (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden)</para>
86 <para>7.0 Wheezy</para>
92 <para>Ubuntu 10.04 LTS Lucid Lynx bis 12.10 Oneiric Ocelot</para>
96 <para>openSUSE 11.2 und 11.3</para>
100 <para>SuSE Linux Enterprice Server 11</para>
104 <para>Fedora 13 bis 16</para>
109 <sect2 id="Pakete" xreflabel="Pakete">
110 <title>Pakete</title>
112 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
113 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
116 <para>Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die
117 nicht Bestandteil einer Standard-Perl-Installation sind:</para>
120 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
122 <listitem><para><literal>Archive::Zip</literal></para></listitem>
124 <listitem><para><literal>Config::Std</literal></para></listitem>
126 <listitem><para><literal>DateTime</literal></para></listitem>
128 <listitem><para><literal>DBI</literal></para></listitem>
130 <listitem><para><literal>DBD::Pg</literal></para></listitem>
132 <listitem><para><literal>Email::Address</literal></para></listitem>
134 <listitem><para><literal>Email::MIME</literal></para></listitem>
136 <listitem><para><literal>JSON</literal></para></listitem>
138 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
140 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
141 linkend="config.sending-email.smtp"/>")</para></listitem>
143 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
144 linkend="config.sending-email.smtp"/>")</para></listitem>
146 <listitem><para><literal>Params::Validate</literal></para></listitem>
148 <listitem><para><literal>PDF::API2</literal></para></listitem>
150 <listitem><para><literal>Rose::Object</literal></para></listitem>
152 <listitem><para><literal>Rose::DB</literal></para></listitem>
154 <listitem><para><literal>Rose::DB::Object</literal></para></listitem>
156 <listitem><para><literal>Template</literal></para></listitem>
158 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
160 <listitem><para><literal>Text::Iconv</literal></para></listitem>
162 <listitem><para><literal>URI</literal></para></listitem>
164 <listitem><para><literal>XML::Writer</literal></para></listitem>
166 <listitem><para><literal>YAML</literal></para></listitem>
169 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
170 <literal>Net::SSLGlue</literal>.</para>
172 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
173 hinzugekommen, <literal>URI</literal> und
174 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
177 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
178 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
179 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
180 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
182 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
183 hinzugekommen.</para>
185 <para><literal>Email::Address</literal> und
186 <literal>List::MoreUtils</literal> sind schon länger feste
187 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
188 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
189 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
190 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
193 <para>Die zu installierenden Pakete können in den verschiedenen
194 Distributionen unterschiedlich heißen.</para>
196 <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
198 <programlisting>apt-get install apache2 postgresql libarchive-zip-perl \
199 libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
200 libemail-address-perl libemail-mime-perl liblist-moreutils-perl libpdf-api2-perl \
201 librose-object-perl librose-db-perl librose-db-object-perl \
202 libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
203 libxml-writer-perl libyaml-perl libconfig-std-perl \
204 libparams-validate-perl libjson-perl libclass-accessor-perl \
205 libnet-sslglue-perl libnet-smtp-ssl-perl</programlisting>
207 <para>Für Fedora Core benötigen Sie diese Pakete:</para>
209 <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
210 perl-DBI perl-DBD-Pg perl-Email-Address perl-Email-MIME perl-List-MoreUtils \
211 perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
212 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
213 perl-XML-Writer perl-YAML perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
215 <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
217 <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
218 perl-DateTime perl-DBI perl-DBD-Pg perl-Email-MIME perl-MailTools perl-List-MoreUtils \
219 perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
220 perl-URI perl-XML-Writer perl-YAML perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
222 <para>kivitendo enthält ein Script, mit dem überprüft werden kann, ob
223 alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
226 <programlisting>./scripts/installation_check.pl</programlisting>
230 <sect1 id="Manuelle-Installation-des-Programmpaketes"
231 xreflabel="Manuelle Installation des Programmpaketes">
232 <title>Manuelle Installation des Programmpaketes</title>
234 <para>Die kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird
235 im Dokumentenverzeichnis des Webservers (z.B.
236 <filename>/var/www/html/</filename>,
237 <filename>/srv/www/htdocs</filename> oder
238 <filename>/var/www/</filename>) entpackt:</para>
240 <programlisting>cd /var/www
241 tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
243 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
245 <programlisting>cd kivitendo-erp</programlisting>
247 <para>Alternativ können Sie auch einen Alias in der
248 Webserverkonfiguration benutzen, um auf das tatsächliche
249 Installationsverzeichnis zu verweisen.</para>
251 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
252 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
253 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
254 core <constant>apache</constant> oder bei OpenSuSE <constant>wwwrun</constant>).</para>
256 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
257 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
259 <programlisting>chown -R www-data users spool webdav</programlisting>
261 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
262 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
264 <programlisting>chown www-data templates users</programlisting>
267 <sect1 id="config.config-file">
268 <title>kivitendo-Konfigurationsdatei</title>
270 <sect2 id="config.config-file.introduction"
271 xreflabel="Einführung in die Konfigurationsdatei">
272 <title>Einführung</title>
274 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
275 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
276 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
277 von kivitendo bzw. der Migration von älteren Versionen angelegt
280 <para>Als Vorlage dient die Datei
281 <filename>config/kivitendo.conf.default</filename> (kurz: "die
282 Default-Datei"):</para>
284 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
286 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
287 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
288 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
289 Abschnitte und Werte enthalten, die von denen der Default-Datei
294 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
295 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
299 <para>Diese Hauptkonfigurationsdatei ist dann eine
300 installationsspezifische Datei, d.h. sie enthält bspw. lokale
301 Passwörter und wird auch nicht im Versionsmanagement (git)
304 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
305 Mandaten, bzw. Datenbanken gleich.</para>
308 <sect2 id="config.config-file.sections-parameters">
309 <title>Abschnitte und Parameter</title>
311 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
312 entsprechend kommentiert sind:</para>
315 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
316 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
318 <listitem><para><literal>authentication/database</literal></para></listitem>
320 <listitem><para><literal>authentication/ldap</literal></para></listitem>
322 <listitem><para><literal>system</literal></para></listitem>
324 <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
326 <listitem><para><literal>paths</literal></para></listitem>
328 <listitem><para><literal>applications</literal></para></listitem>
330 <listitem><para><literal>environment</literal></para></listitem>
332 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
334 <listitem><para><literal>print_templates</literal></para></listitem>
336 <listitem><para><literal>task_server</literal></para></listitem>
338 <listitem><para><literal>periodic_invoices</literal></para></listitem>
340 <listitem><para><literal>console</literal></para></listitem>
342 <listitem><para><literal>debug</literal></para></listitem>
345 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
346 einzustellen oder zu kontrollieren sind, sind:</para>
348 <programlisting>[authentication]
349 admin_password = geheim
351 [authentication/database]
359 dbcharset = UTF-8</programlisting>
361 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
362 <varname>[periodic_invoices]</varname> den Login eines Benutzers
363 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
364 mit Informationen über die erstellten Rechnungen bekommt.</para>
366 <para>Nutzt man den <link
367 linkend="config.task-server">Taskserver</link> für <link
368 linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,
369 muss unter <varname>[task_server]</varname> ein Login eines Benutzers
370 angegeben werden, mit dem sich der Taskserver an kivitendo bei der
371 Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
373 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
374 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
377 <sect2 id="config.config-file.prior-versions">
378 <title>Versionen vor 2.6.3</title>
380 <para>In älteren kivitendo Versionen gab es im Verzeichnis
381 <filename>config</filename> die Dateien
382 <filename>authentication.pl</filename> und
383 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
384 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
385 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
386 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
388 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
389 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
390 manuell übertragen und die alten Konfigurationsdateien anschließend
391 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
392 entsprechende Fehlermeldung an.</para>
396 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
397 <title>Anpassung der PostgreSQL-Konfiguration</title>
399 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
401 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
402 <title>Zeichensätze/die Verwendung von UTF-8</title>
404 <para>Bei aktuellen Serverinstallationen braucht man hier meist nicht
407 <para>Dieses kann überprüft werden: ist das Encoding der Datenbank
408 “template1” “UTF8”, so braucht man nichts weiteres diesbezüglich
409 unternehmen. Zum Testen:
411 <programlisting>su postgres
413 exit </programlisting>
415 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
416 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
417 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
420 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
422 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
423 Versionsnummer angepasst werden.</para>
425 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
427 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
428 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
429 kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
431 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
432 <literal>\l</literal> geprüft werden.</para>
435 <sect2 id="Änderungen-an-Konfigurationsdateien">
436 <title>Änderungen an Konfigurationsdateien</title>
438 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
439 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
440 <filename>/var/lib/pgsql/data/</filename> oder
441 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
442 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
443 Parameter <varname>listen_address</varname> gesteuert. Laufen
444 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
445 <literal>localhost</literal> verwendet werden. Andernfalls müssen
446 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
447 was mit dem Wert <literal>*</literal> geschieht.</para>
449 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
450 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
451 sein sollte, müssen die Berichtigungen für den Zugriff geändert
452 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
453 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
454 Datenbank zum Beispiel:</para>
456 <programlisting>local all kivitendo password
457 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
460 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
461 <title>Erweiterung für servergespeicherte Prozeduren</title>
463 <para>In der Datenbank <literal>template1</literal> muss die
464 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
465 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
466 <programlisting>su - postgres
467 psql template1</programlisting>
469 führen Sie die folgenden Kommandos aus:</para>
471 <programlisting>create language 'plpgsql';
475 <sect2 id="Datenbankbenutzer-anlegen">
476 <title>Datenbankbenutzer anlegen</title>
478 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
479 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
480 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
483 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
484 beantworten, genauso ist die Berechtigung neue User (Roles) zu
485 generieren nicht nötig.</para>
486 <programlisting>su - postgres
487 createuser -d -P kivitendo
488 exit</programlisting>
490 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
491 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
492 den hier gewählten Benutzernamen.</para>
496 <sect1 id="Apache-Konfiguration">
497 <title>Webserver-Konfiguration</title>
500 <title>Grundkonfiguration mittels CGI</title>
503 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
504 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
505 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
508 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
509 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
510 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
511 anderen Datei hinzu, die beim Starten des Webservers eingelesen
514 <programlisting>AddHandler cgi-script .pl
515 Alias /kivitendo-erp/ /var/www/kiviteno-erp/
517 <Directory /var/www/kivitendo-erp>
518 Options ExecCGI Includes FollowSymlinks
521 <Directory /var/www/kivitendo-erp/users>
524 </Directory></programlisting>
526 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
527 das kivitendo-Archiv entpacket haben.</para>
530 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
531 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
534 <para>Auf einigen Webservern werden manchmal die Grafiken und
535 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
536 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
538 <programlisting>EnableSendfile Off</programlisting>
541 <sect2 id="Apache-Konfiguration.FCGI"
542 xreflabel="Konfiguration für FastCGI/FCGI">
543 <title>Konfiguration für FastCGI/FCGI</title>
545 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
546 <title>Was ist FastCGI?</title>
548 <para>Direkt aus <ulink
549 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
552 <para><citation> FastCGI ist ein Standard für die Einbindung
553 externer Software zur Generierung dynamischer Webseiten in einem
554 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
555 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
556 umgehen. </citation></para>
559 <sect3 id="Apache-Konfiguration.FCGI.Warum">
560 <title>Warum FastCGI?</title>
562 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
563 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
564 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
565 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
566 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
567 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
568 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
569 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
570 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
571 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
572 deutlich länger dauert als früher, und dass davon 90% für das Laden
573 der Module verwendet wird.</para>
575 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
576 wird nur die eigentliche Programmlogik ausgeführt.</para>
579 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
580 <title>Getestete Kombinationen aus Webservern und Plugin</title>
582 <para>Folgende Kombinationen sind getestet:</para>
586 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
590 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
594 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
595 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
596 mod_fastcgi nicht mehr explizit eingegangen.</para>
598 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
602 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
603 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
604 aber Version 0.72 und neuer eingesetzt werden.</para>
606 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
609 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
613 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
614 <title>Konfiguration des Webservers</title>
616 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
617 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
618 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
619 debuggen die beim ersten aufsetzen auftreten können. Sollte die
620 Installation schon funktionieren, lesen Sie weiter.</para>
622 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
623 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
625 <programlisting>a2enmod fcgid</programlisting>
627 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
628 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
629 und <function>Directory</function>-Direktiven. Dabei wird zwischen
630 dem Installationspfad von kivitendo im Dateisystem
631 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
632 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
633 ("<filename>/url/for/kivitendo-erp</filename>").</para>
635 <para>Folgender Konfigurationsschnipsel funktioniert mit
638 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
639 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
641 <Directory /path/to/kivitendo-erp>
643 Options ExecCGI Includes FollowSymlinks
648 <DirectoryMatch /path/to/kivitendo-erp/users>
651 </DirectoryMatch></programlisting>
653 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
654 die maximale Größe eines Requests. Diese sollte wie folgt
655 hochgesetzt werden:</para>
657 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
659 <para>Das ganze sollte dann so aussehen:</para>
661 <programlisting>AddHandler fcgid-script .fpl
662 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
663 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
664 FcgidMaxRequestLen 10485760
666 <Directory /path/to/kivitendo-erp>
668 Options ExecCGI Includes FollowSymlinks
673 <DirectoryMatch /path/to/kivitendo-erp/users>
676 </DirectoryMatch></programlisting>
678 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
679 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
680 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
681 gibt es hier kleine Performance-Einbußen.</para>
683 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
684 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
685 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
687 <programlisting># Zugriff über CGI
688 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
690 # Zugriff mit mod_fcgid:
691 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
692 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
694 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
695 die normale Version erreichbar, und unter
696 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
697 FastCGI-Version.</para>
702 <sect1 id="config.task-server">
703 <title>Der Task-Server</title>
705 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
706 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
707 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
708 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
709 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
712 <sect2 id="Konfiguration-des-Task-Servers">
713 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
715 <para>Die Konfiguration erfolgt über den Abschnitt
716 <literal>[task_server]</literal> in der Datei
717 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
718 Optionen sind:</para>
722 <term><varname>login</varname></term>
725 <para>gültiger kivitendo-Benutzername, der benutzt wird, um die
726 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
727 in der Administration angelegt werden. Diese Option muss
728 angegeben werden.</para>
733 <term><varname>run_as</varname></term>
736 <para>Wird der Server vom Systembenutzer <literal>root</literal>
737 gestartet, so wechselt er auf den mit <literal>run_as</literal>
738 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
739 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
741 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
742 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
743 unter dem auch der Webserver läuft.</para>
748 <term><varname>debug</varname></term>
751 <para>Schaltet Debug-Informationen an und aus.</para>
757 <sect2 id="Einbinden-in-den-Boot-Prozess">
758 <title>Automatisches Starten des Task-Servers beim Booten</title>
760 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
761 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
762 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
764 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
765 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
766 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
767 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
768 anstelle eines symbolischen Links verwendet werden können.</para>
771 <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
774 <para>Kopieren Sie die Datei
775 <filename>scripts/boot/system-v/kivitendo-server</filename>
776 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
777 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
778 <literal>DAEMON=....</literal>). Binden Sie das Script in den
779 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
783 <para>Debian-basierende Systeme:</para>
785 <programlisting>update-rc.d kivitendo-task-server defaults
786 # Nur bei Debian Squeeze und neuer:
787 insserv kivitendo-task-server</programlisting>
791 <para>OpenSuSE und Fedora Core:</para>
793 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
797 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
798 werden: <command>/etc/init.d/kivitendo-task-server
799 start</command></para>
803 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
805 <para>Kopieren Sie die Datei
806 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
807 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
808 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
809 <literal>exec ....</literal>).</para>
811 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
812 werden: <command>service kivitendo-task-server
813 start</command></para>
817 <sect2 id="Prozesskontrolle">
818 <title>Wie der Task-Server gestartet und beendet wird</title>
820 <para>Der Task-Server wird wie folgt kontrolliert:</para>
822 <programlisting>./scripts/task_server.pl Befehl</programlisting>
824 <para><literal>Befehl</literal> ist dabei eine der folgenden
829 <para><literal>start</literal> startet eine neue Instanz des
830 Task-Servers. Die Prozess-ID wird innerhalb des
831 <filename>users</filename>-Verzeichnisses abgelegt.</para>
835 <para><literal>stop</literal> beendet einen laufenden
840 <para><literal>restart</literal> beendet und startet ihn
845 <para><literal>status</literal> berichtet, ob der Task-Server
850 <para>Der Task-Server wechselt beim Starten automatisch in das
851 kivitendo-Installationsverzeichnis.</para>
853 <para>Dieselben Optionen können auch für die SystemV-basierenden
854 Runlevel-Scripte benutzt werden (siehe oben).</para>
856 <sect2 id="Prozesskontrolle2">
857 <title>Task-Server mit mehreren Mandanten</title>
859 <para>Beim Task-Server wird der Login-Name des Benutzers, unter dem der
860 Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat
861 man mehrere Mandanten muß man auch mehrere Konfigurationsdateien
864 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf,
865 wo in der Kategorie [task_server] der gewünschte "login" steht.</para>
867 <para>Der alternative Task-Server wird dann mit folgendem Befehl
870 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
874 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
875 <title>Benutzerauthentifizierung und Administratorpasswort</title>
877 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
878 über die Verwaltung von Gruppen und weitere Einstellungen</para>
880 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
881 <title>Grundlagen zur Benutzerauthentifizierung</title>
883 <para>kivitendo verwaltet die Benutzerinformationen in einer
884 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
885 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
886 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
887 können, müssen aber nicht unterschiedlich sein.</para>
889 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
890 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
891 abgelegt werden.</para>
893 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
894 entweder gegen die Authentifizierungsdatenbank oder gegen einen
895 LDAP-Server überprüft werden.</para>
897 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
898 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
899 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
900 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
901 einer Version vor v2.6.0 angelegt werden. Eine
902 Beispielkonfigurationsdatei
903 <filename>config/kivitendo.conf.default</filename> existiert, die als
904 Vorlage benutzt werden kann.</para>
907 <sect2 id="Administratorpasswort">
908 <title>Administratorpasswort</title>
910 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
911 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
912 nur dort und nicht mehr im Administrationsinterface selber geändert
913 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
914 Abschnitt <varname>[authentication]</varname>.</para>
917 <sect2 id="Authentifizierungsdatenbank">
918 <title>Authentifizierungsdatenbank</title>
920 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
921 Parametern in <varname>[authentication/database]</varname>
922 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
926 <term><literal>host</literal></term>
929 <para>Der Rechnername oder die IP-Adresse des
930 Datenbankservers</para>
935 <term><literal>port</literal></term>
938 <para>Die Portnummer des Datenbankservers, meist 5432</para>
943 <term><literal>db</literal></term>
946 <para>Der Name der Authentifizierungsdatenbank</para>
951 <term><literal>user</literal></term>
954 <para>Der Benutzername, mit dem sich kivitendo beim
955 Datenbankserver anmeldet (z.B.
956 "<literal>postgres</literal>")</para>
961 <term><literal>password</literal></term>
964 <para>Das Passwort für den Datenbankbenutzer</para>
969 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
970 automatisch anlegen (mehr dazu siehe unten).</para>
973 <sect2 id="Passwortüberprüfung">
974 <title>Passwortüberprüfung</title>
976 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
977 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
978 Active-Directory-Server. Welche davon benutzt wird, regelt der
979 Parameter <varname>module</varname> im Abschnitt
980 <varname>[authentication]</varname>.</para>
982 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
983 gespeichert werden, so muss der Parameter <varname>module</varname>
984 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
985 der Administrator als auch die Benutzer selber ihre Psaswörter in
986 kivitendo ändern.</para>
988 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
989 benutzt werden, so muss der Parameter <varname>module</varname> auf
990 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
991 zusätzliche Informationen über den LDAP-Server im Abschnitt
992 <literal>[authentication/ldap]</literal> angegeben werden:</para>
996 <term><literal>host</literal></term>
999 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1000 Active-Directory-Servers. Diese Angabe ist zwingend
1001 erforderlich.</para>
1006 <term><literal>port</literal></term>
1009 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1014 <term><literal>tls</literal></term>
1017 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1018 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1019 ‘<literal>0</literal>’ belassen</para>
1024 <term><literal>attribute</literal></term>
1027 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1028 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1029 meist ‘<literal>sAMAccountName</literal>’, für andere
1030 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1031 zwingend erforderlich.</para>
1036 <term><literal>base_dn</literal></term>
1039 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1040 Diese Angabe ist zwingend erforderlich.</para>
1045 <term><literal>filter</literal></term>
1048 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1049 <literal><%login%></literal>, so wird dieses durch den vom
1050 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1051 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1052 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1057 <term><literal>bind_dn</literal> und
1058 <literal>bind_password</literal></term>
1061 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1062 durchsucht werden kann (z.B. ist dies bei
1063 Active-Directory-Servern der Fall), so kann diese hier angegeben
1064 werden. Für Active-Directory-Server kann als
1065 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1066 z.B. ‘<literal>cn=Martin
1067 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1068 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1069 also ‘<literal>Martin Mustermann</literal>’.</para>
1075 <sect2 id="Name-des-Session-Cookies">
1076 <title>Name des Session-Cookies</title>
1078 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1079 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1080 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1081 Parameter <varname>cookie_name</varname> im Abschnitt
1082 <varname>[authentication]</varname>gesetzt.</para>
1084 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1085 Server existiert.</para>
1088 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1089 <title>Anlegen der Authentifizierungsdatenbank</title>
1091 <para>Nachdem alle Einstellungen in
1092 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1093 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1094 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1095 der folgenden URL erreichbar sein sollte:</para>
1098 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1102 <sect1 id="Benutzer--und-Gruppenverwaltung">
1103 <title>Benutzer- und Gruppenverwaltung</title>
1105 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1106 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1107 folgender URL finden:</para>
1110 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1112 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1113 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1115 <sect2 id="Zusammenhänge">
1116 <title>Zusammenhänge</title>
1118 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1119 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1120 mit kivitendo arbeiten zu können, muss eine Person einen
1121 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1122 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1123 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1124 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1127 <para>Die Basisdaten der Benutzer, die in der Administration
1128 eingegeben werden können, werden in einer zweiten Datenbank
1129 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1130 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1131 Pro kivitendo-Installation gibt es nur eine
1132 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1135 <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
1136 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1137 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1138 angezeigt. Diese Rechte werden ebenfalls in der
1139 Authentifizierungsdatenbank gespeichert.</para>
1141 <para>Um Rechte verteilen zu können, verwendet kivitendo ein
1142 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1143 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1144 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1145 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1146 Benutzer Mitglied ist.</para>
1148 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1149 Benutzer angelegt werden sollten, lautet:</para>
1151 <orderedlist numeration="arabic">
1153 <para>Datenbank anlegen</para>
1157 <para>Gruppen anlegen</para>
1161 <para>Benutzer anlegen</para>
1165 <para>Benutzer den Gruppen zuordnen</para>
1170 <sect2 id="Datenbanken-anlegen">
1171 <title>Datenbanken anlegen</title>
1173 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1174 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1175 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1177 <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
1178 wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
1179 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
1181 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1182 verwenden müssen, da diese Einstellungen momentan global in kivitendo
1183 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1184 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1185 angelegt worden sein.</para>
1188 <sect2 id="Gruppen-anlegen">
1189 <title>Gruppen anlegen</title>
1191 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1192 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1193 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1194 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1196 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1197 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1198 Datenbanken, die in dieser Installation verwaltet werden.</para>
1201 <sect2 id="Benutzer-anlegen">
1202 <title>Benutzer anlegen</title>
1204 <para>Beim Anlegen von Benutzern werden für viele Parameter
1205 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1206 deutschen Raumes entsprechen.</para>
1208 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1209 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1210 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1211 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1212 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1214 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1215 eben angelegten Datenbanken eingetragen werden.</para>
1218 <sect2 id="Gruppenmitgliedschaften-verwalten">
1219 <title>Gruppenmitgliedschaften verwalten</title>
1221 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1222 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1224 <orderedlist numeration="arabic">
1226 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1227 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1232 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1233 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1234 alle im System angelegten Gruppen und Benutzer enthält. Durch
1235 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1236 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1241 <sect2 id="Migration-alter-Installationen">
1242 <title>Migration alter Installationen</title>
1244 <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
1245 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1246 <literal>users</literal> verwaltet wurden, so bietet kivitendo die
1247 Möglichkeit, diese Benutzerdaten automatisch in die
1248 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1249 sich nach dem Update der Installation das erste Mal im
1250 Administrationsbereich anmeldet. Findet kivitendo die Datei
1251 <literal>users/members</literal>, so wird der Migrationsprozess
1254 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1255 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1256 kivitendo noch die Möglichkeit an, dass automatisch eine
1257 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1258 Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
1259 Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
1260 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1261 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1265 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1266 <title>E-Mail-Versand aus kivitendo heraus</title>
1268 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1269 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1270 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1271 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1272 eigenen Internet-Providers).</para>
1274 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1275 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1277 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1278 <title>Versand über lokalen E-Mail-Server</title>
1280 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1281 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1283 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1284 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1286 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1287 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1288 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1290 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1291 E-Mail-Servers verwiesen.</para>
1294 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1295 <title>Versand über einen SMTP-Server</title>
1297 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1298 konfiguriert ist.</para>
1300 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1301 Parameter dienen dabei der weiteren Konfiguration:</para>
1305 <term><varname>hostname</varname></term>
1307 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1311 <term><varname>port</varname></term>
1313 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1314 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1315 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1319 <term><varname>security</varname></term>
1321 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1322 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1323 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1324 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1328 <term><varname>login</varname> und <varname>password</varname></term>
1330 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1331 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1332 Verschlüsselung aktiviert werden.</para></listitem>
1336 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1339 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1340 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSuSE:
1341 <literal>perl-Net-SSLGlue</literal></para></listitem>
1343 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1344 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSuSE:
1345 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1350 <sect1 id="Drucken-mit-kivitendo">
1351 <title>Drucken mit kivitendo</title>
1353 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1354 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1355 die Pakete mit:</para>
1357 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1358 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1360 <para>TODO: RPM-Pakete.</para>
1362 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1364 <listitem><para>Standard</para></listitem>
1365 <listitem><para>f-tex</para></listitem>
1366 <listitem><para>RB</para></listitem>
1369 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1370 <title>Vorlagenverzeichnis anlegen</title>
1371 <para>Im Administrationsbereich lässt sich bei einem Benutzer/Mandanten einer dieser Vorlagensätze als Basis für die zu
1372 druckenden Dokumente auswählen. Rufen Sie dazu die <guimenu>Benutzerverwaltung</guimenu> auf.</para>
1374 <para>Wählen Sie dort einen Benutzer aus oder legen Sie einen neuen an. In der Benutzerbearbeiten-Maske müssen Sie zwei Dinge
1378 <listitem><para><option>Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1379 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1380 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1381 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1384 <para>Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</para>
1386 <para>Die Abhängigkeiten kann man prüfen mit:</para>
1388 <programlisting>/scripts/installation_check.pl -l</programlisting>
1391 <sect2 id="Vorlagen-Standard">
1392 <title>Standard</title>
1394 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1400 <title>f-tex</title>
1402 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1404 <sect3 id="f-tex-Feature-Übersicht">
1405 <title>Feature-Übersicht</title>
1407 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1408 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1410 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1411 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1413 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1414 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1416 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1417 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1418 <filename>letter.lco</filename>).</para></listitem>
1420 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1421 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1423 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1424 Rechnung das Land verlässt).</para></listitem>
1426 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1427 <filename>translatinos.tex</filename>.</para></listitem>
1429 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1433 <sect3 id="f-tex-Installation">
1434 <title>Die Installation</title>
1436 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1437 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1439 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1440 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1443 <para>oder etwas Detaillierter:</para>
1446 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1447 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1448 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1449 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1450 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1454 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1455 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1456 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1457 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1462 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1463 enthält. Bei Updates oder nach erneutem
1467 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1468 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1469 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1472 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1473 <filename>*.lco</filename>-Datei erfolgen.
1477 <sect3 id="f-tex-Funktionsübersicht">
1478 <title>f-tex Funktionsübersicht</title>
1480 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1481 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1482 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1483 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1484 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1488 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1489 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1490 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1491 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1492 Kunde)</para></listitem>
1495 <para>Nachteil:</para>
1498 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1499 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1500 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1501 schnell häftig in den Fuss schiessen.
1504 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1505 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1506 ausgeliefert werden, erfreuen.
1509 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1513 <sect3 id="f-tex-Bruttopreise">
1514 <title>Bruttopreise für Endverbraucher</title>
1516 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1517 Preise Brutto" auszuwählen, aber:</para>
1520 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1521 Zuordung einer Default-Preisgruppe handhaben)</para>
1524 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1525 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1530 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1531 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1532 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1533 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1536 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1537 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1538 Netto" auszuwählen.</para></listitem>
1539 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1540 ohne dass sich der Auftragswert ändert.</para></listitem>
1544 <sect3 id="f-tex-lieferadressen">
1545 <title>Lieferadressen</title>
1547 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1548 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1549 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1550 der Wert der Hauptadresse angezeigt.
1555 <sect2 id="Vorlagen-RB">
1558 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1562 <sect2 id="allgemeine-hinweise-zu-latex">
1563 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1564 <para>In den allermeisten Installationen sollte drucken jetzt schon
1565 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1566 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1567 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1572 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1573 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1574 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1578 <para>! Package inputenc Error: Unicode char \u8:... set up for
1579 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1580 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1581 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1582 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1583 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1587 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1588 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1589 Prüfen Sie den Namen in der Konfiguration (Standard:
1590 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1591 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1594 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1597 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_tmp_files" auf 1</para>
1598 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1601 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1604 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1607 <para>wechsele in das users Verzeichnis von kivitendo</para>
1608 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1611 <para>LaTeX Suchpfad anpassen:</para>
1612 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1615 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1616 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1617 <para>Es sollte die letzte Datei ganz unten sein</para>
1620 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1621 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1622 <para>in der *.tex datei nach dem Fehler suchen.</para>
1628 <sect1 id="OpenDocument-Vorlagen">
1629 <title>OpenDocument-Vorlagen</title>
1631 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1632 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1633 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1634 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1635 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1636 <filename>config/kivitendo.conf</filename> die Variable
1637 <literal>opendocument</literal> im Abschnitt
1638 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1639 Dieses ist die Standardeinstellung.</para>
1641 <para>Weiterhin muss in der Datei
1642 <filename>config/kivitendo.conf</filename> die Variable
1643 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1644 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1645 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1648 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1649 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1650 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1651 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1652 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1653 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1655 <para>Nach der Installation müssen in der Datei
1656 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1657 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1658 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1659 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1660 enthalten. Beide stehen im Abschnitt
1661 <literal>applications</literal>.</para>
1663 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1664 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1665 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1666 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1667 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1668 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1669 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1670 werden muss. Der Nachteil ist, dass diese Methode Python und die
1671 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1674 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1675 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1676 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1677 Dokumentenvorlage enthalten sein und
1678 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1679 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1680 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1681 ebenfalls enthalten sein muss.</para>
1683 <para>Als letztes muss herausgefunden werden, welchen Namen
1684 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1685 gibt. Unter Debian ist dies momentan
1686 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1687 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1688 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1689 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1690 folgender Befehl auszuführen:</para>
1692 <para><literal>mv users/.openoffice.org2
1693 users/.openoffice</literal></para>
1695 <para>Dieses Verzeichnis, wie auch das komplette
1696 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1697 sein. Dieses wurde bereits erledigt (siehe <xref
1698 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1699 erneut überprüft werden, wenn die Konvertierung nach PDF
1703 <sect1 id="config.eur">
1704 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1707 <sect2 id="config.eur.introduction"
1708 xreflabel="Einführung in die Konfiguration zur EUR">
1709 <title>Einführung</title>
1711 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1712 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1713 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1715 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1716 die Mandantendatenbank verschoben und dabei auch gleich in drei
1717 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1718 steuern lässt.</para>
1721 <sect2 id="config.eur.parameters"
1722 xreflabel="Konfigurationsparameter für EUR">
1723 <title>Konfigurationsparameter</title>
1725 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1726 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1730 <term><varname>profit_determination</varname></term>
1733 <para>Dieser Parameter legt die Berechnungsmethode für die
1734 Gewinnermittlung fest. Er enthält entweder
1735 <literal>balance</literal> für
1736 Betriebsvermögensvergleich/Bilanzierung oder
1737 <literal>income</literal> für die
1738 Einnahmen-Überschuss-Rechnung.</para>
1743 <term><varname>accounting_method</varname></term>
1746 <para>Dieser Parameter steuert die Buchungs- und
1747 Berechnungsmethoden für die Versteuerungsart. Er enthält
1748 entweder <literal>accrual</literal> für die Soll-Versteuerung
1749 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1754 <term><varname>inventory_system</varname></term>
1757 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1758 enthält entweder <literal>perpetual</literal> für die
1759 Bestandsmethode oder <literal>periodic</literal> für die
1760 Aufwandsmethode.</para>
1765 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1766 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1767 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1768 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1769 Bestandsmethode.</para>
1771 <para>Die Konfiguration "<varname>eur</varname>" unter
1772 <varname>[system]</varname> in der <link
1773 linkend="config.config-file">Konfigurationsdatei</link>
1774 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1775 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1778 <sect2 id="config.eur.setting-parameters">
1779 <title>Festlegen der Parameter</title>
1781 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1782 der Admininstration können diese Optionen nun unabhängig voneinander
1783 eingestellt werden.</para>
1785 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1786 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1789 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1790 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1791 angezeigt. Unter <guimenu>System</guimenu>
1792 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1793 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1794 dass eine Änderung vorhandene Daten so belässt und damit
1795 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1796 Warenbuchungsmethode (siehe auch
1797 <link linkend="config.eur.inventory-system-perpetual">
1798 Bemerkungen zu Bestandsmethode</link>).</para>
1801 <sect2 id="config.eur.inventory-system-perpetual">
1802 <title>Bemerkungen zu Bestandsmethode</title>
1804 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1805 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1806 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1807 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1808 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1809 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1810 Einkaufsrechnungen berechnet wird.</para>
1812 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1813 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1814 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1818 <sect2 id="config.eur.knonw-issues">
1819 <title>Bekannte Probleme</title>
1821 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1822 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1823 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1824 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1825 die Konfigurationsvariable
1826 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1829 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1830 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1834 <sect1 id="config.skr04-update-3804">
1835 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1837 <sect2 id="config.skr04-update-3804.introduction">
1838 <title>Einführung</title>
1840 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1841 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1842 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1843 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1844 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1845 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1846 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1847 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1848 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1849 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1850 Screenshots dargestellt.</para>
1852 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1853 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1854 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1855 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1858 <sect2 id="config.skr04-update-3804.create-chart">
1859 <title>Konto 3804 manuell anlegen</title>
1861 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1862 anzulegen und zu konfigurieren. Zuerst wird in
1863 <guimenu>System</guimenu> ->
1864 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1865 erfassen</guimenuitem> das Konto angelegt.</para>
1868 <screeninfo>Konto 3804 erfassen</screeninfo>
1872 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1878 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1879 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1880 wie im folgenden Screenshot angezeigt anpassen.
1884 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1888 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1894 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1895 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1899 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1903 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1909 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1910 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1911 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1912 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1916 <screeninfo>Konto 4315 anpassen</screeninfo>
1920 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1926 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1927 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1931 <screeninfo>Steuerliste vergleichen</screeninfo>
1935 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1942 <sect1 id="config.client">
1943 <title>Einstellungen pro Mandant</title>
1945 <para>Einige Einstellungen können von einem Benutzer mit dem
1946 <link linkend="Zusammenhänge">Recht</link> "Administration
1947 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1948 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1949 Mandanten-Datenbank gültig. Die Einstellungen sind
1950 unter <guimenu>System</guimenu>
1951 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
1953 <para>Bitte beachten Sie die Hinweise zu den einzelnen
1954 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
1955 im laufenden Betrieb geändert werden (siehe
1956 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
1957 Bestandsmethode</link>).</para>
1959 <para>Die Einstellungen <literal>show_bestbefore</literal>
1960 und <literal>payments_changeable</literal> aus dem
1961 Abschnitt <literal>features</literal> und die Einstellungen im
1962 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
1963 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
1964 werden bei einem Datenbankupdate einer älteren Version automatisch
1965 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
1966 entfernt werden.</para>
1969 <sect1 id="kivitendo-ERP-verwenden">
1970 <title>kivitendo ERP verwenden</title>
1972 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1973 folgender URL erreichbar:</para>
1976 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
1978 <para>Die Administrationsseite erreichen Sie unter:</para>
1981 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1985 <chapter id="features" xreflabel="Features und Funktionen">
1986 <title>Features und Funktionen</title>
1988 <sect1 id="features.periodic-invoices"
1989 xreflabel="Wiedekehrende Rechnungen">
1990 <title>Wiederkehrende Rechnungen</title>
1992 <sect2 id="features.periodic-invoices.introduction"
1993 xreflabel="Einführung in wiederkehrende Rechnungen">
1994 <title>Einführung</title>
1996 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
1997 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
1998 Die konfigurierten Aufträge werden später automatisch in Rechnungen
1999 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2000 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2001 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2002 wiederzufinden sind.</para>
2005 <sect2 id="features.periodic-invoices.configuration"
2006 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2007 <title>Konfiguration</title>
2009 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2010 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2011 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2012 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2013 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2016 <para>Folgende Parameter kann man konfigurieren:</para>
2023 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2024 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2025 neuen Monats).</para>
2027 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2028 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2029 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2030 nächsten Periodenwechsel für alle Perioden, seit der letzten
2031 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2032 verhindern, muss man vorher das Startdatum neu setzen.</para>
2034 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2035 erstellt. Man kann sich diese Aufträge aber gesondert in den
2036 Berichten anzeigen lassen.</para>
2041 <term>Periodizität</term>
2044 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2045 Rechnungen überprüft werden soll. Für jede Periode seit dem
2046 Startdatum wird überprüft, ob für die Periode (beginnend immer
2047 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2048 wurde. Unter Umständen können bei einem Startdatum in der
2049 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2054 <term>Buchen auf</term>
2057 <para>Das Forderungskonto, in der Regel "Forderungen aus
2058 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2059 Buchungsgruppen der betreffenden Waren.</para>
2064 <term>Startdatum</term>
2067 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2073 <term>Enddatum</term>
2076 <para>ab wann keine Rechnungen mehr erstellt werden
2082 <term>Automatische Verlängerung um x Monate</term>
2085 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2086 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2087 hier die Anzahl der Monate eingeben, um die das Enddatum
2088 automatisch nach hinten geschoben wird.</para>
2093 <term>Drucken</term>
2096 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2097 Rechnungen auch gleich ausdrucken lassen.</para>
2102 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2103 Informationen zu den erstellten Rechnungen verschickt werden.
2104 Konfiguriert wird dies in der <link
2105 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2106 <filename>config/kivitendo.conf</filename> im Abschnitt
2107 <varname>[periodic_invoices]</varname>.</para>
2110 <sect2 id="features.periodic-invoices.reports">
2111 <title>Auflisten</title>
2113 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2114 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2115 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2116 wiederkehrenden Rechnungen verschaffen kann.</para>
2119 <sect2 id="features.periodic-invoices.task-server">
2120 <title>Erzeugung der eigentlichen Rechnungen</title>
2122 <para>Die zeitliche und periodische Überprüfung, ob eine
2123 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2124 durch den <link linkend="config.task-server">Taskserver</link>, einen
2125 externen Dienst, der automatisch beim Start des Servers gestartet
2126 werden sollte.</para>
2129 <sect2 id="features.periodic-invoices.create-for-current-month">
2130 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2132 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2133 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2134 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2135 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2136 generiert hat. Alternativ setzt man das Startdatum auf den
2137 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2138 manuell über den Workflow.</para>
2142 <sect1 id="dokumentenvorlagen-und-variablen">
2143 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2145 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2146 <title>Einführung</title>
2148 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2149 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2150 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2151 <function><%variablenname%></function> verwendet wird. Für
2152 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2154 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2156 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2157 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2158 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2159 alle Vorlagenarten.</para>
2161 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2162 verfügbar als hier aufgelistet werden. Die meisten davon können
2163 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2164 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2165 diese wie folgt erhalten werden:</para>
2169 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2170 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2174 <para>In <filename>Form.pm</filename> die Funktion
2175 <function>parse_template</function> suchen und hier die Zeile
2176 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2180 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2181 ein PDF für eine Rechnung erzeugen.</para>
2185 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2186 der Variablen <varname>$self</varname> in der Form <varname>'key'
2187 => 'value',</varname>. Alle <varname>key</varname>s sind
2193 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2194 <title>Variablen ausgeben</title>
2196 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2197 Tags geschrieben werden, also z.B.
2198 <varname><%variablenname%></varname>.</para>
2200 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2201 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2202 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2203 werden die folgenden Flags unterstützt:</para>
2207 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2208 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2209 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2210 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2214 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2215 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2216 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2217 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2218 ist dieses Flag sinnvoll.</para>
2222 <para>Beispiel:</para>
2224 <programlisting><%quototal NOFORMAT%></programlisting>
2227 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2228 <title>Verwendung in Druckbefehlen</title>
2230 <para>In der Admininstration können Drucker definiert werden. Auch im
2231 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2232 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2233 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2234 <function>`...`</function> nicht zu unerwünschtem Verhalten
2237 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2238 für das die Telefonnummer eines Ansprechpartners als Teil der
2239 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2240 z.B. wie folgt aussehen:</para>
2242 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2245 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2246 xreflabel="Anfang und Ende der Tags verändern">
2247 <title>Anfang und Ende der Tags verändern</title>
2249 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2250 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2251 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2252 <function><%customer%></function>. Da diese Form aber z.B. in
2253 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2254 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2255 Stil umgestellt werden.</para>
2257 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2258 Format gültigen Kommentarzeichen anfangen, dann
2259 <function>config:</function> enthalten, die entsprechende Option
2260 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2261 enden. Beispiel für LaTeX:</para>
2263 <programlisting>% config: tag-style=($ $)</programlisting>
2265 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2266 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2267 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2269 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2272 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2273 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2275 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2276 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2277 "<filename>.ext</filename>" geeignet zu ersetzen:
2278 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2279 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2283 <term><filename>bin_list.ext</filename></term>
2286 <para>Lagerliste</para>
2291 <term><filename>check.ext</filename></term>
2299 <term><filename>invoice.ext</filename></term>
2302 <para>Rechnung</para>
2307 <term><filename>packing_list.ext</filename></term>
2310 <para>Packliste</para>
2315 <term><filename>pick_list.ext</filename></term>
2318 <para>Sammelliste</para>
2323 <term><filename>purchase_delivery_order.ext</filename></term>
2326 <para>Lieferschein (Einkauf)</para>
2331 <term><filename>purcharse_order.ext</filename></term>
2334 <para>Bestellung an Lieferanten</para>
2339 <term><filename>request_quotation.ext</filename></term>
2342 <para>Anfrage an Lieferanten</para>
2347 <term><filename>sales_delivery_order.ext</filename></term>
2350 <para>Lieferschein (Verkauf)</para>
2355 <term><filename>sales_order.ext</filename></term>
2358 <para>Bestellung</para>
2363 <term><filename>sales_quotation.ext</filename></term>
2366 <para>Angebot an Kunden</para>
2371 <term><filename>zahlungserinnerung.ext</filename></term>
2374 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2379 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2382 <para>Rechnung über Mahngebühren (Dateiname im Programm
2383 konfigurierbar)</para>
2389 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2390 <title>Sprache, Drucker und E-Mail</title>
2392 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2393 eingearbeitet. So wird aus der Vorlage
2394 <filename>sales_order.ext</filename> bei Sprache
2395 <function>de</function> und Druckerkürzel <function>lpr2</function>
2396 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2397 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2398 bekommen dann noch das Kürzel <filename>_email</filename>, der
2399 vollständige Vorlagenname wäre dann
2400 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2401 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2402 werden. Diese wird verwendet, wenn keine der anderen Varianten
2403 gefunden wird.</para>
2405 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2406 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2407 verschickt wird, ist:</para>
2411 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2415 <para><filename>sales_order_de_lpr2.tex</filename></para>
2419 <para><filename>sales_order.tex</filename></para>
2423 <para><filename>default.tex</filename></para>
2427 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2428 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2430 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2433 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2434 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2437 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2438 xreflabel="Metainformationen zur angeforderten Vorlage">
2439 <title>Metainformationen zur angeforderten Vorlage</title>
2441 <para>Diese Variablen liefern Informationen darüber welche Variante
2442 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2443 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2444 Formulare einbinden möchten.</para>
2448 <term><varname>template_meta.formname</varname></term>
2451 <para>Basisname der Vorlage. Identisch mit der <link
2452 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2453 zu den Dateinamen</link> ohne die Erweiterung. Ein
2454 Verkaufsauftrag enthält hier
2455 <constant>sales_order</constant>.</para>
2460 <term><varname>template_meta.language.description</varname></term>
2463 <para>Beschreibung der verwendeten Sprache</para>
2468 <term><varname>template_meta.language.template_code</varname></term>
2471 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2472 Kürzel das im Dateinamen verwendetet wird.</para>
2477 <term><varname>template_meta.language.output_numberformat</varname></term>
2480 <para>Zahlenformat der verwendeten Sprache in der Form
2481 "<constant>1.000,00</constant>". Experimentell! Nur
2482 interessant für Vorlagen die mit unformatierten Werten
2488 <term><varname>template_meta.language.output_dateformat</varname></term>
2491 <para>Datumsformat der verwendeten Sprache in der Form
2492 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2493 interessant für Vorlagen die mit unformatierten Werten
2499 <term><varname>template_meta.format</varname></term>
2502 <para>Das angeforderte Format. Kann im Moment die Werte
2503 <constant>pdf</constant>, <constant>postscript</constant>,
2504 <constant>html</constant>, <constant>opendocument</constant>,
2505 <constant>opendocument_pdf</constant> und
2506 <constant>excel</constant> enthalten.</para>
2511 <term><varname>template_meta.extension</varname></term>
2514 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2515 <constant>format</constant> entschieden.</para>
2520 <term><varname>template_meta.media</varname></term>
2523 <para>Ausgabemedium. Kann zur Zeit die Werte
2524 <constant>screen</constant> für Bildschirm,
2525 <constant>email</constant> für E-Mmail (triggert das
2526 <constant>_email</constant> Kürzel im Dateinamen),
2527 <constant>printer</constant> für Drucker, und
2528 <constant>queue</constant> für Warteschlange enthalten.</para>
2533 <term><varname>template_meta.printer.description</varname></term>
2536 <para>Beschreibung des ausgewählten Druckers</para>
2541 <term><varname>template_meta.printer.template_code</varname></term>
2544 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2545 dem Kürzel das im Dateinamen verwendetet wird.</para>
2550 <term><varname>template_meta.tmpfile</varname></term>
2553 <para>Datei-Prefix für temporäre Dateien.</para>
2559 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2560 <title>Stammdaten von Kunden und Lieferanten</title>
2564 <term><varname>account_number</varname></term>
2567 <para>Kontonummer</para>
2572 <term><varname>bank</varname></term>
2575 <para>Name der Bank</para>
2580 <term><varname>bank_code</varname></term>
2583 <para>Bankleitzahl</para>
2588 <term><varname>bic</varname></term>
2591 <para>Bank-Identifikations-Code (Bank Identifier Code,
2597 <term><varname>business</varname></term>
2600 <para>Kunden-/Lieferantentyp</para>
2605 <term><varname>city</varname></term>
2613 <term><varname>contact</varname></term>
2616 <para>Kontakt</para>
2621 <term><varname>country</varname></term>
2629 <term><varname>cp_email</varname></term>
2632 <para>Email des Ansprechpartners</para>
2637 <term><varname>cp_givenname</varname></term>
2640 <para>Vorname des Ansprechpartners</para>
2645 <term><varname>cp_greeting</varname></term>
2648 <para>Anrede des Ansprechpartners</para>
2653 <term><varname>cp_name</varname></term>
2656 <para>Name des Ansprechpartners</para>
2661 <term><varname>cp_phone1</varname></term>
2664 <para>Telefonnummer 1 des Ansprechpartners</para>
2669 <term><varname>cp_phone2</varname></term>
2672 <para>Telefonnummer 2 des Ansprechpartners</para>
2677 <term><varname>cp_title</varname></term>
2680 <para>Titel des Ansprechpartners</para>
2685 <term><varname>creditlimit</varname></term>
2688 <para>Kreditlimit</para>
2693 <term><varname>customeremail</varname></term>
2696 <para>Email des Kunden; nur für Kunden</para>
2701 <term><varname>customerfax</varname></term>
2704 <para>Faxnummer des Kunden; nur für Kunden</para>
2709 <term><varname>customernotes</varname></term>
2712 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2717 <term><varname>customernumber</varname></term>
2720 <para>Kundennummer; nur für Kunden</para>
2725 <term><varname>customerphone</varname></term>
2728 <para>Telefonnummer des Kunden; nur für Kunden</para>
2733 <term><varname>discount</varname></term>
2741 <term><varname>email</varname></term>
2744 <para>Emailadresse</para>
2749 <term><varname>fax</varname></term>
2752 <para>Faxnummer</para>
2757 <term><varname>homepage</varname></term>
2760 <para>Homepage</para>
2765 <term><varname>iban</varname></term>
2768 <para>Internationale Kontonummer (International Bank Account
2769 Number, IBAN)</para>
2774 <term><varname>language</varname></term>
2777 <para>Sprache</para>
2782 <term><varname>name</varname></term>
2785 <para>Firmenname</para>
2790 <term><varname>payment_description</varname></term>
2793 <para>Name der Zahlart</para>
2798 <term><varname>payment_terms</varname></term>
2801 <para>Zahlungskonditionen</para>
2806 <term><varname>phone</varname></term>
2809 <para>Telefonnummer</para>
2814 <term><varname>shiptocity</varname></term>
2817 <para>Stadt (Lieferadresse) <link
2818 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2823 <term><varname>shiptocontact</varname></term>
2826 <para>Kontakt (Lieferadresse) <link
2827 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2832 <term><varname>shiptocountry</varname></term>
2835 <para>Land (Lieferadresse) <link
2836 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2841 <term><varname>shiptodepartment1</varname></term>
2844 <para>Abteilung 1 (Lieferadresse) <link
2845 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2850 <term><varname>shiptodepartment2</varname></term>
2853 <para>Abteilung 2 (Lieferadresse) <link
2854 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2859 <term><varname>shiptoemail</varname></term>
2862 <para>Email (Lieferadresse) <link
2863 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2868 <term><varname>shiptofax</varname></term>
2871 <para>Fax (Lieferadresse) <link
2872 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2877 <term><varname>shiptoname</varname></term>
2880 <para>Firmenname (Lieferadresse) <link
2881 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2886 <term><varname>shiptophone</varname></term>
2889 <para>Telefonnummer (Lieferadresse) <link
2890 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2895 <term><varname>shiptostreet</varname></term>
2898 <para>Straße und Hausnummer (Lieferadresse) <link
2899 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2904 <term><varname>shiptozipcode</varname></term>
2907 <para>Postleitzahl (Lieferadresse) <link
2908 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2913 <term><varname>street</varname></term>
2916 <para>Straße und Hausnummer</para>
2921 <term><varname>taxnumber</varname></term>
2924 <para>Steuernummer</para>
2929 <term><varname>ustid</varname></term>
2932 <para>Umsatzsteuer-Identifikationsnummer</para>
2937 <term><varname>vendoremail</varname></term>
2940 <para>Email des Lieferanten; nur für Lieferanten</para>
2945 <term><varname>vendorfax</varname></term>
2948 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2953 <term><varname>vendornotes</varname></term>
2956 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2961 <term><varname>vendornumber</varname></term>
2964 <para>Lieferantennummer; nur für Lieferanten</para>
2969 <term><varname>vendorphone</varname></term>
2972 <para>Telefonnummer des Lieferanten; nur für
2978 <term><varname>zipcode</varname></term>
2981 <para>Postleitzahl</para>
2986 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
2987 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
2988 Stammdaten nicht eingetragen, so haben die Variablen
2989 <varname>shipto*</varname> den gleichen Wert wie die die
2990 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
2991 einige <varname>shipto*</varname>-Variablen so nicht in den
2992 Stammdaten wiederfinden sondern schlicht Kopien der
2993 Lieferdatenvariablen sind (z.B.
2994 <varname>shiptocontact</varname>).</para>
2998 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
2999 <title>Informationen über den Bearbeiter</title>
3003 <term><varname>employee_address</varname></term>
3006 <para>Adressfeld</para>
3011 <term><varname>employee_businessnumber</varname></term>
3014 <para>Firmennummer</para>
3019 <term><varname>employee_company</varname></term>
3022 <para>Firmenname</para>
3027 <term><varname>employee_co_ustid</varname></term>
3030 <para>Usatzsteuer-Identifikationsnummer</para>
3035 <term><varname>employee_duns</varname></term>
3038 <para>DUNS-Nummer</para>
3043 <term><varname>employee_email</varname></term>
3051 <term><varname>employee_fax</varname></term>
3059 <term><varname>employee_name</varname></term>
3062 <para>voller Name</para>
3067 <term><varname>employee_signature</varname></term>
3070 <para>Signatur</para>
3075 <term><varname>employee_taxnumber</varname></term>
3078 <para>Steuernummer</para>
3083 <term><varname>employee_tel</varname></term>
3086 <para>Telefonnummer</para>
3092 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3093 <title>Informationen über den Bearbeiter</title>
3097 <term><varname>salesman_address</varname></term>
3100 <para>Adressfeld</para>
3105 <term><varname>salesman_businessnumber</varname></term>
3108 <para>Firmennummer</para>
3113 <term><varname>salesman_company</varname></term>
3116 <para>Firmenname</para>
3121 <term><varname>salesman_co_ustid</varname></term>
3124 <para>Usatzsteuer-Identifikationsnummer</para>
3129 <term><varname>salesman_duns</varname></term>
3132 <para>DUNS-Nummer</para>
3137 <term><varname>salesman_email</varname></term>
3145 <term><varname>salesman_fax</varname></term>
3153 <term><varname>salesman_name</varname></term>
3156 <para>voller Name</para>
3161 <term><varname>salesman_signature</varname></term>
3164 <para>Signatur</para>
3169 <term><varname>salesman_taxnumber</varname></term>
3172 <para>Steuernummer</para>
3177 <term><varname>salesman_tel</varname></term>
3180 <para>Telefonnummer</para>
3186 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3187 <title>Variablen für die einzelnen Steuern</title>
3191 <term><varname>tax</varname></term>
3199 <term><varname>taxbase</varname></term>
3202 <para>zu versteuernder Betrag</para>
3207 <term><varname>taxdescription</varname></term>
3210 <para>Name der Steuer</para>
3215 <term><varname>taxrate</varname></term>
3218 <para>Steuersatz</para>
3225 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3226 <title>Variablen in Rechnungen</title>
3228 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3229 <title>Allgemeine Variablen</title>
3233 <term><varname>creditremaining</varname></term>
3236 <para>Verbleibender Kredit</para>
3241 <term><varname>currency</varname></term>
3244 <para>Währung</para>
3249 <term><varname>cusordnumber</varname></term>
3252 <para>Bestellnummer beim Kunden</para>
3257 <term><varname>deliverydate</varname></term>
3260 <para>Lieferdatum</para>
3265 <term><varname>duedate</varname></term>
3268 <para>Fälligkeitsdatum</para>
3273 <term><varname>globalprojectnumber</varname></term>
3276 <para>Projektnummer des ganzen Beleges</para>
3281 <term><varname>globalprojectdescription</varname></term>
3284 <para>Projekbeschreibung des ganzen Beleges</para>
3289 <term><varname>intnotes</varname></term>
3292 <para>Interne Bemerkungen</para>
3297 <term><varname>invdate</varname></term>
3300 <para>Rechnungsdatum</para>
3305 <term><varname>invnumber</varname></term>
3308 <para>Rechnungsnummer</para>
3313 <term><varname>invtotal</varname></term>
3316 <para>gesamter Rechnungsbetrag</para>
3321 <term><varname>notes</varname></term>
3324 <para>Bemerkungen der Rechnung</para>
3329 <term><varname>orddate</varname></term>
3332 <para>Auftragsdatum</para>
3337 <term><varname>ordnumber</varname></term>
3340 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3341 erstellt wurde</para>
3346 <term><varname>payment_description</varname></term>
3349 <para>Name der Zahlart</para>
3354 <term><varname>payment_terms</varname></term>
3357 <para>Zahlungskonditionen</para>
3362 <term><varname>quodate</varname></term>
3365 <para>Angebotsdatum</para>
3370 <term><varname>quonumber</varname></term>
3373 <para>Angebotsnummer</para>
3378 <term><varname>shippingpoint</varname></term>
3381 <para>Versandort</para>
3386 <term><varname>shipvia</varname></term>
3389 <para>Transportmittel</para>
3394 <term><varname>subtotal</varname></term>
3397 <para>Zwischensumme aller Posten ohne Steuern</para>
3402 <term><varname>total</varname></term>
3405 <para>Restsumme der Rechnung (Summe abzüglich bereits
3406 bezahlter Posten)</para>
3411 <term><varname>transaction_description</varname></term>
3414 <para>Vorgangsbezeichnung</para>
3419 <term><varname>transdate</varname></term>
3422 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3423 erstellt wurde</para>
3429 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3430 <title>Variablen für jeden Posten auf der Rechnung</title>
3434 <term><varname>bin</varname></term>
3437 <para>Stellage</para>
3442 <term><varname>description</varname></term>
3445 <para>Artikelbeschreibung</para>
3450 <term><varname>discount</varname></term>
3453 <para>Rabatt als Betrag</para>
3458 <term><varname>discount_sub</varname></term>
3461 <para>Zwischensumme mit Rabatt</para>
3466 <term><varname>drawing</varname></term>
3469 <para>Zeichnung</para>
3474 <term><varname>ean</varname></term>
3477 <para>EAN-Code</para>
3482 <term><varname>image</varname></term>
3490 <term><varname>linetotal</varname></term>
3493 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3498 <term><varname>longdescription</varname></term>
3501 <para>Langtext</para>
3506 <term><varname>microfiche</varname></term>
3509 <para>Mikrofilm</para>
3514 <term><varname>netprice</varname></term>
3517 <para>Nettopreis</para>
3522 <term><varname>nodiscount_linetotal</varname></term>
3525 <para>Zeilensumme ohne Rabatt</para>
3530 <term><varname>nodiscount_sub</varname></term>
3533 <para>Zwischensumme ohne Rabatt</para>
3538 <term><varname>number</varname></term>
3541 <para>Artikelnummer</para>
3546 <term><varname>ordnumber_oe</varname></term>
3549 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3550 aus einem Sammelauftrag erstellt wurde</para>
3555 <term><varname>p_discount</varname></term>
3558 <para>Rabatt in Prozent</para>
3563 <term><varname>partnotes</varname></term>
3566 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3571 <term><varname>partsgroup</varname></term>
3574 <para>Warengruppe</para>
3579 <term><varname>price_factor</varname></term>
3582 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3588 <term><varname>price_factor_name</varname></term>
3591 <para>Der Name des Preisfaktors, sofern einer eingestellt
3597 <term><varname>projectnumber</varname></term>
3600 <para>Projektnummer</para>
3605 <term><varname>projectdescription</varname></term>
3608 <para>Projektbeschreibung</para>
3613 <term><varname>qty</varname></term>
3621 <term><varname>reqdate</varname></term>
3624 <para>Lieferdatum</para>
3629 <term><varname>runningnumber</varname></term>
3632 <para>Position auf der Rechnung (1, 2, 3...)</para>
3637 <term><varname>sellprice</varname></term>
3640 <para>Verkaufspreis</para>
3645 <term><varname>serialnumber</varname></term>
3648 <para>Seriennummer</para>
3653 <term><varname>tax_rate</varname></term>
3656 <para>Steuersatz</para>
3661 <term><varname>transdate_oe</varname></term>
3664 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3665 aus einem Sammelauftrag erstellt wurde</para>
3670 <term><varname>unit</varname></term>
3673 <para>Einheit</para>
3678 <term><varname>weight</varname></term>
3681 <para>Gewicht</para>
3686 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3687 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3688 einer <function>foreach</function>-Schleife ausgegeben werden, da
3689 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3690 können. Die Variablen dafür lauten:</para>
3694 <term><varname>make</varname></term>
3697 <para>Lieferant</para>
3702 <term><varname>model</varname></term>
3705 <para>Lieferantenartikelnummer</para>
3711 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3712 <title>Variablen für die einzelnen Zahlungseingänge</title>
3716 <term><varname>payment</varname></term>
3724 <term><varname>paymentaccount</varname></term>
3732 <term><varname>paymentdate</varname></term>
3740 <term><varname>paymentmemo</varname></term>
3748 <term><varname>paymentsource</varname></term>
3757 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3758 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3760 <para>Die vom Benutzer definierten Variablen für Kunden und
3761 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3762 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3763 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3764 Variablennamen zusammen.</para>
3766 <para>Beispiel: Der Benutzer hat eine Variable namens
3767 <varname>number_of_employees</varname> definiert, die die Anzahl der
3768 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3769 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3774 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3775 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3777 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3778 <title>Namen der Vorlagen</title>
3780 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3781 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3782 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3783 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3784 Vorlagenname für diese Mahnstufe mit dem Zusatz
3785 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3786 für die ausgewählte Sprache und den ausgewählten Drucker
3790 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3791 <title>Allgemeine Variablen in Mahnungen</title>
3793 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3794 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3795 Kunden stehen als Variablen <varname>name</varname>,
3796 <varname>street</varname>, <varname>zipcode</varname>,
3797 <varname>city</varname>, <varname>country</varname>,
3798 <varname>department_1</varname>, <varname>department_2</varname>,
3799 und <varname>email</varname> zur Verfügung.</para>
3801 <para>Weitere Variablen beinhalten:</para>
3805 <term><varname>dunning_date</varname></term>
3808 <para>Datum der Mahnung</para>
3813 <term><varname>dunning_duedate</varname></term>
3816 <para>Fälligkeitsdatum für diese Mahhnung</para>
3821 <term><varname>dunning_id</varname></term>
3824 <para>Mahnungsnummer</para>
3829 <term><varname>fee</varname></term>
3832 <para>Kummulative Mahngebühren</para>
3837 <term><varname>interest_rate</varname></term>
3840 <para>Zinssatz per anno in Prozent</para>
3845 <term><varname>total_amount</varname></term>
3848 <para>Gesamter noch zu zahlender Betrag als
3849 <function>fee</function> + <function>total_interest</function>
3850 + <function>total_open_amount</function></para>
3855 <term><varname>total_interest</varname></term>
3858 <para>Zinsen per anno über alle Rechnungen</para>
3863 <term><varname>total_open_amount</varname></term>
3866 <para>Summe über alle offene Beträge der Rechnungen</para>
3872 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3873 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3877 <term><varname>dn_amount</varname></term>
3880 <para>Rechnungssumme (brutto)</para>
3885 <term><varname>dn_duedate</varname></term>
3888 <para>Originales Fälligkeitsdatum der Rechnung</para>
3893 <term><varname>dn_dunning_date</varname></term>
3896 <para>Datum der Mahnung</para>
3901 <term><varname>dn_dunning_duedate</varname></term>
3904 <para>Fälligkeitsdatum der Mahnung</para>
3909 <term><varname>dn_fee</varname></term>
3912 <para>Kummulative Mahngebühr</para>
3917 <term><varname>dn_interest</varname></term>
3920 <para>Zinsen per anno für diese Rechnung</para>
3925 <term><varname>dn_invnumber</varname></term>
3928 <para>Rechnungsnummer</para>
3933 <term><varname>dn_linetotal</varname></term>
3936 <para>Noch zu zahlender Betrag (ergibt sich aus
3937 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3938 + <varname>dn_interest</varname>)</para>
3943 <term><varname>dn_netamount</varname></term>
3946 <para>Rechnungssumme (netto)</para>
3951 <term><varname>dn_open_amount</varname></term>
3954 <para>Offener Rechnungsbetrag</para>
3959 <term><varname>dn_ordnumber</varname></term>
3962 <para>Bestellnummer</para>
3967 <term><varname>dn_transdate</varname></term>
3970 <para>Rechnungsdatum</para>
3975 <term><varname>dn_curr</varname></term>
3978 <para>Währung, in der die Rechnung erstellt wurde. (Die
3979 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
3985 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
3986 <title>Variablen in automatisch erzeugten Rechnungen über
3987 Mahngebühren</title>
3989 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3990 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3991 Kunden stehen als Variablen <varname>name</varname>,
3992 <varname>street</varname>, <varname>zipcode</varname>,
3993 <varname>city</varname>, <varname>country</varname>,
3994 <varname>department_1</varname>, <varname>department_2</varname>,
3995 und <varname>email</varname> zur Verfügung.</para>
3997 <para>Weitere Variablen beinhalten:</para>
4001 <term><varname>duedate</varname></term>
4004 <para>Fälligkeitsdatum der Rechnung</para>
4009 <term><varname>dunning_id</varname></term>
4012 <para>Mahnungsnummer</para>
4017 <term><varname>fee</varname></term>
4020 <para>Mahngebühren</para>
4025 <term><varname>interest</varname></term>
4033 <term><varname>invamount</varname></term>
4036 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4037 <varname>interest</varname>)</para>
4042 <term><varname>invdate</varname></term>
4045 <para>Rechnungsdatum</para>
4050 <term><varname>invnumber</varname></term>
4053 <para>Rechnungsnummer</para>
4060 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4061 <title>Variablen in anderen Vorlagen</title>
4064 <title>Einführung</title>
4066 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4067 Rechnung. Allerdings heißen die Variablen, die mit
4068 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4069 fangen sie mit <varname>quo</varname> für "quotation" an:
4070 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4071 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4072 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4074 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4075 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4076 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4077 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4080 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4081 in Rechnungen aufgeführt.</para>
4084 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4085 <title>Angebote und Preisanfragen</title>
4089 <term><varname>quonumber</varname></term>
4092 <para>Angebots- bzw. Anfragenummer</para>
4097 <term><varname>reqdate</varname></term>
4100 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4101 Preisanfragen)</para>
4106 <term><varname>transdate</varname></term>
4109 <para>Angebots- bzw. Anfragedatum</para>
4115 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4116 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4120 <term><varname>ordnumber</varname></term>
4123 <para>Auftragsnummer</para>
4128 <term><varname>reqdate</varname></term>
4131 <para>Lieferdatum</para>
4136 <term><varname>transdate</varname></term>
4139 <para>Auftragsdatum</para>
4145 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4146 <title>Lieferscheine (Verkauf und Einkauf)</title>
4150 <term><varname>cusordnumber</varname></term>
4153 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4154 des Lieferanten (im Einkauf)</para>
4159 <term><varname>donumber</varname></term>
4162 <para>Lieferscheinnummer</para>
4167 <term><varname>transdate</varname></term>
4170 <para>Lieferscheindatum</para>
4175 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4176 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4177 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4178 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4179 <function>foreach</function>-Schleife ausgegeben werden. Diese
4180 Variablen sind:</para>
4184 <term><varname>si_bin</varname></term>
4187 <para>Lagerplatz</para>
4192 <term><varname>si_chargenumber</varname></term>
4195 <para>Chargennummer</para>
4200 <term><varname>si_bestbefore</varname></term>
4203 <para>Mindesthaltbarkeit</para>
4208 <term><varname>si_number</varname></term>
4211 <para>Artikelnummer</para>
4216 <term><varname>si_qty</varname></term>
4219 <para>Anzahl bzw. Menge</para>
4224 <term><varname>si_runningnumber</varname></term>
4227 <para>Positionsnummer (1, 2, 3 etc)</para>
4232 <term><varname>si_unit</varname></term>
4235 <para>Einheit</para>
4240 <term><varname>si_warehouse</varname></term>
4249 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4250 <title>Variablen für Sammelrechnung</title>
4254 <term><varname>c0total</varname></term>
4257 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4263 <term><varname>c30total</varname></term>
4266 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4267 und < 60 Tage</para>
4272 <term><varname>c60total</varname></term>
4275 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4276 und < 90 Tage</para>
4281 <term><varname>c90total</varname></term>
4284 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4290 <term><varname>total</varname></term>
4293 <para>Gesamtbetrag aller Rechnungen</para>
4298 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4302 <term><varname>invnumber</varname></term>
4305 <para>Rechnungsnummer</para>
4310 <term><varname>invdate</varname></term>
4313 <para>Rechnungsdatum</para>
4318 <term><varname>duedate</varname></term>
4321 <para>Fälligkeitsdatum</para>
4326 <term><varname>amount</varname></term>
4329 <para>Summe der Rechnung</para>
4334 <term><varname>open</varname></term>
4337 <para>Noch offener Betrag der Rechnung</para>
4342 <term><varname>c0</varname></term>
4345 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4351 <term><varname>c30</varname></term>
4354 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4360 <term><varname>c60</varname></term>
4363 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4369 <term><varname>c90</varname></term>
4372 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4380 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4381 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4383 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4384 <title>Einfürhung</title>
4386 <para>Der Parser kennt neben den Variablen einige weitere
4387 Konstrukte, die gesondert behandelt werden. Diese sind wie
4388 Variablennamen in spezieller Weise markiert:
4389 <command><%anweisung%> ... <%end%></command></para>
4391 <para>Anmerkung zum <command><%end%></command>: Der besseren
4392 Verständlichkeit halber kann man nach dem <command>end</command>
4393 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4394 Anweisung (z.B. <command>if</command> oder
4395 <command>foreach</command>) damit abgeschlossen wird.</para>
4397 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4398 <command><%if type == "sales_quotation"%></command>, so könnte
4399 er mit <command><%end%></command> genauso abgeschlossen werden
4400 wie mit <command><%end if%></command> oder auch
4401 <command><%end type == "sales_quotation"%></command>.</para>
4404 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4405 <title>Der if-Block</title>
4407 <programlisting><%if variablenname%>
4409 <%end%></programlisting>
4411 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4412 und dem "end" werden nur ausgegeben, wenn die Variable
4413 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4415 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4416 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4417 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4418 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4420 <programlisting><%if payment%>
4422 <%foreach payment%>
4423 Am <%paymentdate%>: <%payment%> €
4424 <%end foreach%>
4425 <%end if%></programlisting>
4427 <para>Die Bedingung kann auch negiert werden, indem das Wort
4428 <function>not</function> nach dem <filename>if</filename> verwendet
4429 wird. Beispiel:</para>
4431 <programlisting><%if not cp_greeting%>
4433 <%end%></programlisting>
4435 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4436 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4437 einer Variablen mit einer festen Zeichenkette oder einer anderen
4438 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4439 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4440 die rechte Seite des Vergleichsoperators in Anführungszeichen
4441 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4442 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4445 <programlisting><%if var1 == "Wert"%></programlisting>
4447 <para>Testet die Variable <varname>var1</varname> auf
4448 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4449 Mittels <function>!=</function> anstelle von <function>==</function>
4450 würde auf Ungleichheit getestet.</para>
4452 <programlisting><%if var1 == var2%></programlisting>
4454 <para>Testet die Variable <varname>var1</varname> auf
4455 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4456 <function>!=</function> anstelle von <function>==</function> würde
4457 auf Ungleichheit getestet.</para>
4459 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4460 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4461 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4462 dieselbe Syntax wie oben nur mit <function>=~</function> und
4463 <function>!~</function> als Vergleichsoperatoren.</para>
4465 <para>Beispiel für einen Test, ob die Variable
4466 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4467 <constant>schwierig</constant> enthält:</para>
4469 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4472 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4473 <title>Der foreach-Block</title>
4475 <programlisting><%foreach variablenname%>
4477 <%end%></programlisting>
4479 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4480 wie das Perl-Array der Variablen <varname>variablenname</varname>
4481 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4482 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4483 benutzt. In jedem Durchlauf werden die <link
4484 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4485 Variablen</link> jeweils auf den Wert für die aktuelle Position
4488 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4490 <programlisting><%foreach number%>
4491 Position: <%runningnumber%>
4492 Anzahl: <%qty%>
4493 Artikelnummer: <%number%>
4494 Beschreibung: <%description%>
4496 <%end%></programlisting>
4498 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4499 <function><%foreach%></function>-Block innerhalb einer
4500 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4501 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4502 Inhalt zwischen <function><%foreach%></function> und
4503 <function><%end%></function> wiederholt, nicht aber die
4504 komplette Zeile, in der er steht.</para>
4508 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4509 <title>Markup-Code zur Textformatierung innerhalb von
4512 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4513 anders formatiert haben möchte, so ist dies begrenzt möglich.
4514 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4515 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4516 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4517 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4518 (HTML oder PDF über LaTeX) umgesetzt.</para>
4520 <para>Die unterstützen Formatierungen sind:</para>
4524 <term><b>Text</b></term>
4527 <para>Text wird in Fettdruck gesetzt.</para>
4532 <term><i>Text</i></term>
4535 <para>Text wird kursiv gesetzt.</para>
4540 <term><u>Text</u></term>
4543 <para>Text wird unterstrichen.</para>
4548 <term><s>Text</s></term>
4551 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4552 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4557 <term><bullet></term>
4560 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4566 <para>Der Befehl <command><bullet></command> funktioniert
4567 momentan auch nur in Latex-Vorlagen.</para>
4571 <sect1 id="excel-templates">
4572 <title>Excel-Vorlagen</title>
4574 <sect2 id="excel-templates.summary">
4575 <title>Zusammenfassung</title>
4577 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4578 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4582 <sect2 id="excel-templates.usage">
4583 <title>Bedienung</title>
4585 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4586 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4587 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4589 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4590 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4591 werden. In den normalen Verkaufsmasken taucht nun
4592 <constant>Excel</constant> als auswählbares Format auf und kann von da
4593 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4595 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4596 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4597 <filename>sales_quotation.xls</filename> gespeichert.</para>
4600 <sect2 id="excel-templates.syntax">
4601 <title>Variablensyntax</title>
4603 <para>Einfache Syntax:
4604 <command><<varname>></command></para>
4606 <para>Dabei sind <constant><<</constant> und
4607 <constant>>></constant> die Delimiter. Da Excel auf festen
4608 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4609 weitere <constant><</constant> oder <constant>></constant>
4610 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4613 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4615 <para>Um die Limitierung der festen Breite zu reduzieren, können
4616 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4617 dazwishen dann erhalten. Beispiel:</para>
4619 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4621 <para>Die Variablen werden interpoliert, und linksbündig mit
4622 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4623 lang, werden überzählige Zeichen abgeschnitten.</para>
4625 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4626 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4628 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4630 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4631 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4635 <sect2 id="excel-templates.limitations">
4636 <title>Einschränkungen</title>
4638 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4639 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4640 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4641 Text zu ersetzen.</para>
4643 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4644 <command><%if%></command> und
4645 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4646 <constant><% %></constant> kommt in den Headerinformationen
4647 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4648 <constant><<</constant> und <constant>>></constant>
4655 <title>Entwicklerdokumentation</title>
4657 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4658 <title>Globale Variablen</title>
4661 <title>Wie sehen globale Variablen in Perl aus?</title>
4663 <para>Globale Variablen liegen in einem speziellen namespace namens
4664 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4665 globs global und die meisten speziellen Variablen sind...
4668 <para>Daraus ergeben sich folgende Formen:</para>
4672 <term><literal>$main::form</literal></term>
4675 <para>expliziter Namespace "main"</para>
4680 <term><literal>$::form</literal></term>
4683 <para>impliziter Namespace "main"</para>
4688 <term><literal>open FILE, "file.txt"</literal></term>
4691 <para><varname>FILE</varname> ist global</para>
4696 <term><literal>$_</literal></term>
4699 <para>speziell</para>
4704 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4705 Schlüsselwort wie "<function>global</function>", mit dem man
4706 importieren kann. <function>my</function>, <function>our</function>
4707 und <function>local</function> machen was anderes.</para>
4711 <term><literal>my $form</literal></term>
4714 <para>lexikalische Variable, gültig bis zum Ende des
4720 <term><literal>our $form</literal></term>
4723 <para><varname>$form</varname> referenziert ab hier
4724 <varname>$PACKAGE::form</varname>.</para>
4729 <term><literal>local $form</literal></term>
4732 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4733 des scopes zurückgesetzt</para>
4740 <title>Warum sind globale Variablen ein Problem?</title>
4742 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4744 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4745 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4746 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4747 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4748 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4749 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4752 <para>Das zweite Problem ist <function>strict</function>. Unter
4753 <function>strict</function> werden alle Variablen die nicht explizit
4754 mit <function>Package</function>, <function>my</function> oder
4755 <function>our</function> angegeben werden als Tippfehler angemarkert,
4756 dies hat, seit der Einführung, u.a. schon so manche langwierige
4757 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4758 angegeben werden, werden die nicht geprüft, und somit kann sich
4759 schnell ein Tippfehler einschleichen.</para>
4763 <title>Kanonische globale Variablen</title>
4765 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4766 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4767 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4768 umhergereicht werden.</para>
4770 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4774 <para><varname>$::form</varname></para>
4778 <para><varname>%::myconfig</varname></para>
4782 <para><varname>$::locale</varname></para>
4786 <para><varname>$::lxdebug</varname></para>
4790 <para><varname>$::auth</varname></para>
4794 <para><varname>$::lx_office_conf</varname></para>
4798 <para><varname>$::instance_conf</varname></para>
4802 <para><varname>$::dispatcher</varname></para>
4806 <para><varname>$::request</varname></para>
4810 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4811 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4812 Eigenschaften (Konventionen):</para>
4815 <title>$::form</title>
4819 <para>Ist ein Objekt der Klasse
4820 "<classname>Form</classname>"</para>
4824 <para>Wird nach jedem Request gelöscht</para>
4828 <para>Muss auch in Tests und Konsolenscripts vorhanden
4833 <para>Enthält am Anfang eines Requests die Requestparameter vom
4838 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4839 cachen, das wird aber momentan absichtlich zerstört</para>
4843 <para><varname>$::form</varname> wurde unter <productname>SQL
4844 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4845 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4846 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4847 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4848 <function>IS->retrieve_customer()</function> in Sicherheit
4851 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4852 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4853 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4854 richtigen Wert zu setzen:</para>
4856 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4857 $::myconfig{numberformat} = $numberformat;
4858 # (...) div Berechnungen
4859 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4861 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4862 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4863 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4864 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4865 Es geht ziemlich sicher etwas kaputt.</para>
4867 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4868 in den <productname>Template::Toolkit</productname> Templates
4869 außerhalb der Controller: der Ausdruck <function>[% var
4870 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4871 Unter Controllern ist der Standard Scope anders, da lautet der
4872 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4873 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4874 <function><%var%></function> zeigt auf
4875 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4876 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4879 <programlisting>[%- IF business %]
4880 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4881 [%- END %]</programlisting>
4883 <para>Entweder wird hier dann $::form->{business} ausgewertet
4884 oder aber der Funktion
4885 <function>$form->parse_html_template</function> wird explizit
4886 noch ein zusätzlicher Hash übergeben, der dann auch in den
4887 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4889 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4891 <para>Innerhalb von Schleifen wird
4892 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4893 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4894 welches über alle Positionen eines Lieferscheins in Schleife
4897 <programlisting>for $i (1 .. $form->{rowcount}) {
4899 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4900 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4901 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4907 <title>%::myconfig</title>
4911 <para>Das einzige Hash unter den globalen Variablen</para>
4915 <para>Wird spätestens benötigt wenn auf die Datenbank
4916 zugegriffen wird</para>
4920 <para>Wird bei jedem Request neu erstellt.</para>
4924 <para>Enthält die Userdaten des aktuellen Logins</para>
4928 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4929 extern serialisiert werden, weil da auch der Datenbankzugriff
4930 für diesen user drinsteht.</para>
4934 <para>Enthält unter anderem Listenbegrenzung vclimit,
4935 Datumsformat dateformat und Nummernformat numberformat</para>
4939 <para>Enthält Datenbankzugriffinformationen</para>
4943 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4944 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4945 aktuellen Users entscheiden müssen, befragen
4946 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4947 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4948 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4949 Informationen über den Benutzer die über die
4950 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
4954 <title>$::locale</title>
4958 <para>Objekt der Klasse "Locale"</para>
4962 <para>Wird pro Request erstellt</para>
4966 <para>Muss auch für Tests und Scripte immer verfügbar
4971 <para>Cached intern über Requestgrenzen hinweg benutzte
4976 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4977 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
4981 <title>$::lxdebug</title>
4985 <para>Objekt der Klasse "LXDebug"</para>
4989 <para>Wird global gecached</para>
4993 <para>Muss immer verfügbar sein, in nahezu allen
4998 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
4999 bereit, wie "<function>enter_sub</function>" und
5000 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5001 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5002 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5003 "<function>message</function>" und "<function>dump</function>" mit
5004 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5007 <para>Beispielsweise so:</para>
5009 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5010 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5014 <title>$::auth</title>
5018 <para>Objekt der Klasse "SL::Auth"</para>
5022 <para>Wird global gecached</para>
5026 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5030 <para>Wird nach jedem Request resettet.</para>
5034 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5035 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5036 vom aktuellen User abhängen wird das Objekt aus
5037 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5038 Request kurz resettet.</para>
5042 <title>$::lx_office_conf</title>
5046 <para>Objekt der Klasse
5047 "<classname>SL::LxOfficeConf</classname>"</para>
5051 <para>Global gecached</para>
5055 <para>Repräsentation der
5056 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5060 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5061 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5062 das Programm die Konfiguration ändern kann oder sollte.</para>
5064 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5065 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5068 <programlisting>[debug]
5069 file = /tmp/kivitendo-debug.log</programlisting>
5071 <para>ist der Key <varname>file</varname> im Programm als
5072 <varname>$::lx_office_conf->{debug}{file}</varname>
5076 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5077 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5082 <title>$::instance_conf</title>
5086 <para>Objekt der Klasse
5087 "<classname>SL::InstanceConfiguration</classname>"</para>
5091 <para>wird pro Request neu erstellt</para>
5095 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5096 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5097 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5098 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5099 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5103 <title>$::dispatcher</title>
5107 <para>Objekt der Klasse
5108 "<varname>SL::Dispatcher</varname>"</para>
5112 <para>wird pro Serverprozess erstellt.</para>
5116 <para>enthält Informationen über die technische Verbindung zum
5121 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5122 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5123 Objekt untergebracht.</para>
5127 <title>$::request</title>
5131 <para>Hashref (evtl später Objekt)</para>
5135 <para>Wird pro Request neu initialisiert.</para>
5139 <para>Keine Unterstruktur garantiert.</para>
5143 <para><varname>$::request</varname> ist ein generischer Platz um
5144 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5145 at a distance benutzt werden, sondern um lokales memoizing zu
5146 ermöglichen, das garantiert am Ende des Requests zerstört
5149 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5150 liegt, sollte eigentlich hier liegen. Die groben
5151 Differentialkriterien sind:</para>
5155 <para>Kommt es vom User, und soll unverändert wieder an den
5156 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5160 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5161 Requests gebraucht werden? Dann
5162 <varname>$::request</varname></para>
5166 <para>Muss ich von anderen Teilen des Programms lesend drauf
5167 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5168 Wrappermethode</para>
5175 <title>Ehemalige globale Variablen</title>
5177 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5181 <title>$::cgi</title>
5185 <para>war nötig, weil cookie Methoden nicht als
5186 Klassenfunktionen funktionieren</para>
5190 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5191 Klassennamespace gehalten wird und über Requestgrenzen
5196 <para>liegt jetzt unter
5197 <varname>$::request->{cgi}</varname></para>
5203 <title>$::all_units</title>
5207 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5208 ein paar hundert mal pro Request eine Liste der Einheiten
5209 brauchen, und de als Parameter durch einen Riesenstack von
5210 Funktionen geschleift werden müssten.</para>
5214 <para>Liegt jetzt unter
5215 <varname>$::request->{cache}{all_units}</varname></para>
5220 <function>AM->retrieve_all_units()</function> gesetzt oder
5227 <title>%::called_subs</title>
5231 <para>wurde benutzt um callsub deep recursions
5236 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5237 möglichen Rekursioenen darstellt, und da nie welche
5242 <para>komplette recursion protection wurde entfernt.</para>
5249 <sect1 id="devel.fcgi">
5250 <title>Entwicklung unter FastCGI</title>
5252 <sect2 id="devel.fcgi.general">
5253 <title>Allgemeines</title>
5255 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5256 werden, muss der Webserver neu gestartet werden.</para>
5258 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5259 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5260 müssen folgende Aspekte beachtet werden.</para>
5263 <sect2 id="devel.fcgi.exiting">
5264 <title>Programmende und Ausnahmen</title>
5266 <para>Betrifft die Funktionen <function>warn</function>,
5267 <function>die</function>, <function>exit</function>,
5268 <function>carp</function> und <function>confess</function>.</para>
5270 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5271 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5272 am Laufen zu halten. Man kann mit <function>die</function>,
5273 <function>confess</function> oder <function>carp</function> Fehler
5274 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5275 eigene <function>$::form-</function>error()> tut im Prinzip das
5276 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5277 <function>exit</function> hingegen werden nicht abgefangen.
5278 <function>warn</function> wird direkt nach STDERR, also in Server Log
5279 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5280 Warnungen in das kivitendo Log umgeleitet wurden), und
5281 <function>exit</function> wird die Ausführung beenden.</para>
5283 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5284 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5285 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5286 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5289 <sect2 id="devel.fcgi.globals">
5290 <title>Globale Variablen</title>
5292 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5293 anderen gelangen, müssen alle globalen Variablen vor einem Request
5294 sauber initialisiert werden. Das ist besonders wichtig im
5295 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5296 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5299 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5300 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5301 erklärt. Bitte keine anderen einführen ohne das sauber zu
5302 dokumentieren.</para>
5304 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5305 man sicher geht, dass man die richtige erwischt.</para>
5308 <sect2 id="devel.fcgi.performance">
5309 <title>Performance und Statistiken</title>
5311 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5312 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5313 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5314 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5315 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5316 Moose/Rose::DB Version sind es 5-6s.</para>
5318 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5319 den kritischen Pfaden, unter 0,15 sonst.</para>
5322 <sect2 id="devel.fcgi.known-issues">
5323 <title>Bekannte Probleme</title>
5325 <sect3 id="devel.fcgi.known-issues.encoding">
5326 <title>Encoding Awareness</title>
5328 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
5329 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
5330 falsch kodierte Zeichen eher unwissend, und geben sie einfach
5331 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
5332 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
5338 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5339 <title>SQL-Upgradedateien</title>
5341 <sect2 id="db-upgrade-files.introduction"
5342 xreflabel="Einführung in die Datenbank-Upgradedateien">
5343 <title>Einführung</title>
5345 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5346 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5347 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5348 Entwicklung im stable- und unstable-Baum betrifft.</para>
5350 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
5351 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5352 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5353 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5354 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5355 Kontrollinformationen enthält.</para>
5357 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5358 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5359 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5360 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5361 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5362 keine Versionsnummern mehr braucht.</para>
5364 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
5365 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5366 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5367 Anmeldung automatisch angelegt wird.</para>
5370 <sect2 id="db-upgrade-files.format"
5371 xreflabel="Format der Upgradedateien">
5372 <title>Format der Kontrollinformationen</title>
5374 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5375 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5376 hat dabei das folgende Format:</para>
5378 <para>Für SQL-Upgradedateien:</para>
5380 <programlisting>-- @key: value</programlisting>
5382 <para>Für Perl-Upgradedateien:</para>
5384 <programlisting># @key: value</programlisting>
5386 <para>Leerzeichen vor "<varname>value</varname>" werden
5389 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5393 <term><varname>tag</varname></term>
5396 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5397 Dieser "tag" kann von anderen Kontrolldateien in ihren
5398 Abhängigkeiten verwendet werden (Schlüsselwort
5399 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5400 in der Datenbank eingetragen wird.</para>
5402 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5403 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5405 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5406 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5407 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5413 <term><varname>charset</varname></term>
5416 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5417 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5418 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5419 Abwesenheit des Tags der Zeichensatz
5420 "<literal>ISO-8859-15</literal>" angenommen.</para>
5425 <term><varname>description</varname></term>
5428 <para>Benötigt. Eine Beschreibung, was in diesem Update
5429 passiert. Diese wird dem Benutzer beim eigentlichen
5430 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5431 sein sollte, sollte die Beschreibung auf Deutsch
5437 <term><varname>depends</varname></term>
5440 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5441 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5442 dass die in dieser Liste aufgeführten Scripte bereits
5443 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5445 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5446 Script "b" existiert, das von Änderungen in "a" abhängt, und
5447 eine neue Kontrolldatei für "c" erstellt wird, die von
5448 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5449 Tag "b" als Abhängigkeit zu definieren.</para>
5451 <para>Es ist nicht erlaubt, sich selbst referenzierende
5452 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5453 und "c" -> "a").</para>
5458 <term><varname>priority</varname></term>
5461 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5462 der Scripte ausgeführt werden, die die gleichen
5463 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5464 der Wert 1000 benutzt.</para>
5466 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5467 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5468 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5469 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5470 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5471 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5472 Priorität alphabetisch nach dem "tag".</para>
5477 <term><varname>ignore</varname></term>
5480 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5481 Skript bei der Anmeldung ignoriert und entsprechend nicht
5488 <sect2 id="db-upgrade-files.dbupgrade-tool"
5489 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5490 <title>Hilfsscript dbupgrade2_tool.pl</title>
5492 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5493 existiert ein Hilfsscript namens
5494 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5495 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5496 liest alle Datenbankupgradescripte aus dem Verzeichnis
5497 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5498 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5499 von der Kommandozeile überprüft werden können.</para>
5501 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5502 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5503 sich aber auch Informationen auf verschiedene Art ausgeben
5508 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5509 --list</command>"</para>
5511 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5512 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5513 würde. Es werden neben der Listenposition der Tag, die
5514 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5518 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5519 --tree</command>"</para>
5521 <para>Listet alle Tags in Baumform basierend auf den
5522 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5523 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5524 beim übergeordneten Script als Abhängigkeit eingetragen
5528 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5529 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5530 --rtree</command>"</para>
5532 <para>Listet alle Tags in Baumform basierend auf den
5533 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5534 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5535 die das übergeordnete Script als Abhängigkeit eingetragen
5540 <para>Baumform mit Postscriptausgabe:
5541 "<command>./scripts/dbupgrade2_tool.pl
5542 --graphviz</command>"</para>
5544 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5545 seiner Hilfe die <link
5546 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5547 Baumform</link> in eine Postscriptdatei namens
5548 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5549 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5550 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5551 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5556 <para>Scripte, von denen kein anderes Script abhängt:
5557 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5559 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5560 Scripte abhängen.</para>
5566 <sect1 id="translations-languages" xreflabel="Translations and languages">
5567 <title>Translations and languages</title>
5569 <sect2 id="translations-languages.introduction"
5570 xreflabel="Introduction to translations and languages">
5571 <title>Introduction</title>
5574 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5575 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5578 <para>This section describes how localization packages in kivitendo
5579 are built. Currently the only language fully supported is German, and
5580 since most of the internal messages are held in English the English
5581 version is usable too.</para>
5583 <para>A stub version of French is included but not functunal at this
5587 <sect2 id="translations-languages.file-structure"
5588 xreflabel="File structure">
5589 <title>File structure</title>
5591 <para>The structure of locales in kivitendo is:</para>
5593 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5595 <para>where <langcode> stands for an abbreviation of the
5596 language package. The builtin packages use two letter <ulink
5597 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5598 but the actual name is not relevant for the program and can easily be
5600 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5601 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5602 from SQL Ledger are named in this way.</para>
5604 <para>In such a language directory the following files are
5609 <term>LANGUAGE</term>
5612 <para>This file is mandatory.</para>
5614 <para>The <filename>LANGUAGE</filename> file contains the self
5615 descripted name of the language. It should contain a native
5616 representation first, and in parenthesis an english translation
5617 after that. Example:</para>
5619 <programlisting>Deutsch (German)</programlisting>
5624 <term>charset</term>
5627 <para>This file should be present.</para>
5629 <para>The <filename>charset</filename> file describes which
5630 charset a language package is written in and applies to all
5631 other language files in the package. It is possible to write
5632 some language packages without an explicit charset, but it is
5633 still strongly recommended. You'll never know in what
5634 environment your language package will be used, and neither
5635 UTF-8 nor Latin1 are guaranteed.</para>
5637 <para>The whole content of this file is a string that can be
5638 recognized as a valid charset encoding. Example:</para>
5640 <programlisting>UTF-8</programlisting>
5648 <para>This file is mandatory.</para>
5650 <para>The central translation file. It is essentially an inline
5651 Perl script autogenerated by <command>locales.pl</command>. To
5652 generate it, generate the directory and the two files mentioned
5653 above, and execute the following command:</para>
5655 <programlisting>scripts/locales.pl <langcode></programlisting>
5657 <para>Otherwise you can simply copy one of the other languages.
5658 You will be told how many are missing like this:</para>
5660 <programlisting>$ scripts/locales.pl en
5661 English - 0.6% - 2015/2028 missing</programlisting>
5663 <para>A file named "<filename>missing</filename>" will be
5664 generated and can be edited. You can also edit the
5665 "<filename>all</filename>" file directly. Edit everything you
5666 like to fit the target language and execute
5667 <command>locales.pl</command> again. See how the missing words
5673 <term>Num2text</term>
5676 <para>Legacy code from SQL Ledger. It provides a means for
5677 numbers to be converted into natural language, like
5678 <literal>1523 => one thousand five hundred twenty
5679 three</literal>. If you want to provide it, it must be inlinable
5680 Perl code which provides a <function>num2text</function> sub. If
5681 an <function>init</function> sub exists it will be executed
5684 <para>Only used in the check and receipt printing module.</para>
5689 <term>special_chars</term>
5692 <para>kivitendo comes with a lot of interfaces to different
5693 formats, some of which are rather picky with their accepted
5694 charset. The <filename>special_chars</filename> file contains a
5695 listing of chars not suited for different file format and
5696 provides substitutions. It is written in "Simple Ini" style,
5697 containing a block for every file format.</para>
5699 <para>First entry should be the order of substitution for
5700 entries as a whitespace separated list. All entries are
5701 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5702 and <literal>\\</literal> all work.</para>
5704 <para>After that every entry is a special char that should be
5705 translated when writing text into such a file.</para>
5707 <para>Example:</para>
5709 <programlisting>[Template/XML]
5710 order=& < > \n
5714 \n=<br></programlisting>
5716 <para>Note the importance of the order in this example.
5717 Substituting < and > befor & would lead to $gt; become
5720 <para>For a list of valid formats, see the German
5721 <filename>special_chars</filename> entry. As of this writing the
5722 following are recognized:</para>
5724 <programlisting>HTML
5729 Template/OpenDocument
5730 filenames</programlisting>
5732 <para>The last of which is very machine dependant. Remember that
5733 a lot of characters are forbidden by some filesystems, for
5734 exmaple MS Windows doesn't like ':' in its files where Linux
5735 doesn't mind that. If you want the files created with your
5736 language pack to be portable, find all chars that could cause
5742 <term>missing</term>
5745 <para>This file is not a part of the language package
5748 <para>This is a file generated by
5749 <command>scripts/locales.pl</command> while processing your
5750 locales. It's only to have the missing entries singled out and
5751 does not belong to a language package.</para>
5759 <para>This file is not a part of the language package
5762 <para>Another file generated by
5763 <command>scripts/locales.pl</command>. If for any reason a
5764 translation does not appear anymore and can be deleted, it gets
5765 moved here. The last 50 or so entries deleted are saved here in
5766 case you made a typo, so that you don't have to translate
5767 everything again. If a tranlsation is missing, the lost file is
5768 checked first. If you maintain a language package, you might
5769 want to keep this safe somewhere.</para>
5776 <sect1 id="devel.testsuite">
5777 <title>Die kivitendo-Test-Suite</title>
5779 <sect2 id="devel.testsuite.intro">
5780 <title>Einführung</title>
5782 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5784 <para>Die grundlegenden Fakten sind:</para>
5787 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5789 <listitem><para>Ein Script (bzw. ein Test) in <filename>f/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5791 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5793 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>f/</filename>, deren
5794 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5798 <sect2 id="devel.testsuite.prerequisites">
5799 <title>Voraussetzungen</title>
5801 <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>
5804 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
5805 <literal>perl-Test-Deep</literal>; openSuSE: <literal>perl-Test-Deep</literal>)</para></listitem>
5806 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
5807 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
5808 werden.</para></listitem>
5812 <sect2 id="devel.testsuite.execution">
5814 Existierende Tests ausführen
5817 <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
5818 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.sh</filename>.</para>
5820 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.sh</filename> ohne weitere Parameter aus
5821 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
5823 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.sh</filename>. Beispielsweise:</para>
5825 <programlisting>t/test.sh t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
5829 <sect2 id="devel.testsuite.meaning_of_scripts">
5831 Bedeutung der verschiedenen Test-Scripte
5834 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
5835 während der Entwicklung nützliche Tests sind:</para>
5838 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
5839 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
5840 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
5841 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
5842 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
5843 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
5846 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
5849 <sect2 id="devel.testsuite.create_new">
5851 Neue Test-Scripte erstellen
5854 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
5855 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
5857 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
5859 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
5862 <para> Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden:</para>
5865 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
5866 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
5867 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
5868 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
5869 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
5870 <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>
5874 <sect3 id="devel.testsuite.directory_and_test_names">
5876 Konvention für Verzeichnis- und Dateinamen
5879 <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>
5882 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
5884 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
5885 <filename>bad_function_params.t</filename>).</para></listitem>
5887 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen
5888 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
5890 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
5891 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
5895 <sect3 id="devel.testsuite.minimal_example">
5897 Minimales Skelett für eigene Scripte
5900 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
5902 <programlisting>use Test::More tests => 0;
5906 use Support::TestSetup;
5908 Support::TestSetup::login();</programlisting>
5910 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
5911 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
5912 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
5913 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
5915 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
5916 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
5921 <sect1 id="devel.style-guide">
5922 <title>Stil-Richtlinien</title>
5924 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5925 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5926 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5927 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5929 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5932 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5933 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5938 <para>Es werden keine echten Tabs sondern Leerzeichen
5943 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5945 <programlisting>foreach my $row (@data) {
5947 # do something with $row
5951 $row->{modules} = MODULE->retrieve(
5952 id => $row->{id},
5953 date => $use_now ? localtime() : $row->{time},
5957 $report->add($row);
5962 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
5963 Zeile wie der letzte Befehl. Beispiele:</para>
5965 <programlisting>sub debug {
5971 <programlisting>if ($form->{item_rows} > 0) {
5977 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
5978 der Befehl / die öffnende schließende Klammer, die den Block
5979 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
5980 Beispiele wie bei 3. gelten.</para>
5984 <para>Die Wörter "<function>else</function>",
5985 "<function>elsif</function>", "<function>while</function>" befinden
5986 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
5989 <programlisting>if ($form->{sum} > 1000) {
5991 } elsif ($form->{sum} > 0) {
5999 } until ($a > 0);</programlisting>
6003 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6004 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6005 und grep-ähnliche Operatoren. Beispiel:</para>
6007 <programlisting>$main::lxdebug->message("Could not find file.");
6008 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6012 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6014 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6015 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6016 Blöcke schon. Beispiel:</para>
6018 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6023 $form->{sum} += $form->{"row_$i"};
6024 $form->{ $form->{index} } += 1;
6026 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6030 <para>Mehrzeilige Befehle</para>
6034 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6035 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6036 werden, in der die ersten Funktionsparameter in der ersten Zeile
6037 stehen. Beispiel:</para>
6039 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6040 $form->{some_col_value});</programlisting>
6044 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6045 besten in einer übersichtlichen Tabellenstruktur organisiert
6046 wird. Beispiel:</para>
6048 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6049 : $form->{oldcount} ? $form->{oldcount} + 1
6050 : $form->{rowcount} - $form->{rowbase};</programlisting>
6056 <para>Kommentare</para>
6060 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6061 soweit wie der Code eingerückt sein.</para>
6065 <para>Seitliche hängende Kommentare sollten einheitlich
6066 formatiert werden.</para>
6070 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6071 auf Englisch zu verfassen. So wie ich keine Lust habe,
6072 französischen Quelltext zu lesen, sollte auch der kivitendo
6073 Quelltext für nicht-Deutschsprachige lesbar sein.
6076 <programlisting>my $found = 0;
6084 $i = 0 # initialize $i
6086 $i *= $const; # do something crazy
6087 $i = $n; # recover $i</programlisting>
6093 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6094 Interpolation gewünscht ist. Beispiel:</para>
6096 <programlisting>$form->{sum} = 0;
6097 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6098 $some_hash{42} = 54;</programlisting>
6102 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6103 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6104 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6105 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6107 <para>Als Beispiel sei die Funktion
6108 <function>print_options</function> aus
6109 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6113 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6114 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6117 <para>Emacs und vim haben beide recht einfache Methoden zur
6118 Entfernung von trailing whitespace. Emacs kennt das Kommande
6119 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6120 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6121 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6126 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6128 <para>In der Vergangenheit wurde versucht,
6129 <command>perltidy</command> zu verwenden, um einen einheitlichen
6130 Stil zu erlangen. Es hat sich aber gezeigt, dass
6131 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6132 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6133 den Interessierten sind hier die
6134 <command>perltidy</command>-Optionen, die grob den beschriebenen
6135 Richtlinien entsprechen:</para>
6137 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6138 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6139 -lp -vt=1 -vtc=1</programlisting>
6143 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6144 Debugmeldungen auch.</para>
6146 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6147 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6148 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6150 <para>Die <classname>LXDebug</classname>-Methode
6151 "<function>message</function>" nimmt als ersten Paramter außerdem
6152 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6153 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6154 und werden in den meisten Fällen auch vom Repository
6155 zurückgewiesen.</para>
6159 <para>Alle neuen Module müssen use strict verwenden.</para>
6161 <para><varname>$form</varname>, <varname>$auth</varname>,
6162 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6163 <varname>%myconfig</varname> werden derzeit aus dem main package
6164 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6165 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6170 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6171 <title>Dokumentation erstellen</title>
6173 <sect2 id="devel.build-doc.introduction">
6174 <title>Einführung</title>
6176 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6177 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6178 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6179 Editor nutzt, der spezielle Unterstützung für
6180 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6181 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6182 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6186 <sect2 id="devel.build-doc.required-software">
6187 <title>Benötigte Software</title>
6189 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6190 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6191 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6192 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6193 <command>scripts/build_doc.sh</command>.</para>
6195 <para>Das Script benötigt zur Konvertierung verschiedene
6196 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6202 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6203 in einer halbwegs aktuellen Version</para>
6207 <para>Das Java-Build-System <ulink
6208 url="http://ant.apache.org/">Apache Ant</ulink></para>
6212 <para>Das Dokumentations-System Dobudish für
6213 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6214 diverser Stylesheets und Grafiken zur Konvertierung von
6215 <productname>DocBook</productname> XML in andere Formate. Das
6216 Paket, das benötigt wird, ist zum Zeitpunkt der
6217 Dokumentationserstellung
6218 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6219 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6224 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6225 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6226 Debian/Ubuntu:</para>
6228 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6230 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6231 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6232 Annahme, das <productname>Dobudish</productname> in
6233 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6235 <programlisting>cd doc/build
6236 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6239 <sect2 id="devel.build-doc.build">
6240 <title>PDFs und HTML-Seiten erstellen</title>
6242 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6243 benötigten Software mit einem einfachen Aufruf direkt aus dem
6244 kivitendo-Installationsverzeichnis heraus:</para>
6246 <programlisting>./scripts/build_doc.sh</programlisting>
6249 <sect2 id="devel.build-doc.repository">
6250 <title>Einchecken in das Git-Repository</title>
6252 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6253 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6254 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6255 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6257 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6258 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob