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>
554 Includes FollowSymlinks
557 <Directory /var/www/lx-erp/users>
560 </Directory></programlisting>
562 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
563 das Lx-Office-Archiv entpacket haben.</para>
566 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
567 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
570 <para>Auf einigen Webservern werden manchmal die Grafiken und
571 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
572 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
574 <programlisting>EnableSendfile Off</programlisting>
577 <sect2 id="Apache-Konfiguration.FCGI"
578 xreflabel="Konfiguration für FastCGI/FCGI">
579 <title>Konfiguration für FastCGI/FCGI</title>
581 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
582 <title>Was ist FastCGI?</title>
584 <para>Direkt aus <ulink
585 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
588 <para><citation> FastCGI ist ein Standard für die Einbindung
589 externer Software zur Generierung dynamischer Webseiten in einem
590 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
591 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
592 umgehen. </citation></para>
595 <sect3 id="Apache-Konfiguration.FCGI.Warum">
596 <title>Warum FastCGI?</title>
598 <para>Perl Programme (wie Lx-Office eines ist) werden nicht statisch
599 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
600 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
601 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
602 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
603 müssen, ist die Funktionalität von Lx-Office soweit gewachsen, dass
604 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
605 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
606 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
607 führt dazu dass ein Lx-Office Aufruf der Kernmasken mittlerweile
608 deutlich länger dauert als früher, und dass davon 90% für das Laden
609 der Module verwendet wird.</para>
611 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
612 wird nur die eigentliche Programmlogik ausgeführt.</para>
615 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
616 <title>Getestete Kombinationen aus Webservern und Plugin</title>
618 <para>Folgende Kombinationen sind getestet:</para>
622 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
626 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
630 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
631 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
632 mod_fastcgi nicht mehr explizit eingegangen.</para>
634 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
638 <para>FCGI 0.69 und höher ist extrem strict in der Behandlung von
639 Unicode, und verweigert bestimmte Eingaben von Lx-Office. Falls es
640 Probleme mit Umlauten in Ihrere Installation gibt, muss auf die
641 Vorgängerversion FCGI 0.68 ausgewichen werden.</para>
643 <para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
646 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
650 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
651 <title>Konfiguration des Webservers</title>
653 <para>Bevor Sie versuchen, eine Lx-Office Installation unter FCGI
654 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
655 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
656 debuggen die beim ersten aufsetzen auftreten können. Sollte die
657 Installation schon funktionieren, lesen Sie weiter.</para>
659 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
660 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
662 <programlisting>a2enmod fcgid</programlisting>
664 <para>Die Konfiguration für die Verwendung von Lx-Office mit FastCGI
665 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
666 und <function>Directory</function>-Direktiven. Dabei wird zwischen
667 dem Installationspfad von Lx-Office im Dateisystem
668 ("<filename>/path/to/lx-office-erp</filename>") und der URL
669 unterschieden, unter der Lx-Office im Webbrowser erreichbar ist
670 ("<filename>/url/for/lx-office-erp</filename>").</para>
672 <para>Folgender Konfigurationsschnipsel funktioniert mit
675 <programlisting>AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi
676 Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/
678 <Directory /path/to/lx-office-erp>
680 Options ExecCGI Includes FollowSymlinks
685 <DirectoryMatch /path/to/lx-office-erp/users>
688 </DirectoryMatch></programlisting>
690 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
691 die maximale Größe eines Requests. Diese sollte wie folgt
692 hochgesetzt werden:</para>
694 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
696 <para>Das ganze sollte dann so aussehen:</para>
698 <programlisting>AddHandler fcgid-script .fpl
699 AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
700 Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/
701 FcgidMaxRequestLen 10485760
703 <Directory /path/to/lx-office-erp>
705 Options ExecCGI Includes FollowSymlinks
710 <DirectoryMatch /path/to/lx-office-erp/users>
713 </DirectoryMatch></programlisting>
715 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
716 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
717 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
718 gibt es hier kleine Performance-Einbußen.</para>
720 <para>Es ist möglich, die gleiche Lx-Office Version parallel unter
721 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
722 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
724 <programlisting># Zugriff über CGI
725 Alias /url/for/lx-office-erp /path/to/lx-office-erp
727 # Zugriff mit mod_fcgid:
728 AliasMatch ^/url/for/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
729 Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/</programlisting>
731 <para>Dann ist unter <filename>/url/for/lx-office-erp/</filename>
732 die normale Version erreichbar, und unter
733 <constant>/url/for/lx-office-erp-fcgid/</constant> die
734 FastCGI-Version.</para>
739 <sect1 id="config.task-server">
740 <title>Der Task-Server</title>
742 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
743 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
744 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
745 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
746 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
749 <sect2 id="Konfiguration-des-Task-Servers">
750 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
752 <para>Die Konfiguration erfolgt über den Abschnitt
753 <literal>[task_server]</literal> in der Datei
754 <filename>config/lx_office.conf</filename>. Die dort verfügbaren
755 Optionen sind:</para>
759 <term><varname>login</varname></term>
762 <para>gültiger Lx-Office-Benutzername, der benutzt wird, um die
763 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
764 in der Administration angelegt werden. Diese Option muss
765 angegeben werden.</para>
770 <term><varname>run_as</varname></term>
773 <para>Wird der Server vom Systembenutzer <literal>root</literal>
774 gestartet, so wechselt er auf den mit <literal>run_as</literal>
775 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
776 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
778 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
779 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
780 unter dem auch der Webserver läuft.</para>
785 <term><varname>debug</varname></term>
788 <para>Schaltet Debug-Informationen an und aus.</para>
794 <sect2 id="Einbinden-in-den-Boot-Prozess">
795 <title>Automatisches Starten des Task-Servers beim Booten</title>
797 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
798 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
799 Starten automatisch in das Lx-Office-Installationsverzeichnis.</para>
801 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
802 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
803 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
804 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
805 anstelle eines symbolischen Links verwendet werden können.</para>
808 <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
811 <para>Kopieren Sie die Datei
812 <filename>scripts/boot/system-v/lx-office-task-server</filename>
813 nach <filename>/etc/init.d/lx-office-task-server</filename>. Passen
814 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
815 <literal>DAEMON=....</literal>). Binden Sie das Script in den
816 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
820 <para>Debian-basierende Systeme:</para>
822 <programlisting>update-rc.d lx-office-task-server defaults
823 # Nur bei Debian Squeeze und neuer:
824 insserv lx-office-task-server</programlisting>
828 <para>OpenSuSE und Fedora Core:</para>
830 <programlisting>chkconfig --add lx-office-task-server</programlisting>
834 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
835 werden: <command>/etc/init.d/lx-office-task-server
836 start</command></para>
840 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
842 <para>Kopieren Sie die Datei
843 <filename>scripts/boot/upstart/lx-office-task-server.conf</filename>
844 nach <filename>/etc/init/lx-office-task-server.conf</filename>.
845 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
846 <literal>exec ....</literal>).</para>
848 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
849 werden: <command>service lx-office-task-server
850 start</command></para>
854 <sect2 id="Prozesskontrolle">
855 <title>Wie der Task-Server gestartet und beendet wird</title>
857 <para>Der Task-Server wird wie folgt kontrolliert:</para>
859 <programlisting>./scripts/task_server.pl Befehl</programlisting>
861 <para><literal>Befehl</literal> ist dabei eine der folgenden
866 <para><literal>start</literal> startet eine neue Instanz des
867 Task-Servers. Die Prozess-ID wird innerhalb des
868 <filename>users</filename>-Verzeichnisses abgelegt.</para>
872 <para><literal>stop</literal> beendet einen laufenden
877 <para><literal>restart</literal> beendet und startet ihn
882 <para><literal>status</literal> berichtet, ob der Task-Server
887 <para>Der Task-Server wechselt beim Starten automatisch in das
888 Lx-Office-Installationsverzeichnis.</para>
890 <para>Dieselben Optionen können auch für die SystemV-basierenden
891 Runlevel-Scripte benutzt werden (siehe oben).</para>
895 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
896 <title>Benutzerauthentifizierung und Administratorpasswort</title>
898 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
899 über die Verwaltung von Gruppen und weitere Einstellungen</para>
901 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
902 <title>Grundlagen zur Benutzerauthentifizierung</title>
904 <para>Lx-Office verwaltet die Benutzerinformationen in einer
905 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
906 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
907 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
908 können, müssen aber nicht unterschiedlich sein.</para>
910 <para>Im einfachsten Fall gibt es für Lx-Office nur eine einzige
911 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
912 abgelegt werden.</para>
914 <para>Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter
915 entweder gegen die Authentifizierungsdatenbank oder gegen einen
916 LDAP-Server überprüft werden.</para>
918 <para>Welche Art der Passwortüberprüfung Lx-Office benutzt und wie
919 Lx-Office die Authentifizierungsdatenbank erreichen kann, wird in der
920 Konfigurationsdatei <filename>config/lx_office.conf</filename>
921 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
922 einer Version vor v2.6.0 angelegt werden. Eine
923 Beispielkonfigurationsdatei
924 <filename>config/lx_office.conf.default</filename> existiert, die als
925 Vorlage benutzt werden kann.</para>
928 <sect2 id="Administratorpasswort">
929 <title>Administratorpasswort</title>
931 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
932 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
933 nur dort und nicht mehr im Administrationsinterface selber geändert
934 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
935 Abschnitt <varname>[authentication]</varname>.</para>
938 <sect2 id="Authentifizierungsdatenbank">
939 <title>Authentifizierungsdatenbank</title>
941 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
942 Parametern in <varname>[authentication/database]</varname>
943 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
947 <term><literal>host</literal></term>
950 <para>Der Rechnername oder die IP-Adresse des
951 Datenbankservers</para>
956 <term><literal>port</literal></term>
959 <para>Die Portnummer des Datenbankservers, meist 5432</para>
964 <term><literal>db</literal></term>
967 <para>Der Name der Authentifizierungsdatenbank</para>
972 <term><literal>user</literal></term>
975 <para>Der Benutzername, mit dem sich Lx-Office beim
976 Datenbankserver anmeldet (z.B.
977 "<literal>postgres</literal>")</para>
982 <term><literal>password</literal></term>
985 <para>Das Passwort für den Datenbankbenutzer</para>
990 <para>Die Datenbank muss noch nicht existieren. Lx-Office kann sie
991 automatisch anlegen (mehr dazu siehe unten).</para>
994 <sect2 id="Passwortüberprüfung">
995 <title>Passwortüberprüfung</title>
997 <para>Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen
998 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
999 Active-Directory-Server. Welche davon benutzt wird, regelt der
1000 Parameter <varname>module</varname> im Abschnitt
1001 <varname>[authentication]</varname>.</para>
1003 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1004 gespeichert werden, so muss der Parameter <varname>module</varname>
1005 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1006 der Administrator als auch die Benutzer selber ihre Psaswörter in
1007 Lx-Office ändern.</para>
1009 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1010 benutzt werden, so muss der Parameter <varname>module</varname> auf
1011 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1012 zusätzliche Informationen über den LDAP-Server im Abschnitt
1013 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1017 <term><literal>host</literal></term>
1020 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1021 Active-Directory-Servers. Diese Angabe ist zwingend
1022 erforderlich.</para>
1027 <term><literal>port</literal></term>
1030 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1035 <term><literal>tls</literal></term>
1038 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1039 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1040 ‘<literal>0</literal>’ belassen</para>
1045 <term><literal>attribute</literal></term>
1048 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1049 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1050 meist ‘<literal>sAMAccountName</literal>’, für andere
1051 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1052 zwingend erforderlich.</para>
1057 <term><literal>base_dn</literal></term>
1060 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1061 Diese Angabe ist zwingend erforderlich.</para>
1066 <term><literal>filter</literal></term>
1069 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1070 <literal><%login%></literal>, so wird dieses durch den vom
1071 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1072 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1073 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1078 <term><literal>bind_dn</literal> und
1079 <literal>bind_password</literal></term>
1082 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1083 durchsucht werden kann (z.B. ist dies bei
1084 Active-Directory-Servern der Fall), so kann diese hier angegeben
1085 werden. Für Active-Directory-Server kann als
1086 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1087 z.B. ‘<literal>cn=Martin
1088 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1089 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1090 also ‘<literal>Martin Mustermann</literal>’.</para>
1096 <sect2 id="Name-des-Session-Cookies">
1097 <title>Name des Session-Cookies</title>
1099 <para>Sollen auf einem Server mehrere Lx-Office-Installationen
1100 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1101 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1102 Parameter <varname>cookie_name</varname> im Abschnitt
1103 <varname>[authentication]</varname>gesetzt.</para>
1105 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1106 Server existiert.</para>
1109 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1110 <title>Anlegen der Authentifizierungsdatenbank</title>
1112 <para>Nachdem alle Einstellungen in
1113 <filename>config/lx_office.conf</filename> vorgenommen wurden, muss
1114 Lx-Office die Authentifizierungsdatenbank anlegen. Dieses geschieht
1115 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1116 der folgenden URL erreichbar sein sollte:</para>
1119 url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
1123 <sect1 id="Benutzer--und-Gruppenverwaltung">
1124 <title>Benutzer- und Gruppenverwaltung</title>
1126 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1127 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1128 folgender URL finden:</para>
1131 url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
1133 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1134 <filename>config/lx_office.conf</filename> eingetragen haben.</para>
1136 <sect2 id="Zusammenhänge">
1137 <title>Zusammenhänge</title>
1139 <para>Lx-Office verwendet eine Datenbank zum Speichern all seiner
1140 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1141 mit Lx-Office arbeiten zu können, muss eine Person einen
1142 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1143 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1144 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1145 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1148 <para>Die Basisdaten der Benutzer, die in der Administration
1149 eingegeben werden können, werden in einer zweiten Datenbank
1150 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1151 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1152 Pro Lx-Office-Installation gibt es nur eine
1153 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1156 <para>Lx-Office kann seinen Benutzern Zugriff auf bestimmte
1157 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1158 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1159 angezeigt. Diese Rechte werden ebenfalls in der
1160 Authentifizierungsdatenbank gespeichert.</para>
1162 <para>Um Rechte verteilen zu können, verwendet Lx-Office ein
1163 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1164 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1165 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1166 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1167 Benutzer Mitglied ist.</para>
1169 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1170 Benutzer angelegt werden sollten, lautet:</para>
1172 <orderedlist numeration="arabic">
1174 <para>Datenbank anlegen</para>
1178 <para>Gruppen anlegen</para>
1182 <para>Benutzer anlegen</para>
1186 <para>Benutzer den Gruppen zuordnen</para>
1191 <sect2 id="Datenbanken-anlegen">
1192 <title>Datenbanken anlegen</title>
1194 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1195 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1196 Beispielen ist dies ‘<literal>lxoffice</literal>’).</para>
1198 <para>Wenn Sie für die Lx-Office-Installation nicht den europäischen
1199 Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so
1200 müssen Sie vor dem Anlegen der Datenbank in der Datei
1201 <filename>config/lx_office.conf</filename> die Variable
1202 <literal>dbcharset</literal> im Abschnitt <literal>system</literal>
1203 auf den Wert ‘<literal>UTF-8</literal>’ setzen. Zusätzlich muss beim
1204 Anlegen der Datenbank ‘<literal>UTF-8 Unicode</literal>’ als
1205 Schriftsatz ausgewählt werden.</para>
1207 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1208 verwenden müssen, da diese Einstellungen momentan global in Lx-Office
1209 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1210 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1211 angelegt worden sein.</para>
1214 <sect2 id="Gruppen-anlegen">
1215 <title>Gruppen anlegen</title>
1217 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1218 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1219 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1220 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1222 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1223 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1224 Datenbanken, die in dieser Installation verwaltet werden.</para>
1227 <sect2 id="Benutzer-anlegen">
1228 <title>Benutzer anlegen</title>
1230 <para>Beim Anlegen von Benutzern werden für viele Parameter
1231 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1232 deutschen Raumes entsprechen.</para>
1234 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1235 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1236 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1237 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1238 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1240 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1241 eben angelegten Datenbanken eingetragen werden.</para>
1244 <sect2 id="Gruppenmitgliedschaften-verwalten">
1245 <title>Gruppenmitgliedschaften verwalten</title>
1247 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1248 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1250 <orderedlist numeration="arabic">
1252 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1253 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1258 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1259 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1260 alle im System angelegten Gruppen und Benutzer enthält. Durch
1261 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1262 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1267 <sect2 id="Migration-alter-Installationen">
1268 <title>Migration alter Installationen</title>
1270 <para>Wenn Lx-Office 2.6.3 über eine ältere Version installiert wird,
1271 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1272 <literal>users</literal> verwaltet wurden, so bietet Lx-Office die
1273 Möglichkeit, diese Benutzerdaten automatisch in die
1274 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1275 sich nach dem Update der Installation das erste Mal im
1276 Administrationsbereich anmeldet. Findet Lx-Office die Datei
1277 <literal>users/members</literal>, so wird der Migrationsprozess
1280 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1281 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1282 Lx-Office noch die Möglichkeit an, dass automatisch eine
1283 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1284 Funktionen von Lx-Office gewährt. Alle migrierten Benutzern werden
1285 Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis
1286 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1287 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1291 <sect1 id="Drucken-mit-Lx-Office">
1292 <title>Drucken mit Lx-Office</title>
1294 <para>Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen.
1295 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1296 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1297 Debianoiden Betriebssystemen sind das die Pakete:</para>
1299 <para><literal>texlive-latex-base texlive-latex-extra
1300 texlive-fonts-recommended</literal></para>
1302 <para>Diese hinteren beiden enthalten Bibliotheken und Schriftarten die
1303 von den Standardvorlagen verwendet werden.</para>
1305 <para>TODO: rpm Pakete.</para>
1307 <para>In den allermeisten Installationen sollte drucken jetzt schon
1308 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1309 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1310 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1315 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1316 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1317 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1322 <para>! Package inputenc Error: Unicode char \u8:æ¡
\9c not set up for
1323 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1324 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1325 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1326 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1327 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1331 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1332 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1333 Prüfen Sie den Namen in der Konfiguration (Standard:
1334 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1335 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1339 <sect1 id="OpenDocument-Vorlagen">
1340 <title>OpenDocument-Vorlagen</title>
1342 <para>Lx-Office unterstützt die Verwendung von Vorlagen im
1343 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1344 Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1345 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1346 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1347 <filename>config/lx_office.conf</filename> die Variable
1348 <literal>opendocument</literal> im Abschnitt
1349 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1350 Dieses ist die Standardeinstellung.</para>
1352 <para>Weiterhin muss in der Datei
1353 <filename>config/lx_office.conf</filename> die Variable
1354 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1355 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1356 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1359 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1360 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1361 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1362 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1363 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1364 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1366 <para>Nach der Installation müssen in der Datei
1367 <filename>config/lx_config.conf</filename> zwei weitere Variablen
1368 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1369 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1370 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1371 enthalten. Beide stehen im Abschnitt
1372 <literal>applications</literal>.</para>
1374 <para>Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit
1375 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1376 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1377 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1378 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1379 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1380 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1381 werden muss. Der Nachteil ist, dass diese Methode Python und die
1382 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1385 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1386 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1387 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1388 Dokumentenvorlage enthalten sein und
1389 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1390 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1391 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1392 ebenfalls enthalten sein muss.</para>
1394 <para>Als letztes muss herausgefunden werden, welchen Namen
1395 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1396 gibt. Unter Debian ist dies momentan
1397 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1398 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1399 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1400 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1401 folgender Befehl auszuführen:</para>
1403 <para><literal>mv users/.openoffice.org2
1404 users/.openoffice</literal></para>
1406 <para>Dieses Verzeichnis, wie auch das komplette
1407 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1408 sein. Dieses wurde bereits erledigt (siehe <xref
1409 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1410 erneut überprüft werden, wenn die Konvertierung nach PDF
1414 <sect1 id="config.eur">
1415 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1418 <sect2 id="config.eur.introduction"
1419 xreflabel="Einführung in die Konfiguration zur EUR">
1420 <title>Einführung</title>
1422 <para>Lx-Office besaß bis inklusive Version 2.6.3 einen
1423 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1424 Konfigurationsdatei <filename>config/lx_office.conf</filename>
1425 befindet. Somit galt er für alle Mandanten, die in dieser Installation
1426 benutzt wurden.</para>
1428 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1429 die Mandantendatenbank verschoben und dabei auch gleich in drei
1430 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1431 steuern lässt.</para>
1434 <sect2 id="config.eur.parameters"
1435 xreflabel="Konfigurationsparameter für EUR">
1436 <title>Konfigurationsparameter</title>
1438 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1439 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1443 <term><varname>profit_determination</varname></term>
1446 <para>Dieser Parameter legt die Berechnungsmethode für die
1447 Gewinnermittlung fest. Er enthält entweder
1448 <literal>balance</literal> für
1449 Betriebsvermögensvergleich/Bilanzierung oder
1450 <literal>income</literal> für die
1451 Einnahmen-Überschuss-Rechnung.</para>
1456 <term><varname>accounting_method</varname></term>
1459 <para>Dieser Parameter steuert die Buchungs- und
1460 Berechnungsmethoden für die Versteuerungsart. Er enthält
1461 entweder <literal>accrual</literal> für die Soll-Versteuerung
1462 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1467 <term><varname>inventory_system</varname></term>
1470 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1471 enthält entweder <literal>perpetual</literal> für die
1472 Bestandsmethode oder <literal>periodic</literal> für die
1473 Aufwandsmethode.</para>
1478 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1479 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1480 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1481 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1482 Bestandsmethode.</para>
1484 <para>Die Konfiguration "<varname>eur</varname>" unter
1485 <varname>[system]</varname> in der <link
1486 linkend="config.config-file">Konfigurationsdatei</link>
1487 <filename>config/lx_office.conf</filename> wird nun nicht mehr
1488 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1491 <sect2 id="config.eur.setting-parameters">
1492 <title>Festlegen der Parameter</title>
1494 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1495 der Admininstration können diese Optionen nun unabhängig voneinander
1496 eingestellt werden.</para>
1498 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1499 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1502 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1503 Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt
1504 (read-only). Eine spätere Änderung ist für einen bestehenden Mandanten
1505 nicht mehr möglich. Dies war auch vorher nicht möglich, bzw.
1506 vorhandene Daten wurden so belassen und haben damit die Ergebnisse
1510 <sect2 id="config.eur.inventory-system-perpetual">
1511 <title>Bemerkungen zu Bestandsmethode</title>
1513 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1514 funktioniert in Lx-Office aber nur unter bestimmten Bedingungen:
1515 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1516 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1517 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1518 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1519 Einkaufsrechnungen berechnet wird.</para>
1521 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1522 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1523 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1527 <sect2 id="config.eur.knonw-issues">
1528 <title>Bekannte Probleme</title>
1530 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1531 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1532 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1533 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1534 die Konfigurationsvariable
1535 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1538 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1539 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1543 <sect1 id="config.skr04-update-3804">
1544 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1546 <sect2 id="config.skr04-update-3804.introduction">
1547 <title>Einführung</title>
1549 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1550 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1551 Lx-Office beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1552 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1553 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1554 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1555 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1556 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1557 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1558 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1559 Screenshots dargestellt.</para>
1561 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1562 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1563 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1564 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1567 <sect2 id="config.skr04-update-3804.create-chart">
1568 <title>Konto 3804 manuell anlegen</title>
1570 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1571 anzulegen und zu konfigurieren. Zuerst wird in
1572 <guimenu>System</guimenu> ->
1573 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1574 erfassen</guimenuitem> das Konto angelegt.</para>
1577 <screeninfo>Konto 3804 erfassen</screeninfo>
1581 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1587 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1588 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1589 wie im folgenden Screenshot angezeigt anpassen.
1593 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1597 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1603 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1604 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1608 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1612 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1618 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1619 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1620 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1621 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1625 <screeninfo>Konto 4315 anpassen</screeninfo>
1629 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1635 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1636 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1640 <screeninfo>Steuerliste vergleichen</screeninfo>
1644 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1651 <sect1 id="Lx-Office-ERP-verwenden">
1652 <title>Lx-Office ERP verwenden</title>
1654 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1655 folgender URL erreichbar:</para>
1658 url="http://localhost/lx-office-erp/login.pl">http://localhost/lx-office-erp/login.pl</ulink></para>
1660 <para>Die Administrationsseite erreichen Sie unter:</para>
1663 url="http://localhost/lx-office-erp/admin.pl">http://localhost/lx-office-erp/admin.pl</ulink></para>
1667 <chapter id="features" xreflabel="Features und Funktionen">
1668 <title>Features und Funktionen</title>
1670 <sect1 id="features.periodic-invoices"
1671 xreflabel="Wiedekehrende Rechnungen">
1672 <title>Wiederkehrende Rechnungen</title>
1674 <sect2 id="features.periodic-invoices.introduction"
1675 xreflabel="Einführung in wiederkehrende Rechnungen">
1676 <title>Einführung</title>
1678 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
1679 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
1680 Die konfigurierten Aufträge werden später automatisch in Rechnungen
1681 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
1682 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
1683 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
1684 wiederzufinden sind.</para>
1687 <sect2 id="features.periodic-invoices.configuration"
1688 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
1689 <title>Konfiguration</title>
1691 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
1692 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
1693 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
1694 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
1695 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
1698 <para>Folgende Parameter kann man konfigurieren:</para>
1705 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
1706 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
1707 neuen Monats).</para>
1709 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
1710 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
1711 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
1712 nächsten Periodenwechsel für alle Perioden, seit der letzten
1713 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
1714 verhindern, muss man vorher das Startdatum neu setzen.</para>
1716 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
1717 erstellt. Man kann sich diese Aufträge aber gesondert in den
1718 Berichten anzeigen lassen.</para>
1723 <term>Periodizität</term>
1726 <para>Ob monatlich, quartalsweise oder jährlich auf neue
1727 Rechnungen überprüft werden soll. Für jede Periode seit dem
1728 Startdatum wird überprüft, ob für die Periode (beginnend immer
1729 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
1730 wurde. Unter Umständen können bei einem Startdatum in der
1731 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
1736 <term>Buchen auf</term>
1739 <para>Das Forderungskonto, in der Regel "Forderungen aus
1740 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
1741 Buchungsgruppen der betreffenden Waren.</para>
1746 <term>Startdatum</term>
1749 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
1755 <term>Enddatum</term>
1758 <para>ab wann keine Rechnungen mehr erstellt werden
1764 <term>Automatische Verlängerung um x Monate</term>
1767 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
1768 eingetragenen Enddatums weiterhin erstellt werden, so kann man
1769 hier die Anzahl der Monate eingeben, um die das Enddatum
1770 automatisch nach hinten geschoben wird.</para>
1775 <term>Drucken</term>
1778 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
1779 Rechnungen auch gleich ausdrucken lassen.</para>
1784 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
1785 Informationen zu den erstellten Rechnungen verschickt werden.
1786 Konfiguriert wird dies in der <link
1787 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
1788 <filename>config/lx_office.conf</filename> im Abschnitt
1789 <varname>[periodic_invoices]</varname>.</para>
1792 <sect2 id="features.periodic-invoices.reports">
1793 <title>Auflisten</title>
1795 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
1796 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
1797 Rechnungen inaktiv", mit denen man sich einen Überglick über die
1798 wiederkehrenden Rechnungen verschaffen kann.</para>
1801 <sect2 id="features.periodic-invoices.task-server">
1802 <title>Erzeugung der eigentlichen Rechnungen</title>
1804 <para>Die zeitliche und periodische Überprüfung, ob eine
1805 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
1806 durch den <link linkend="config.task-server">Taskserver</link>, einen
1807 externen Dienst, der automatisch beim Start des Servers gestartet
1808 werden sollte.</para>
1811 <sect2 id="features.periodic-invoices.create-for-current-month">
1812 <title>Erste Rechnung für aktuellen Monat erstellen</title>
1814 <para>Will man im laufenden Monat eine monatlich wiederkehrende
1815 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
1816 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
1817 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
1818 generiert hat. Alternativ setzt man das Startdatum auf den
1819 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
1820 manuell über den Workflow.</para>
1824 <sect1 id="dokumentenvorlagen-und-variablen">
1825 <title>Dokumentenvorlagen und verfügbare Variablen</title>
1827 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
1828 <title>Einführung</title>
1830 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
1831 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
1832 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
1833 <function><%variablenname%></function> verwendet wird. Für
1834 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
1836 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
1838 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
1839 unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern es nicht
1840 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
1841 alle Vorlagenarten.</para>
1843 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
1844 verfügbar als hier aufgelistet werden. Die meisten davon können
1845 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
1846 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
1847 diese wie folgt erhalten werden:</para>
1851 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
1852 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
1856 <para>In <filename>Form.pm</filename> die Funktion
1857 <function>parse_template</function> suchen und hier die Zeile
1858 <command>print(STDERR Dumper($self));</command> einfügen.</para>
1862 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
1863 ein PDF für eine Rechnung erzeugen.</para>
1867 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
1868 der Variablen <varname>$self</varname> in der Form <varname>'key'
1869 => 'value',</varname>. Alle <varname>key</varname>s sind
1875 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
1876 <title>Variablen ausgeben</title>
1878 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
1879 Tags geschrieben werden, also z.B.
1880 <varname><%variablenname%></varname>.</para>
1882 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
1883 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
1884 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
1885 werden die folgenden Flags unterstützt:</para>
1889 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
1890 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
1891 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
1892 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
1896 <para><option>NOESCAPE</option> unterdrückt das Escapen von
1897 Sonderzeichen für die Vorlagensprache. Wenn also in einer
1898 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
1899 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
1900 ist dieses Flag sinnvoll.</para>
1904 <para>Beispiel:</para>
1906 <programlisting><%quototal NOFORMAT%></programlisting>
1909 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
1910 <title>Verwendung in Druckbefehlen</title>
1912 <para>In der Admininstration können Drucker definiert werden. Auch im
1913 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
1914 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
1915 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
1916 <function>`...`</function> nicht zu unerwünschtem Verhalten
1919 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
1920 für das die Telefonnummer eines Ansprechpartners als Teil der
1921 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
1922 z.B. wie folgt aussehen:</para>
1924 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
1927 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
1928 xreflabel="Anfang und Ende der Tags verändern">
1929 <title>Anfang und Ende der Tags verändern</title>
1931 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
1932 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
1933 Prozentzeichen und dem Größerzeichen endet, beispielsweise
1934 <function><%customer%></function>. Da diese Form aber z.B. in
1935 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
1936 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
1937 Stil umgestellt werden.</para>
1939 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
1940 Format gültigen Kommentarzeichen anfangen, dann
1941 <function>config:</function> enthalten, die entsprechende Option
1942 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
1943 enden. Beispiel für LaTeX:</para>
1945 <programlisting>% config: tag-style=($ $)</programlisting>
1947 <para>Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen,
1948 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
1949 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
1951 <programlisting><!-- config: tag-style=($ $) --></programlisting>
1954 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
1955 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
1957 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
1958 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
1959 "<filename>.ext</filename>" geeignet zu ersetzen:
1960 "<filename>.tex</filename>" für LaTeX-Vorlagen und
1961 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
1965 <term><filename>bin_list.ext</filename></term>
1968 <para>Lagerliste</para>
1973 <term><filename>check.ext</filename></term>
1981 <term><filename>invoice.ext</filename></term>
1984 <para>Rechnung</para>
1989 <term><filename>packing_list.ext</filename></term>
1992 <para>Packliste</para>
1997 <term><filename>pick_list.ext</filename></term>
2000 <para>Sammelliste</para>
2005 <term><filename>purchase_delivery_order.ext</filename></term>
2008 <para>Lieferschein (Einkauf)</para>
2013 <term><filename>purcharse_order.ext</filename></term>
2016 <para>Bestellung an Lieferanten</para>
2021 <term><filename>request_quotation.ext</filename></term>
2024 <para>Anfrage an Lieferanten</para>
2029 <term><filename>sales_delivery_order.ext</filename></term>
2032 <para>Lieferschein (Verkauf)</para>
2037 <term><filename>sales_order.ext</filename></term>
2040 <para>Bestellung</para>
2045 <term><filename>sales_quotation.ext</filename></term>
2048 <para>Angebot an Kunden</para>
2053 <term><filename>zahlungserinnerung.ext</filename></term>
2056 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2061 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2064 <para>Rechnung über Mahngebühren (Dateiname im Programm
2065 konfigurierbar)</para>
2071 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2072 <title>Sprache, Drucker und E-Mail</title>
2074 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2075 eingearbeitet. So wird aus der Vorlage
2076 <filename>sales_order.ext</filename> bei Sprache
2077 <function>de</function> und Druckerkürzel <function>lpr2</function>
2078 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2079 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2080 bekommen dann noch das Kürzel <filename>_email</filename>, der
2081 vollständige Vorlagenname wäre dann
2082 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2083 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2084 werden. Diese wird verwendet, wenn keine der anderen Varianten
2085 gefunden wird.</para>
2087 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2088 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2089 verschickt wird, ist:</para>
2093 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2097 <para><filename>sales_order_de_lpr2.tex</filename></para>
2101 <para><filename>sales_order.tex</filename></para>
2105 <para><filename>default.tex</filename></para>
2109 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2110 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2112 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2115 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2116 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2119 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2120 xreflabel="Metainformationen zur angeforderten Vorlage">
2121 <title>Metainformationen zur angeforderten Vorlage</title>
2123 <para>Diese Variablen liefern Informationen darüber welche Variante
2124 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2125 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2126 Formulare einbinden möchten.</para>
2130 <term><varname>template_meta.formname</varname></term>
2133 <para>Basisname der Vorlage. Identisch mit der <link
2134 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2135 zu den Dateinamen</link> ohne die Erweiterung. Ein
2136 Verkaufsauftrag enthält hier
2137 <constant>sales_order</constant>.</para>
2142 <term><varname>template_meta.language.description</varname></term>
2145 <para>Beschreibung der verwendeten Sprache</para>
2150 <term><varname>template_meta.language.template_code</varname></term>
2153 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2154 Kürzel das im Dateinamen verwendetet wird.</para>
2159 <term><varname>template_meta.language.output_numberformat</varname></term>
2162 <para>Zahlenformat der verwendeten Sprache in der Form
2163 "<constant>1.000,00</constant>". Experimentell! Nur
2164 interessant für Vorlagen die mit unformatierten Werten
2170 <term><varname>template_meta.language.output_dateformat</varname></term>
2173 <para>Datumsformat der verwendeten Sprache in der Form
2174 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2175 interessant für Vorlagen die mit unformatierten Werten
2181 <term><varname>template_meta.format</varname></term>
2184 <para>Das angeforderte Format. Kann im Moment die Werte
2185 <constant>pdf</constant>, <constant>postscript</constant>,
2186 <constant>html</constant>, <constant>opendocument</constant>,
2187 <constant>opendocument_pdf</constant> und
2188 <constant>excel</constant> enthalten.</para>
2193 <term><varname>template_meta.extension</varname></term>
2196 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2197 <constant>format</constant> entschieden.</para>
2202 <term><varname>template_meta.media</varname></term>
2205 <para>Ausgabemedium. Kann zur Zeit die Werte
2206 <constant>screen</constant> für Bildschirm,
2207 <constant>email</constant> für E-Mmail (triggert das
2208 <constant>_email</constant> Kürzel im Dateinamen),
2209 <constant>printer</constant> für Drucker, und
2210 <constant>queue</constant> für Warteschlange enthalten.</para>
2215 <term><varname>template_meta.printer.description</varname></term>
2218 <para>Beschreibung des ausgewählten Druckers</para>
2223 <term><varname>template_meta.printer.template_code</varname></term>
2226 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2227 dem Kürzel das im Dateinamen verwendetet wird.</para>
2233 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2234 <title>Stammdaten von Kunden und Lieferanten</title>
2238 <term><varname>account_number</varname></term>
2241 <para>Kontonummer</para>
2246 <term><varname>bank</varname></term>
2249 <para>Name der Bank</para>
2254 <term><varname>bank_code</varname></term>
2257 <para>Bankleitzahl</para>
2262 <term><varname>bic</varname></term>
2265 <para>Bank-Identifikations-Code (Bank Identifier Code,
2271 <term><varname>business</varname></term>
2274 <para>Kunden-/Lieferantentyp</para>
2279 <term><varname>city</varname></term>
2287 <term><varname>contact</varname></term>
2290 <para>Kontakt</para>
2295 <term><varname>country</varname></term>
2303 <term><varname>cp_email</varname></term>
2306 <para>Email des Ansprechpartners</para>
2311 <term><varname>cp_givenname</varname></term>
2314 <para>Vorname des Ansprechpartners</para>
2319 <term><varname>cp_greeting</varname></term>
2322 <para>Anrede des Ansprechpartners</para>
2327 <term><varname>cp_name</varname></term>
2330 <para>Name des Ansprechpartners</para>
2335 <term><varname>cp_phone1</varname></term>
2338 <para>Telefonnummer 1 des Ansprechpartners</para>
2343 <term><varname>cp_phone2</varname></term>
2346 <para>Telefonnummer 2 des Ansprechpartners</para>
2351 <term><varname>cp_title</varname></term>
2354 <para>Titel des Ansprechpartners</para>
2359 <term><varname>creditlimit</varname></term>
2362 <para>Kreditlimit</para>
2367 <term><varname>customeremail</varname></term>
2370 <para>Email des Kunden; nur für Kunden</para>
2375 <term><varname>customerfax</varname></term>
2378 <para>Faxnummer des Kunden; nur für Kunden</para>
2383 <term><varname>customernotes</varname></term>
2386 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2391 <term><varname>customernumber</varname></term>
2394 <para>Kundennummer; nur für Kunden</para>
2399 <term><varname>customerphone</varname></term>
2402 <para>Telefonnummer des Kunden; nur für Kunden</para>
2407 <term><varname>discount</varname></term>
2415 <term><varname>email</varname></term>
2418 <para>Emailadresse</para>
2423 <term><varname>fax</varname></term>
2426 <para>Faxnummer</para>
2431 <term><varname>homepage</varname></term>
2434 <para>Homepage</para>
2439 <term><varname>iban</varname></term>
2442 <para>Internationale Kontonummer (International Bank Account
2443 Number, IBAN)</para>
2448 <term><varname>language</varname></term>
2451 <para>Sprache</para>
2456 <term><varname>name</varname></term>
2459 <para>Firmenname</para>
2464 <term><varname>payment_description</varname></term>
2467 <para>Name der Zahlart</para>
2472 <term><varname>payment_terms</varname></term>
2475 <para>Zahlungskonditionen</para>
2480 <term><varname>phone</varname></term>
2483 <para>Telefonnummer</para>
2488 <term><varname>shiptocity</varname></term>
2491 <para>Stadt (Lieferadresse) <link
2492 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2497 <term><varname>shiptocontact</varname></term>
2500 <para>Kontakt (Lieferadresse) <link
2501 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2506 <term><varname>shiptocountry</varname></term>
2509 <para>Land (Lieferadresse) <link
2510 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2515 <term><varname>shiptodepartment1</varname></term>
2518 <para>Abteilung 1 (Lieferadresse) <link
2519 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2524 <term><varname>shiptodepartment2</varname></term>
2527 <para>Abteilung 2 (Lieferadresse) <link
2528 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2533 <term><varname>shiptoemail</varname></term>
2536 <para>Email (Lieferadresse) <link
2537 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2542 <term><varname>shiptofax</varname></term>
2545 <para>Fax (Lieferadresse) <link
2546 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2551 <term><varname>shiptoname</varname></term>
2554 <para>Firmenname (Lieferadresse) <link
2555 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2560 <term><varname>shiptophone</varname></term>
2563 <para>Telefonnummer (Lieferadresse) <link
2564 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2569 <term><varname>shiptostreet</varname></term>
2572 <para>Straße und Hausnummer (Lieferadresse) <link
2573 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2578 <term><varname>shiptozipcode</varname></term>
2581 <para>Postleitzahl (Lieferadresse) <link
2582 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2587 <term><varname>street</varname></term>
2590 <para>Straße und Hausnummer</para>
2595 <term><varname>taxnumber</varname></term>
2598 <para>Steuernummer</para>
2603 <term><varname>ustid</varname></term>
2606 <para>Umsatzsteuer-Identifikationsnummer</para>
2611 <term><varname>vendoremail</varname></term>
2614 <para>Email des Lieferanten; nur für Lieferanten</para>
2619 <term><varname>vendorfax</varname></term>
2622 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2627 <term><varname>vendornotes</varname></term>
2630 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2635 <term><varname>vendornumber</varname></term>
2638 <para>Lieferantennummer; nur für Lieferanten</para>
2643 <term><varname>vendorphone</varname></term>
2646 <para>Telefonnummer des Lieferanten; nur für
2652 <term><varname>zipcode</varname></term>
2655 <para>Postleitzahl</para>
2660 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
2661 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
2662 Stammdaten nicht eingetragen, so haben die Variablen
2663 <varname>shipto*</varname> den gleichen Wert wie die die
2664 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
2665 einige <varname>shipto*</varname>-Variablen so nicht in den
2666 Stammdaten wiederfinden sondern schlicht Kopien der
2667 Lieferdatenvariablen sind (z.B.
2668 <varname>shiptocontact</varname>).</para>
2672 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
2673 <title>Informationen über den Bearbeiter</title>
2677 <term><varname>employee_address</varname></term>
2680 <para>Adressfeld</para>
2685 <term><varname>employee_businessnumber</varname></term>
2688 <para>Firmennummer</para>
2693 <term><varname>employee_company</varname></term>
2696 <para>Firmenname</para>
2701 <term><varname>employee_co_ustid</varname></term>
2704 <para>Usatzsteuer-Identifikationsnummer</para>
2709 <term><varname>employee_duns</varname></term>
2712 <para>DUNS-Nummer</para>
2717 <term><varname>employee_email</varname></term>
2725 <term><varname>employee_fax</varname></term>
2733 <term><varname>employee_name</varname></term>
2736 <para>voller Name</para>
2741 <term><varname>employee_signature</varname></term>
2744 <para>Signatur</para>
2749 <term><varname>employee_taxnumber</varname></term>
2752 <para>Steuernummer</para>
2757 <term><varname>employee_tel</varname></term>
2760 <para>Telefonnummer</para>
2766 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
2767 <title>Informationen über den Bearbeiter</title>
2771 <term><varname>salesman_address</varname></term>
2774 <para>Adressfeld</para>
2779 <term><varname>salesman_businessnumber</varname></term>
2782 <para>Firmennummer</para>
2787 <term><varname>salesman_company</varname></term>
2790 <para>Firmenname</para>
2795 <term><varname>salesman_co_ustid</varname></term>
2798 <para>Usatzsteuer-Identifikationsnummer</para>
2803 <term><varname>salesman_duns</varname></term>
2806 <para>DUNS-Nummer</para>
2811 <term><varname>salesman_email</varname></term>
2819 <term><varname>salesman_fax</varname></term>
2827 <term><varname>salesman_name</varname></term>
2830 <para>voller Name</para>
2835 <term><varname>salesman_signature</varname></term>
2838 <para>Signatur</para>
2843 <term><varname>salesman_taxnumber</varname></term>
2846 <para>Steuernummer</para>
2851 <term><varname>salesman_tel</varname></term>
2854 <para>Telefonnummer</para>
2860 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
2861 <title>Variablen für die einzelnen Steuern</title>
2865 <term><varname>tax</varname></term>
2873 <term><varname>taxbase</varname></term>
2876 <para>zu versteuernder Betrag</para>
2881 <term><varname>taxdescription</varname></term>
2884 <para>Name der Steuer</para>
2889 <term><varname>taxrate</varname></term>
2892 <para>Steuersatz</para>
2899 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
2900 <title>Variablen in Rechnungen</title>
2902 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
2903 <title>Allgemeine Variablen</title>
2907 <term><varname>creditremaining</varname></term>
2910 <para>Verbleibender Kredit</para>
2915 <term><varname>currency</varname></term>
2918 <para>Währung</para>
2923 <term><varname>cusordnumber</varname></term>
2926 <para>Bestellnummer beim Kunden</para>
2931 <term><varname>deliverydate</varname></term>
2934 <para>Lieferdatum</para>
2939 <term><varname>duedate</varname></term>
2942 <para>Fälligkeitsdatum</para>
2947 <term><varname>globalprojectnumber</varname></term>
2950 <para>Projektnummer des ganzen Beleges</para>
2955 <term><varname>globalprojectdescription</varname></term>
2958 <para>Projekbeschreibung des ganzen Beleges</para>
2963 <term><varname>intnotes</varname></term>
2966 <para>Interne Bemerkungen</para>
2971 <term><varname>invdate</varname></term>
2974 <para>Rechnungsdatum</para>
2979 <term><varname>invnumber</varname></term>
2982 <para>Rechnungsnummer</para>
2987 <term><varname>invtotal</varname></term>
2990 <para>gesamter Rechnungsbetrag</para>
2995 <term><varname>notes</varname></term>
2998 <para>Bemerkungen der Rechnung</para>
3003 <term><varname>orddate</varname></term>
3006 <para>Auftragsdatum</para>
3011 <term><varname>ordnumber</varname></term>
3014 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3015 erstellt wurde</para>
3020 <term><varname>payment_description</varname></term>
3023 <para>Name der Zahlart</para>
3028 <term><varname>payment_terms</varname></term>
3031 <para>Zahlungskonditionen</para>
3036 <term><varname>quodate</varname></term>
3039 <para>Angebotsdatum</para>
3044 <term><varname>quonumber</varname></term>
3047 <para>Angebotsnummer</para>
3052 <term><varname>shippingpoint</varname></term>
3055 <para>Versandort</para>
3060 <term><varname>shipvia</varname></term>
3063 <para>Transportmittel</para>
3068 <term><varname>subtotal</varname></term>
3071 <para>Zwischensumme aller Posten ohne Steuern</para>
3076 <term><varname>total</varname></term>
3079 <para>Restsumme der Rechnung (Summe abzüglich bereits
3080 bezahlter Posten)</para>
3085 <term><varname>transaction_description</varname></term>
3088 <para>Vorgangsbezeichnung</para>
3093 <term><varname>transdate</varname></term>
3096 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3097 erstellt wurde</para>
3103 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3104 <title>Variablen für jeden Posten auf der Rechnung</title>
3108 <term><varname>bin</varname></term>
3111 <para>Stellage</para>
3116 <term><varname>description</varname></term>
3119 <para>Artikelbeschreibung</para>
3124 <term><varname>discount</varname></term>
3127 <para>Rabatt als Betrag</para>
3132 <term><varname>discount_sub</varname></term>
3135 <para>Zwischensumme mit Rabatt</para>
3140 <term><varname>drawing</varname></term>
3143 <para>Zeichnung</para>
3148 <term><varname>ean</varname></term>
3151 <para>EAN-Code</para>
3156 <term><varname>image</varname></term>
3164 <term><varname>linetotal</varname></term>
3167 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3172 <term><varname>longdescription</varname></term>
3175 <para>Langtext</para>
3180 <term><varname>microfiche</varname></term>
3183 <para>Mikrofilm</para>
3188 <term><varname>netprice</varname></term>
3191 <para>Nettopreis</para>
3196 <term><varname>nodiscount_linetotal</varname></term>
3199 <para>Zeilensumme ohne Rabatt</para>
3204 <term><varname>nodiscount_sub</varname></term>
3207 <para>Zwischensumme ohne Rabatt</para>
3212 <term><varname>number</varname></term>
3215 <para>Artikelnummer</para>
3220 <term><varname>ordnumber_oe</varname></term>
3223 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3224 aus einem Sammelauftrag erstellt wurde</para>
3229 <term><varname>p_discount</varname></term>
3232 <para>Rabatt in Prozent</para>
3237 <term><varname>partnotes</varname></term>
3240 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3245 <term><varname>partsgroup</varname></term>
3248 <para>Warengruppe</para>
3253 <term><varname>price_factor</varname></term>
3256 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3262 <term><varname>price_factor_name</varname></term>
3265 <para>Der Name des Preisfaktors, sofern einer eingestellt
3271 <term><varname>projectnumber</varname></term>
3274 <para>Projektnummer</para>
3279 <term><varname>projectdescription</varname></term>
3282 <para>Projektbeschreibung</para>
3287 <term><varname>qty</varname></term>
3295 <term><varname>reqdate</varname></term>
3298 <para>Lieferdatum</para>
3303 <term><varname>runningnumber</varname></term>
3306 <para>Position auf der Rechnung (1, 2, 3...)</para>
3311 <term><varname>sellprice</varname></term>
3314 <para>Verkaufspreis</para>
3319 <term><varname>serialnumber</varname></term>
3322 <para>Seriennummer</para>
3327 <term><varname>tax_rate</varname></term>
3330 <para>Steuersatz</para>
3335 <term><varname>transdate_oe</varname></term>
3338 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3339 aus einem Sammelauftrag erstellt wurde</para>
3344 <term><varname>unit</varname></term>
3347 <para>Einheit</para>
3352 <term><varname>weight</varname></term>
3355 <para>Gewicht</para>
3360 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3361 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3362 einer <function>foreach</function>-Schleife ausgegeben werden, da
3363 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3364 können. Die Variablen dafür lauten:</para>
3368 <term><varname>make</varname></term>
3371 <para>Lieferant</para>
3376 <term><varname>model</varname></term>
3379 <para>Lieferantenartikelnummer</para>
3385 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3386 <title>Variablen für die einzelnen Zahlungseingänge</title>
3390 <term><varname>payment</varname></term>
3398 <term><varname>paymentaccount</varname></term>
3406 <term><varname>paymentdate</varname></term>
3414 <term><varname>paymentmemo</varname></term>
3422 <term><varname>paymentsource</varname></term>
3431 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3432 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3434 <para>Die vom Benutzer definierten Variablen für Kunden und
3435 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3436 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3437 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3438 Variablennamen zusammen.</para>
3440 <para>Beispiel: Der Benutzer hat eine Variable namens
3441 <varname>number_of_employees</varname> definiert, die die Anzahl der
3442 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3443 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3448 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3449 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3451 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3452 <title>Namen der Vorlagen</title>
3454 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3455 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3456 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3457 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3458 Vorlagenname für diese Mahnstufe mit dem Zusatz
3459 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3460 für die ausgewählte Sprache und den ausgewählten Drucker
3464 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3465 <title>Allgemeine Variablen in Mahnungen</title>
3467 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3468 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3469 Kunden stehen als Variablen <varname>name</varname>,
3470 <varname>street</varname>, <varname>zipcode</varname>,
3471 <varname>city</varname>, <varname>country</varname>,
3472 <varname>department_1</varname>, <varname>department_2</varname>,
3473 und <varname>email</varname> zur Verfügung.</para>
3475 <para>Weitere Variablen beinhalten:</para>
3479 <term><varname>dunning_date</varname></term>
3482 <para>Datum der Mahnung</para>
3487 <term><varname>dunning_duedate</varname></term>
3490 <para>Fälligkeitsdatum für diese Mahhnung</para>
3495 <term><varname>dunning_id</varname></term>
3498 <para>Mahnungsnummer</para>
3503 <term><varname>fee</varname></term>
3506 <para>Kummulative Mahngebühren</para>
3511 <term><varname>interest_rate</varname></term>
3514 <para>Zinssatz per anno in Prozent</para>
3519 <term><varname>total_amount</varname></term>
3522 <para>Gesamter noch zu zahlender Betrag als
3523 <function>fee</function> + <function>total_interest</function>
3524 + <function>total_open_amount</function></para>
3529 <term><varname>total_interest</varname></term>
3532 <para>Zinsen per anno über alle Rechnungen</para>
3537 <term><varname>total_open_amount</varname></term>
3540 <para>Summe über alle offene Beträge der Rechnungen</para>
3546 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3547 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3551 <term><varname>dn_amount</varname></term>
3554 <para>Rechnungssumme (brutto)</para>
3559 <term><varname>dn_duedate</varname></term>
3562 <para>Originales Fälligkeitsdatum der Rechnung</para>
3567 <term><varname>dn_dunning_date</varname></term>
3570 <para>Datum der Mahnung</para>
3575 <term><varname>dn_dunning_duedate</varname></term>
3578 <para>Fälligkeitsdatum der Mahnung</para>
3583 <term><varname>dn_fee</varname></term>
3586 <para>Kummulative Mahngebühr</para>
3591 <term><varname>dn_interest</varname></term>
3594 <para>Zinsen per anno für diese Rechnung</para>
3599 <term><varname>dn_invnumber</varname></term>
3602 <para>Rechnungsnummer</para>
3607 <term><varname>dn_linetotal</varname></term>
3610 <para>Noch zu zahlender Betrag (ergibt sich aus
3611 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3612 + <varname>dn_interest</varname>)</para>
3617 <term><varname>dn_netamount</varname></term>
3620 <para>Rechnungssumme (netto)</para>
3625 <term><varname>dn_open_amount</varname></term>
3628 <para>Offener Rechnungsbetrag</para>
3633 <term><varname>dn_ordnumber</varname></term>
3636 <para>Bestellnummer</para>
3641 <term><varname>dn_transdate</varname></term>
3644 <para>Rechnungsdatum</para>
3649 <term><varname>dn_curr</varname></term>
3652 <para>Währung, in der die Rechnung erstellt wurde. (Die
3653 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
3659 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
3660 <title>Variablen in automatisch erzeugten Rechnungen über
3661 Mahngebühren</title>
3663 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3664 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3665 Kunden stehen als Variablen <varname>name</varname>,
3666 <varname>street</varname>, <varname>zipcode</varname>,
3667 <varname>city</varname>, <varname>country</varname>,
3668 <varname>department_1</varname>, <varname>department_2</varname>,
3669 und <varname>email</varname> zur Verfügung.</para>
3671 <para>Weitere Variablen beinhalten:</para>
3675 <term><varname>duedate</varname></term>
3678 <para>Fälligkeitsdatum der Rechnung</para>
3683 <term><varname>dunning_id</varname></term>
3686 <para>Mahnungsnummer</para>
3691 <term><varname>fee</varname></term>
3694 <para>Mahngebühren</para>
3699 <term><varname>interest</varname></term>
3707 <term><varname>invamount</varname></term>
3710 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
3711 <varname>interest</varname>)</para>
3716 <term><varname>invdate</varname></term>
3719 <para>Rechnungsdatum</para>
3724 <term><varname>invnumber</varname></term>
3727 <para>Rechnungsnummer</para>
3734 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
3735 <title>Variablen in anderen Vorlagen</title>
3738 <title>Einführung</title>
3740 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
3741 Rechnung. Allerdings heißen die Variablen, die mit
3742 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
3743 fangen sie mit <varname>quo</varname> für "quotation" an:
3744 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
3745 wiederum fangen sie mit <varname>ord</varname> für "order" an:
3746 <varname>ordnumber</varname> für Bestellnummer etc.</para>
3748 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
3749 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
3750 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
3751 Vorlage keine Bedeutung haben oder noch nicht belegt sein
3754 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
3755 in Rechnungen aufgeführt.</para>
3758 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
3759 <title>Angebote und Preisanfragen</title>
3763 <term><varname>quonumber</varname></term>
3766 <para>Angebots- bzw. Anfragenummer</para>
3771 <term><varname>reqdate</varname></term>
3774 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
3775 Preisanfragen)</para>
3780 <term><varname>transdate</varname></term>
3783 <para>Angebots- bzw. Anfragedatum</para>
3789 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
3790 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
3794 <term><varname>ordnumber</varname></term>
3797 <para>Auftragsnummer</para>
3802 <term><varname>reqdate</varname></term>
3805 <para>Lieferdatum</para>
3810 <term><varname>transdate</varname></term>
3813 <para>Auftragsdatum</para>
3819 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
3820 <title>Lieferscheine (Verkauf und Einkauf)</title>
3824 <term><varname>cusordnumber</varname></term>
3827 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
3828 des Lieferanten (im Einkauf)</para>
3833 <term><varname>donumber</varname></term>
3836 <para>Lieferscheinnummer</para>
3841 <term><varname>transdate</varname></term>
3844 <para>Lieferscheindatum</para>
3849 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
3850 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
3851 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
3852 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
3853 <function>foreach</function>-Schleife ausgegeben werden. Diese
3854 Variablen sind:</para>
3858 <term><varname>si_bin</varname></term>
3861 <para>Lagerplatz</para>
3866 <term><varname>si_chargenumber</varname></term>
3869 <para>Chargennummer</para>
3874 <term><varname>si_bestbefore</varname></term>
3877 <para>Mindesthaltbarkeit</para>
3882 <term><varname>si_number</varname></term>
3885 <para>Artikelnummer</para>
3890 <term><varname>si_qty</varname></term>
3893 <para>Anzahl bzw. Menge</para>
3898 <term><varname>si_runningnumber</varname></term>
3901 <para>Positionsnummer (1, 2, 3 etc)</para>
3906 <term><varname>si_unit</varname></term>
3909 <para>Einheit</para>
3914 <term><varname>si_warehouse</varname></term>
3923 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
3924 <title>Variablen für Sammelrechnung</title>
3928 <term><varname>c0total</varname></term>
3931 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
3937 <term><varname>c30total</varname></term>
3940 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
3941 und < 60 Tage</para>
3946 <term><varname>c60total</varname></term>
3949 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
3950 und < 90 Tage</para>
3955 <term><varname>c90total</varname></term>
3958 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
3964 <term><varname>total</varname></term>
3967 <para>Gesamtbetrag aller Rechnungen</para>
3972 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
3976 <term><varname>invnumber</varname></term>
3979 <para>Rechnungsnummer</para>
3984 <term><varname>invdate</varname></term>
3987 <para>Rechnungsdatum</para>
3992 <term><varname>duedate</varname></term>
3995 <para>Fälligkeitsdatum</para>
4000 <term><varname>amount</varname></term>
4003 <para>Summe der Rechnung</para>
4008 <term><varname>open</varname></term>
4011 <para>Noch offener Betrag der Rechnung</para>
4016 <term><varname>c0</varname></term>
4019 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4025 <term><varname>c30</varname></term>
4028 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4034 <term><varname>c60</varname></term>
4037 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4043 <term><varname>c90</varname></term>
4046 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4054 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4055 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4057 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4058 <title>Einfürhung</title>
4060 <para>Der Parser kennt neben den Variablen einige weitere
4061 Konstrukte, die gesondert behandelt werden. Diese sind wie
4062 Variablennamen in spezieller Weise markiert:
4063 <command><%anweisung%> ... <%end%></command></para>
4065 <para>Anmerkung zum <command><%end%></command>: Der besseren
4066 Verständlichkeit halber kann man nach dem <command>end</command>
4067 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4068 Anweisung (z.B. <command>if</command> oder
4069 <command>foreach</command>) damit abgeschlossen wird.</para>
4071 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4072 <command><%if type == "sales_quotation"%></command>, so könnte
4073 er mit <command><%end%></command> genauso abgeschlossen werden
4074 wie mit <command><%end if%></command> oder auch
4075 <command><%end type == "sales_quotation"%></command>.</para>
4078 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4079 <title>Der if-Block</title>
4081 <programlisting><%if variablenname%>
4083 <%end%></programlisting>
4085 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4086 und dem "end" werden nur ausgegeben, wenn die Variable
4087 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4089 <para>Die Bedingung kann auch negiert werden, indem das Wort
4090 <function>not</function> nach dem <filename>if</filename> verwendet
4091 wird. Beispiel:</para>
4093 <programlisting><%if not cp_greeting%>
4095 <%end%></programlisting>
4097 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4098 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4099 einer Variablen mit einer festen Zeichenkette oder einer anderen
4100 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4101 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4102 die rechte Seite des Vergleichsoperators in Anführungszeichen
4103 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4104 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4107 <programlisting><%if var1 == "Wert"%></programlisting>
4109 <para>Testet die Variable <varname>var1</varname> auf
4110 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4111 Mittels <function>!=</function> anstelle von <function>==</function>
4112 würde auf Ungleichheit getestet.</para>
4114 <programlisting>%if var1 == var2%></programlisting>
4116 <para>Testet die Variable <varname>var1</varname> auf
4117 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4118 <function>!=</function> anstelle von <function>==</function> würde
4119 auf Ungleichheit getestet.</para>
4121 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4122 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4123 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4124 dieselbe Syntax wie oben nur mit <function>=~</function> und
4125 <function>!~</function> als Vergleichsoperatoren.</para>
4127 <para>Beispiel für einen Test, ob die Variable
4128 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4129 <constant>schwierig</constant> enthält:</para>
4131 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4134 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4135 <title>Der foreach-Block</title>
4137 <programlisting><%foreach variablenname%>
4139 <%end%></programlisting>
4141 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4142 wie das Perl-Array der Variablen <varname>variablenname</varname>
4143 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4144 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4145 benutzt. In jedem Durchlauf werden die <link
4146 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4147 Variablen</link> jeweils auf den Wert für die aktuelle Position
4150 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4152 <programlisting><%foreach number%>
4153 Position: <%runningnumber%>
4154 Anzahl: <%qty%>
4155 Artikelnummer: <%number%>
4156 Beschreibung: <%description%>
4158 <%end%></programlisting>
4160 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4161 <function><%foreach%></function>-Block innerhalb einer
4162 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4163 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4164 Inhalt zwischen <function><%foreach%></function> und
4165 <function><%end%></function> wiederholt, nicht aber die
4166 komplette Zeile, in der er steht.</para>
4170 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4171 <title>Markup-Code zur Textformatierung innerhalb von
4174 <para>Wenn der Benutzer innhalb von Formularen in Lx-Office Text
4175 anders formatiert haben möchte, so ist dies begrenzt möglich.
4176 Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4177 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4178 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4179 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4180 (HTML oder PDF über LaTeX) umgesetzt.</para>
4182 <para>Die unterstützen Formatierungen sind:</para>
4186 <term><b>Text</b></term>
4189 <para>Text wird in Fettdruck gesetzt.</para>
4194 <term><i>Text</i></term>
4197 <para>Text wird kursiv gesetzt.</para>
4202 <term><u>Text</u></term>
4205 <para>Text wird unterstrichen.</para>
4210 <term><s>Text</s></term>
4213 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4214 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4219 <term><bullet></term>
4222 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4228 <para>Der Befehl <command><bullet></command> funktioniert
4229 momentan auch nur in Latex-Vorlagen.</para>
4233 <sect1 id="excel-templates">
4234 <title>Excel-Vorlagen</title>
4236 <sect2 id="excel-templates.summary">
4237 <title>Zusammenfassung</title>
4239 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4240 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4244 <sect2 id="excel-templates.usage">
4245 <title>Bedienung</title>
4247 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4248 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4249 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4251 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4252 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4253 werden. In den normalen Verkaufsmasken taucht nun
4254 <constant>Excel</constant> als auswählbares Format auf und kann von da
4255 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4257 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4258 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4259 <filename>sales_quotation.xls</filename> gespeichert.</para>
4262 <sect2 id="excel-templates.syntax">
4263 <title>Variablensyntax</title>
4265 <para>Einfache Syntax:
4266 <command><<varname>></command></para>
4268 <para>Dabei sind <constant><<</constant> und
4269 <constant>>></constant> die Delimiter. Da Excel auf festen
4270 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4271 weitere <constant><</constant> oder <constant>></constant>
4272 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4275 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4277 <para>Um die Limitierung der festen Breite zu reduzieren, können
4278 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4279 dazwishen dann erhalten. Beispiel:</para>
4281 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4283 <para>Die Variablen werden interpoliert, und linksbündig mit
4284 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4285 lang, werden überzählige Zeichen abgeschnitten.</para>
4287 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4288 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4290 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4292 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4293 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4297 <sect2 id="excel-templates.limitations">
4298 <title>Einschränkungen</title>
4300 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4301 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4302 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4303 Text zu ersetzen.</para>
4305 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4306 <command><%if%></command> und
4307 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4308 <constant><% %></constant> kommt in den Headerinformationen
4309 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4310 <constant><<</constant> und <constant>>></constant>
4317 <title>Entwicklerdokumentation</title>
4319 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4320 <title>Globale Variablen</title>
4323 <title>Wie sehen globale Variablen in Perl aus?</title>
4325 <para>Globale Variablen liegen in einem speziellen namespace namens
4326 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4327 globs global und die meisten speziellen Variablen sind...
4330 <para>Daraus ergeben sich folgende Formen:</para>
4334 <term><literal>$main::form</literal></term>
4337 <para>expliziter Namespace "main"</para>
4342 <term><literal>$::form</literal></term>
4345 <para>impliziter Namespace "main"</para>
4350 <term><literal>open FILE, "file.txt"</literal></term>
4353 <para><varname>FILE</varname> ist global</para>
4358 <term><literal>$_</literal></term>
4361 <para>speziell</para>
4366 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4367 Schlüsselwort wie "<function>global</function>", mit dem man
4368 importieren kann. <function>my</function>, <function>our</function>
4369 und <function>local</function> machen was anderes.</para>
4373 <term><literal>my $form</literal></term>
4376 <para>lexikalische Variable, gültig bis zum Ende des
4382 <term><literal>our $form</literal></term>
4385 <para><varname>$form</varname> referenziert ab hier
4386 <varname>$PACKAGE::form</varname>.</para>
4391 <term><literal>local $form</literal></term>
4394 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4395 des scopes zurückgesetzt</para>
4402 <title>Warum sind globale Variablen ein Problem?</title>
4404 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4406 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4407 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4408 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4409 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4410 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4411 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4414 <para>Das zweite Problem ist <function>strict</function>. Unter
4415 <function>strict</function> werden alle Variablen die nicht explizit
4416 mit <function>Package</function>, <function>my</function> oder
4417 <function>our</function> angegeben werden als Tippfehler angemarkert,
4418 dies hat, seit der Einführung, u.a. schon so manche langwierige
4419 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4420 angegeben werden, werden die nicht geprüft, und somit kann sich
4421 schnell ein Tippfehler einschleichen.</para>
4425 <title>Kanonische globale Variablen</title>
4427 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4428 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4429 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4430 umhergereicht werden.</para>
4432 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4436 <para><varname>$::form</varname></para>
4440 <para><varname>%::myconfig</varname></para>
4444 <para><varname>$::locale</varname></para>
4448 <para><varname>$::lxdebug</varname></para>
4452 <para><varname>$::auth</varname></para>
4456 <para><varname>$::lx_office_conf</varname></para>
4460 <para><varname>$::instance_conf</varname></para>
4464 <para><varname>$::dispatcher</varname></para>
4468 <para><varname>$::request</varname></para>
4472 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4473 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4474 Eigenschaften (Konventionen):</para>
4477 <title>$::form</title>
4481 <para>Ist ein Objekt der Klasse
4482 "<classname>Form</classname>"</para>
4486 <para>Wird nach jedem Request gelöscht</para>
4490 <para>Muss auch in Tests und Konsolenscripts vorhanden
4495 <para>Enthält am Anfang eines Requests die Requestparameter vom
4500 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4501 cachen, das wird aber momentan absichtlich zerstört</para>
4505 <para><varname>$::form</varname> wurde unter <productname>SQL
4506 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4507 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4508 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4509 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4510 <function>IS->retrieve_customer()</function> in Sicherheit
4513 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4514 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4515 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4516 richtigen Wert zu setzen:</para>
4518 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4519 $::myconfig{numberformat} = $numberformat;
4520 # (...) div Berechnungen
4521 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4523 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4524 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4525 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4526 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4527 Es geht ziemlich sicher etwas kaputt.</para>
4529 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4530 in den <productname>Template::Toolkit</productname> Templates
4531 außerhalb der Controller: der Ausdruck <function>[% var
4532 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4533 Unter Controllern ist der Standard Scope anders, da lautet der
4534 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4535 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4536 <function><%var%></function> zeigt auf
4537 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4538 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4541 <programlisting>[%- IF business %]
4542 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4543 [%- END %]</programlisting>
4545 <para>Entweder wird hier dann $::form->{business} ausgewertet
4546 oder aber der Funktion
4547 <function>$form->parse_html_template</function> wird explizit
4548 noch ein zusätzlicher Hash übergeben, der dann auch in den
4549 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4551 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4553 <para>Innerhalb von Schleifen wird
4554 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4555 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4556 welches über alle Positionen eines Lieferscheins in Schleife
4559 <programlisting>for $i (1 .. $form->{rowcount}) {
4561 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4562 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4563 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4569 <title>%::myconfig</title>
4573 <para>Das einzige Hash unter den globalen Variablen</para>
4577 <para>Wird spätestens benötigt wenn auf die Datenbank
4578 zugegriffen wird</para>
4582 <para>Wird bei jedem Request neu erstellt.</para>
4586 <para>Enthält die Userdaten des aktuellen Logins</para>
4590 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4591 extern serialisiert werden, weil da auch der Datenbankzugriff
4592 für diesen user drinsteht.</para>
4596 <para>Enthält unter anderem Listenbegrenzung vclimit,
4597 Datumsformat dateformat und Nummernformat numberformat</para>
4601 <para>Enthält Datenbankzugriffinformationen</para>
4605 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4606 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4607 aktuellen Users entscheiden müssen, befragen
4608 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4609 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4610 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4611 Informationen über den Benutzer die über die
4612 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
4616 <title>$::locale</title>
4620 <para>Objekt der Klasse "Locale"</para>
4624 <para>Wird pro Request erstellt</para>
4628 <para>Muss auch für Tests und Scripte immer verfügbar
4633 <para>Cached intern über Requestgrenzen hinweg benutzte
4638 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4639 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
4643 <title>$::lxdebug</title>
4647 <para>Objekt der Klasse "LXDebug"</para>
4651 <para>Wird global gecached</para>
4655 <para>Muss immer verfügbar sein, in nahezu allen
4660 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
4661 bereit, wie "<function>enter_sub</function>" und
4662 "<function>leave_sub</function>", mit denen in den alten Modulen ein
4663 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
4664 der man die Wallclockzeit seit Requeststart loggen kann, sowie
4665 "<function>message</function>" und "<function>dump</function>" mit
4666 denen man flott Informationen ins Log (tmp/lx-office-debug.log)
4669 <para>Beispielsweise so:</para>
4671 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
4672 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
4676 <title>$::auth</title>
4680 <para>Objekt der Klasse "SL::Auth"</para>
4684 <para>Wird global gecached</para>
4688 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
4692 <para>Wird nach jedem Request resettet.</para>
4696 <para><varname>$::auth</varname> stellt Funktionen bereit um die
4697 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
4698 vom aktuellen User abhängen wird das Objekt aus
4699 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
4700 Request kurz resettet.</para>
4704 <title>$::lx_office_conf</title>
4708 <para>Objekt der Klasse
4709 "<classname>SL::LxOfficeConf</classname>"</para>
4713 <para>Global gecached</para>
4717 <para>Repräsentation der
4718 <filename>config/lx_office.conf[.default]</filename>-Dateien</para>
4722 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
4723 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
4724 das Programm die Konfiguration ändern kann oder sollte.</para>
4726 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
4727 Debug- und Trace-Log-Datei wie folgt konfiguriert und
4730 <programlisting>[debug]
4731 file = /tmp/lx-office-debug.log</programlisting>
4733 <para>ist der Key <varname>file</varname> im Programm als
4734 <varname>$::lx_office_conf->{debug}{file}</varname>
4738 <para>Zugriff auf die Konfiguration erfolgt im Moment über
4739 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
4744 <title>$::instance_conf</title>
4748 <para>Objekt der Klasse
4749 "<classname>SL::InstanceConfiguration</classname>"</para>
4753 <para>wird pro Request neu erstellt</para>
4757 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
4758 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
4759 ist hier eine Mandantendatenbank. Beispielsweise überprüft
4760 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
4761 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
4765 <title>$::dispatcher</title>
4769 <para>Objekt der Klasse
4770 "<varname>SL::Dispatcher</varname>"</para>
4774 <para>wird pro Serverprozess erstellt.</para>
4778 <para>enthält Informationen über die technische Verbindung zum
4783 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
4784 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
4785 Objekt untergebracht.</para>
4789 <title>$::request</title>
4793 <para>Hashref (evtl später Objekt)</para>
4797 <para>Wird pro Request neu initialisiert.</para>
4801 <para>Keine Unterstruktur garantiert.</para>
4805 <para><varname>$::request</varname> ist ein generischer Platz um
4806 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
4807 at a distance benutzt werden, sondern um lokales memoizing zu
4808 ermöglichen, das garantiert am Ende des Requests zerstört
4811 <para>Vieles von dem, was im moment in <varname>$::form</varname>
4812 liegt, sollte eigentlich hier liegen. Die groben
4813 Differentialkriterien sind:</para>
4817 <para>Kommt es vom User, und soll unverändert wieder an den
4818 User? Dann <varname>$::form</varname>, steht da eh schon</para>
4822 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
4823 Requests gebraucht werden? Dann
4824 <varname>$::request</varname></para>
4828 <para>Muss ich von anderen Teilen des Programms lesend drauf
4829 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
4830 Wrappermethode</para>
4837 <title>Ehemalige globale Variablen</title>
4839 <para>Die folgenden Variablen waren einmal im Programm, und wurden
4843 <title>$::cgi</title>
4847 <para>war nötig, weil cookie Methoden nicht als
4848 Klassenfunktionen funktionieren</para>
4852 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
4853 Klassennamespace gehalten wird und über Requestgrenzen
4858 <para>liegt jetzt unter
4859 <varname>$::request->{cgi}</varname></para>
4865 <title>$::all_units</title>
4869 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
4870 ein paar hundert mal pro Request eine Liste der Einheiten
4871 brauchen, und de als Parameter durch einen Riesenstack von
4872 Funktionen geschleift werden müssten.</para>
4876 <para>Liegt jetzt unter
4877 <varname>$::request->{cache}{all_units}</varname></para>
4882 <function>AM->retrieve_all_units()</function> gesetzt oder
4889 <title>%::called_subs</title>
4893 <para>wurde benutzt um callsub deep recursions
4898 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
4899 möglichen Rekursioenen darstellt, und da nie welche
4904 <para>komplette recursion protection wurde entfernt.</para>
4911 <sect1 id="devel.fcgi">
4912 <title>Entwicklung unter FastCGI</title>
4914 <sect2 id="devel.fcgi.general">
4915 <title>Allgemeines</title>
4917 <para>Wenn Änderungen in der Konfiguration von Lx-Office gemacht
4918 werden, muss der Webserver neu gestartet werden.</para>
4920 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
4921 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
4922 müssen folgende Aspekte beachtet werden.</para>
4925 <sect2 id="devel.fcgi.exiting">
4926 <title>Programmende und Ausnahmen</title>
4928 <para>Betrifft die Funktionen <function>warn</function>,
4929 <function>die</function>, <function>exit</function>,
4930 <function>carp</function> und <function>confess</function>.</para>
4932 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
4933 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
4934 am Laufen zu halten. Man kann mit <function>die</function>,
4935 <function>confess</function> oder <function>carp</function> Fehler
4936 ausgeben, die dann vom Dispatcher angezeigt werden. Die Lx-Office
4937 eigene <function>$::form-</function>error()> tut im Prinzip das
4938 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
4939 <function>exit</function> hingegen werden nicht abgefangen.
4940 <function>warn</function> wird direkt nach STDERR, also in Server Log
4941 eine Nachricht schreiben (sofern in der Konfiguration nicht die
4942 Warnungen in das Lx-Office Log umgeleitet wurden), und
4943 <function>exit</function> wird die Ausführung beenden.</para>
4945 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
4946 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
4947 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
4948 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
4951 <sect2 id="devel.fcgi.globals">
4952 <title>Globale Variablen</title>
4954 <para>Um zu vermeiden, dass Informationen von einem Request in einen
4955 anderen gelangen, müssen alle globalen Variablen vor einem Request
4956 sauber initialisiert werden. Das ist besonders wichtig im
4957 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
4958 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
4961 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
4962 abgetrennten Block, der alle kanonischen globalen Variablen listet und
4963 erklärt. Bitte keine anderen einführen ohne das sauber zu
4964 dokumentieren.</para>
4966 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
4967 man sicher geht, dass man die richtige erwischt.</para>
4970 <sect2 id="devel.fcgi.performance">
4971 <title>Performance und Statistiken</title>
4973 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
4974 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
4975 Rechnungsmaske in Lx-Office 2.4.3 stable dauert auf einem Core2duo mit
4976 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
4977 sind es je nach Menge der definierten Variablen 1-2s. Ab der
4978 Moose/Rose::DB Version sind es 5-6s.</para>
4980 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
4981 den kritischen Pfaden, unter 0,15 sonst.</para>
4984 <sect2 id="devel.fcgi.known-issues">
4985 <title>Bekannte Probleme</title>
4987 <sect3 id="devel.fcgi.known-issues.encoding">
4988 <title>Encoding Awareness</title>
4990 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
4991 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
4992 falsch kodierte Zeichen eher unwissend, und geben sie einfach
4993 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
4994 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
5000 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5001 <title>SQL-Upgradedateien</title>
5003 <sect2 id="db-upgrade-files.introduction"
5004 xreflabel="Einführung in die Datenbank-Upgradedateien">
5005 <title>Einführung</title>
5007 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5008 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5009 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5010 Entwicklung im stable- und unstable-Baum betrifft.</para>
5012 <para>Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert.
5013 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5014 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5015 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5016 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5017 Kontrollinformationen enthält.</para>
5019 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5020 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5021 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5022 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5023 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5024 keine Versionsnummern mehr braucht.</para>
5026 <para>Lx-Office merkt sich dabei, welches der Upgradescripte in
5027 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5028 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5029 Anmeldung automatisch angelegt wird.</para>
5032 <sect2 id="db-upgrade-files.format"
5033 xreflabel="Format der Upgradedateien">
5034 <title>Format der Kontrollinformationen</title>
5036 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5037 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5038 hat dabei das folgende Format:</para>
5040 <para>Für SQL-Upgradedateien:</para>
5042 <programlisting>-- @key: value</programlisting>
5044 <para>Für Perl-Upgradedateien:</para>
5046 <programlisting># @key: value</programlisting>
5048 <para>Leerzeichen vor "<varname>value</varname>" werden
5051 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5055 <term><varname>tag</varname></term>
5058 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5059 Dieser "tag" kann von anderen Kontrolldateien in ihren
5060 Abhängigkeiten verwendet werden (Schlüsselwort
5061 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5062 in der Datenbank eingetragen wird.</para>
5064 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5065 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5067 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5068 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5069 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5075 <term><varname>charset</varname></term>
5078 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5079 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5080 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5081 Abwesenheit des Tags der Zeichensatz
5082 "<literal>ISO-8859-15</literal>" angenommen.</para>
5087 <term><varname>description</varname></term>
5090 <para>Benötigt. Eine Beschreibung, was in diesem Update
5091 passiert. Diese wird dem Benutzer beim eigentlichen
5092 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5093 sein sollte, sollte die Beschreibung auf Deutsch
5099 <term><varname>depends</varname></term>
5102 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5103 von denen dieses Upgradescript abhängt. Lx-Office stellt sicher,
5104 dass die in dieser Liste aufgeführten Scripte bereits
5105 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5107 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5108 Script "b" existiert, das von Änderungen in "a" abhängt, und
5109 eine neue Kontrolldatei für "c" erstellt wird, die von
5110 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5111 Tag "b" als Abhängigkeit zu definieren.</para>
5113 <para>Es ist nicht erlaubt, sich selbst referenzierende
5114 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5115 und "c" -> "a").</para>
5120 <term><varname>priority</varname></term>
5123 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5124 der Scripte ausgeführt werden, die die gleichen
5125 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5126 der Wert 1000 benutzt.</para>
5128 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5129 "depends" benutzt werden. Lx-Office sortiert die auszuführenden
5130 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5131 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5132 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5133 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5134 Priorität alphabetisch nach dem "tag".</para>
5139 <term><varname>ignore</varname></term>
5142 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5143 Skript bei der Anmeldung ignoriert und entsprechend nicht
5150 <sect2 id="db-upgrade-files.dbupgrade-tool"
5151 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5152 <title>Hilfsscript dbupgrade2_tool.pl</title>
5154 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5155 existiert ein Hilfsscript namens
5156 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5157 Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5158 liest alle Datenbankupgradescripte aus dem Verzeichnis
5159 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5160 gleichen Methoden wie Lx-Office selber, sodass alle Fehlersituationen
5161 von der Kommandozeile überprüft werden können.</para>
5163 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5164 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5165 sich aber auch Informationen auf verschiedene Art ausgeben
5170 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5171 --list</command>"</para>
5173 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5174 Reihenfolge sortiert, in der Lx-Office die Scripte ausführen
5175 würde. Es werden neben der Listenposition der Tag, die
5176 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5180 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5181 --tree</command>"</para>
5183 <para>Listet alle Tags in Baumform basierend auf den
5184 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5185 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5186 beim übergeordneten Script als Abhängigkeit eingetragen
5190 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5191 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5192 --rtree</command>"</para>
5194 <para>Listet alle Tags in Baumform basierend auf den
5195 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5196 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5197 die das übergeordnete Script als Abhängigkeit eingetragen
5202 <para>Baumform mit Postscriptausgabe:
5203 "<command>./scripts/dbupgrade2_tool.pl
5204 --graphviz</command>"</para>
5206 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5207 seiner Hilfe die <link
5208 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5209 Baumform</link> in eine Postscriptdatei namens
5210 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5211 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5212 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5213 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5218 <para>Scripte, von denen kein anderes Script abhängt:
5219 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5221 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5222 Scripte abhängen.</para>
5228 <sect1 id="translations-languages" xreflabel="Translations and languages">
5229 <title>Translations and languages</title>
5231 <sect2 id="translations-languages.introduction"
5232 xreflabel="Introduction to translations and languages">
5233 <title>Introduction</title>
5236 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5237 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5240 <para>This section describes how localization packages in Lx-Office
5241 are built. Currently the only language fully supported is German, and
5242 since most of the internal messages are held in English the English
5243 version is usable too.</para>
5245 <para>A stub version of French is included but not functunal at this
5249 <sect2 id="translations-languages.file-structure"
5250 xreflabel="File structure">
5251 <title>File structure</title>
5253 <para>The structure of locales in Lx-Office is:</para>
5255 <programlisting>lx-office/locale/<langcode>/</programlisting>
5257 <para>where <langcode> stands for an abbreviation of the
5258 language package. The builtin packages use two letter <ulink
5259 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5260 but the actual name is not relevant for the program and can easily be
5262 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5263 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5264 from SQL Ledger are named in this way.</para>
5266 <para>In such a language directory the following files are
5271 <term>LANGUAGE</term>
5274 <para>This file is mandatory.</para>
5276 <para>The <filename>LANGUAGE</filename> file contains the self
5277 descripted name of the language. It should contain a native
5278 representation first, and in parenthesis an english translation
5279 after that. Example:</para>
5281 <programlisting>Deutsch (German)</programlisting>
5286 <term>charset</term>
5289 <para>This file should be present.</para>
5291 <para>The <filename>charset</filename> file describes which
5292 charset a language package is written in and applies to all
5293 other language files in the package. It is possible to write
5294 some language packages without an explicit charset, but it is
5295 still strongly recommended. You'll never know in what
5296 environment your language package will be used, and neither
5297 UTF-8 nor Latin1 are guaranteed.</para>
5299 <para>The whole content of this file is a string that can be
5300 recognized as a valid charset encoding. Example:</para>
5302 <programlisting>UTF-8</programlisting>
5310 <para>This file is mandatory.</para>
5312 <para>The central translation file. It is essentially an inline
5313 Perl script autogenerated by <command>locales.pl</command>. To
5314 generate it, generate the directory and the two files mentioned
5315 above, and execute the following command:</para>
5317 <programlisting>scripts/locales.pl <langcode></programlisting>
5319 <para>Otherwise you can simply copy one of the other languages.
5320 You will be told how many are missing like this:</para>
5322 <programlisting>$ scripts/locales.pl en
5323 English - 0.6% - 2015/2028 missing</programlisting>
5325 <para>A file named "<filename>missing</filename>" will be
5326 generated and can be edited. You can also edit the
5327 "<filename>all</filename>" file directly. Edit everything you
5328 like to fit the target language and execute
5329 <command>locales.pl</command> again. See how the missing words
5335 <term>Num2text</term>
5338 <para>Legacy code from SQL Ledger. It provides a means for
5339 numbers to be converted into natural language, like
5340 <literal>1523 => one thousand five hundred twenty
5341 three</literal>. If you want to provide it, it must be inlinable
5342 Perl code which provides a <function>num2text</function> sub. If
5343 an <function>init</function> sub exists it will be executed
5346 <para>Only used in the check and receipt printing module.</para>
5351 <term>special_chars</term>
5354 <para>Lx-Office comes with a lot of interfaces to different
5355 formats, some of which are rather picky with their accepted
5356 charset. The <filename>special_chars</filename> file contains a
5357 listing of chars not suited for different file format and
5358 provides substitutions. It is written in "Simple Ini" style,
5359 containing a block for every file format.</para>
5361 <para>First entry should be the order of substitution for
5362 entries as a whitespace separated list. All entries are
5363 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5364 and <literal>\\</literal> all work.</para>
5366 <para>After that every entry is a special char that should be
5367 translated when writing text into such a file.</para>
5369 <para>Example:</para>
5371 <programlisting>[Template/XML]
5372 order=& < > \n
5376 \n=<br></programlisting>
5378 <para>Note the importance of the order in this example.
5379 Substituting < and > befor & would lead to $gt; become
5382 <para>For a list of valid formats, see the German
5383 <filename>special_chars</filename> entry. As of this writing the
5384 following are recognized:</para>
5386 <programlisting>HTML
5391 Template/OpenDocument
5392 filenames</programlisting>
5394 <para>The last of which is very machine dependant. Remember that
5395 a lot of characters are forbidden by some filesystems, for
5396 exmaple MS Windows doesn't like ':' in its files where Linux
5397 doesn't mind that. If you want the files created with your
5398 language pack to be portable, find all chars that could cause
5404 <term>missing</term>
5407 <para>This file is not a part of the language package
5410 <para>This is a file generated by
5411 <command>scripts/locales.pl</command> while processing your
5412 locales. It's only to have the missing entries singled out and
5413 does not belong to a language package.</para>
5421 <para>This file is not a part of the language package
5424 <para>Another file generated by
5425 <command>scripts/locales.pl</command>. If for any reason a
5426 translation does not appear anymore and can be deleted, it gets
5427 moved here. The last 50 or so entries deleted are saved here in
5428 case you made a typo, so that you don't have to translate
5429 everything again. If a tranlsation is missing, the lost file is
5430 checked first. If you maintain a language package, you might
5431 want to keep this safe somewhere.</para>
5438 <sect1 id="devel.style-guide">
5439 <title>Stil-Richtlinien</title>
5441 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5442 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5443 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5444 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5446 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5449 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5450 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5455 <para>Es werden keine echten Tabs sondern Leerzeichen
5460 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5462 <programlisting>foreach my $row (@data) {
5464 # do something with $row
5468 $row->{modules} = MODULE->retrieve(
5469 id => $row->{id},
5470 date => $use_now ? localtime() : $row->{time},
5474 $report->add($row);
5479 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
5480 Zeile wie der letzte Befehl. Beispiele:</para>
5482 <programlisting>sub debug {
5488 <programlisting>if ($form->{item_rows} > 0) {
5494 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
5495 der Befehl / die öffnende schließende Klammer, die den Block
5496 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
5497 Beispiele wie bei 3. gelten.</para>
5501 <para>Die Wörter "<function>else</function>",
5502 "<function>elsif</function>", "<function>while</function>" befinden
5503 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
5506 <programlisting>if ($form->{sum} > 1000) {
5508 } elsif ($form->{sum} > 0) {
5516 } until ($a > 0);</programlisting>
5520 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
5521 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
5522 und grep-ähnliche Operatoren. Beispiel:</para>
5524 <programlisting>$main::lxdebug->message("Could not find file.");
5525 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
5529 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
5531 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
5532 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
5533 Blöcke schon. Beispiel:</para>
5535 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
5540 $form->{sum} += $form->{"row_$i"};
5541 $form->{ $form->{index} } += 1;
5543 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
5547 <para>Mehrzeilige Befehle</para>
5551 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
5552 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
5553 werden, in der die ersten Funktionsparameter in der ersten Zeile
5554 stehen. Beispiel:</para>
5556 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
5557 $form->{some_col_value});</programlisting>
5561 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
5562 besten in einer übersichtlichen Tabellenstruktur organisiert
5563 wird. Beispiel:</para>
5565 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
5566 : $form->{oldcount} ? $form->{oldcount} + 1
5567 : $form->{rowcount} - $form->{rowbase};</programlisting>
5573 <para>Kommentare</para>
5577 <para>Kommentare, die alleine in einer Zeile stehen, sollten
5578 soweit wie der Code eingerückt sein.</para>
5582 <para>Seitliche hängende Kommentare sollten einheitlich
5583 formatiert werden.</para>
5587 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
5588 auf Englisch zu verfassen. So wie ich keine Lust habe,
5589 französischen Quelltext zu lesen, sollte auch der Lx-Office
5590 Quelltext für nicht-Deutschsprachige lesbar sein.
5593 <programlisting>my $found = 0;
5601 $i = 0 # initialize $i
5603 $i *= $const; # do something crazy
5604 $i = $n; # recover $i</programlisting>
5610 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
5611 Interpolation gewünscht ist. Beispiel:</para>
5613 <programlisting>$form->{sum} = 0;
5614 $form->{"row_$i"} = $form->{"row_$i"} - 5;
5615 $some_hash{42} = 54;</programlisting>
5619 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
5620 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
5621 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
5622 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
5624 <para>Als Beispiel sei die Funktion
5625 <function>print_options</function> aus
5626 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
5630 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
5631 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
5634 <para>Emacs und vim haben beide recht einfache Methoden zur
5635 Entfernung von trailing whitespace. Emacs kennt das Kommande
5636 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
5637 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
5638 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
5643 <para>Es wird kein <command>perltidy</command> verwendet.</para>
5645 <para>In der Vergangenheit wurde versucht,
5646 <command>perltidy</command> zu verwenden, um einen einheitlichen
5647 Stil zu erlangen. Es hat sich aber gezeigt, dass
5648 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
5649 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
5650 den Interessierten sind hier die
5651 <command>perltidy</command>-Optionen, die grob den beschriebenen
5652 Richtlinien entsprechen:</para>
5654 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
5655 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
5656 -lp -vt=1 -vtc=1</programlisting>
5660 <para><varname>STDERR</varname> ist tabu. Unkonditionale
5661 Debugmeldungen auch.</para>
5663 <para>Lx-Office bietet mit dem Modul <classname>LXDebug</classname>
5664 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
5665 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
5667 <para>Die <classname>LXDebug</classname>-Methode
5668 "<function>message</function>" nimmt als ersten Paramter außerdem
5669 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
5670 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
5671 und werden in den meisten Fällen auch vom Repository
5672 zurückgewiesen.</para>
5676 <para>Alle neuen Module müssen use strict verwenden.</para>
5678 <para><varname>$form</varname>, <varname>$auth</varname>,
5679 <varname>$locale</varname>, <varname>$lxdebug</varname> und
5680 <varname>%myconfig</varname> werden derzeit aus dem main package
5681 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
5682 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
5687 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
5688 <title>Dokumentation erstellen</title>
5690 <sect2 id="devel.build-doc.introduction">
5691 <title>Einführung</title>
5693 <para>Diese Dokumentation ist in <productname>DocBook</productname>
5694 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
5695 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
5696 Editor nutzt, der spezielle Unterstützung für
5697 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
5698 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
5699 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
5703 <sect2 id="devel.build-doc.required-software">
5704 <title>Benötigte Software</title>
5706 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
5707 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
5708 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
5709 erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script
5710 <command>scripts/build_doc.sh</command>.</para>
5712 <para>Das Script benötigt zur Konvertierung verschiedene
5713 Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht benötigt
5719 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
5720 in einer halbwegs aktuellen Version</para>
5724 <para>Das Java-Build-System <ulink
5725 url="http://ant.apache.org/">Apache Ant</ulink></para>
5729 <para>Das Dokumentations-System Dobudish für
5730 <productname>DocBook</productname> 4.5, eine Zusammenstellung
5731 diverser Stylesheets und Grafiken zur Konvertierung von
5732 <productname>DocBook</productname> XML in andere Formate. Das
5733 Paket, das benötigt wird, ist zum Zeitpunkt der
5734 Dokumentationserstellung
5735 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
5736 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
5741 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
5742 sind auf allen gängigen Plattformen verfügbar. Beispiel für
5743 Debian/Ubuntu:</para>
5745 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
5747 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
5748 <filename>doc/build</filename> entpackt werden. Beispiel unter der
5749 Annahme, das <productname>Dobudish</productname> in
5750 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
5752 <programlisting>cd doc/build
5753 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
5756 <sect2 id="devel.build-doc.build">
5757 <title>PDFs und HTML-Seiten erstellen</title>
5759 <para>Die eigentliche Konvertierung erfolgt nach Installation der
5760 benötigten Software mit einem einfachen Aufruf direkt aus dem
5761 Lx-Office-Installationsverzeichnis heraus:</para>
5763 <programlisting>./scripts/build_doc.sh</programlisting>
5766 <sect2 id="devel.build-doc.repository">
5767 <title>Einchecken in das Git-Repository</title>
5769 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
5770 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
5771 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
5772 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
5774 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
5775 symbolischen Links gehören hingegen nicht in das Repository.</para>