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="lx-office-documentation" lang="de">
5 <title>Lx-Office: 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>auf der Lx-Office-Homepage unter <ulink
15 url="http://lx-office.org/index.php?id=dokumentation">http://lx-office.org/index.php?id=dokumentation</ulink></para>
19 <para>im Lx-Office-Wiki unter Dokumentation (<ulink
20 url="http://wiki.lx-office.org/index.php/Lx-Office_ERP">http://wiki.lx-office.org/index.php/Lx-Office_ERP</ulink>)</para>
24 <para>im Lx-Office-Forum: <ulink
25 url="http://www.lx-office.org/forum/">http://www.lx-office.org/forum/</ulink></para>
31 <title>Installation und Grundkonfiguration</title>
33 <sect1 id="Benötigte-Software-und-Pakete">
34 <title>Benötigte Software und Pakete</title>
36 <sect2 id="Betriebssystem">
37 <title>Betriebssystem</title>
39 <para>Lx-Office ist für Linux konzipiert, und sollte auf jedem
40 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
41 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
42 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
43 ohne große Probleme auf den derzeit aktuellen verbreiteten
44 Distributionen läuft.</para>
46 <para>Anfang 2012 sind das folgende Systeme, von denen bekannt ist,
47 dass Lx-Office auf ihnen läuft:</para>
51 <para>Ubuntu 8.04 LTS Hardy Heron, 10.04 LTS Lucid Lynx bis 11.10
56 <para>Debian 5.0 Lenny und 6.0 Squeeze</para>
60 <para>openSUSE 11.2 und 11.3</para>
64 <para>SuSE Linux Enterprice Server 11</para>
68 <para>Fedora 13 bis 15</para>
72 <para>Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die
73 Module im Archiv recht alt sind, und das viele der benötigten Module
74 nicht einfach zu installieren sind. Dafür sollte es kurz nach dem
75 Release ein eigenes .deb geben.</para>
77 <para>Alternativ dazu kann die normale Installation durchgeführt
79 linkend="Manuelle-Installation-des-Programmpaketes" />), wenn vorher
80 ein Kompatibilitätspaket installiert wird, das die fehlenden Pakete
81 bereitstellt. Das Paket ist auf <ulink
82 url="https://sourceforge.net/projects/lx-office/files/Lx-Office%20ERP/2.6.3/">Sourceforge</ulink>
83 unter dem Namen <filename>lx-erp-perl-libs-compat-v2.tar.gz</filename>
86 <para>Zur Installation das Paket in das entpackte Lx-Office
87 Verzeichnis entpacken:</para>
89 <programlisting>tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/</programlisting>
91 <para>Zusätzlich müssen dann noch die folgenden Pakete installiert
94 <programlisting>apt-get install libbit-vector-perl libsub-exporter-perl libclone-perl \
95 libclass-factory-util-perl</programlisting>
97 <para>Danach sollte der Installationscheck (siehe <xref
98 linkend="Pakete" />) die enthaltenen Pakete erkennen.</para>
101 <sect2 id="Pakete" xreflabel="Pakete">
102 <title>Pakete</title>
104 <para>Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist
105 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
108 <para>Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die
109 nicht Bestandteil einer Standard-Perl-Installation sind:</para>
117 <para>Archive::Zip</para>
121 <para>Config::Std</para>
125 <para>DateTime</para>
137 <para>Email::Address</para>
145 <para>List::MoreUtils</para>
149 <para>Params::Validate</para>
153 <para>PDF::API2</para>
157 <para>Rose::Object</para>
161 <para>Rose::DB</para>
165 <para>Rose::DB::Object</para>
169 <para>Template</para>
173 <para>Text::CSV_XS</para>
177 <para>Text::Iconv</para>
185 <para>XML::Writer</para>
193 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
194 hinzugekommen, <literal>URI</literal> und
195 <literal>XML::Writer</literal> sind notwendig. Ohne startet Lx-Office
198 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
199 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
200 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
201 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
203 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
204 hinzugekommen.</para>
206 <para><literal>Email::Address</literal> und
207 <literal>List::MoreUtils</literal> sind schon länger feste
208 Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide
209 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
210 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
211 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
214 <para>Die zu installierenden Pakete können in den verschiedenen
215 Distributionen unterschiedlich heißen.</para>
217 <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
219 <programlisting>apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
220 libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
221 libemail-address-perl liblist-moreutils-perl libpdf-api2-perl \
222 librose-object-perl librose-db-perl librose-db-object-perl \
223 libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
224 libxml-writer-perl libyaml-perl libconfig-std-perl \
225 libparams-validate-perl libjson-perl libclass-accessor-perl</programlisting>
227 <para>Für Fedora Core benötigen Sie diese Pakete:</para>
229 <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
230 perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils \
231 perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
232 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
233 perl-XML-Writer perl-YAML</programlisting>
235 <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
237 <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
238 perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils \
239 perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
240 perl-URI perl-XML-Writer perl-YAML</programlisting>
242 <para>Bei openSuSE 11 ist <literal>parent</literal> bereits enthalten,
243 und braucht nicht nachinstalliert werden. Die
244 <literal>Rose::*</literal> Pakete sind derzeit nicht für SuSE gepackt,
245 und müssen anderweitig nachinstalliert werden.</para>
247 <para>Lx-Office enthält ein Script, mit dem überprüft werden kann, ob
248 alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
251 <programlisting>./scripts/installation_check.pl</programlisting>
255 <sect1 id="Manuelle-Installation-des-Programmpaketes"
256 xreflabel="Manuelle Installation des Programmpaketes">
257 <title>Manuelle Installation des Programmpaketes</title>
259 <para>Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.3.tgz) wird
260 im Dokumentenverzeichnis des Webservers (z.B.
261 <filename>/var/www/html/</filename>,
262 <filename>/srv/www/htdocs</filename> oder
263 <filename>/var/www/</filename>) entpackt:</para>
265 <programlisting>cd /var/www tar xvzf
266 lxoffice-erp-2.6.3.tgz</programlisting>
268 <para>Verändern Sie evtl. noch den Namen des Verzeichnisses und wechseln Sie in es:</para>
270 <programlisting>mv lxoffice-erp/ lx-erp/
271 cd lx-erp</programlisting>
273 <para>Alternativ können Sie auch einen Alias in der
274 Webserverkonfiguration benutzen, um auf das tatsächliche
275 Installationsverzeichnis zu verweisen.</para>
277 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
278 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
279 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
280 core <constant>apache</constant> oder bei OpenSuSE <constant>wwwrun</constant>).</para>
282 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
283 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
285 <programlisting>chown -R www-data users spool webdav</programlisting>
287 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
288 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in Lx-Office angelegt wird:</para>
290 <programlisting>chown www-data templates users</programlisting>
293 <sect1 id="config.config-file">
294 <title>Lx-Office-Konfigurationsdatei</title>
296 <sect2 id="config.config-file.introduction"
297 xreflabel="Einführung in die Konfigurationsdatei">
298 <title>Einführung</title>
300 <para>Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei
301 die benötigt wird: <filename>config/lx_office.conf</filename> (kurz:
302 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
303 von Lx-Office bzw. der Migration von älteren Versionen angelegt
306 <para>Als Vorlage dient die Datei
307 <filename>config/lx_office.conf.default</filename> (kurz: "die
308 Default-Datei"):</para>
310 <programlisting>$ cp config/lx_office.conf.default config/lx_office.conf</programlisting>
312 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
313 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
314 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
315 Abschnitte und Werte enthalten, die von denen der Default-Datei
318 <para>Diese Hauptkonfigurationsdatei ist dann eine
319 installationsspezifische Datei, d.h. sie enthält bspw. lokale
320 Passwörter und wird auch nicht im Versionsmanagement (git)
323 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
324 Mandaten, bzw. Datenbanken gleich.</para>
327 <sect2 id="config.config-file.sections-parameters">
328 <title>Abschnitte und Parameter</title>
330 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
331 entsprechend kommentiert sind:</para>
335 <para><literal>authentication</literal></para>
339 <para><literal>authentication/database</literal></para>
343 <para><literal>authentication/ldap</literal></para>
347 <para><literal>system</literal></para>
351 <para><literal>features</literal></para>
355 <para><literal>paths</literal></para>
359 <para><literal>applications</literal></para>
363 <para><literal>environment</literal></para>
367 <para><literal>print_templates</literal></para>
371 <para><literal>task_server</literal></para>
375 <para><literal>periodic_invoices</literal></para>
379 <para><literal>console</literal></para>
383 <para><literal>debug</literal></para>
387 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
388 einzustellen oder zu kontrollieren sind, sind:</para>
390 <programlisting>[authentication]
391 admin_password = geheim
393 [authentication/database]
401 dbcharset = UTF-8</programlisting>
403 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
404 <varname>[periodic_invoices]</varname> den Login eines Benutzers
405 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
406 mit Informationen über die erstellten Rechnungen bekommt.</para>
408 <para>Nutzt man den <link
409 linkend="config.task-server">Taskserver</link> für <link
410 linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,
411 muss unter <varname>[task_server]</varname> ein Login eines Benutzers
412 angegeben werden, mit dem sich der Taskserver an Lx-Office bei der
413 Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
415 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
416 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
419 <sect2 id="config.config-file.prior-versions">
420 <title>Versionen vor 2.6.3</title>
422 <para>In älteren Lx-Office Versionen gab es im Verzeichnis
423 <filename>config</filename> die Dateien
424 <filename>authentication.pl</filename> und
425 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
426 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
427 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
428 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
430 <para>Beim Update von einer Lx-Office-Version vor 2.6.3 auf 2.6.3 oder
431 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
432 manuell übertragen und die alten Konfigurationsdateien anschließend
433 gelöscht oder verschoben werden. Ansonsten zeigt Lx-Office eine
434 entsprechende Fehlermeldung an.</para>
438 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
439 <title>Anpassung der PostgreSQL-Konfiguration</title>
441 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
443 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
444 <title>Zeichensätze/die Verwendung von UTF-8</title>
446 <para>Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet
447 werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in
448 Version 8.2 oder neuer benutzt werden, und der
449 PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale
450 angelegt worden sein.</para>
452 <para>Dieses ist kann überprüft werden: ist das Encoding der Datenbank
453 “template1” “UTF8”, so kann auch Lx-Office mit UTF-8 betrieben werden.
454 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
455 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
456 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
459 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
461 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
462 Versionsnummer angepasst werden.</para>
464 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
466 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
467 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
468 Lx-Office mit ISO-8859-15 als Encoding betrieben werden.</para>
470 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
471 <literal>\l</literal> geprüft werden.</para>
474 <sect2 id="Änderungen-an-Konfigurationsdateien">
475 <title>Änderungen an Konfigurationsdateien</title>
477 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
478 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
479 <filename>/var/lib/pgsql/data/</filename> oder
480 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
481 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
482 Parameter <varname>listen_address</varname> gesteuert. Laufen
483 PostgreSQL und Lx-Office auf demselben Rechner, so kann dort der Wert
484 <literal>localhost</literal> verwendet werden. Andernfalls müssen
485 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
486 was mit dem Wert <literal>*</literal> geschieht.</para>
488 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
489 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
490 sein sollte, müssen die Berichtigungen für den Zugriff geändert
491 werden. Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale
492 Verbindungen immer zuzulassen:</para>
494 <programlisting>local all all trust
495 host all all 127.0.0.1 255.0.0.0 trust</programlisting>
497 <para>Besser ist es, für eine bestimmte Datenbank Zugriff nur per
498 Passwort zuzulassen. Beispielsweise:</para>
500 <programlisting>local all lxoffice password
501 host all lxoffice 127.0.0.1 255.255.255.255 password</programlisting>
504 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
505 <title>Erweiterung für servergespeicherte Prozeduren</title>
507 <para>In der Datenbank <literal>template1</literal> muss die
508 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
509 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an, und
510 führen Sie die folgenden Kommandos aus:</para>
512 <programlisting>create language 'plpgsql';</programlisting>
515 <sect2 id="Datenbankbenutzer-anlegen">
516 <title>Datenbankbenutzer anlegen</title>
518 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
519 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
520 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
523 <programlisting>su - postgres createuser -d -P lxoffice</programlisting>
525 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
526 Sie den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” bzw.
527 den hier gewählten Benutzernamen.</para>
531 <sect1 id="Apache-Konfiguration">
532 <title>Webserver-Konfiguration</title>
535 <title>Grundkonfiguration mittels CGI</title>
538 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
539 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
540 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
543 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
544 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
545 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
546 anderen Datei hinzu, die beim Starten des Webservers eingelesen
549 <programlisting>AddHandler cgi-script .pl
550 Alias /lx-erp/ /var/www/lx-erp/
552 <Directory /var/www/lx-erp>
553 Options ExecCGI Includes FollowSymlinks
556 <Directory /var/www/lx-erp/users>
559 </Directory></programlisting>
561 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
562 das Lx-Office-Archiv entpacket haben.</para>
565 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
566 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
569 <para>Auf einigen Webservern werden manchmal die Grafiken und
570 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
571 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
573 <programlisting>EnableSendfile Off</programlisting>
576 <sect2 id="Apache-Konfiguration.FCGI"
577 xreflabel="Konfiguration für FastCGI/FCGI">
578 <title>Konfiguration für FastCGI/FCGI</title>
580 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
581 <title>Was ist FastCGI?</title>
583 <para>Direkt aus <ulink
584 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
587 <para><citation> FastCGI ist ein Standard für die Einbindung
588 externer Software zur Generierung dynamischer Webseiten in einem
589 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
590 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
591 umgehen. </citation></para>
594 <sect3 id="Apache-Konfiguration.FCGI.Warum">
595 <title>Warum FastCGI?</title>
597 <para>Perl Programme (wie Lx-Office eines ist) werden nicht statisch
598 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
599 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
600 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
601 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
602 müssen, ist die Funktionalität von Lx-Office soweit gewachsen, dass
603 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
604 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
605 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
606 führt dazu dass ein Lx-Office Aufruf der Kernmasken mittlerweile
607 deutlich länger dauert als früher, und dass davon 90% für das Laden
608 der Module verwendet wird.</para>
610 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
611 wird nur die eigentliche Programmlogik ausgeführt.</para>
614 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
615 <title>Getestete Kombinationen aus Webservern und Plugin</title>
617 <para>Folgende Kombinationen sind getestet:</para>
621 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
625 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
629 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
630 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
631 mod_fastcgi nicht mehr explizit eingegangen.</para>
633 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
637 <para>FCGI 0.69 und höher ist extrem strict in der Behandlung von
638 Unicode, und verweigert bestimmte Eingaben von Lx-Office. Falls es
639 Probleme mit Umlauten in Ihrere Installation gibt, muss auf die
640 Vorgängerversion FCGI 0.68 ausgewichen werden.</para>
642 <para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
645 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
649 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
650 <title>Konfiguration des Webservers</title>
652 <para>Bevor Sie versuchen, eine Lx-Office Installation unter FCGI
653 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
654 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
655 debuggen die beim ersten aufsetzen auftreten können. Sollte die
656 Installation schon funktionieren, lesen Sie weiter.</para>
658 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
659 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
661 <programlisting>a2enmod fcgid</programlisting>
663 <para>Die Konfiguration für die Verwendung von Lx-Office mit FastCGI
664 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
665 und <function>Directory</function>-Direktiven. Dabei wird zwischen
666 dem Installationspfad von Lx-Office im Dateisystem
667 ("<filename>/path/to/lx-office-erp</filename>") und der URL
668 unterschieden, unter der Lx-Office im Webbrowser erreichbar ist
669 ("<filename>/url/for/lx-office-erp</filename>").</para>
671 <para>Folgender Konfigurationsschnipsel funktioniert mit
674 <programlisting>AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi
675 Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/
677 <Directory /path/to/lx-office-erp>
679 Options ExecCGI Includes FollowSymlinks
684 <DirectoryMatch /path/to/lx-office-erp/users>
687 </DirectoryMatch></programlisting>
689 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
690 die maximale Größe eines Requests. Diese sollte wie folgt
691 hochgesetzt werden:</para>
693 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
695 <para>Das ganze sollte dann so aussehen:</para>
697 <programlisting>AddHandler fcgid-script .fpl
698 AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
699 Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/
700 FcgidMaxRequestLen 10485760
702 <Directory /path/to/lx-office-erp>
704 Options ExecCGI Includes FollowSymlinks
709 <DirectoryMatch /path/to/lx-office-erp/users>
712 </DirectoryMatch></programlisting>
714 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
715 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
716 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
717 gibt es hier kleine Performance-Einbußen.</para>
719 <para>Es ist möglich, die gleiche Lx-Office Version parallel unter
720 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
721 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
723 <programlisting># Zugriff über CGI
724 Alias /url/for/lx-office-erp /path/to/lx-office-erp
726 # Zugriff mit mod_fcgid:
727 AliasMatch ^/url/for/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
728 Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/</programlisting>
730 <para>Dann ist unter <filename>/url/for/lx-office-erp/</filename>
731 die normale Version erreichbar, und unter
732 <constant>/url/for/lx-office-erp-fcgid/</constant> die
733 FastCGI-Version.</para>
738 <sect1 id="config.task-server">
739 <title>Der Task-Server</title>
741 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
742 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
743 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
744 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
745 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
748 <sect2 id="Konfiguration-des-Task-Servers">
749 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
751 <para>Die Konfiguration erfolgt über den Abschnitt
752 <literal>[task_server]</literal> in der Datei
753 <filename>config/lx_office.conf</filename>. Die dort verfügbaren
754 Optionen sind:</para>
758 <term><varname>login</varname></term>
761 <para>gültiger Lx-Office-Benutzername, der benutzt wird, um die
762 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
763 in der Administration angelegt werden. Diese Option muss
764 angegeben werden.</para>
769 <term><varname>run_as</varname></term>
772 <para>Wird der Server vom Systembenutzer <literal>root</literal>
773 gestartet, so wechselt er auf den mit <literal>run_as</literal>
774 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
775 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
777 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
778 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
779 unter dem auch der Webserver läuft.</para>
784 <term><varname>debug</varname></term>
787 <para>Schaltet Debug-Informationen an und aus.</para>
793 <sect2 id="Einbinden-in-den-Boot-Prozess">
794 <title>Automatisches Starten des Task-Servers beim Booten</title>
796 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
797 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
798 Starten automatisch in das Lx-Office-Installationsverzeichnis.</para>
800 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
801 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
802 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
803 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
804 anstelle eines symbolischen Links verwendet werden können.</para>
807 <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
810 <para>Kopieren Sie die Datei
811 <filename>scripts/boot/system-v/kivitendo-server</filename>
812 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
813 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
814 <literal>DAEMON=....</literal>). Binden Sie das Script in den
815 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
819 <para>Debian-basierende Systeme:</para>
821 <programlisting>update-rc.d kivitendo-task-server defaults
822 # Nur bei Debian Squeeze und neuer:
823 insserv kivitendo-task-server</programlisting>
827 <para>OpenSuSE und Fedora Core:</para>
829 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
833 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
834 werden: <command>/etc/init.d/kivitendo-task-server
835 start</command></para>
839 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
841 <para>Kopieren Sie die Datei
842 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
843 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
844 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
845 <literal>exec ....</literal>).</para>
847 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
848 werden: <command>service kivitendo-task-server
849 start</command></para>
853 <sect2 id="Prozesskontrolle">
854 <title>Wie der Task-Server gestartet und beendet wird</title>
856 <para>Der Task-Server wird wie folgt kontrolliert:</para>
858 <programlisting>./scripts/task_server.pl Befehl</programlisting>
860 <para><literal>Befehl</literal> ist dabei eine der folgenden
865 <para><literal>start</literal> startet eine neue Instanz des
866 Task-Servers. Die Prozess-ID wird innerhalb des
867 <filename>users</filename>-Verzeichnisses abgelegt.</para>
871 <para><literal>stop</literal> beendet einen laufenden
876 <para><literal>restart</literal> beendet und startet ihn
881 <para><literal>status</literal> berichtet, ob der Task-Server
886 <para>Der Task-Server wechselt beim Starten automatisch in das
887 Lx-Office-Installationsverzeichnis.</para>
889 <para>Dieselben Optionen können auch für die SystemV-basierenden
890 Runlevel-Scripte benutzt werden (siehe oben).</para>
894 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
895 <title>Benutzerauthentifizierung und Administratorpasswort</title>
897 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
898 über die Verwaltung von Gruppen und weitere Einstellungen</para>
900 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
901 <title>Grundlagen zur Benutzerauthentifizierung</title>
903 <para>Lx-Office verwaltet die Benutzerinformationen in einer
904 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
905 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
906 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
907 können, müssen aber nicht unterschiedlich sein.</para>
909 <para>Im einfachsten Fall gibt es für Lx-Office nur eine einzige
910 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
911 abgelegt werden.</para>
913 <para>Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter
914 entweder gegen die Authentifizierungsdatenbank oder gegen einen
915 LDAP-Server überprüft werden.</para>
917 <para>Welche Art der Passwortüberprüfung Lx-Office benutzt und wie
918 Lx-Office die Authentifizierungsdatenbank erreichen kann, wird in der
919 Konfigurationsdatei <filename>config/lx_office.conf</filename>
920 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
921 einer Version vor v2.6.0 angelegt werden. Eine
922 Beispielkonfigurationsdatei
923 <filename>config/lx_office.conf.default</filename> existiert, die als
924 Vorlage benutzt werden kann.</para>
927 <sect2 id="Administratorpasswort">
928 <title>Administratorpasswort</title>
930 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
931 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
932 nur dort und nicht mehr im Administrationsinterface selber geändert
933 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
934 Abschnitt <varname>[authentication]</varname>.</para>
937 <sect2 id="Authentifizierungsdatenbank">
938 <title>Authentifizierungsdatenbank</title>
940 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
941 Parametern in <varname>[authentication/database]</varname>
942 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
946 <term><literal>host</literal></term>
949 <para>Der Rechnername oder die IP-Adresse des
950 Datenbankservers</para>
955 <term><literal>port</literal></term>
958 <para>Die Portnummer des Datenbankservers, meist 5432</para>
963 <term><literal>db</literal></term>
966 <para>Der Name der Authentifizierungsdatenbank</para>
971 <term><literal>user</literal></term>
974 <para>Der Benutzername, mit dem sich Lx-Office beim
975 Datenbankserver anmeldet (z.B.
976 "<literal>postgres</literal>")</para>
981 <term><literal>password</literal></term>
984 <para>Das Passwort für den Datenbankbenutzer</para>
989 <para>Die Datenbank muss noch nicht existieren. Lx-Office kann sie
990 automatisch anlegen (mehr dazu siehe unten).</para>
993 <sect2 id="Passwortüberprüfung">
994 <title>Passwortüberprüfung</title>
996 <para>Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen
997 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
998 Active-Directory-Server. Welche davon benutzt wird, regelt der
999 Parameter <varname>module</varname> im Abschnitt
1000 <varname>[authentication]</varname>.</para>
1002 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1003 gespeichert werden, so muss der Parameter <varname>module</varname>
1004 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1005 der Administrator als auch die Benutzer selber ihre Psaswörter in
1006 Lx-Office ändern.</para>
1008 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1009 benutzt werden, so muss der Parameter <varname>module</varname> auf
1010 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1011 zusätzliche Informationen über den LDAP-Server im Abschnitt
1012 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1016 <term><literal>host</literal></term>
1019 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1020 Active-Directory-Servers. Diese Angabe ist zwingend
1021 erforderlich.</para>
1026 <term><literal>port</literal></term>
1029 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1034 <term><literal>tls</literal></term>
1037 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1038 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1039 ‘<literal>0</literal>’ belassen</para>
1044 <term><literal>attribute</literal></term>
1047 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1048 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1049 meist ‘<literal>sAMAccountName</literal>’, für andere
1050 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1051 zwingend erforderlich.</para>
1056 <term><literal>base_dn</literal></term>
1059 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1060 Diese Angabe ist zwingend erforderlich.</para>
1065 <term><literal>filter</literal></term>
1068 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1069 <literal><%login%></literal>, so wird dieses durch den vom
1070 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1071 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1072 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1077 <term><literal>bind_dn</literal> und
1078 <literal>bind_password</literal></term>
1081 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1082 durchsucht werden kann (z.B. ist dies bei
1083 Active-Directory-Servern der Fall), so kann diese hier angegeben
1084 werden. Für Active-Directory-Server kann als
1085 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1086 z.B. ‘<literal>cn=Martin
1087 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1088 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1089 also ‘<literal>Martin Mustermann</literal>’.</para>
1095 <sect2 id="Name-des-Session-Cookies">
1096 <title>Name des Session-Cookies</title>
1098 <para>Sollen auf einem Server mehrere Lx-Office-Installationen
1099 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1100 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1101 Parameter <varname>cookie_name</varname> im Abschnitt
1102 <varname>[authentication]</varname>gesetzt.</para>
1104 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1105 Server existiert.</para>
1108 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1109 <title>Anlegen der Authentifizierungsdatenbank</title>
1111 <para>Nachdem alle Einstellungen in
1112 <filename>config/lx_office.conf</filename> vorgenommen wurden, muss
1113 Lx-Office die Authentifizierungsdatenbank anlegen. Dieses geschieht
1114 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1115 der folgenden URL erreichbar sein sollte:</para>
1118 url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
1122 <sect1 id="Benutzer--und-Gruppenverwaltung">
1123 <title>Benutzer- und Gruppenverwaltung</title>
1125 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1126 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1127 folgender URL finden:</para>
1130 url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
1132 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1133 <filename>config/lx_office.conf</filename> eingetragen haben.</para>
1135 <sect2 id="Zusammenhänge">
1136 <title>Zusammenhänge</title>
1138 <para>Lx-Office verwendet eine Datenbank zum Speichern all seiner
1139 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1140 mit Lx-Office arbeiten zu können, muss eine Person einen
1141 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1142 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1143 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1144 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1147 <para>Die Basisdaten der Benutzer, die in der Administration
1148 eingegeben werden können, werden in einer zweiten Datenbank
1149 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1150 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1151 Pro Lx-Office-Installation gibt es nur eine
1152 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1155 <para>Lx-Office kann seinen Benutzern Zugriff auf bestimmte
1156 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1157 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1158 angezeigt. Diese Rechte werden ebenfalls in der
1159 Authentifizierungsdatenbank gespeichert.</para>
1161 <para>Um Rechte verteilen zu können, verwendet Lx-Office ein
1162 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1163 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1164 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1165 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1166 Benutzer Mitglied ist.</para>
1168 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1169 Benutzer angelegt werden sollten, lautet:</para>
1171 <orderedlist numeration="arabic">
1173 <para>Datenbank anlegen</para>
1177 <para>Gruppen anlegen</para>
1181 <para>Benutzer anlegen</para>
1185 <para>Benutzer den Gruppen zuordnen</para>
1190 <sect2 id="Datenbanken-anlegen">
1191 <title>Datenbanken anlegen</title>
1193 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1194 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1195 Beispielen ist dies ‘<literal>lxoffice</literal>’).</para>
1197 <para>Wenn Sie für die Lx-Office-Installation nicht den europäischen
1198 Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so
1199 müssen Sie vor dem Anlegen der Datenbank in der Datei
1200 <filename>config/lx_office.conf</filename> die Variable
1201 <literal>dbcharset</literal> im Abschnitt <literal>system</literal>
1202 auf den Wert ‘<literal>UTF-8</literal>’ setzen. Zusätzlich muss beim
1203 Anlegen der Datenbank ‘<literal>UTF-8 Unicode</literal>’ als
1204 Schriftsatz ausgewählt werden.</para>
1206 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1207 verwenden müssen, da diese Einstellungen momentan global in Lx-Office
1208 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1209 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1210 angelegt worden sein.</para>
1213 <sect2 id="Gruppen-anlegen">
1214 <title>Gruppen anlegen</title>
1216 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1217 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1218 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1219 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1221 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1222 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1223 Datenbanken, die in dieser Installation verwaltet werden.</para>
1226 <sect2 id="Benutzer-anlegen">
1227 <title>Benutzer anlegen</title>
1229 <para>Beim Anlegen von Benutzern werden für viele Parameter
1230 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1231 deutschen Raumes entsprechen.</para>
1233 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1234 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1235 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1236 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1237 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1239 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1240 eben angelegten Datenbanken eingetragen werden.</para>
1243 <sect2 id="Gruppenmitgliedschaften-verwalten">
1244 <title>Gruppenmitgliedschaften verwalten</title>
1246 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1247 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1249 <orderedlist numeration="arabic">
1251 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1252 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1257 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1258 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1259 alle im System angelegten Gruppen und Benutzer enthält. Durch
1260 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1261 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1266 <sect2 id="Migration-alter-Installationen">
1267 <title>Migration alter Installationen</title>
1269 <para>Wenn Lx-Office 2.6.3 über eine ältere Version installiert wird,
1270 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1271 <literal>users</literal> verwaltet wurden, so bietet Lx-Office die
1272 Möglichkeit, diese Benutzerdaten automatisch in die
1273 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1274 sich nach dem Update der Installation das erste Mal im
1275 Administrationsbereich anmeldet. Findet Lx-Office die Datei
1276 <literal>users/members</literal>, so wird der Migrationsprozess
1279 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1280 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1281 Lx-Office noch die Möglichkeit an, dass automatisch eine
1282 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1283 Funktionen von Lx-Office gewährt. Alle migrierten Benutzern werden
1284 Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis
1285 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1286 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1290 <sect1 id="Drucken-mit-Lx-Office">
1291 <title>Drucken mit Lx-Office</title>
1293 <para>Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen.
1294 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1295 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1296 Debianoiden Betriebssystemen sind das die Pakete:</para>
1298 <para><literal>texlive-latex-base texlive-latex-extra
1299 texlive-fonts-recommended</literal></para>
1301 <para>Diese hinteren beiden enthalten Bibliotheken und Schriftarten die
1302 von den Standardvorlagen verwendet werden.</para>
1304 <para>TODO: rpm Pakete.</para>
1306 <para>In den allermeisten Installationen sollte drucken jetzt schon
1307 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1308 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1309 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1314 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1315 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1316 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1321 <para>! Package inputenc Error: Unicode char \u8:æ¡
\9c not set up for
1322 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1323 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1324 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1325 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1326 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1330 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1331 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1332 Prüfen Sie den Namen in der Konfiguration (Standard:
1333 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1334 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1338 <sect1 id="OpenDocument-Vorlagen">
1339 <title>OpenDocument-Vorlagen</title>
1341 <para>Lx-Office unterstützt die Verwendung von Vorlagen im
1342 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1343 Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1344 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1345 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1346 <filename>config/lx_office.conf</filename> die Variable
1347 <literal>opendocument</literal> im Abschnitt
1348 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1349 Dieses ist die Standardeinstellung.</para>
1351 <para>Weiterhin muss in der Datei
1352 <filename>config/lx_office.conf</filename> die Variable
1353 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1354 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1355 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1358 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1359 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1360 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1361 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1362 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1363 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1365 <para>Nach der Installation müssen in der Datei
1366 <filename>config/lx_config.conf</filename> zwei weitere Variablen
1367 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1368 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1369 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1370 enthalten. Beide stehen im Abschnitt
1371 <literal>applications</literal>.</para>
1373 <para>Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit
1374 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1375 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1376 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1377 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1378 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1379 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1380 werden muss. Der Nachteil ist, dass diese Methode Python und die
1381 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1384 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1385 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1386 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1387 Dokumentenvorlage enthalten sein und
1388 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1389 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1390 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1391 ebenfalls enthalten sein muss.</para>
1393 <para>Als letztes muss herausgefunden werden, welchen Namen
1394 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1395 gibt. Unter Debian ist dies momentan
1396 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1397 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1398 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1399 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1400 folgender Befehl auszuführen:</para>
1402 <para><literal>mv users/.openoffice.org2
1403 users/.openoffice</literal></para>
1405 <para>Dieses Verzeichnis, wie auch das komplette
1406 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1407 sein. Dieses wurde bereits erledigt (siehe <xref
1408 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1409 erneut überprüft werden, wenn die Konvertierung nach PDF
1413 <sect1 id="config.eur">
1414 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1417 <sect2 id="config.eur.introduction"
1418 xreflabel="Einführung in die Konfiguration zur EUR">
1419 <title>Einführung</title>
1421 <para>Lx-Office besaß bis inklusive Version 2.6.3 einen
1422 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1423 Konfigurationsdatei <filename>config/lx_office.conf</filename>
1424 befindet. Somit galt er für alle Mandanten, die in dieser Installation
1425 benutzt wurden.</para>
1427 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1428 die Mandantendatenbank verschoben und dabei auch gleich in drei
1429 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1430 steuern lässt.</para>
1433 <sect2 id="config.eur.parameters"
1434 xreflabel="Konfigurationsparameter für EUR">
1435 <title>Konfigurationsparameter</title>
1437 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1438 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1442 <term><varname>profit_determination</varname></term>
1445 <para>Dieser Parameter legt die Berechnungsmethode für die
1446 Gewinnermittlung fest. Er enthält entweder
1447 <literal>balance</literal> für
1448 Betriebsvermögensvergleich/Bilanzierung oder
1449 <literal>income</literal> für die
1450 Einnahmen-Überschuss-Rechnung.</para>
1455 <term><varname>accounting_method</varname></term>
1458 <para>Dieser Parameter steuert die Buchungs- und
1459 Berechnungsmethoden für die Versteuerungsart. Er enthält
1460 entweder <literal>accrual</literal> für die Soll-Versteuerung
1461 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1466 <term><varname>inventory_system</varname></term>
1469 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1470 enthält entweder <literal>perpetual</literal> für die
1471 Bestandsmethode oder <literal>periodic</literal> für die
1472 Aufwandsmethode.</para>
1477 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1478 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1479 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1480 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1481 Bestandsmethode.</para>
1483 <para>Die Konfiguration "<varname>eur</varname>" unter
1484 <varname>[system]</varname> in der <link
1485 linkend="config.config-file">Konfigurationsdatei</link>
1486 <filename>config/lx_office.conf</filename> wird nun nicht mehr
1487 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1490 <sect2 id="config.eur.setting-parameters">
1491 <title>Festlegen der Parameter</title>
1493 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1494 der Admininstration können diese Optionen nun unabhängig voneinander
1495 eingestellt werden.</para>
1497 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1498 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1501 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1502 Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt
1503 (read-only). Eine spätere Änderung ist für einen bestehenden Mandanten
1504 nicht mehr möglich. Dies war auch vorher nicht möglich, bzw.
1505 vorhandene Daten wurden so belassen und haben damit die Ergebnisse
1509 <sect2 id="config.eur.inventory-system-perpetual">
1510 <title>Bemerkungen zu Bestandsmethode</title>
1512 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1513 funktioniert in Lx-Office aber nur unter bestimmten Bedingungen:
1514 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1515 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1516 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1517 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1518 Einkaufsrechnungen berechnet wird.</para>
1520 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1521 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1522 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1526 <sect2 id="config.eur.knonw-issues">
1527 <title>Bekannte Probleme</title>
1529 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1530 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1531 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1532 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1533 die Konfigurationsvariable
1534 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1537 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1538 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1542 <sect1 id="config.skr04-update-3804">
1543 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1545 <sect2 id="config.skr04-update-3804.introduction">
1546 <title>Einführung</title>
1548 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1549 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1550 Lx-Office beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1551 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1552 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1553 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1554 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1555 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1556 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1557 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1558 Screenshots dargestellt.</para>
1560 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1561 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1562 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1563 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1566 <sect2 id="config.skr04-update-3804.create-chart">
1567 <title>Konto 3804 manuell anlegen</title>
1569 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1570 anzulegen und zu konfigurieren. Zuerst wird in
1571 <guimenu>System</guimenu> ->
1572 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1573 erfassen</guimenuitem> das Konto angelegt.</para>
1576 <screeninfo>Konto 3804 erfassen</screeninfo>
1580 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1586 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1587 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1588 wie im folgenden Screenshot angezeigt anpassen.
1592 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1596 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1602 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1603 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1607 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1611 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1617 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1618 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1619 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1620 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1624 <screeninfo>Konto 4315 anpassen</screeninfo>
1628 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1634 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1635 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1639 <screeninfo>Steuerliste vergleichen</screeninfo>
1643 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1650 <sect1 id="Lx-Office-ERP-verwenden">
1651 <title>Lx-Office ERP verwenden</title>
1653 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1654 folgender URL erreichbar:</para>
1657 url="http://localhost/lx-office-erp/login.pl">http://localhost/lx-office-erp/login.pl</ulink></para>
1659 <para>Die Administrationsseite erreichen Sie unter:</para>
1662 url="http://localhost/lx-office-erp/admin.pl">http://localhost/lx-office-erp/admin.pl</ulink></para>
1666 <chapter id="features" xreflabel="Features und Funktionen">
1667 <title>Features und Funktionen</title>
1669 <sect1 id="features.periodic-invoices"
1670 xreflabel="Wiedekehrende Rechnungen">
1671 <title>Wiederkehrende Rechnungen</title>
1673 <sect2 id="features.periodic-invoices.introduction"
1674 xreflabel="Einführung in wiederkehrende Rechnungen">
1675 <title>Einführung</title>
1677 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
1678 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
1679 Die konfigurierten Aufträge werden später automatisch in Rechnungen
1680 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
1681 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
1682 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
1683 wiederzufinden sind.</para>
1686 <sect2 id="features.periodic-invoices.configuration"
1687 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
1688 <title>Konfiguration</title>
1690 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
1691 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
1692 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
1693 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
1694 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
1697 <para>Folgende Parameter kann man konfigurieren:</para>
1704 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
1705 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
1706 neuen Monats).</para>
1708 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
1709 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
1710 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
1711 nächsten Periodenwechsel für alle Perioden, seit der letzten
1712 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
1713 verhindern, muss man vorher das Startdatum neu setzen.</para>
1715 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
1716 erstellt. Man kann sich diese Aufträge aber gesondert in den
1717 Berichten anzeigen lassen.</para>
1722 <term>Periodizität</term>
1725 <para>Ob monatlich, quartalsweise oder jährlich auf neue
1726 Rechnungen überprüft werden soll. Für jede Periode seit dem
1727 Startdatum wird überprüft, ob für die Periode (beginnend immer
1728 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
1729 wurde. Unter Umständen können bei einem Startdatum in der
1730 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
1735 <term>Buchen auf</term>
1738 <para>Das Forderungskonto, in der Regel "Forderungen aus
1739 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
1740 Buchungsgruppen der betreffenden Waren.</para>
1745 <term>Startdatum</term>
1748 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
1754 <term>Enddatum</term>
1757 <para>ab wann keine Rechnungen mehr erstellt werden
1763 <term>Automatische Verlängerung um x Monate</term>
1766 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
1767 eingetragenen Enddatums weiterhin erstellt werden, so kann man
1768 hier die Anzahl der Monate eingeben, um die das Enddatum
1769 automatisch nach hinten geschoben wird.</para>
1774 <term>Drucken</term>
1777 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
1778 Rechnungen auch gleich ausdrucken lassen.</para>
1783 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
1784 Informationen zu den erstellten Rechnungen verschickt werden.
1785 Konfiguriert wird dies in der <link
1786 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
1787 <filename>config/lx_office.conf</filename> im Abschnitt
1788 <varname>[periodic_invoices]</varname>.</para>
1791 <sect2 id="features.periodic-invoices.reports">
1792 <title>Auflisten</title>
1794 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
1795 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
1796 Rechnungen inaktiv", mit denen man sich einen Überglick über die
1797 wiederkehrenden Rechnungen verschaffen kann.</para>
1800 <sect2 id="features.periodic-invoices.task-server">
1801 <title>Erzeugung der eigentlichen Rechnungen</title>
1803 <para>Die zeitliche und periodische Überprüfung, ob eine
1804 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
1805 durch den <link linkend="config.task-server">Taskserver</link>, einen
1806 externen Dienst, der automatisch beim Start des Servers gestartet
1807 werden sollte.</para>
1810 <sect2 id="features.periodic-invoices.create-for-current-month">
1811 <title>Erste Rechnung für aktuellen Monat erstellen</title>
1813 <para>Will man im laufenden Monat eine monatlich wiederkehrende
1814 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
1815 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
1816 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
1817 generiert hat. Alternativ setzt man das Startdatum auf den
1818 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
1819 manuell über den Workflow.</para>
1823 <sect1 id="dokumentenvorlagen-und-variablen">
1824 <title>Dokumentenvorlagen und verfügbare Variablen</title>
1826 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
1827 <title>Einführung</title>
1829 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
1830 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
1831 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
1832 <function><%variablenname%></function> verwendet wird. Für
1833 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
1835 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
1837 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
1838 unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern es nicht
1839 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
1840 alle Vorlagenarten.</para>
1842 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
1843 verfügbar als hier aufgelistet werden. Die meisten davon können
1844 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
1845 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
1846 diese wie folgt erhalten werden:</para>
1850 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
1851 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
1855 <para>In <filename>Form.pm</filename> die Funktion
1856 <function>parse_template</function> suchen und hier die Zeile
1857 <command>print(STDERR Dumper($self));</command> einfügen.</para>
1861 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
1862 ein PDF für eine Rechnung erzeugen.</para>
1866 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
1867 der Variablen <varname>$self</varname> in der Form <varname>'key'
1868 => 'value',</varname>. Alle <varname>key</varname>s sind
1874 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
1875 <title>Variablen ausgeben</title>
1877 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
1878 Tags geschrieben werden, also z.B.
1879 <varname><%variablenname%></varname>.</para>
1881 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
1882 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
1883 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
1884 werden die folgenden Flags unterstützt:</para>
1888 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
1889 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
1890 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
1891 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
1895 <para><option>NOESCAPE</option> unterdrückt das Escapen von
1896 Sonderzeichen für die Vorlagensprache. Wenn also in einer
1897 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
1898 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
1899 ist dieses Flag sinnvoll.</para>
1903 <para>Beispiel:</para>
1905 <programlisting><%quototal NOFORMAT%></programlisting>
1908 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
1909 <title>Verwendung in Druckbefehlen</title>
1911 <para>In der Admininstration können Drucker definiert werden. Auch im
1912 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
1913 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
1914 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
1915 <function>`...`</function> nicht zu unerwünschtem Verhalten
1918 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
1919 für das die Telefonnummer eines Ansprechpartners als Teil der
1920 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
1921 z.B. wie folgt aussehen:</para>
1923 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
1926 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
1927 xreflabel="Anfang und Ende der Tags verändern">
1928 <title>Anfang und Ende der Tags verändern</title>
1930 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
1931 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
1932 Prozentzeichen und dem Größerzeichen endet, beispielsweise
1933 <function><%customer%></function>. Da diese Form aber z.B. in
1934 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
1935 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
1936 Stil umgestellt werden.</para>
1938 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
1939 Format gültigen Kommentarzeichen anfangen, dann
1940 <function>config:</function> enthalten, die entsprechende Option
1941 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
1942 enden. Beispiel für LaTeX:</para>
1944 <programlisting>% config: tag-style=($ $)</programlisting>
1946 <para>Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen,
1947 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
1948 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
1950 <programlisting><!-- config: tag-style=($ $) --></programlisting>
1953 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
1954 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
1956 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
1957 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
1958 "<filename>.ext</filename>" geeignet zu ersetzen:
1959 "<filename>.tex</filename>" für LaTeX-Vorlagen und
1960 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
1964 <term><filename>bin_list.ext</filename></term>
1967 <para>Lagerliste</para>
1972 <term><filename>check.ext</filename></term>
1980 <term><filename>invoice.ext</filename></term>
1983 <para>Rechnung</para>
1988 <term><filename>packing_list.ext</filename></term>
1991 <para>Packliste</para>
1996 <term><filename>pick_list.ext</filename></term>
1999 <para>Sammelliste</para>
2004 <term><filename>purchase_delivery_order.ext</filename></term>
2007 <para>Lieferschein (Einkauf)</para>
2012 <term><filename>purcharse_order.ext</filename></term>
2015 <para>Bestellung an Lieferanten</para>
2020 <term><filename>request_quotation.ext</filename></term>
2023 <para>Anfrage an Lieferanten</para>
2028 <term><filename>sales_delivery_order.ext</filename></term>
2031 <para>Lieferschein (Verkauf)</para>
2036 <term><filename>sales_order.ext</filename></term>
2039 <para>Bestellung</para>
2044 <term><filename>sales_quotation.ext</filename></term>
2047 <para>Angebot an Kunden</para>
2052 <term><filename>zahlungserinnerung.ext</filename></term>
2055 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2060 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2063 <para>Rechnung über Mahngebühren (Dateiname im Programm
2064 konfigurierbar)</para>
2070 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2071 <title>Sprache, Drucker und E-Mail</title>
2073 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2074 eingearbeitet. So wird aus der Vorlage
2075 <filename>sales_order.ext</filename> bei Sprache
2076 <function>de</function> und Druckerkürzel <function>lpr2</function>
2077 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2078 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2079 bekommen dann noch das Kürzel <filename>_email</filename>, der
2080 vollständige Vorlagenname wäre dann
2081 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2082 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2083 werden. Diese wird verwendet, wenn keine der anderen Varianten
2084 gefunden wird.</para>
2086 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2087 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2088 verschickt wird, ist:</para>
2092 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2096 <para><filename>sales_order_de_lpr2.tex</filename></para>
2100 <para><filename>sales_order.tex</filename></para>
2104 <para><filename>default.tex</filename></para>
2108 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2109 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2111 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2114 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2115 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2118 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2119 xreflabel="Metainformationen zur angeforderten Vorlage">
2120 <title>Metainformationen zur angeforderten Vorlage</title>
2122 <para>Diese Variablen liefern Informationen darüber welche Variante
2123 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2124 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2125 Formulare einbinden möchten.</para>
2129 <term><varname>template_meta.formname</varname></term>
2132 <para>Basisname der Vorlage. Identisch mit der <link
2133 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2134 zu den Dateinamen</link> ohne die Erweiterung. Ein
2135 Verkaufsauftrag enthält hier
2136 <constant>sales_order</constant>.</para>
2141 <term><varname>template_meta.language.description</varname></term>
2144 <para>Beschreibung der verwendeten Sprache</para>
2149 <term><varname>template_meta.language.template_code</varname></term>
2152 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2153 Kürzel das im Dateinamen verwendetet wird.</para>
2158 <term><varname>template_meta.language.output_numberformat</varname></term>
2161 <para>Zahlenformat der verwendeten Sprache in der Form
2162 "<constant>1.000,00</constant>". Experimentell! Nur
2163 interessant für Vorlagen die mit unformatierten Werten
2169 <term><varname>template_meta.language.output_dateformat</varname></term>
2172 <para>Datumsformat der verwendeten Sprache in der Form
2173 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2174 interessant für Vorlagen die mit unformatierten Werten
2180 <term><varname>template_meta.format</varname></term>
2183 <para>Das angeforderte Format. Kann im Moment die Werte
2184 <constant>pdf</constant>, <constant>postscript</constant>,
2185 <constant>html</constant>, <constant>opendocument</constant>,
2186 <constant>opendocument_pdf</constant> und
2187 <constant>excel</constant> enthalten.</para>
2192 <term><varname>template_meta.extension</varname></term>
2195 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2196 <constant>format</constant> entschieden.</para>
2201 <term><varname>template_meta.media</varname></term>
2204 <para>Ausgabemedium. Kann zur Zeit die Werte
2205 <constant>screen</constant> für Bildschirm,
2206 <constant>email</constant> für E-Mmail (triggert das
2207 <constant>_email</constant> Kürzel im Dateinamen),
2208 <constant>printer</constant> für Drucker, und
2209 <constant>queue</constant> für Warteschlange enthalten.</para>
2214 <term><varname>template_meta.printer.description</varname></term>
2217 <para>Beschreibung des ausgewählten Druckers</para>
2222 <term><varname>template_meta.printer.template_code</varname></term>
2225 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2226 dem Kürzel das im Dateinamen verwendetet wird.</para>
2232 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2233 <title>Stammdaten von Kunden und Lieferanten</title>
2237 <term><varname>account_number</varname></term>
2240 <para>Kontonummer</para>
2245 <term><varname>bank</varname></term>
2248 <para>Name der Bank</para>
2253 <term><varname>bank_code</varname></term>
2256 <para>Bankleitzahl</para>
2261 <term><varname>bic</varname></term>
2264 <para>Bank-Identifikations-Code (Bank Identifier Code,
2270 <term><varname>business</varname></term>
2273 <para>Kunden-/Lieferantentyp</para>
2278 <term><varname>city</varname></term>
2286 <term><varname>contact</varname></term>
2289 <para>Kontakt</para>
2294 <term><varname>country</varname></term>
2302 <term><varname>cp_email</varname></term>
2305 <para>Email des Ansprechpartners</para>
2310 <term><varname>cp_givenname</varname></term>
2313 <para>Vorname des Ansprechpartners</para>
2318 <term><varname>cp_greeting</varname></term>
2321 <para>Anrede des Ansprechpartners</para>
2326 <term><varname>cp_name</varname></term>
2329 <para>Name des Ansprechpartners</para>
2334 <term><varname>cp_phone1</varname></term>
2337 <para>Telefonnummer 1 des Ansprechpartners</para>
2342 <term><varname>cp_phone2</varname></term>
2345 <para>Telefonnummer 2 des Ansprechpartners</para>
2350 <term><varname>cp_title</varname></term>
2353 <para>Titel des Ansprechpartners</para>
2358 <term><varname>creditlimit</varname></term>
2361 <para>Kreditlimit</para>
2366 <term><varname>customeremail</varname></term>
2369 <para>Email des Kunden; nur für Kunden</para>
2374 <term><varname>customerfax</varname></term>
2377 <para>Faxnummer des Kunden; nur für Kunden</para>
2382 <term><varname>customernotes</varname></term>
2385 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2390 <term><varname>customernumber</varname></term>
2393 <para>Kundennummer; nur für Kunden</para>
2398 <term><varname>customerphone</varname></term>
2401 <para>Telefonnummer des Kunden; nur für Kunden</para>
2406 <term><varname>discount</varname></term>
2414 <term><varname>email</varname></term>
2417 <para>Emailadresse</para>
2422 <term><varname>fax</varname></term>
2425 <para>Faxnummer</para>
2430 <term><varname>homepage</varname></term>
2433 <para>Homepage</para>
2438 <term><varname>iban</varname></term>
2441 <para>Internationale Kontonummer (International Bank Account
2442 Number, IBAN)</para>
2447 <term><varname>language</varname></term>
2450 <para>Sprache</para>
2455 <term><varname>name</varname></term>
2458 <para>Firmenname</para>
2463 <term><varname>payment_description</varname></term>
2466 <para>Name der Zahlart</para>
2471 <term><varname>payment_terms</varname></term>
2474 <para>Zahlungskonditionen</para>
2479 <term><varname>phone</varname></term>
2482 <para>Telefonnummer</para>
2487 <term><varname>shiptocity</varname></term>
2490 <para>Stadt (Lieferadresse) <link
2491 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2496 <term><varname>shiptocontact</varname></term>
2499 <para>Kontakt (Lieferadresse) <link
2500 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2505 <term><varname>shiptocountry</varname></term>
2508 <para>Land (Lieferadresse) <link
2509 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2514 <term><varname>shiptodepartment1</varname></term>
2517 <para>Abteilung 1 (Lieferadresse) <link
2518 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2523 <term><varname>shiptodepartment2</varname></term>
2526 <para>Abteilung 2 (Lieferadresse) <link
2527 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2532 <term><varname>shiptoemail</varname></term>
2535 <para>Email (Lieferadresse) <link
2536 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2541 <term><varname>shiptofax</varname></term>
2544 <para>Fax (Lieferadresse) <link
2545 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2550 <term><varname>shiptoname</varname></term>
2553 <para>Firmenname (Lieferadresse) <link
2554 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2559 <term><varname>shiptophone</varname></term>
2562 <para>Telefonnummer (Lieferadresse) <link
2563 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2568 <term><varname>shiptostreet</varname></term>
2571 <para>Straße und Hausnummer (Lieferadresse) <link
2572 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2577 <term><varname>shiptozipcode</varname></term>
2580 <para>Postleitzahl (Lieferadresse) <link
2581 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2586 <term><varname>street</varname></term>
2589 <para>Straße und Hausnummer</para>
2594 <term><varname>taxnumber</varname></term>
2597 <para>Steuernummer</para>
2602 <term><varname>ustid</varname></term>
2605 <para>Umsatzsteuer-Identifikationsnummer</para>
2610 <term><varname>vendoremail</varname></term>
2613 <para>Email des Lieferanten; nur für Lieferanten</para>
2618 <term><varname>vendorfax</varname></term>
2621 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2626 <term><varname>vendornotes</varname></term>
2629 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2634 <term><varname>vendornumber</varname></term>
2637 <para>Lieferantennummer; nur für Lieferanten</para>
2642 <term><varname>vendorphone</varname></term>
2645 <para>Telefonnummer des Lieferanten; nur für
2651 <term><varname>zipcode</varname></term>
2654 <para>Postleitzahl</para>
2659 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
2660 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
2661 Stammdaten nicht eingetragen, so haben die Variablen
2662 <varname>shipto*</varname> den gleichen Wert wie die die
2663 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
2664 einige <varname>shipto*</varname>-Variablen so nicht in den
2665 Stammdaten wiederfinden sondern schlicht Kopien der
2666 Lieferdatenvariablen sind (z.B.
2667 <varname>shiptocontact</varname>).</para>
2671 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
2672 <title>Informationen über den Bearbeiter</title>
2676 <term><varname>employee_address</varname></term>
2679 <para>Adressfeld</para>
2684 <term><varname>employee_businessnumber</varname></term>
2687 <para>Firmennummer</para>
2692 <term><varname>employee_company</varname></term>
2695 <para>Firmenname</para>
2700 <term><varname>employee_co_ustid</varname></term>
2703 <para>Usatzsteuer-Identifikationsnummer</para>
2708 <term><varname>employee_duns</varname></term>
2711 <para>DUNS-Nummer</para>
2716 <term><varname>employee_email</varname></term>
2724 <term><varname>employee_fax</varname></term>
2732 <term><varname>employee_name</varname></term>
2735 <para>voller Name</para>
2740 <term><varname>employee_signature</varname></term>
2743 <para>Signatur</para>
2748 <term><varname>employee_taxnumber</varname></term>
2751 <para>Steuernummer</para>
2756 <term><varname>employee_tel</varname></term>
2759 <para>Telefonnummer</para>
2765 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
2766 <title>Informationen über den Bearbeiter</title>
2770 <term><varname>salesman_address</varname></term>
2773 <para>Adressfeld</para>
2778 <term><varname>salesman_businessnumber</varname></term>
2781 <para>Firmennummer</para>
2786 <term><varname>salesman_company</varname></term>
2789 <para>Firmenname</para>
2794 <term><varname>salesman_co_ustid</varname></term>
2797 <para>Usatzsteuer-Identifikationsnummer</para>
2802 <term><varname>salesman_duns</varname></term>
2805 <para>DUNS-Nummer</para>
2810 <term><varname>salesman_email</varname></term>
2818 <term><varname>salesman_fax</varname></term>
2826 <term><varname>salesman_name</varname></term>
2829 <para>voller Name</para>
2834 <term><varname>salesman_signature</varname></term>
2837 <para>Signatur</para>
2842 <term><varname>salesman_taxnumber</varname></term>
2845 <para>Steuernummer</para>
2850 <term><varname>salesman_tel</varname></term>
2853 <para>Telefonnummer</para>
2859 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
2860 <title>Variablen für die einzelnen Steuern</title>
2864 <term><varname>tax</varname></term>
2872 <term><varname>taxbase</varname></term>
2875 <para>zu versteuernder Betrag</para>
2880 <term><varname>taxdescription</varname></term>
2883 <para>Name der Steuer</para>
2888 <term><varname>taxrate</varname></term>
2891 <para>Steuersatz</para>
2898 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
2899 <title>Variablen in Rechnungen</title>
2901 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
2902 <title>Allgemeine Variablen</title>
2906 <term><varname>creditremaining</varname></term>
2909 <para>Verbleibender Kredit</para>
2914 <term><varname>currency</varname></term>
2917 <para>Währung</para>
2922 <term><varname>cusordnumber</varname></term>
2925 <para>Bestellnummer beim Kunden</para>
2930 <term><varname>deliverydate</varname></term>
2933 <para>Lieferdatum</para>
2938 <term><varname>duedate</varname></term>
2941 <para>Fälligkeitsdatum</para>
2946 <term><varname>globalprojectnumber</varname></term>
2949 <para>Projektnummer des ganzen Beleges</para>
2954 <term><varname>globalprojectdescription</varname></term>
2957 <para>Projekbeschreibung des ganzen Beleges</para>
2962 <term><varname>intnotes</varname></term>
2965 <para>Interne Bemerkungen</para>
2970 <term><varname>invdate</varname></term>
2973 <para>Rechnungsdatum</para>
2978 <term><varname>invnumber</varname></term>
2981 <para>Rechnungsnummer</para>
2986 <term><varname>invtotal</varname></term>
2989 <para>gesamter Rechnungsbetrag</para>
2994 <term><varname>notes</varname></term>
2997 <para>Bemerkungen der Rechnung</para>
3002 <term><varname>orddate</varname></term>
3005 <para>Auftragsdatum</para>
3010 <term><varname>ordnumber</varname></term>
3013 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3014 erstellt wurde</para>
3019 <term><varname>payment_description</varname></term>
3022 <para>Name der Zahlart</para>
3027 <term><varname>payment_terms</varname></term>
3030 <para>Zahlungskonditionen</para>
3035 <term><varname>quodate</varname></term>
3038 <para>Angebotsdatum</para>
3043 <term><varname>quonumber</varname></term>
3046 <para>Angebotsnummer</para>
3051 <term><varname>shippingpoint</varname></term>
3054 <para>Versandort</para>
3059 <term><varname>shipvia</varname></term>
3062 <para>Transportmittel</para>
3067 <term><varname>subtotal</varname></term>
3070 <para>Zwischensumme aller Posten ohne Steuern</para>
3075 <term><varname>total</varname></term>
3078 <para>Restsumme der Rechnung (Summe abzüglich bereits
3079 bezahlter Posten)</para>
3084 <term><varname>transaction_description</varname></term>
3087 <para>Vorgangsbezeichnung</para>
3092 <term><varname>transdate</varname></term>
3095 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3096 erstellt wurde</para>
3102 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3103 <title>Variablen für jeden Posten auf der Rechnung</title>
3107 <term><varname>bin</varname></term>
3110 <para>Stellage</para>
3115 <term><varname>description</varname></term>
3118 <para>Artikelbeschreibung</para>
3123 <term><varname>discount</varname></term>
3126 <para>Rabatt als Betrag</para>
3131 <term><varname>discount_sub</varname></term>
3134 <para>Zwischensumme mit Rabatt</para>
3139 <term><varname>drawing</varname></term>
3142 <para>Zeichnung</para>
3147 <term><varname>ean</varname></term>
3150 <para>EAN-Code</para>
3155 <term><varname>image</varname></term>
3163 <term><varname>linetotal</varname></term>
3166 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3171 <term><varname>longdescription</varname></term>
3174 <para>Langtext</para>
3179 <term><varname>microfiche</varname></term>
3182 <para>Mikrofilm</para>
3187 <term><varname>netprice</varname></term>
3190 <para>Nettopreis</para>
3195 <term><varname>nodiscount_linetotal</varname></term>
3198 <para>Zeilensumme ohne Rabatt</para>
3203 <term><varname>nodiscount_sub</varname></term>
3206 <para>Zwischensumme ohne Rabatt</para>
3211 <term><varname>number</varname></term>
3214 <para>Artikelnummer</para>
3219 <term><varname>ordnumber_oe</varname></term>
3222 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3223 aus einem Sammelauftrag erstellt wurde</para>
3228 <term><varname>p_discount</varname></term>
3231 <para>Rabatt in Prozent</para>
3236 <term><varname>partnotes</varname></term>
3239 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3244 <term><varname>partsgroup</varname></term>
3247 <para>Warengruppe</para>
3252 <term><varname>price_factor</varname></term>
3255 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3261 <term><varname>price_factor_name</varname></term>
3264 <para>Der Name des Preisfaktors, sofern einer eingestellt
3270 <term><varname>projectnumber</varname></term>
3273 <para>Projektnummer</para>
3278 <term><varname>projectdescription</varname></term>
3281 <para>Projektbeschreibung</para>
3286 <term><varname>qty</varname></term>
3294 <term><varname>reqdate</varname></term>
3297 <para>Lieferdatum</para>
3302 <term><varname>runningnumber</varname></term>
3305 <para>Position auf der Rechnung (1, 2, 3...)</para>
3310 <term><varname>sellprice</varname></term>
3313 <para>Verkaufspreis</para>
3318 <term><varname>serialnumber</varname></term>
3321 <para>Seriennummer</para>
3326 <term><varname>tax_rate</varname></term>
3329 <para>Steuersatz</para>
3334 <term><varname>transdate_oe</varname></term>
3337 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3338 aus einem Sammelauftrag erstellt wurde</para>
3343 <term><varname>unit</varname></term>
3346 <para>Einheit</para>
3351 <term><varname>weight</varname></term>
3354 <para>Gewicht</para>
3359 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3360 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3361 einer <function>foreach</function>-Schleife ausgegeben werden, da
3362 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3363 können. Die Variablen dafür lauten:</para>
3367 <term><varname>make</varname></term>
3370 <para>Lieferant</para>
3375 <term><varname>model</varname></term>
3378 <para>Lieferantenartikelnummer</para>
3384 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3385 <title>Variablen für die einzelnen Zahlungseingänge</title>
3389 <term><varname>payment</varname></term>
3397 <term><varname>paymentaccount</varname></term>
3405 <term><varname>paymentdate</varname></term>
3413 <term><varname>paymentmemo</varname></term>
3421 <term><varname>paymentsource</varname></term>
3430 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3431 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3433 <para>Die vom Benutzer definierten Variablen für Kunden und
3434 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3435 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3436 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3437 Variablennamen zusammen.</para>
3439 <para>Beispiel: Der Benutzer hat eine Variable namens
3440 <varname>number_of_employees</varname> definiert, die die Anzahl der
3441 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3442 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3447 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3448 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3450 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3451 <title>Namen der Vorlagen</title>
3453 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3454 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3455 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3456 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3457 Vorlagenname für diese Mahnstufe mit dem Zusatz
3458 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3459 für die ausgewählte Sprache und den ausgewählten Drucker
3463 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3464 <title>Allgemeine Variablen in Mahnungen</title>
3466 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3467 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3468 Kunden stehen als Variablen <varname>name</varname>,
3469 <varname>street</varname>, <varname>zipcode</varname>,
3470 <varname>city</varname>, <varname>country</varname>,
3471 <varname>department_1</varname>, <varname>department_2</varname>,
3472 und <varname>email</varname> zur Verfügung.</para>
3474 <para>Weitere Variablen beinhalten:</para>
3478 <term><varname>dunning_date</varname></term>
3481 <para>Datum der Mahnung</para>
3486 <term><varname>dunning_duedate</varname></term>
3489 <para>Fälligkeitsdatum für diese Mahhnung</para>
3494 <term><varname>dunning_id</varname></term>
3497 <para>Mahnungsnummer</para>
3502 <term><varname>fee</varname></term>
3505 <para>Kummulative Mahngebühren</para>
3510 <term><varname>interest_rate</varname></term>
3513 <para>Zinssatz per anno in Prozent</para>
3518 <term><varname>total_amount</varname></term>
3521 <para>Gesamter noch zu zahlender Betrag als
3522 <function>fee</function> + <function>total_interest</function>
3523 + <function>total_open_amount</function></para>
3528 <term><varname>total_interest</varname></term>
3531 <para>Zinsen per anno über alle Rechnungen</para>
3536 <term><varname>total_open_amount</varname></term>
3539 <para>Summe über alle offene Beträge der Rechnungen</para>
3545 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3546 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3550 <term><varname>dn_amount</varname></term>
3553 <para>Rechnungssumme (brutto)</para>
3558 <term><varname>dn_duedate</varname></term>
3561 <para>Originales Fälligkeitsdatum der Rechnung</para>
3566 <term><varname>dn_dunning_date</varname></term>
3569 <para>Datum der Mahnung</para>
3574 <term><varname>dn_dunning_duedate</varname></term>
3577 <para>Fälligkeitsdatum der Mahnung</para>
3582 <term><varname>dn_fee</varname></term>
3585 <para>Kummulative Mahngebühr</para>
3590 <term><varname>dn_interest</varname></term>
3593 <para>Zinsen per anno für diese Rechnung</para>
3598 <term><varname>dn_invnumber</varname></term>
3601 <para>Rechnungsnummer</para>
3606 <term><varname>dn_linetotal</varname></term>
3609 <para>Noch zu zahlender Betrag (ergibt sich aus
3610 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3611 + <varname>dn_interest</varname>)</para>
3616 <term><varname>dn_netamount</varname></term>
3619 <para>Rechnungssumme (netto)</para>
3624 <term><varname>dn_open_amount</varname></term>
3627 <para>Offener Rechnungsbetrag</para>
3632 <term><varname>dn_ordnumber</varname></term>
3635 <para>Bestellnummer</para>
3640 <term><varname>dn_transdate</varname></term>
3643 <para>Rechnungsdatum</para>
3648 <term><varname>dn_curr</varname></term>
3651 <para>Währung, in der die Rechnung erstellt wurde. (Die
3652 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
3658 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
3659 <title>Variablen in automatisch erzeugten Rechnungen über
3660 Mahngebühren</title>
3662 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3663 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3664 Kunden stehen als Variablen <varname>name</varname>,
3665 <varname>street</varname>, <varname>zipcode</varname>,
3666 <varname>city</varname>, <varname>country</varname>,
3667 <varname>department_1</varname>, <varname>department_2</varname>,
3668 und <varname>email</varname> zur Verfügung.</para>
3670 <para>Weitere Variablen beinhalten:</para>
3674 <term><varname>duedate</varname></term>
3677 <para>Fälligkeitsdatum der Rechnung</para>
3682 <term><varname>dunning_id</varname></term>
3685 <para>Mahnungsnummer</para>
3690 <term><varname>fee</varname></term>
3693 <para>Mahngebühren</para>
3698 <term><varname>interest</varname></term>
3706 <term><varname>invamount</varname></term>
3709 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
3710 <varname>interest</varname>)</para>
3715 <term><varname>invdate</varname></term>
3718 <para>Rechnungsdatum</para>
3723 <term><varname>invnumber</varname></term>
3726 <para>Rechnungsnummer</para>
3733 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
3734 <title>Variablen in anderen Vorlagen</title>
3737 <title>Einführung</title>
3739 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
3740 Rechnung. Allerdings heißen die Variablen, die mit
3741 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
3742 fangen sie mit <varname>quo</varname> für "quotation" an:
3743 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
3744 wiederum fangen sie mit <varname>ord</varname> für "order" an:
3745 <varname>ordnumber</varname> für Bestellnummer etc.</para>
3747 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
3748 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
3749 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
3750 Vorlage keine Bedeutung haben oder noch nicht belegt sein
3753 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
3754 in Rechnungen aufgeführt.</para>
3757 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
3758 <title>Angebote und Preisanfragen</title>
3762 <term><varname>quonumber</varname></term>
3765 <para>Angebots- bzw. Anfragenummer</para>
3770 <term><varname>reqdate</varname></term>
3773 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
3774 Preisanfragen)</para>
3779 <term><varname>transdate</varname></term>
3782 <para>Angebots- bzw. Anfragedatum</para>
3788 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
3789 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
3793 <term><varname>ordnumber</varname></term>
3796 <para>Auftragsnummer</para>
3801 <term><varname>reqdate</varname></term>
3804 <para>Lieferdatum</para>
3809 <term><varname>transdate</varname></term>
3812 <para>Auftragsdatum</para>
3818 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
3819 <title>Lieferscheine (Verkauf und Einkauf)</title>
3823 <term><varname>cusordnumber</varname></term>
3826 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
3827 des Lieferanten (im Einkauf)</para>
3832 <term><varname>donumber</varname></term>
3835 <para>Lieferscheinnummer</para>
3840 <term><varname>transdate</varname></term>
3843 <para>Lieferscheindatum</para>
3848 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
3849 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
3850 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
3851 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
3852 <function>foreach</function>-Schleife ausgegeben werden. Diese
3853 Variablen sind:</para>
3857 <term><varname>si_bin</varname></term>
3860 <para>Lagerplatz</para>
3865 <term><varname>si_chargenumber</varname></term>
3868 <para>Chargennummer</para>
3873 <term><varname>si_bestbefore</varname></term>
3876 <para>Mindesthaltbarkeit</para>
3881 <term><varname>si_number</varname></term>
3884 <para>Artikelnummer</para>
3889 <term><varname>si_qty</varname></term>
3892 <para>Anzahl bzw. Menge</para>
3897 <term><varname>si_runningnumber</varname></term>
3900 <para>Positionsnummer (1, 2, 3 etc)</para>
3905 <term><varname>si_unit</varname></term>
3908 <para>Einheit</para>
3913 <term><varname>si_warehouse</varname></term>
3922 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
3923 <title>Variablen für Sammelrechnung</title>
3927 <term><varname>c0total</varname></term>
3930 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
3936 <term><varname>c30total</varname></term>
3939 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
3940 und < 60 Tage</para>
3945 <term><varname>c60total</varname></term>
3948 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
3949 und < 90 Tage</para>
3954 <term><varname>c90total</varname></term>
3957 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
3963 <term><varname>total</varname></term>
3966 <para>Gesamtbetrag aller Rechnungen</para>
3971 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
3975 <term><varname>invnumber</varname></term>
3978 <para>Rechnungsnummer</para>
3983 <term><varname>invdate</varname></term>
3986 <para>Rechnungsdatum</para>
3991 <term><varname>duedate</varname></term>
3994 <para>Fälligkeitsdatum</para>
3999 <term><varname>amount</varname></term>
4002 <para>Summe der Rechnung</para>
4007 <term><varname>open</varname></term>
4010 <para>Noch offener Betrag der Rechnung</para>
4015 <term><varname>c0</varname></term>
4018 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4024 <term><varname>c30</varname></term>
4027 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4033 <term><varname>c60</varname></term>
4036 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4042 <term><varname>c90</varname></term>
4045 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4053 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4054 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4056 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4057 <title>Einfürhung</title>
4059 <para>Der Parser kennt neben den Variablen einige weitere
4060 Konstrukte, die gesondert behandelt werden. Diese sind wie
4061 Variablennamen in spezieller Weise markiert:
4062 <command><%anweisung%> ... <%end%></command></para>
4064 <para>Anmerkung zum <command><%end%></command>: Der besseren
4065 Verständlichkeit halber kann man nach dem <command>end</command>
4066 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4067 Anweisung (z.B. <command>if</command> oder
4068 <command>foreach</command>) damit abgeschlossen wird.</para>
4070 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4071 <command><%if type == "sales_quotation"%></command>, so könnte
4072 er mit <command><%end%></command> genauso abgeschlossen werden
4073 wie mit <command><%end if%></command> oder auch
4074 <command><%end type == "sales_quotation"%></command>.</para>
4077 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4078 <title>Der if-Block</title>
4080 <programlisting><%if variablenname%>
4082 <%end%></programlisting>
4084 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4085 und dem "end" werden nur ausgegeben, wenn die Variable
4086 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4088 <para>Die Bedingung kann auch negiert werden, indem das Wort
4089 <function>not</function> nach dem <filename>if</filename> verwendet
4090 wird. Beispiel:</para>
4092 <programlisting><%if not cp_greeting%>
4094 <%end%></programlisting>
4096 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4097 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4098 einer Variablen mit einer festen Zeichenkette oder einer anderen
4099 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4100 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4101 die rechte Seite des Vergleichsoperators in Anführungszeichen
4102 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4103 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4106 <programlisting><%if var1 == "Wert"%></programlisting>
4108 <para>Testet die Variable <varname>var1</varname> auf
4109 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4110 Mittels <function>!=</function> anstelle von <function>==</function>
4111 würde auf Ungleichheit getestet.</para>
4113 <programlisting>%if var1 == var2%></programlisting>
4115 <para>Testet die Variable <varname>var1</varname> auf
4116 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4117 <function>!=</function> anstelle von <function>==</function> würde
4118 auf Ungleichheit getestet.</para>
4120 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4121 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4122 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4123 dieselbe Syntax wie oben nur mit <function>=~</function> und
4124 <function>!~</function> als Vergleichsoperatoren.</para>
4126 <para>Beispiel für einen Test, ob die Variable
4127 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4128 <constant>schwierig</constant> enthält:</para>
4130 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4133 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4134 <title>Der foreach-Block</title>
4136 <programlisting><%foreach variablenname%>
4138 <%end%></programlisting>
4140 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4141 wie das Perl-Array der Variablen <varname>variablenname</varname>
4142 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4143 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4144 benutzt. In jedem Durchlauf werden die <link
4145 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4146 Variablen</link> jeweils auf den Wert für die aktuelle Position
4149 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4151 <programlisting><%foreach number%>
4152 Position: <%runningnumber%>
4153 Anzahl: <%qty%>
4154 Artikelnummer: <%number%>
4155 Beschreibung: <%description%>
4157 <%end%></programlisting>
4159 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4160 <function><%foreach%></function>-Block innerhalb einer
4161 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4162 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4163 Inhalt zwischen <function><%foreach%></function> und
4164 <function><%end%></function> wiederholt, nicht aber die
4165 komplette Zeile, in der er steht.</para>
4169 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4170 <title>Markup-Code zur Textformatierung innerhalb von
4173 <para>Wenn der Benutzer innhalb von Formularen in Lx-Office Text
4174 anders formatiert haben möchte, so ist dies begrenzt möglich.
4175 Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4176 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4177 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4178 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4179 (HTML oder PDF über LaTeX) umgesetzt.</para>
4181 <para>Die unterstützen Formatierungen sind:</para>
4185 <term><b>Text</b></term>
4188 <para>Text wird in Fettdruck gesetzt.</para>
4193 <term><i>Text</i></term>
4196 <para>Text wird kursiv gesetzt.</para>
4201 <term><u>Text</u></term>
4204 <para>Text wird unterstrichen.</para>
4209 <term><s>Text</s></term>
4212 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4213 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4218 <term><bullet></term>
4221 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4227 <para>Der Befehl <command><bullet></command> funktioniert
4228 momentan auch nur in Latex-Vorlagen.</para>
4232 <sect1 id="excel-templates">
4233 <title>Excel-Vorlagen</title>
4235 <sect2 id="excel-templates.summary">
4236 <title>Zusammenfassung</title>
4238 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4239 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4243 <sect2 id="excel-templates.usage">
4244 <title>Bedienung</title>
4246 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4247 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4248 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4250 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4251 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4252 werden. In den normalen Verkaufsmasken taucht nun
4253 <constant>Excel</constant> als auswählbares Format auf und kann von da
4254 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4256 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4257 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4258 <filename>sales_quotation.xls</filename> gespeichert.</para>
4261 <sect2 id="excel-templates.syntax">
4262 <title>Variablensyntax</title>
4264 <para>Einfache Syntax:
4265 <command><<varname>></command></para>
4267 <para>Dabei sind <constant><<</constant> und
4268 <constant>>></constant> die Delimiter. Da Excel auf festen
4269 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4270 weitere <constant><</constant> oder <constant>></constant>
4271 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4274 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4276 <para>Um die Limitierung der festen Breite zu reduzieren, können
4277 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4278 dazwishen dann erhalten. Beispiel:</para>
4280 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4282 <para>Die Variablen werden interpoliert, und linksbündig mit
4283 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4284 lang, werden überzählige Zeichen abgeschnitten.</para>
4286 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4287 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4289 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4291 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4292 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4296 <sect2 id="excel-templates.limitations">
4297 <title>Einschränkungen</title>
4299 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4300 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4301 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4302 Text zu ersetzen.</para>
4304 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4305 <command><%if%></command> und
4306 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4307 <constant><% %></constant> kommt in den Headerinformationen
4308 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4309 <constant><<</constant> und <constant>>></constant>
4316 <title>Entwicklerdokumentation</title>
4318 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4319 <title>Globale Variablen</title>
4322 <title>Wie sehen globale Variablen in Perl aus?</title>
4324 <para>Globale Variablen liegen in einem speziellen namespace namens
4325 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4326 globs global und die meisten speziellen Variablen sind...
4329 <para>Daraus ergeben sich folgende Formen:</para>
4333 <term><literal>$main::form</literal></term>
4336 <para>expliziter Namespace "main"</para>
4341 <term><literal>$::form</literal></term>
4344 <para>impliziter Namespace "main"</para>
4349 <term><literal>open FILE, "file.txt"</literal></term>
4352 <para><varname>FILE</varname> ist global</para>
4357 <term><literal>$_</literal></term>
4360 <para>speziell</para>
4365 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4366 Schlüsselwort wie "<function>global</function>", mit dem man
4367 importieren kann. <function>my</function>, <function>our</function>
4368 und <function>local</function> machen was anderes.</para>
4372 <term><literal>my $form</literal></term>
4375 <para>lexikalische Variable, gültig bis zum Ende des
4381 <term><literal>our $form</literal></term>
4384 <para><varname>$form</varname> referenziert ab hier
4385 <varname>$PACKAGE::form</varname>.</para>
4390 <term><literal>local $form</literal></term>
4393 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4394 des scopes zurückgesetzt</para>
4401 <title>Warum sind globale Variablen ein Problem?</title>
4403 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4405 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4406 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4407 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4408 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4409 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4410 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4413 <para>Das zweite Problem ist <function>strict</function>. Unter
4414 <function>strict</function> werden alle Variablen die nicht explizit
4415 mit <function>Package</function>, <function>my</function> oder
4416 <function>our</function> angegeben werden als Tippfehler angemarkert,
4417 dies hat, seit der Einführung, u.a. schon so manche langwierige
4418 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4419 angegeben werden, werden die nicht geprüft, und somit kann sich
4420 schnell ein Tippfehler einschleichen.</para>
4424 <title>Kanonische globale Variablen</title>
4426 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4427 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4428 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4429 umhergereicht werden.</para>
4431 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4435 <para><varname>$::form</varname></para>
4439 <para><varname>%::myconfig</varname></para>
4443 <para><varname>$::locale</varname></para>
4447 <para><varname>$::lxdebug</varname></para>
4451 <para><varname>$::auth</varname></para>
4455 <para><varname>$::lx_office_conf</varname></para>
4459 <para><varname>$::instance_conf</varname></para>
4463 <para><varname>$::dispatcher</varname></para>
4467 <para><varname>$::request</varname></para>
4471 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4472 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4473 Eigenschaften (Konventionen):</para>
4476 <title>$::form</title>
4480 <para>Ist ein Objekt der Klasse
4481 "<classname>Form</classname>"</para>
4485 <para>Wird nach jedem Request gelöscht</para>
4489 <para>Muss auch in Tests und Konsolenscripts vorhanden
4494 <para>Enthält am Anfang eines Requests die Requestparameter vom
4499 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4500 cachen, das wird aber momentan absichtlich zerstört</para>
4504 <para><varname>$::form</varname> wurde unter <productname>SQL
4505 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4506 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4507 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4508 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4509 <function>IS->retrieve_customer()</function> in Sicherheit
4512 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4513 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4514 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4515 richtigen Wert zu setzen:</para>
4517 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4518 $::myconfig{numberformat} = $numberformat;
4519 # (...) div Berechnungen
4520 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4522 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4523 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4524 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4525 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4526 Es geht ziemlich sicher etwas kaputt.</para>
4528 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4529 in den <productname>Template::Toolkit</productname> Templates
4530 außerhalb der Controller: der Ausdruck <function>[% var
4531 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4532 Unter Controllern ist der Standard Scope anders, da lautet der
4533 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4534 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4535 <function><%var%></function> zeigt auf
4536 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4537 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4540 <programlisting>[%- IF business %]
4541 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4542 [%- END %]</programlisting>
4544 <para>Entweder wird hier dann $::form->{business} ausgewertet
4545 oder aber der Funktion
4546 <function>$form->parse_html_template</function> wird explizit
4547 noch ein zusätzlicher Hash übergeben, der dann auch in den
4548 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4550 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4552 <para>Innerhalb von Schleifen wird
4553 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4554 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4555 welches über alle Positionen eines Lieferscheins in Schleife
4558 <programlisting>for $i (1 .. $form->{rowcount}) {
4560 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4561 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4562 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4568 <title>%::myconfig</title>
4572 <para>Das einzige Hash unter den globalen Variablen</para>
4576 <para>Wird spätestens benötigt wenn auf die Datenbank
4577 zugegriffen wird</para>
4581 <para>Wird bei jedem Request neu erstellt.</para>
4585 <para>Enthält die Userdaten des aktuellen Logins</para>
4589 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4590 extern serialisiert werden, weil da auch der Datenbankzugriff
4591 für diesen user drinsteht.</para>
4595 <para>Enthält unter anderem Listenbegrenzung vclimit,
4596 Datumsformat dateformat und Nummernformat numberformat</para>
4600 <para>Enthält Datenbankzugriffinformationen</para>
4604 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4605 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4606 aktuellen Users entscheiden müssen, befragen
4607 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4608 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4609 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4610 Informationen über den Benutzer die über die
4611 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
4615 <title>$::locale</title>
4619 <para>Objekt der Klasse "Locale"</para>
4623 <para>Wird pro Request erstellt</para>
4627 <para>Muss auch für Tests und Scripte immer verfügbar
4632 <para>Cached intern über Requestgrenzen hinweg benutzte
4637 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4638 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
4642 <title>$::lxdebug</title>
4646 <para>Objekt der Klasse "LXDebug"</para>
4650 <para>Wird global gecached</para>
4654 <para>Muss immer verfügbar sein, in nahezu allen
4659 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
4660 bereit, wie "<function>enter_sub</function>" und
4661 "<function>leave_sub</function>", mit denen in den alten Modulen ein
4662 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
4663 der man die Wallclockzeit seit Requeststart loggen kann, sowie
4664 "<function>message</function>" und "<function>dump</function>" mit
4665 denen man flott Informationen ins Log (tmp/lx-office-debug.log)
4668 <para>Beispielsweise so:</para>
4670 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
4671 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
4675 <title>$::auth</title>
4679 <para>Objekt der Klasse "SL::Auth"</para>
4683 <para>Wird global gecached</para>
4687 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
4691 <para>Wird nach jedem Request resettet.</para>
4695 <para><varname>$::auth</varname> stellt Funktionen bereit um die
4696 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
4697 vom aktuellen User abhängen wird das Objekt aus
4698 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
4699 Request kurz resettet.</para>
4703 <title>$::lx_office_conf</title>
4707 <para>Objekt der Klasse
4708 "<classname>SL::LxOfficeConf</classname>"</para>
4712 <para>Global gecached</para>
4716 <para>Repräsentation der
4717 <filename>config/lx_office.conf[.default]</filename>-Dateien</para>
4721 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
4722 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
4723 das Programm die Konfiguration ändern kann oder sollte.</para>
4725 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
4726 Debug- und Trace-Log-Datei wie folgt konfiguriert und
4729 <programlisting>[debug]
4730 file = /tmp/lx-office-debug.log</programlisting>
4732 <para>ist der Key <varname>file</varname> im Programm als
4733 <varname>$::lx_office_conf->{debug}{file}</varname>
4737 <para>Zugriff auf die Konfiguration erfolgt im Moment über
4738 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
4743 <title>$::instance_conf</title>
4747 <para>Objekt der Klasse
4748 "<classname>SL::InstanceConfiguration</classname>"</para>
4752 <para>wird pro Request neu erstellt</para>
4756 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
4757 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
4758 ist hier eine Mandantendatenbank. Beispielsweise überprüft
4759 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
4760 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
4764 <title>$::dispatcher</title>
4768 <para>Objekt der Klasse
4769 "<varname>SL::Dispatcher</varname>"</para>
4773 <para>wird pro Serverprozess erstellt.</para>
4777 <para>enthält Informationen über die technische Verbindung zum
4782 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
4783 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
4784 Objekt untergebracht.</para>
4788 <title>$::request</title>
4792 <para>Hashref (evtl später Objekt)</para>
4796 <para>Wird pro Request neu initialisiert.</para>
4800 <para>Keine Unterstruktur garantiert.</para>
4804 <para><varname>$::request</varname> ist ein generischer Platz um
4805 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
4806 at a distance benutzt werden, sondern um lokales memoizing zu
4807 ermöglichen, das garantiert am Ende des Requests zerstört
4810 <para>Vieles von dem, was im moment in <varname>$::form</varname>
4811 liegt, sollte eigentlich hier liegen. Die groben
4812 Differentialkriterien sind:</para>
4816 <para>Kommt es vom User, und soll unverändert wieder an den
4817 User? Dann <varname>$::form</varname>, steht da eh schon</para>
4821 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
4822 Requests gebraucht werden? Dann
4823 <varname>$::request</varname></para>
4827 <para>Muss ich von anderen Teilen des Programms lesend drauf
4828 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
4829 Wrappermethode</para>
4836 <title>Ehemalige globale Variablen</title>
4838 <para>Die folgenden Variablen waren einmal im Programm, und wurden
4842 <title>$::cgi</title>
4846 <para>war nötig, weil cookie Methoden nicht als
4847 Klassenfunktionen funktionieren</para>
4851 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
4852 Klassennamespace gehalten wird und über Requestgrenzen
4857 <para>liegt jetzt unter
4858 <varname>$::request->{cgi}</varname></para>
4864 <title>$::all_units</title>
4868 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
4869 ein paar hundert mal pro Request eine Liste der Einheiten
4870 brauchen, und de als Parameter durch einen Riesenstack von
4871 Funktionen geschleift werden müssten.</para>
4875 <para>Liegt jetzt unter
4876 <varname>$::request->{cache}{all_units}</varname></para>
4881 <function>AM->retrieve_all_units()</function> gesetzt oder
4888 <title>%::called_subs</title>
4892 <para>wurde benutzt um callsub deep recursions
4897 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
4898 möglichen Rekursioenen darstellt, und da nie welche
4903 <para>komplette recursion protection wurde entfernt.</para>
4910 <sect1 id="devel.fcgi">
4911 <title>Entwicklung unter FastCGI</title>
4913 <sect2 id="devel.fcgi.general">
4914 <title>Allgemeines</title>
4916 <para>Wenn Änderungen in der Konfiguration von Lx-Office gemacht
4917 werden, muss der Webserver neu gestartet werden.</para>
4919 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
4920 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
4921 müssen folgende Aspekte beachtet werden.</para>
4924 <sect2 id="devel.fcgi.exiting">
4925 <title>Programmende und Ausnahmen</title>
4927 <para>Betrifft die Funktionen <function>warn</function>,
4928 <function>die</function>, <function>exit</function>,
4929 <function>carp</function> und <function>confess</function>.</para>
4931 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
4932 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
4933 am Laufen zu halten. Man kann mit <function>die</function>,
4934 <function>confess</function> oder <function>carp</function> Fehler
4935 ausgeben, die dann vom Dispatcher angezeigt werden. Die Lx-Office
4936 eigene <function>$::form-</function>error()> tut im Prinzip das
4937 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
4938 <function>exit</function> hingegen werden nicht abgefangen.
4939 <function>warn</function> wird direkt nach STDERR, also in Server Log
4940 eine Nachricht schreiben (sofern in der Konfiguration nicht die
4941 Warnungen in das Lx-Office Log umgeleitet wurden), und
4942 <function>exit</function> wird die Ausführung beenden.</para>
4944 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
4945 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
4946 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
4947 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
4950 <sect2 id="devel.fcgi.globals">
4951 <title>Globale Variablen</title>
4953 <para>Um zu vermeiden, dass Informationen von einem Request in einen
4954 anderen gelangen, müssen alle globalen Variablen vor einem Request
4955 sauber initialisiert werden. Das ist besonders wichtig im
4956 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
4957 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
4960 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
4961 abgetrennten Block, der alle kanonischen globalen Variablen listet und
4962 erklärt. Bitte keine anderen einführen ohne das sauber zu
4963 dokumentieren.</para>
4965 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
4966 man sicher geht, dass man die richtige erwischt.</para>
4969 <sect2 id="devel.fcgi.performance">
4970 <title>Performance und Statistiken</title>
4972 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
4973 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
4974 Rechnungsmaske in Lx-Office 2.4.3 stable dauert auf einem Core2duo mit
4975 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
4976 sind es je nach Menge der definierten Variablen 1-2s. Ab der
4977 Moose/Rose::DB Version sind es 5-6s.</para>
4979 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
4980 den kritischen Pfaden, unter 0,15 sonst.</para>
4983 <sect2 id="devel.fcgi.known-issues">
4984 <title>Bekannte Probleme</title>
4986 <sect3 id="devel.fcgi.known-issues.encoding">
4987 <title>Encoding Awareness</title>
4989 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
4990 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
4991 falsch kodierte Zeichen eher unwissend, und geben sie einfach
4992 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
4993 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
4999 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5000 <title>SQL-Upgradedateien</title>
5002 <sect2 id="db-upgrade-files.introduction"
5003 xreflabel="Einführung in die Datenbank-Upgradedateien">
5004 <title>Einführung</title>
5006 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5007 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5008 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5009 Entwicklung im stable- und unstable-Baum betrifft.</para>
5011 <para>Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert.
5012 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5013 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5014 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5015 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5016 Kontrollinformationen enthält.</para>
5018 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5019 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5020 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5021 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5022 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5023 keine Versionsnummern mehr braucht.</para>
5025 <para>Lx-Office merkt sich dabei, welches der Upgradescripte in
5026 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5027 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5028 Anmeldung automatisch angelegt wird.</para>
5031 <sect2 id="db-upgrade-files.format"
5032 xreflabel="Format der Upgradedateien">
5033 <title>Format der Kontrollinformationen</title>
5035 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5036 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5037 hat dabei das folgende Format:</para>
5039 <para>Für SQL-Upgradedateien:</para>
5041 <programlisting>-- @key: value</programlisting>
5043 <para>Für Perl-Upgradedateien:</para>
5045 <programlisting># @key: value</programlisting>
5047 <para>Leerzeichen vor "<varname>value</varname>" werden
5050 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5054 <term><varname>tag</varname></term>
5057 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5058 Dieser "tag" kann von anderen Kontrolldateien in ihren
5059 Abhängigkeiten verwendet werden (Schlüsselwort
5060 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5061 in der Datenbank eingetragen wird.</para>
5063 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5064 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5066 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5067 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5068 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5074 <term><varname>charset</varname></term>
5077 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5078 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5079 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5080 Abwesenheit des Tags der Zeichensatz
5081 "<literal>ISO-8859-15</literal>" angenommen.</para>
5086 <term><varname>description</varname></term>
5089 <para>Benötigt. Eine Beschreibung, was in diesem Update
5090 passiert. Diese wird dem Benutzer beim eigentlichen
5091 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5092 sein sollte, sollte die Beschreibung auf Deutsch
5098 <term><varname>depends</varname></term>
5101 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5102 von denen dieses Upgradescript abhängt. Lx-Office stellt sicher,
5103 dass die in dieser Liste aufgeführten Scripte bereits
5104 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5106 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5107 Script "b" existiert, das von Änderungen in "a" abhängt, und
5108 eine neue Kontrolldatei für "c" erstellt wird, die von
5109 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5110 Tag "b" als Abhängigkeit zu definieren.</para>
5112 <para>Es ist nicht erlaubt, sich selbst referenzierende
5113 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5114 und "c" -> "a").</para>
5119 <term><varname>priority</varname></term>
5122 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5123 der Scripte ausgeführt werden, die die gleichen
5124 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5125 der Wert 1000 benutzt.</para>
5127 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5128 "depends" benutzt werden. Lx-Office sortiert die auszuführenden
5129 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5130 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5131 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5132 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5133 Priorität alphabetisch nach dem "tag".</para>
5138 <term><varname>ignore</varname></term>
5141 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5142 Skript bei der Anmeldung ignoriert und entsprechend nicht
5149 <sect2 id="db-upgrade-files.dbupgrade-tool"
5150 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5151 <title>Hilfsscript dbupgrade2_tool.pl</title>
5153 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5154 existiert ein Hilfsscript namens
5155 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5156 Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5157 liest alle Datenbankupgradescripte aus dem Verzeichnis
5158 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5159 gleichen Methoden wie Lx-Office selber, sodass alle Fehlersituationen
5160 von der Kommandozeile überprüft werden können.</para>
5162 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5163 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5164 sich aber auch Informationen auf verschiedene Art ausgeben
5169 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5170 --list</command>"</para>
5172 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5173 Reihenfolge sortiert, in der Lx-Office die Scripte ausführen
5174 würde. Es werden neben der Listenposition der Tag, die
5175 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5179 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5180 --tree</command>"</para>
5182 <para>Listet alle Tags in Baumform basierend auf den
5183 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5184 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5185 beim übergeordneten Script als Abhängigkeit eingetragen
5189 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5190 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5191 --rtree</command>"</para>
5193 <para>Listet alle Tags in Baumform basierend auf den
5194 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5195 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5196 die das übergeordnete Script als Abhängigkeit eingetragen
5201 <para>Baumform mit Postscriptausgabe:
5202 "<command>./scripts/dbupgrade2_tool.pl
5203 --graphviz</command>"</para>
5205 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5206 seiner Hilfe die <link
5207 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5208 Baumform</link> in eine Postscriptdatei namens
5209 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5210 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5211 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5212 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5217 <para>Scripte, von denen kein anderes Script abhängt:
5218 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5220 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5221 Scripte abhängen.</para>
5227 <sect1 id="translations-languages" xreflabel="Translations and languages">
5228 <title>Translations and languages</title>
5230 <sect2 id="translations-languages.introduction"
5231 xreflabel="Introduction to translations and languages">
5232 <title>Introduction</title>
5235 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5236 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5239 <para>This section describes how localization packages in Lx-Office
5240 are built. Currently the only language fully supported is German, and
5241 since most of the internal messages are held in English the English
5242 version is usable too.</para>
5244 <para>A stub version of French is included but not functunal at this
5248 <sect2 id="translations-languages.file-structure"
5249 xreflabel="File structure">
5250 <title>File structure</title>
5252 <para>The structure of locales in Lx-Office is:</para>
5254 <programlisting>lx-office/locale/<langcode>/</programlisting>
5256 <para>where <langcode> stands for an abbreviation of the
5257 language package. The builtin packages use two letter <ulink
5258 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5259 but the actual name is not relevant for the program and can easily be
5261 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5262 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5263 from SQL Ledger are named in this way.</para>
5265 <para>In such a language directory the following files are
5270 <term>LANGUAGE</term>
5273 <para>This file is mandatory.</para>
5275 <para>The <filename>LANGUAGE</filename> file contains the self
5276 descripted name of the language. It should contain a native
5277 representation first, and in parenthesis an english translation
5278 after that. Example:</para>
5280 <programlisting>Deutsch (German)</programlisting>
5285 <term>charset</term>
5288 <para>This file should be present.</para>
5290 <para>The <filename>charset</filename> file describes which
5291 charset a language package is written in and applies to all
5292 other language files in the package. It is possible to write
5293 some language packages without an explicit charset, but it is
5294 still strongly recommended. You'll never know in what
5295 environment your language package will be used, and neither
5296 UTF-8 nor Latin1 are guaranteed.</para>
5298 <para>The whole content of this file is a string that can be
5299 recognized as a valid charset encoding. Example:</para>
5301 <programlisting>UTF-8</programlisting>
5309 <para>This file is mandatory.</para>
5311 <para>The central translation file. It is essentially an inline
5312 Perl script autogenerated by <command>locales.pl</command>. To
5313 generate it, generate the directory and the two files mentioned
5314 above, and execute the following command:</para>
5316 <programlisting>scripts/locales.pl <langcode></programlisting>
5318 <para>Otherwise you can simply copy one of the other languages.
5319 You will be told how many are missing like this:</para>
5321 <programlisting>$ scripts/locales.pl en
5322 English - 0.6% - 2015/2028 missing</programlisting>
5324 <para>A file named "<filename>missing</filename>" will be
5325 generated and can be edited. You can also edit the
5326 "<filename>all</filename>" file directly. Edit everything you
5327 like to fit the target language and execute
5328 <command>locales.pl</command> again. See how the missing words
5334 <term>Num2text</term>
5337 <para>Legacy code from SQL Ledger. It provides a means for
5338 numbers to be converted into natural language, like
5339 <literal>1523 => one thousand five hundred twenty
5340 three</literal>. If you want to provide it, it must be inlinable
5341 Perl code which provides a <function>num2text</function> sub. If
5342 an <function>init</function> sub exists it will be executed
5345 <para>Only used in the check and receipt printing module.</para>
5350 <term>special_chars</term>
5353 <para>Lx-Office comes with a lot of interfaces to different
5354 formats, some of which are rather picky with their accepted
5355 charset. The <filename>special_chars</filename> file contains a
5356 listing of chars not suited for different file format and
5357 provides substitutions. It is written in "Simple Ini" style,
5358 containing a block for every file format.</para>
5360 <para>First entry should be the order of substitution for
5361 entries as a whitespace separated list. All entries are
5362 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5363 and <literal>\\</literal> all work.</para>
5365 <para>After that every entry is a special char that should be
5366 translated when writing text into such a file.</para>
5368 <para>Example:</para>
5370 <programlisting>[Template/XML]
5371 order=& < > \n
5375 \n=<br></programlisting>
5377 <para>Note the importance of the order in this example.
5378 Substituting < and > befor & would lead to $gt; become
5381 <para>For a list of valid formats, see the German
5382 <filename>special_chars</filename> entry. As of this writing the
5383 following are recognized:</para>
5385 <programlisting>HTML
5390 Template/OpenDocument
5391 filenames</programlisting>
5393 <para>The last of which is very machine dependant. Remember that
5394 a lot of characters are forbidden by some filesystems, for
5395 exmaple MS Windows doesn't like ':' in its files where Linux
5396 doesn't mind that. If you want the files created with your
5397 language pack to be portable, find all chars that could cause
5403 <term>missing</term>
5406 <para>This file is not a part of the language package
5409 <para>This is a file generated by
5410 <command>scripts/locales.pl</command> while processing your
5411 locales. It's only to have the missing entries singled out and
5412 does not belong to a language package.</para>
5420 <para>This file is not a part of the language package
5423 <para>Another file generated by
5424 <command>scripts/locales.pl</command>. If for any reason a
5425 translation does not appear anymore and can be deleted, it gets
5426 moved here. The last 50 or so entries deleted are saved here in
5427 case you made a typo, so that you don't have to translate
5428 everything again. If a tranlsation is missing, the lost file is
5429 checked first. If you maintain a language package, you might
5430 want to keep this safe somewhere.</para>
5437 <sect1 id="devel.style-guide">
5438 <title>Stil-Richtlinien</title>
5440 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5441 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5442 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5443 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5445 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5448 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5449 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5454 <para>Es werden keine echten Tabs sondern Leerzeichen
5459 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5461 <programlisting>foreach my $row (@data) {
5463 # do something with $row
5467 $row->{modules} = MODULE->retrieve(
5468 id => $row->{id},
5469 date => $use_now ? localtime() : $row->{time},
5473 $report->add($row);
5478 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
5479 Zeile wie der letzte Befehl. Beispiele:</para>
5481 <programlisting>sub debug {
5487 <programlisting>if ($form->{item_rows} > 0) {
5493 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
5494 der Befehl / die öffnende schließende Klammer, die den Block
5495 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
5496 Beispiele wie bei 3. gelten.</para>
5500 <para>Die Wörter "<function>else</function>",
5501 "<function>elsif</function>", "<function>while</function>" befinden
5502 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
5505 <programlisting>if ($form->{sum} > 1000) {
5507 } elsif ($form->{sum} > 0) {
5515 } until ($a > 0);</programlisting>
5519 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
5520 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
5521 und grep-ähnliche Operatoren. Beispiel:</para>
5523 <programlisting>$main::lxdebug->message("Could not find file.");
5524 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
5528 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
5530 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
5531 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
5532 Blöcke schon. Beispiel:</para>
5534 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
5539 $form->{sum} += $form->{"row_$i"};
5540 $form->{ $form->{index} } += 1;
5542 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
5546 <para>Mehrzeilige Befehle</para>
5550 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
5551 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
5552 werden, in der die ersten Funktionsparameter in der ersten Zeile
5553 stehen. Beispiel:</para>
5555 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
5556 $form->{some_col_value});</programlisting>
5560 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
5561 besten in einer übersichtlichen Tabellenstruktur organisiert
5562 wird. Beispiel:</para>
5564 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
5565 : $form->{oldcount} ? $form->{oldcount} + 1
5566 : $form->{rowcount} - $form->{rowbase};</programlisting>
5572 <para>Kommentare</para>
5576 <para>Kommentare, die alleine in einer Zeile stehen, sollten
5577 soweit wie der Code eingerückt sein.</para>
5581 <para>Seitliche hängende Kommentare sollten einheitlich
5582 formatiert werden.</para>
5586 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
5587 auf Englisch zu verfassen. So wie ich keine Lust habe,
5588 französischen Quelltext zu lesen, sollte auch der Lx-Office
5589 Quelltext für nicht-Deutschsprachige lesbar sein.
5592 <programlisting>my $found = 0;
5600 $i = 0 # initialize $i
5602 $i *= $const; # do something crazy
5603 $i = $n; # recover $i</programlisting>
5609 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
5610 Interpolation gewünscht ist. Beispiel:</para>
5612 <programlisting>$form->{sum} = 0;
5613 $form->{"row_$i"} = $form->{"row_$i"} - 5;
5614 $some_hash{42} = 54;</programlisting>
5618 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
5619 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
5620 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
5621 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
5623 <para>Als Beispiel sei die Funktion
5624 <function>print_options</function> aus
5625 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
5629 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
5630 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
5633 <para>Emacs und vim haben beide recht einfache Methoden zur
5634 Entfernung von trailing whitespace. Emacs kennt das Kommande
5635 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
5636 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
5637 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
5642 <para>Es wird kein <command>perltidy</command> verwendet.</para>
5644 <para>In der Vergangenheit wurde versucht,
5645 <command>perltidy</command> zu verwenden, um einen einheitlichen
5646 Stil zu erlangen. Es hat sich aber gezeigt, dass
5647 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
5648 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
5649 den Interessierten sind hier die
5650 <command>perltidy</command>-Optionen, die grob den beschriebenen
5651 Richtlinien entsprechen:</para>
5653 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
5654 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
5655 -lp -vt=1 -vtc=1</programlisting>
5659 <para><varname>STDERR</varname> ist tabu. Unkonditionale
5660 Debugmeldungen auch.</para>
5662 <para>Lx-Office bietet mit dem Modul <classname>LXDebug</classname>
5663 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
5664 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
5666 <para>Die <classname>LXDebug</classname>-Methode
5667 "<function>message</function>" nimmt als ersten Paramter außerdem
5668 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
5669 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
5670 und werden in den meisten Fällen auch vom Repository
5671 zurückgewiesen.</para>
5675 <para>Alle neuen Module müssen use strict verwenden.</para>
5677 <para><varname>$form</varname>, <varname>$auth</varname>,
5678 <varname>$locale</varname>, <varname>$lxdebug</varname> und
5679 <varname>%myconfig</varname> werden derzeit aus dem main package
5680 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
5681 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
5686 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
5687 <title>Dokumentation erstellen</title>
5689 <sect2 id="devel.build-doc.introduction">
5690 <title>Einführung</title>
5692 <para>Diese Dokumentation ist in <productname>DocBook</productname>
5693 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
5694 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
5695 Editor nutzt, der spezielle Unterstützung für
5696 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
5697 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
5698 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
5702 <sect2 id="devel.build-doc.required-software">
5703 <title>Benötigte Software</title>
5705 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
5706 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
5707 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
5708 erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script
5709 <command>scripts/build_doc.sh</command>.</para>
5711 <para>Das Script benötigt zur Konvertierung verschiedene
5712 Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht benötigt
5718 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
5719 in einer halbwegs aktuellen Version</para>
5723 <para>Das Java-Build-System <ulink
5724 url="http://ant.apache.org/">Apache Ant</ulink></para>
5728 <para>Das Dokumentations-System Dobudish für
5729 <productname>DocBook</productname> 4.5, eine Zusammenstellung
5730 diverser Stylesheets und Grafiken zur Konvertierung von
5731 <productname>DocBook</productname> XML in andere Formate. Das
5732 Paket, das benötigt wird, ist zum Zeitpunkt der
5733 Dokumentationserstellung
5734 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
5735 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
5740 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
5741 sind auf allen gängigen Plattformen verfügbar. Beispiel für
5742 Debian/Ubuntu:</para>
5744 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
5746 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
5747 <filename>doc/build</filename> entpackt werden. Beispiel unter der
5748 Annahme, das <productname>Dobudish</productname> in
5749 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
5751 <programlisting>cd doc/build
5752 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
5755 <sect2 id="devel.build-doc.build">
5756 <title>PDFs und HTML-Seiten erstellen</title>
5758 <para>Die eigentliche Konvertierung erfolgt nach Installation der
5759 benötigten Software mit einem einfachen Aufruf direkt aus dem
5760 Lx-Office-Installationsverzeichnis heraus:</para>
5762 <programlisting>./scripts/build_doc.sh</programlisting>
5765 <sect2 id="devel.build-doc.repository">
5766 <title>Einchecken in das Git-Repository</title>
5768 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
5769 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
5770 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
5771 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
5773 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
5774 symbolischen Links gehören hingegen nicht in das Repository.</para>