Date: Wed, 11 Jan 2012 14:42:39 +0000 (+0100) Subject: Erzeugte PDF- und HTML-Varianten der Dokumentation X-Git-Tag: release-2.7.0beta1~62 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=f8309cb7bc2507c19e17ec59c6c66dd7f49ea351;p=kivitendo-erp.git Erzeugte PDF- und HTML-Varianten der Dokumentation --- diff --git a/doc/dokumentation.pdf b/doc/dokumentation.pdf new file mode 100644 index 000000000..00ec0d53f Binary files /dev/null and b/doc/dokumentation.pdf differ diff --git a/doc/html/ch01.html b/doc/html/ch01.html new file mode 100644 index 000000000..814031d0a --- /dev/null +++ b/doc/html/ch01.html @@ -0,0 +1,5 @@ + + + Kapitel 1. Aktuelle Hinweise

Kapitel 1. Aktuelle Hinweise
Zurück		Weiter

Kapitel 1. Aktuelle Hinweise

Aktuelle Installations- und Konfigurationshinweise gibt es:

auf der Lx-Office-Homepage unter http://lx-office.org/index.php?id=dokumentation +
im Lx-Office-Wiki unter Dokumentation (http://wiki.lx-office.org/index.php/Lx-Office_ERP)
im Lx-Office-Forum: http://www.lx-office.org/forum/ +

Zurück		Weiter
Lx-Office: Installation, Konfiguration, Entwicklung	Zum Anfang	Kapitel 2. Installation und Grundkonfiguration

\ No newline at end of file diff --git a/doc/html/ch02.html b/doc/html/ch02.html new file mode 100644 index 000000000..17a8cfe4f --- /dev/null +++ b/doc/html/ch02.html @@ -0,0 +1,54 @@ + + + Kapitel 2. Installation und Grundkonfiguration

Kapitel 2. Installation und Grundkonfiguration
Zurück		Weiter

Kapitel 2. Installation und Grundkonfiguration

2.1. Benötigte Software und Pakete

2.1.1. Betriebssystem

Lx-Office ist für Linux konzipiert, und sollte auf jedem + unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist + diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde + bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es + ohne große Probleme auf den derzeit aktuellen verbreiteten + Distributionen läuft.

Anfang 2012 sind das folgende Systeme, von denen bekannt ist, dass Lx-Office auf ihnen läuft:

Ubuntu 8.04 LTS Hardy Heron, 10.04 LTS Lucid Lynx bis 11.10 Oneiric Ocelot
Debian 5.0 Lenny und 6.0 Squeeze
openSUSE 11.2 und 11.3
SuSE Linux Enterprice Server 11
Fedora 13 bis 15

Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die + Module im Archiv recht alt sind, und das viele der benötigten Module + nicht einfach zu installieren sind. Dafür sollte es kurz nach dem + Release ein eigenes .deb geben.

Alternativ dazu kann die normale Installation durchgeführt + werden (siehe Manuelle Installation des Programmpaketes), wenn vorher + ein Kompatibilitätspaket installiert wird, das die fehlenden Pakete + bereitstellt. Das Paket ist auf Sourceforge + unter dem Namen lx-erp-perl-libs-compat-v2.tar.gz + hinterlegt.

Zur Installation das Paket in das entpackte Lx-Office + Verzeichnis entpacken:

tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/

Zusätzlich müssen dann noch die folgenden Pakete installiert + weerden

apt-get install libbit-vector-perl libsub-exporter-perl libclone-perl libclass-factory-util-perl

Danach sollte der Installationscheck (siehe Pakete) die enthaltenen Pakete erkennen.

2.1.2. Pakete

Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist + Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2) + benötigt.

Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die + nicht Bestandteil einer Standard-Perl-Installation sind:

parent
Archive::Zip
Config::Std
DateTime
DBI
DBD::Pg
Email::Address
JSON
List::MoreUtils
Params::Validate
PDF::API2
Rose::Object
Rose::DB
Rose::DB::Object
Template
Text::CSV_XS
Text::Iconv
URI
XML::Writer
YAML

Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete + hinzugekommen, URI und + XML::Writer sind notwendig. Ohne startet Lx-Office + nicht.

Gegenüber Version 2.6.1 sind parent, + DateTime, Rose::Object, + Rose::DB und Rose::DB::Object + neu hinzugekommen. IO::Wrap wurde entfernt.

Gegenüber Version 2.6.3 ist JSON neu + hinzugekommen.

+ Email::Address und + List::MoreUtils sind schon länger feste + Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide + sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer + zukünftigen Version aber aus dem Paket entfernt werden. Es wird + empfohlen diese Module zusammen mit den anderen als Bibliotheken zu + installieren.

Die zu installierenden Pakete können in den verschiedenen + Distributionen unterschiedlich heißen.

Für Debian oder Ubuntu benötigen Sie diese Pakete:

apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
+  libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
+  libemail-address-perl liblist-moreutils-perl libpdf-api2-perl \
+  librose-object-perl librose-db-perl librose-db-object-perl \
+  libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
+  libxml-writer-perl libyaml-perl libconfig-std-perl \
+  libparams-validate-perl libjson-perl

Für Fedora Core benötigen Sie diese Pakete:

yum install httpd postgresql-server perl-parent perl-DateTime \
+  perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils \
+  perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
+  perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
+  perl-XML-Writer perl-YAML

Für OpenSuSE benötigen Sie diese Pakete:

zypper install apache2 postgresql-server perl-Archive-Zip \
+  perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils \
+  perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
+  perl-URI perl-XML-Writer perl-YAML

Bei openSuSE 11 ist parent bereits enthalten, + und braucht nicht nachinstalliert werden. Die + Rose::* Pakete sind derzeit nicht für SuSE gepackt, + und müssen anderweitig nachinstalliert werden.

Lx-Office enthält ein Script, mit dem überprüft werden kann, ob + alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie + folgt:

./scripts/installation_check.pl

Zurück		Weiter
Kapitel 1. Aktuelle Hinweise	Zum Anfang	2.2. Manuelle Installation des Programmpaketes

\ No newline at end of file diff --git a/doc/html/ch02s02.html b/doc/html/ch02s02.html new file mode 100644 index 000000000..e4a8d8fe2 --- /dev/null +++ b/doc/html/ch02s02.html @@ -0,0 +1,21 @@ + + + 2.2. Manuelle Installation des Programmpaketes

2.2. Manuelle Installation des Programmpaketes
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.2. Manuelle Installation des Programmpaketes

Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.3.tgz) wird + im Dokumentenverzeichnis des Webservers (z.B. + /var/www/html/, + /srv/www/htdocs oder + /var/www/) entpackt:

cd /var/www tar xvzf
+lxoffice-erp-2.6.2.tgz

Verändern Sie evtl. noch den Namen des Verzeichnisses mit

mv lxoffice-erp/ lx-erp/

Alternativ können Sie auch einen Alias in der + Webserverkonfiguration benutzen, um auf das tatsächliche + Installationsverzeichnis zu verweisen.

Die Verzeichnisse users, + spool und webdav müssen für + den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die + restlichen Dateien müssen für diesen Benutzer lesbar sein. Der + Benutzername ist bei verschiedenen Distributionen unterschiedlich (z.B. + bei Debian/Ubuntu www-data, bei Fedora core + apache oder bei OpenSuSE + wwwrun).

Der folgende Befehl ändert den Besitzer für die oben genannten + Verzeichnisse auf einem Debian/Ubuntu-System:

chown -R www-data lx-office-erp/users lx-office-erp/spool lx-office-erp/webdav

Weiterhin muss der Webserver-Benutzer im Verzeichnis + templates Verzeichnisse für jeden neuen Benutzer, + der in lx-office angelegt wird, anlegen dürfen:

chgrp www-data lx-office-erp/templates
+chmod g+w lx-office-erp/templates

Zurück	Nach oben	Weiter
Kapitel 2. Installation und Grundkonfiguration	Zum Anfang	2.3. Lx-Office-Konfigurationsdatei

\ No newline at end of file diff --git a/doc/html/ch02s03.html b/doc/html/ch02s03.html new file mode 100644 index 000000000..54aaec63c --- /dev/null +++ b/doc/html/ch02s03.html @@ -0,0 +1,77 @@ + + + 2.3. Lx-Office-Konfigurationsdatei

2.3. Lx-Office-Konfigurationsdatei
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.3. Lx-Office-Konfigurationsdatei

2.3.1. Einführung

+ Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei die benötigt wird: config/lx_office.conf (kurz: + "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von Lx-Office bzw. der Migration von älteren Versionen angelegt + werden. +

+ Als Vorlage dient die Datei config/lx_office.conf.default (kurz: "die Default-Datei"): +

$ cp config/lx_office.conf.default config/lx_office.conf

+ Die Default-Datei wird immer zuerst eingelesen. Werte, die in der Hauptkonfigurationsdatei stehen, überschreiben die + Werte aus der Default-Datei. Die Hauptkonfigurationsdatei muss also nur die Abschintte und Werte + enthalten, die von denen der Default-Datei abweichen. +

+ Diese Hauptkonfigurationsdatei ist dann eine installationsspezifische Datei, d.h. sie enthält bspw. lokale Passwörter und wird auch + nicht im Versionsmanagement (git) verwaltet. +

+ Die Konfiguration ist ferner serverabhängig, d.h. für alle Mandaten, bzw. Datenbanken gleich. +

2.3.2. Abschnitte und Parameter

+ Die Konfigurationsdatei besteht aus mehreren Teilen, die entsprechend kommentiert sind: +

+ authentication +
+ authentication/database +
+ authentication/ldap +
+ system +
+ features +
+ paths +
+ applications +
+ environment +
+ print_templates +
+ task_server +
+ periodic_invoices +
+ console +
+ debug +

+ Die üblicherweise wichtigsten Parameter, die am Anfang einzustellen oder zu kontrollieren sind, sind: +

[authentication]
+admin_password = geheim
+
+[authentication/database]
+host     = localhost
+port     = 5432
+db       = lxerp_auth
+user     = postgres
+password =
+
+[system]
+eur = 1
+dbcharset = UTF-8

+ Nutzt man wiederkehrende Rechnungen, kann man unter [periodic_invoices] den Login eines Benutzers angeben, der + nach Erstellung der Rechnungen eine entsprechende E-Mail mit Informationen über die erstellten Rechnungen bekommt. +

+ Nutzt man den Taskserver für wiederkehrende Rechnungen, muss unter [task_server] ein Login eines + Benutzers angegeben werden, mit dem sich der Taskserver an Lx-Office bei der Datenbank anmeldet, die dem Benutzer zugewiesen ist. +

+ Für Entwickler finden sich unter [debug] wichtige Funktionen, um die Fehlersuche zu erleichtern. +

2.3.3. Versionen vor 2.6.3

+ In älteren Lx-Office Versionen gab es im Verzeichnis config die Dateien authentication.pl + und lx-erp.conf, die jeweils Perl-Dateien waren. Es gab auch die Möglichkeit, eine lokale Version der + Konfigurationsdatei zu erstellen (lx-erp-local.conf). Dies ist ab 2.6.3 nicht mehr möglich, aber auch nicht mehr + nötig. +

+ Beim Update von einer Lx-Office-Version vor 2.6.3 auf 2.6.3 oder jünger müssen die Einstellungen aus den alten Konfigurationsdateien + manuell übertragen und die alten Konfigurationsdateien anschließend gelöscht oder verschoben werden. Ansonsten zeigt Lx-Office eine + entsprechende Fehlermeldung an. +

Zurück	Nach oben	Weiter
2.2. Manuelle Installation des Programmpaketes	Zum Anfang	2.4. Anpassung der PostgreSQL-Konfiguration

\ No newline at end of file diff --git a/doc/html/ch02s04.html b/doc/html/ch02s04.html new file mode 100644 index 000000000..942e21c36 --- /dev/null +++ b/doc/html/ch02s04.html @@ -0,0 +1,35 @@ + + + 2.4. Anpassung der PostgreSQL-Konfiguration

2.4. Anpassung der PostgreSQL-Konfiguration
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.4. Anpassung der PostgreSQL-Konfiguration

PostgreSQL muss auf verschiedene Weisen angepasst werden.

2.4.1. Zeichensätze/die Verwendung von UTF-8

Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet + werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in + Version 8.2 oder neuer benutzt werden, und der + PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale + angelegt worden sein.

Dieses ist kann überprüft werden: ist das Encoding der Datenbank “template1” “UTF8”, so kann auch Lx-Office mit UTF-8 + betrieben werden. Andernfalls ist es notwendig, einen neuen Datenbankcluster mit UTF-8-Encoding anzulegen und diesen zu + verwenden. Unter Debian und Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl getan werden:

pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername

Die Datenbankversionsnummer muss an die tatsächlich verwendete Versionsnummer angepasst werden.

Unter anderen Distributionen gibt es ähnliche Methoden.

Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und + ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann + Lx-Office mit ISO-8859-15 als Encoding betrieben werden.

Das Encoding einer Datenbank kann in psql mit \l geprüft werden.

2.4.2. Änderungen an Konfigurationsdateien

In der Datei postgresql.conf, die je nach + Distribution in verschiedenen Verzeichnissen liegen kann (z.B. + /var/lib/pgsql/data/ oder + /etc/postgresql/, muss sichergestellt werden, dass + TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den + Parameter listen_address gesteuert. Laufen + PostgreSQL und Lx-Office auf demselben Rechner, so kann dort der Wert + localhost verwendet werden. Andernfalls müssen + Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden, + was mit dem Wert * geschieht.

In der Datei pg_hba.conf, die im gleichen + Verzeichnis wie die postgresql.conf zu finden sein + sollte, müssen die Berichtigungen für den Zugriff geändert werden. + Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale + Verbindungen immer zuzulassen:

local all all trust
+host all all 127.0.0.1 255.0.0.0 trust

Besser ist es, für eine bestimmte Datenbank Zugriff nur per + Passwort zuzulassen. Beispielsweise:

local all lxoffice password
+host all lxoffice 127.0.0.1 255.255.255.255 password

2.4.3. Erweiterung für servergespeicherte Prozeduren

In der Datenbank template1 muss die + Unterstützung für servergespeicherte Prozeduren eingerichet werden. + Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an, und + führen Sie die folgenden Kommandos aus:

create language 'plpgsql';

2.4.4. Datenbankbenutzer anlegen

Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff + benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer + anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen + können:

su - postgres createuser -d -P lxoffice

Wenn Sie später einen Datenbankzugriff konfigurieren, verändern + Sie den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” bzw. + den hier gewählten Benutzernamen.

Zurück	Nach oben	Weiter
2.3. Lx-Office-Konfigurationsdatei	Zum Anfang	2.5. Webserver-Konfiguration

\ No newline at end of file diff --git a/doc/html/ch02s05.html b/doc/html/ch02s05.html new file mode 100644 index 000000000..f1cb22844 --- /dev/null +++ b/doc/html/ch02s05.html @@ -0,0 +1,103 @@ + + + 2.5. Webserver-Konfiguration

2.5. Webserver-Konfiguration
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.5. Webserver-Konfiguration

2.5.1. Grundkonfiguration mittels CGI

	Anmerkung
	Für einen deutlichen Performanceschub sorgt die Ausführung + mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt + Konfiguration für FastCGI/FCGI beschrieben.

Der Zugriff auf das Programmverzeichnis muss in der Apache + Webserverkonfigurationsdatei httpd.conf eingestellt + werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer + anderen Datei hinzu, die beim Starten des Webservers eingelesen + wird:

AddHandler cgi-script .pl
+Alias /lx-erp/ /var/www/lx-erp/
+
+<Directory /var/www/lx-erp>
+ Options ExecCGI
+ Includes FollowSymlinks
+</Directory>
+
+<Directory /var/www/lx-erp/users>
+ Order Deny,Allow
+ Deny from All
+</Directory>

Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher + das Lx-Office-Archiv entpacket haben.

	Anmerkung
	Vor den einzelnen Optionen muss bei einigen Distributionen ein Plus ‘`+`’ gesetzt werden.

Auf einigen Webservern werden manchmal die Grafiken und + Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft + geholfen, die folgende Option in die Konfiguration aufzunehmen:

EnableSendfile Off

2.5.2. Konfiguration für FastCGI/FCGI

2.5.2.1. Was ist FastCGI?

Direkt aus Wikipedia + kopiert:

+ [ FastCGI ist ein Standard für die Einbindung + externer Software zur Generierung dynamischer Webseiten in einem + Webserver. FastCGI ist vergleichbar zum Common Gateway Interface + (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu + umgehen. ] +

2.5.2.2. Warum FastCGI?

Perl Programme (wie Lx-Office eines ist) werden nicht statisch + kompiliert. Stattdessen werden die Quelldateien bei jedem Start + übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit + ausmacht. Während SQL Ledger einen Großteil der Funktionalität in + einzelne Module kapselt, um immer nur einen kleinen Teil laden zu + müssen, ist die Funktionalität von Lx-Office soweit gewachsen, dass + immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich + benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber + entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies + führt dazu dass ein Lx-Office Aufruf der Kernmasken mittlerweile + deutlich länger dauert als früher, und dass davon 90% für das Laden + der Module verwendet wird.

Mit FastCGI werden nun die Module einmal geladen, und danach + wird nur die eigentliche Programmlogik ausgeführt.

2.5.2.3. Getestete Kombinationen aus Webservern und Plugin

Folgende Kombinationen sind getestet:

Apache 2.2.11 (Ubuntu) und mod_fcgid.
Apache 2.2.11 (Ubuntu) und mod_fastcgi.

Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer + Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf + mod_fastcgi nicht mehr explizit eingegangen.

Als Perl Backend wird das Modul FCGI.pm + verwendet.

Warnung

+ FCGI 0.69 und höher ist extrem strict in der Behandlung von Unicode, und verweigert bestimmte Eingaben von Lx-Office. Falls es + Probleme mit Umlauten in Ihrere Installation gibt, muss auf die Vorgängerversion FCGI 0.68 ausgewichen werden. +

+ Mit CPAN lässt sie sich die Vorgängerversion wie folgt installieren: +

force install M/MS/MSTROUT/FCGI-0.68.tar.gz

2.5.2.4. Konfiguration des Webservers

Bevor Sie versuchen, eine Lx-Office Installation unter FCGI + laufen zu lassen, empfliehlt es sich die Installation ersteinmal + unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu + debuggen die beim ersten aufsetzen auftreten können. Sollte die + Installation schon funktionieren, lesen Sie weiter.

Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann + unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:

a2enmod fcgid

Die Konfiguration für die Verwendung von Lx-Office mit FastCGI + erfolgt durch Anpassung der vorhandenen Alias- + und Directory-Direktiven. Dabei wird zwischen + dem Installationspfad von Lx-Office im Dateisystem + ("/path/to/lx-office-erp") und der URL + unterschieden, unter der Lx-Office im Webbrowser erreichbar ist + ("/url/for/lx-office-erp").

Folgender Konfigurationsschnipsel funktioniert mit + mod_fastcgi:

AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi
+Alias       /url/for/lx-office-erp/          /path/to/lx-office-erp/
+
+<Directory /path/to/lx-office-erp>
+  AllowOverride All
+  Options ExecCGI Includes FollowSymlinks
+  Order Allow,Deny
+  Allow from All
+</Directory>
+
+<DirectoryMatch /path/to/lx-office-erp/users>
+  Order Deny,Allow
+  Deny from All
+</DirectoryMatch>

Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für + die maximale Größe eines Requests. Diese sollte wie folgt + hochgesetzt werden:

FcgidMaxRequestLen 10485760

Das ganze sollte dann so aussehen:

AddHandler fcgid-script .fpl
+AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
+Alias       /url/for/lx-office-erp/          /path/to/lx-office-erp/
+FcgidMaxRequestLen 10485760
+
+<Directory /path/to/lx-office-erp>
+  AllowOverride All
+  Options ExecCGI Includes FollowSymlinks
+  Order Allow,Deny
+  Allow from All
+</Directory>
+
+<DirectoryMatch /path/to/lx-office-erp/users>
+  Order Deny,Allow
+  Deny from All
+</DirectoryMatch>

Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle + Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet. + Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden, + gibt es hier kleine Performance-Einbußen.

Es ist möglich, die gleiche Lx-Office Version parallel unter + CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven + wie oben beschrieben, die URLs werden aber umgeleitet:

# Zugriff über CGI
+Alias       /url/for/lx-office-erp                /path/to/lx-office-erp
+
+# Zugriff mit mod_fcgid:
+AliasMatch ^/url/for/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
+Alias       /url/for/lx-office-erp-fcgid/          /path/to/lx-office-erp/

Dann ist unter /url/for/lx-office-erp/ die normale Version erreichbar, und unter + /url/for/lx-office-erp-fcgid/ die FastCGI-Version.

Zurück	Nach oben	Weiter
2.4. Anpassung der PostgreSQL-Konfiguration	Zum Anfang	2.6. Der Task-Server

\ No newline at end of file diff --git a/doc/html/ch02s06.html b/doc/html/ch02s06.html new file mode 100644 index 000000000..4fe9a32ee --- /dev/null +++ b/doc/html/ch02s06.html @@ -0,0 +1,62 @@ + + + 2.6. Der Task-Server

2.6. Der Task-Server
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.6. Der Task-Server

Der Task-Server ist ein Prozess, der im Hintergrund läuft, in + regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu + festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess + wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen + benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen + bekommen.

2.6.1. Verfügbare und notwendige Konfigurationsoptionen

Die Konfiguration erfolgt über den Abschnitt + [task_server] in der Datei + config/lx_office.conf. Die dort verfügbaren + Optionen sind:

+ login +: + gültiger Lx-Office-Benutzername, der benutzt wird, um die zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss in + der Administration angelegt werden. Diese Option muss angegeben werden. +
+ run_as +: + Wird der Server vom Systembenutzer root gestartet, so wechselt er auf den mit run_as + angegebenen Systembenutzer. Der Systembenutzer muss dieselben Lese- und Schreibrechte haben, wie auch der Webserverbenutzer + (siehe see Manuelle Installation des Programmpaketes). Daher ist es sinnvoll, hier denselben Systembenutzer + einzutragen, unter dem auch der Webserver läuft. +
+ debug +: + Schaltet Debug-Informationen an und aus. +

2.6.2. Automatisches Starten des Task-Servers beim Booten

Der Task-Server verhält sich von seinen Optionen her wie ein + reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim + Starten automatisch in das Lx-Office-Installationsverzeichnis.

Deshalb ist es möglich, ihn durch Setzen eines symbolischen + Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess + einzubinden. Da das bei neueren Linux-Distributionen aber nicht + zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die + anstelle eines symbolischen Links verwendet werden können.

2.6.2.1. SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora + Core)

Kopieren Sie die Datei + scripts/boot/system-v/lx-office-task-server + nach /etc/init.d/lx-office-task-server. Passen + Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile + DAEMON=....). Binden Sie das Script in den + Boot-Prozess ein. Dies ist distributionsabhängig:

Debian-basierende Systeme:

update-rc.d lx-office-task-server defaults
+# Nur bei Debian Squeeze und neuer:
+insserv lx-office-task-server

OpenSuSE und Fedora Core:
```
chkconfig --add lx-office-task-server
```

Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: /etc/init.d/lx-office-task-server + start +

2.6.2.2. Upstart-basierende Systeme (z.B. Ubuntu)

Kopieren Sie die Datei + scripts/boot/upstart/lx-office-task-server.conf + nach /etc/init/lx-office-task-server.conf. + Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile + exec ....).

Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: service lx-office-task-server + start +

2.6.3. Wie der Task-Server gestartet und beendet wird

Der Task-Server wird wie folgt kontrolliert:

./scripts/task_server.pl Befehl

+ Befehl ist dabei eine der folgenden + Optionen:

+ start startet eine neue Instanz des + Task-Servers. Die Prozess-ID wird innerhalb des + users-Verzeichnisses abgelegt.
+ stop beendet einen laufenden + Task-Server.
+ restart beendet und startet ihn + neu.
+ status berichtet, ob der Task-Server + läuft.

Der Task-Server wechselt beim Starten automatisch in das + Lx-Office-Installationsverzeichnis.

Dieselben Optionen können auch für die SystemV-basierenden + Runlevel-Scripte benutzt werden (siehe oben).

Zurück	Nach oben	Weiter
2.5. Webserver-Konfiguration	Zum Anfang	2.7. Benutzerauthentifizierung und Administratorpasswort

\ No newline at end of file diff --git a/doc/html/ch02s07.html b/doc/html/ch02s07.html new file mode 100644 index 000000000..cad0eb807 --- /dev/null +++ b/doc/html/ch02s07.html @@ -0,0 +1,71 @@ + + + 2.7. Benutzerauthentifizierung und Administratorpasswort

2.7. Benutzerauthentifizierung und Administratorpasswort
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.7. Benutzerauthentifizierung und Administratorpasswort

Informationen über die Einrichtung der Benutzerauthentifizierung, + über die Verwaltung von Gruppen und weitere Einstellungen

2.7.1. Grundlagen zur Benutzerauthentifizierung

Lx-Office verwaltet die Benutzerinformationen in einer + Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt + wird. Für jeden Benutzer kann dort eine eigene Datenbank für die + eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken + können, müssen aber nicht unterschiedlich sein.

Im einfachsten Fall gibt es für Lx-Office nur eine einzige + Datenbank, in der sowohl die Benutzerinformationen als auch die Daten + abgelegt werden.

Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter + entweder gegen die Authentifizierungsdatenbank oder gegen einen + LDAP-Server überprüft werden.

Welche Art der Passwortüberprüfung Lx-Office benutzt und wie + Lx-Office die Authentifizierungsdatenbank erreichen kann, wird in der + Konfigurationsdatei config/lx_office.conf + festgelegt. Diese muss bei der Installation und bei einem Upgrade von + einer Version vor v2.6.0 angelegt werden. Eine + Beispielkonfigurationsdatei + config/lx_office.conf.default existiert, die als + Vorlage benutzt werden kann.

2.7.2. Administratorpasswort

Das Passwort, das zum Zugriff auf das Aministrationsinterface benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es + kann auch nur dort und nicht mehr im Administrationsinterface selber geändert werden. Der Parameter dazu heißt + admin_password im Abschnitt [authentication].

2.7.3. Authentifizierungsdatenbank

Die Verbindung zur Authentifizierungsdatenbank wird mit den Parametern in [authentication/database] + konfiguriert. Hier sind die folgenden Parameter anzugeben:

+ host +: Der Rechnername oder die IP-Adresse des Datenbankservers
+ port +: Die Portnummer des Datenbankservers, meist 5432
+ db +: Der Name der Authentifizierungsdatenbank
+ user +: Der Benutzername, mit dem sich Lx-Office beim Datenbankserver anmeldet (z.B. "postgres")
+ password +: Das Passwort für den Datenbankbenutzer

Die Datenbank muss noch nicht existieren. Lx-Office kann sie + automatisch anlegen (mehr dazu siehe unten).

2.7.4. Passwortüberprüfung

Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen die Authentifizierungsdatenbank und gegen einen externen LDAP- + oder Active-Directory-Server. Welche davon benutzt wird, regelt der Parameter module im Abschnitt + [authentication].

Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank gespeichert werden, so muss der Parameter + module den Wert DB enthalten. In diesem Fall können sowohl der Administrator als auch die + Benutzer selber ihre Psaswörter in Lx-Office ändern.

Soll hingegen ein externer LDAP- oder Active-Directory-Server benutzt werden, so muss der Parameter module + auf LDAP gesetzt werden. In diesem Fall müssen zusätzliche Informationen über den LDAP-Server im Abschnitt + [authentication/ldap] angegeben werden:

+ host +: Der Rechnername oder die IP-Adresse des LDAP- oder Active-Directory-Servers. Diese Angabe ist zwingend + erforderlich.
+ port +: Die Portnummer des LDAP-Servers; meist 389.
+ tls +: Wenn Verbindungsverschlüsselung gewünscht ist, so diesen Wert auf ‘1’ setzen, andernfalls auf + ‘0’ belassen
+ attribute +: Das LDAP-Attribut, in dem der Benutzername steht, den der Benutzer eingegeben hat. Für Active-Directory-Server ist dies + meist ‘sAMAccountName’, für andere LDAP-Server hingegen ‘uid’. Diese Angabe ist zwingend + erforderlich.
+ base_dn +: Der Abschnitt des LDAP-Baumes, der durchsucht werden soll. Diese Angabe ist zwingend erforderlich.
+ filter +: Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort <%login%>, so wird dieses durch den + vom Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird der LDAP-Baum nach einem Element durchsucht, bei dem das oben + angegebene Attribut mit dem Benutzernamen identisch ist.
+ bind_dn und bind_password +: Wenn der LDAP-Server eine Anmeldung erfordert, bevor er durchsucht werden kann (z.B. ist dies bei Active-Directory-Servern + der Fall), so kann diese hier angegeben werden. Für Active-Directory-Server kann als ‘bind_dn’ entweder eine + komplette LDAP-DN wie z.B. ‘cn=Martin Mustermann,cn=Users,dc=firmendomain’ auch nur der volle Name des + Benutzers eingegeben werden; in diesem Beispiel also ‘Martin Mustermann’.

2.7.5. Name des Session-Cookies

Sollen auf einem Server mehrere Lx-Office-Installationen aufgesetzt werden, so müssen die Namen der Session-Cookies für alle + Installationen unterschiedlich sein. Der Name des Cookies wird mit dem Parameter cookie_name im Abschnitt + [authentication]gesetzt.

Diese Angabe ist optional, wenn nur eine Installation auf dem + Server existiert.

2.7.6. Anlegen der Authentifizierungsdatenbank

Nachdem alle Einstellungen in + config/lx_office.conf vorgenommen wurden, muss + Lx-Office die Authentifizierungsdatenbank anlegen. Dieses geschieht + automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter + der folgenden URL erreichbar sein sollte:

+ http://localhost/lx-erp/admin.pl +

Zurück	Nach oben	Weiter
2.6. Der Task-Server	Zum Anfang	2.8. Benutzer- und Gruppenverwaltung

\ No newline at end of file diff --git a/doc/html/ch02s08.html b/doc/html/ch02s08.html new file mode 100644 index 000000000..7a8f3863f --- /dev/null +++ b/doc/html/ch02s08.html @@ -0,0 +1,78 @@ + + + 2.8. Benutzer- und Gruppenverwaltung

2.8. Benutzer- und Gruppenverwaltung
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.8. Benutzer- und Gruppenverwaltung

Nach der Installation müssen Benutzer, Gruppen und Datenbanken + angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter + folgender URL finden:

+ http://localhost/lx-erp/admin.pl +

Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei + config/lx_office.conf eingetragen haben.

2.8.1. Zusammenhänge

Lx-Office verwendet eine Datenbank zum Speichern all seiner + Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um + mit Lx-Office arbeiten zu können, muss eine Person einen + Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine + Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist + möglich und normal, dass mehreren Benutzern die selbe Datenbank + zugewiesen wird, sodass sie alle mit den selben Daten arbeiten + können.

Die Basisdaten der Benutzer, die in der Administration + eingegeben werden können, werden in einer zweiten Datenbank + gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese + ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet. + Pro Lx-Office-Installation gibt es nur eine + Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit + Firmendaten.

Lx-Office kann seinen Benutzern Zugriff auf bestimmte + Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht + gestattet, so werden der entsprechenden Menüpunkte auch nicht + angezeigt. Diese Rechte werden ebenfalls in der + Authentifizierungsdatenbank gespeichert.

Um Rechte verteilen zu können, verwendet Lx-Office ein + Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche + erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder + mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen + Funktionen, die mindestens einer Gruppe erlaubt sind, in der der + Benutzer Mitglied ist.

Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und + Benutzer angelegt werden sollten, lautet:

Datenbank anlegen
Gruppen anlegen
Benutzer anlegen
Benutzer den Gruppen zuordnen

2.8.2. Datenbanken anlegen

Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für + den Datenbankzugriff den vorhin angelegten Benutzer (in unseren + Beispielen ist dies ‘lxoffice’).

Wenn Sie für die Lx-Office-Installation nicht den europäischen + Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so + müssen Sie vor dem Anlegen der Datenbank in der Datei + config/lx_office.conf die Variable + dbcharset im Abschnitt system + auf den Wert ‘UTF-8’ setzen. Zusätzlich muss beim + Anlegen der Datenbank ‘UTF-8 Unicode’ als + Schriftsatz ausgewählt werden.

Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz + verwenden müssen, da diese Einstellungen momentan global in Lx-Office + vorgenommen wird und nicht nach Datenbank unterschieden werden kann. + Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz + angelegt worden sein.

2.8.3. Gruppen anlegen

Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein + Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem + Anlegen können Sie die verschiedenen Bereiche wählen, auf die + Mitglieder dieser Gruppe Zugriff haben sollen.

Benutzergruppen sind unabhängig von Datenbanken, da sie in der + Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle + Datenbanken, die in dieser Installation verwaltet werden.

2.8.4. Benutzer anlegen

Beim Anlegen von Benutzern werden für viele Parameter + Standardeinstellungen vorgenommen, die den Gepflogenheiten des + deutschen Raumes entsprechen.

Zwingend anzugeben sind der Loginname sowie die komplette + Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die + Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort + gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung + aktiv, so ist das Passwort-Feld deaktiviert.

In der Datenbankkonfiguration müssen die Zugriffsdaten einer der + eben angelegten Datenbanken eingetragen werden.

2.8.5. Gruppenmitgliedschaften verwalten

Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den + Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:

In der Gruppenverwaltung wählt man eine Gruppe aus. Im + folgenden Dialog kann man dann einzeln die Benutzer der Gruppe + hinzufügen.
In der Gruppenverwaltung wählt man das Tool zur Verwaltung + der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die + alle im System angelegten Gruppen und Benutzer enthält. Durch + Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der + Gruppe in der ausgewählten Spalte hinzugefügt.

2.8.6. Migration alter Installationen

Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird, + in der die Benutzerdaten noch im Dateisystem im Verzeichnis + users verwaltet wurden, so bietet Lx-Office die + Möglichkeit, diese Benutzerdaten automatisch in die + Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man + sich nach dem Update der Installation das erste Mal im + Administrationsbereich anmeldet. Findet Lx-Office die Datei + users/members, so wird der Migrationsprozess + gestartet.

Der Migrationsprozess ist nahezu vollautomatisch. Alle + Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet + Lx-Office noch die Möglichkeit an, dass automatisch eine + Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle + Funktionen von Lx-Office gewährt. Alle migrierten Benutzern werden + Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis + Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können + sich sofort wieder anmelden und mit dem System arbeiten.

Zurück	Nach oben	Weiter
2.7. Benutzerauthentifizierung und Administratorpasswort	Zum Anfang	2.9. Drucken mit Lx-Office

\ No newline at end of file diff --git a/doc/html/ch02s09.html b/doc/html/ch02s09.html new file mode 100644 index 000000000..0328fdf21 --- /dev/null +++ b/doc/html/ch02s09.html @@ -0,0 +1,27 @@ + + + 2.9. Drucken mit Lx-Office

2.9. Drucken mit Lx-Office
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.9. Drucken mit Lx-Office

Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen. + Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am + einfachsten ist dazu eine texlive Installation. Unter + Debianoiden Betriebssystemen sind das die Pakete:

+ texlive-latex-base texlive-latex-extra + texlive-fonts-recommended +

Diese hinteren beiden enthalten Bibliotheken und Schriftarten die + von den Standardvorlagen verwendet werden.

TODO: rpm Pakete.

In den allermeisten Installationen sollte drucken jetzt schon + funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange + Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite + die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum + Beispiel:

! LaTeX Error: File `eurosym.sty' not found. Die entsprechende + LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei + Vorlagen aus der Community auf. Installieren Sie die entsprechenden + Pakete.
! Package inputenc Error: Unicode char \u8:æ¡ not set up for + use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit + einer Standardinstallation exotische utf8 Zeichen zu drucken. + TeXLive unterstützt von Haus nur romanische Schriften und muss mit + diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren. + Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.

Wird garkein Fehler angezeigt sondern nur der Name des Templates, + heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde. + Prüfen Sie den Namen in der Konfiguration (Standard: + pdflatex), und stellen Sie sicher, dass pdflatex + (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden + darf.

Zurück	Nach oben	Weiter
2.8. Benutzer- und Gruppenverwaltung	Zum Anfang	2.10. OpenDocument-Vorlagen

\ No newline at end of file diff --git a/doc/html/ch02s10.html b/doc/html/ch02s10.html new file mode 100644 index 000000000..83935f54d --- /dev/null +++ b/doc/html/ch02s10.html @@ -0,0 +1,56 @@ + + + 2.10. OpenDocument-Vorlagen

2.10. OpenDocument-Vorlagen
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.10. OpenDocument-Vorlagen

Lx-Office unterstützt die Verwendung von Vorlagen im + OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt. + Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus + diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von + OpenDocument-Vorlagen zu aktivieren muss in der Datei + config/lx_office.conf die Variable + opendocument im Abschnitt + print_templates auf ‘1’ stehen. + Dieses ist die Standardeinstellung.

Weiterhin muss in der Datei + config/lx_office.conf die Variable + dbcharset im Abschnitt system auf + die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der + Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen + "UTF-8".

Während die Erzeugung von reinen OpenDocument-Dateien keinerlei + weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF + OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss + neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer” + (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten. + Andere Distributionen enthalten ihn in anderen Paketen.

Nach der Installation müssen in der Datei + config/lx_config.conf zwei weitere Variablen + angepasst werden: openofficeorg_writer muss den + vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten. + xvfb muss den Pfad zum “X virtual frame buffer” + enthalten. Beide stehen im Abschnitt + applications.

Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit + OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die + Variable $openofficeorg_daemon gesetzt ist, startet + ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet + bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz + benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich + reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet + werden muss. Der Nachteil ist, dass diese Methode Python und die + Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2 + sind.

Ist $openofficeorg_daemon nicht gesetzt, so + wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung + mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der + Dokumentenvorlage enthalten sein und + “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage + ‘templates/mastertemplates/German/invoice.odt’ + enthält ein solches Makro, das in jeder anderen Dokumentenvorlage + ebenfalls enthalten sein muss.

Als letztes muss herausgefunden werden, welchen Namen + OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen + gibt. Unter Debian ist dies momentan + ~/.openoffice.org2. Sollte der Name bei Ihrer + OpenOffice.org-Installation anders sein, so muss das Verzeichnis + users/.openoffice.org2 entsprechend umbenannt werden. + Ist der Name z.B. einfach nur .openoffice, so wäre + folgender Befehl auszuführen:

+ mv users/.openoffice.org2 + users/.openoffice +

Dieses Verzeichnis, wie auch das komplette + users-Verzeichnis, muss vom Webserver beschreibbar + sein. Dieses wurde bereits erledigt (siehe Manuelle Installation des Programmpaketes), kann aber erneut + überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.

Zurück	Nach oben	Weiter
2.9. Drucken mit Lx-Office	Zum Anfang	2.11. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR

\ No newline at end of file diff --git a/doc/html/ch02s11.html b/doc/html/ch02s11.html new file mode 100644 index 000000000..3856d30c8 --- /dev/null +++ b/doc/html/ch02s11.html @@ -0,0 +1,59 @@ + + + 2.11. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR

2.11. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.11. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR

2.11.1. Einführung

+ Lx-Office besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens eur, der sich in der + Konfigurationsdatei config/lx_office.conf befindet. Somit galt er für alle Mandanten, die in dieser + Installation benutzt wurden. +

+ Mit der nachfolgenden Version wurde der Parameter zum Einen in die Mandantendatenbank verschoben und dabei auch gleich in drei + Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer steuern lässt. +

2.11.2. Konfigurationsparameter

+ Es gibt drei Parameter, die die Gewinnermittlungsart, Versteuerungsart und die Warenbuchungsmethode regeln: +

+ profit_determination +: + Dieser Parameter legt die Berechnungsmethode für die Gewinnermittlung fest. Er enthält entweder balance für + Betriebsvermögensvergleich/Bilanzierung oder income für die Einnahmen-Überschuss-Rechnung. +
+ accounting_method +: + Dieser Parameter steuert die Buchungs- und Berechnungsmethoden für die Versteuerungsart. Er enthält entweder + accrual für die Soll-Versteuerung oder cash für die Ist-Versteuerung. +
+ inventory_system +: + Dieser Parameter legt die Warenbuchungsmethode fest. Er enthält entweder perpetual für die Bestandsmethode + oder periodic für die Aufwandsmethode. +

+ Zum Vergleich der Funktionalität bis und nach 2.6.3: eur = 1 bedeutete Einnahmen-Überschuss-Rechnung, + Ist-Versteuerung und Aufwandsmethode. eur = 0 bedeutete hingegen Bilanzierung, Soll-Versteuerung und + Bestandsmethode. +

+ Die Konfiguration "eur" unter [system] in der Konfigurationsdatei + config/lx_office.conf wird nun nicht mehr benötigt und + kann entfernt werden. Dies muss manuell geschehen. +

2.11.3. Festlegen der Parameter

+ Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in der Admininstration können diese Optionen nun unabhängig + voneinander eingestellt werden. +

+ Beim Upgrade bestehender Mandanten wird eur ausgelesen und die Variablen werden so gesetzt, daß sich an der Funktionalität nichts + ändert. +

+ Die aktuelle Konfiguration wird unter Nummernkreise und Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt (read-only). + Eine spätere Änderung ist für einen bestehenden Mandanten nicht mehr möglich. Dies war auch vorher nicht möglich, bzw. vorhandene + Daten wurden so belassen und haben damit die Ergebnisse verfälscht. +

2.11.4. Bemerkungen zu Bestandsmethode

+ Die Bestandsmethode ist eigentlich eine sehr elegante Methode, funktioniert in Lx-Office aber nur unter bestimmten Bedingungen: + Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt werden, und man beim Jahreswechsel nicht mit einer leeren + Datenbank anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie der Einkaufswert der Ware nach dem FIFO-Prinzip aus + den Einkaufsrechnungen berechnet wird. +

+ Die Bestandsmethode kann vom Prinzip her also nur funktioneren, wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht + im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode wechseln. +

2.11.5. Bekannte Probleme

+ Bei bestimmten Berichten kann man derzeit noch inviduell einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es werden + im Code Variablen wie $accrual oder $cash gesetzt. Diese Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher + die Konfigurationsvariable $::lx_office_conf{system}->{eur} ausgewertet wurde. +

+ Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die Optionen bewirken, z.B. mit zwei Standardfällen. +

Zurück	Nach oben	Weiter
2.10. OpenDocument-Vorlagen	Zum Anfang	2.12. Lx-Office ERP verwenden

\ No newline at end of file diff --git a/doc/html/ch02s12.html b/doc/html/ch02s12.html new file mode 100644 index 000000000..a2cd592f2 --- /dev/null +++ b/doc/html/ch02s12.html @@ -0,0 +1,8 @@ + + + 2.12. Lx-Office ERP verwenden

2.12. Lx-Office ERP verwenden
Zurück	Kapitel 2. Installation und Grundkonfiguration	Weiter

2.12. Lx-Office ERP verwenden

Nach erfolgreicher Installation ist der Loginbildschirm unter + folgender URL erreichbar:

+ http://localhost/lx-office-erp/login.pl +

Die Administrationsseite erreichen Sie unter:

+ http://localhost/lx-office-erp/admin.pl +

Zurück	Nach oben	Weiter
2.11. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR	Zum Anfang	Kapitel 3. Features und Funktionen

\ No newline at end of file diff --git a/doc/html/ch03.html b/doc/html/ch03.html new file mode 100644 index 000000000..6cf2cef6d --- /dev/null +++ b/doc/html/ch03.html @@ -0,0 +1,58 @@ + + + Kapitel 3. Features und Funktionen

Kapitel 3. Features und Funktionen
Zurück		Weiter

Kapitel 3. Features und Funktionen

3.1. Wiederkehrende Rechnungen

3.1.1. Einführung

+ Wiederkehrende Rechnungen werden als normale Aufträge definiert und konfiguriert, mit allen dazugehörigen Kunden- und + Artikelangaben. Die konfigurierten Aufträge werden später automatisch in Rechnungen umgewandelt, so als ob man den Workflow benutzen + würde, und auch die Auftragsnummer wird übernommen, sodass alle wiederkehrenden Rechnungen, die aus einem Auftrag erstellt wurden, + später leicht wiederzufinden sind. +

3.1.2. Konfiguration

+ Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren, findet sich beim Bearbeiten des Auftrags ein neuer Knopf + "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen Parameter einstellen kann. Hinter dem Knopf wird außerdem noch + angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist oder nicht. +

+ Folgende Parameter kann man konfigurieren: +

Status

+ Bei aktiven Rechnungen wird automatisch eine Rechnung erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines neuen + Monats). +

+ Ist ein Auftrag nicht aktiv, so werden für ihn auch keine wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer + nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim nächsten Periodenwechsel für alle Perioden, seit der letzten aktiven + Periode, jeweils eine Rechnung erstellt. Möchte man dies verhindern, muss man vorher das Startdatum neu setzen. +

+ Für gekündigte Aufträge werden nie mehr Rechnungen erstellt. Man kann sich diese Aufträge aber gesondert in den Berichten anzeigen + lassen. +

Periodizität

+ Ob monatlich, quartalsweise oder jährlich auf neue Rechnungen überprüft werden soll. Für jede Periode seit dem Startdatum wird + überprüft, ob für die Periode (beginnend immer mit dem ersten Tag der Periode) schon eine Rechnung erstellt wurde. Unter Umständen + können bei einem Startdatum in der Vergangenheit gleich mehrere Rechnungen erstellt werden. +

Buchen auf

+ Das Forderungskonto, in der Regel "Forderungen aus Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen + der betreffenden Waren. +

Startdatum

+ ab welchem Datum auf Rechnungserstellung geprüft werden soll +

Enddatum

+ ab wann keine Rechnungen mehr erstellt werden sollen +

Automatische Verlängerung um x Monate

+ Sollen die wiederkehrenden Rechnungen bei Erreichen des eingetragenen Enddatums weiterhin erstellt werden, so kann man hier die + Anzahl der Monate eingeben, um die das Enddatum automatisch nach hinten geschoben wird. +

Drucken

+ Sind Drucker konfiguriert, so kann man sich die erstellten Rechnungen auch gleich ausdrucken lassen. +

+ Nach Erstellung der Rechnungen kann eine E-Mail mit Informationen zu den erstellten Rechnungen verschickt werden. Konfiguriert wird + dies in der Konfigurationsdatei + + config/lx_office.conf im Abschnitt [periodic_invoices]. +

3.1.3. Auflisten

+ Unter Verkauf->Berichte->Aufträge finden sich zwei neue Checkboxen, "Wiederkehrende Rechnungen aktiv" und + "Wiederkehrende Rechnungen inaktiv", mit denen man sich einen Überglick über die wiederkehrenden Rechnungen verschaffen + kann. +

3.1.4. Erzeugung der eigentlichen Rechnungen

+ Die zeitliche und periodische Überprüfung, ob eine wiederkehrende Rechnung automatisch erstellt werden soll, geschieht durch den + Taskserver, einen externen Dienst, der automatisch beim Start des Servers gestartet + werden sollte. +

3.1.5. Erste Rechnung für aktuellen Monat erstellen

+ Will man im laufenden Monat eine monatlich wiederkehrende Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum auf + den Monatsanfang und wartet ein paar Minuten, bis der Taskserver den neu konfigurieren Auftrag erkennt und daraus eine Rechnung + generiert hat. Alternativ setzt man das Startdatum auf den Monatsersten des Folgemonats und erstellt die erste Rechnung direkt + manuell über den Workflow. +

Zurück		Weiter
2.12. Lx-Office ERP verwenden	Zum Anfang	3.2. Dokumentenvorlagen und verfügbare Variablen

\ No newline at end of file diff --git a/doc/html/ch03s02.html b/doc/html/ch03s02.html new file mode 100644 index 000000000..8c937651c --- /dev/null +++ b/doc/html/ch03s02.html @@ -0,0 +1,715 @@ + + + 3.2. Dokumentenvorlagen und verfügbare Variablen

3.2. Dokumentenvorlagen und verfügbare Variablen
Zurück	Kapitel 3. Features und Funktionen	Weiter

3.2. Dokumentenvorlagen und verfügbare Variablen

3.2.1. Einführung

Dies ist eine Auflistung der Standard-Dokumentenvorlagen und + aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in + einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form + <%variablenname%> verwendet wird. Für + LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern + (siehe Anfang und Ende der Tags verändern).

Früher wurde hier nur über LaTeX gesprochen. Inzwischen + unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern es nicht + ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für + alle Vorlagenarten.

Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen + verfügbar als hier aufgelistet werden. Die meisten davon können + allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet + werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann + diese wie folgt erhalten werden:

+ SL/Form.pm öffnen und am Anfang die + Zeile "use Data::Dumper;" einfügen.
In Form.pm die Funktion + parse_template suchen und hier die Zeile + print(STDERR Dumper($self)); einfügen.
Einmal per Browser die gewünschte Vorlage "benutzen", z.B. + ein PDF für eine Rechnung erzeugen.
Im error.log Apache steht die Ausgabe + der Variablen $self in der Form 'key' + => 'value',. Alle keys sind + verfügbar.

3.2.2. Variablen ausgeben

Um eine Variable auszugeben, müssen sie einfach nur zwischen die + Tags geschrieben werden, also z.B. + <%variablenname%>.

Optional kann man auch mit Leerzeichen getrennte Flags angeben, + die man aber nur selten brauchen wird. Die Syntax sieht also so aus: + <%variablenname FLAG1 FLAG2%>. Momentan + werden die folgenden Flags unterstützt:

+ NOFORMAT gilt nur für Zahlenwerte und gibt + den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit + mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn + damit in der Vorlage z.B. von LaTeX gerechnet werden soll.
+ NOESCAPE unterdrückt das Escapen von + Sonderzeichen für die Vorlagensprache. Wenn also in einer + Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX + auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so + ist dieses Flag sinnvoll.

Beispiel:

<%quototal NOFORMAT%>

3.2.3. Verwendung in Druckbefehlen

In der Admininstration können Drucker definiert werden. Auch im + dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen + und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach + den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie + `...` nicht zu unerwünschtem Verhalten + führen.

Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl, + für das die Telefonnummer eines Ansprechpartners als Teil der + Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das + z.B. wie folgt aussehen:

send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%>

3.2.4. Anfang und Ende der Tags verändern

Der Standardstil für Tags sieht vor, dass ein Tag mit dem + Kleinerzeichen und einem Prozentzeichen beginnt und mit dem + Prozentzeichen und dem Größerzeichen endet, beispielsweise + <%customer%>. Da diese Form aber z.B. in + LaTeX zu Problemen führen kann, weil das Prozentzeichen dort + Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der + Stil umgestellt werden.

Dazu werden in die Datei Zeilen geschrieben, die mit dem für das + Format gültigen Kommentarzeichen anfangen, dann + config: enthalten, die entsprechende Option + setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen + enden. Beispiel für LaTeX:

% config: tag-style=($ $)

Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen, + wenn sie wie folgt aussehen: ($customer$). Das + äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:

<!-- config: tag-style=($ $) -->

3.2.5. Zuordnung von den Dateinamen zu den Funktionen

Diese folgende kurze Auflistung zeigt, welche Vorlage bei + welcher Funktion ausgelesen wird. Dabei ist die Dateiendung + ".ext" geeignet zu ersetzen: + ".tex" für LaTeX-Vorlagen und + ".odt" für OpenDocument-Vorlagen.

+ bin_list.ext +: Lagerliste
+ check.ext +: ?
+ invoice.ext +: Rechnung
+ packing_list.ext +: Packliste
+ pick_list.ext +: Sammelliste
+ purchase_delivery_order.ext +: Lieferschein (Einkauf)
+ purcharse_order.ext +: Bestellung an Lieferanten
+ request_quotation.ext +: Anfrage an Lieferanten
+ sales_delivery_order.ext +: Lieferschein (Verkauf)
+ sales_order.ext +: Bestellung
+ sales_quotation.ext +: Angebot an Kunden
+ zahlungserinnerung.ext +: Mahnung (Dateiname im Programm konfigurierbar)
+ zahlungserinnerung_invoice.ext +: Rechnung über Mahngebühren (Dateiname im Programm + konfigurierbar)

3.2.6. Sprache, Drucker und E-Mail

Angeforderte Sprache und Druckerkürzel in den Dateinamen mit + eingearbeitet. So wird aus der Vorlage + sales_order.ext bei Sprache + de und Druckerkürzel lpr2 + der Vorlagenname sales_order_de_lpr2.ext. + Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese + bekommen dann noch das Kürzel _email, der + vollständige Vorlagenname wäre dann + sales_order_email_de_lpr2.ext. In allen Fällen + kann eine Standarddatei default.ext hinterlegt + werden. Diese wird verwendet, wenn keine der anderen Varianten + gefunden wird.

Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit + der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF + verschickt wird, ist:

+ sales_order_email_de_lpr2.tex +
+ sales_order_de_lpr2.tex +
+ sales_order.tex +
+ default.tex +

Die kurzen Varianten dieser Vorlagentitel müssen dann entweder + Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten, + siehe dazu Metainformationen zur angeforderten Vorlage.

3.2.7. Allgemeine Variablen, die in allen Vorlagen vorhanden + sind

3.2.7.1. Metainformationen zur angeforderten Vorlage

Diese Variablen liefern Informationen darüber welche Variante + einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für + Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen + Formulare einbinden möchten.

+ template_meta.formname +: Basisname der Vorlage. Identisch mit der Zurordnung + zu den Dateinamen ohne die Erweiterung. Ein + Verkaufsauftrag enthält hier + sales_order.
+ template_meta.language.description +: Beschreibung der verwendeten Sprache
+ template_meta.language.template_code +: Vorlagenürzel der verwendeten Sprache, identisch mit dem + Kürzel das im Dateinamen verwendetet wird.
+ template_meta.language.output_numberformat +: Zahlenformat der verwendeten Sprache in der Form + "1.000,00". Experimentell! Nur + interessant für Vorlagen die mit unformatierten Werten + arbeiten.
+ template_meta.language.output_dateformat +: Datumsformat der verwendeten Sprache in der Form + "dd.mm.yyyy". Experimentell! Nur + interessant für Vorlagen die mit unformatierten Werten + arbeiten.
+ template_meta.format +: Das angeforderte Format. Kann im Moment die Werte + pdf, postscript, + html, opendocument, + opendocument_pdf und + excel enthalten.
+ template_meta.extension +: Dateierweiterung, wie im Dateinamen. Wird aus + format entschieden.
+ template_meta.media +: Ausgabemedium. Kann zur Zeit die Werte + screen für Bildschirm, + email für E-Mmail (triggert das + _email Kürzel im Dateinamen), + printer für Drucker, und + queue für Warteschlange enthalten.
+ template_meta.printer.description +: Beschreibung des ausgewählten Druckers
+ template_meta.printer.template_code +: Vorlagenürzel des ausgewählten Druckers, identisch mit + dem Kürzel das im Dateinamen verwendetet wird.

3.2.7.2. Stammdaten von Kunden und Lieferanten

+ account_number +: Kontonummer
+ bank +: Name der Bank
+ bank_code +: Bankleitzahl
+ bic +: Bank-Identifikations-Code (Bank Identifier Code, + BIC)
+ business +: Kunden-/Lieferantentyp
+ city +: Stadt
+ contact +: Kontakt
+ country +: Land
+ cp_email +: Email des Ansprechpartners
+ cp_givenname +: Vorname des Ansprechpartners
+ cp_greeting +: Anrede des Ansprechpartners
+ cp_name +: Name des Ansprechpartners
+ cp_phone1 +: Telefonnummer 1 des Ansprechpartners
+ cp_phone2 +: Telefonnummer 2 des Ansprechpartners
+ cp_title +: Titel des Ansprechpartners
+ creditlimit +: Kreditlimit
+ customeremail +: Email des Kunden; nur für Kunden
+ customerfax +: Faxnummer des Kunden; nur für Kunden
+ customernotes +: Bemerkungen beim Kunden; nur für Kunden
+ customernumber +: Kundennummer; nur für Kunden
+ customerphone +: Telefonnummer des Kunden; nur für Kunden
+ discount +: Rabatt
+ email +: Emailadresse
+ fax +: Faxnummer
+ homepage +: Homepage
+ iban +: Internationale Kontonummer (International Bank Account + Number, IBAN)
+ language +: Sprache
+ name +: Firmenname
+ payment_description +: Name der Zahlart
+ payment_terms +: Zahlungskonditionen
+ phone +: Telefonnummer
+ shiptocity +: Stadt (Lieferadresse) * +
+ shiptocontact +: Kontakt (Lieferadresse) * +
+ shiptocountry +: Land (Lieferadresse) * +
+ shiptodepartment1 +: Abteilung 1 (Lieferadresse) * +
+ shiptodepartment2 +: Abteilung 2 (Lieferadresse) * +
+ shiptoemail +: Email (Lieferadresse) * +
+ shiptofax +: Fax (Lieferadresse) * +
+ shiptoname +: Firmenname (Lieferadresse) * +
+ shiptophone +: Telefonnummer (Lieferadresse) * +
+ shiptostreet +: Straße und Hausnummer (Lieferadresse) * +
+ shiptozipcode +: Postleitzahl (Lieferadresse) * +
+ street +: Straße und Hausnummer
+ taxnumber +: Steuernummer
+ ustid +: Umsatzsteuer-Identifikationsnummer
+ vendoremail +: Email des Lieferanten; nur für Lieferanten
+ vendorfax +: Faxnummer des Lieferanten; nur für Lieferanten
+ vendornotes +: Bemerkungen beim Lieferanten; nur für Lieferanten
+ vendornumber +: Lieferantennummer; nur für Lieferanten
+ vendorphone +: Telefonnummer des Lieferanten; nur für + Lieferanten
+ zipcode +: Postleitzahl

	Anmerkung
	Anmerkung: Sind die `shipto`-Felder in den + Stammdaten nicht eingetragen, so haben die Variablen + `shipto` den gleichen Wert wie die die + entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich + einige `shipto*`-Variablen so nicht in den + Stammdaten wiederfinden sondern schlicht Kopien der + Lieferdatenvariablen sind (z.B. + `shiptocontact`).

3.2.7.3. Informationen über den Bearbeiter

+ employee_address +: Adressfeld
+ employee_businessnumber +: Firmennummer
+ employee_company +: Firmenname
+ employee_co_ustid +: Usatzsteuer-Identifikationsnummer
+ employee_duns +: DUNS-Nummer
+ employee_email +: Email
+ employee_fax +: Fax
+ employee_name +: voller Name
+ employee_signature +: Signatur
+ employee_taxnumber +: Steuernummer
+ employee_tel +: Telefonnummer

3.2.7.4. Informationen über den Bearbeiter

+ salesman_address +: Adressfeld
+ salesman_businessnumber +: Firmennummer
+ salesman_company +: Firmenname
+ salesman_co_ustid +: Usatzsteuer-Identifikationsnummer
+ salesman_duns +: DUNS-Nummer
+ salesman_email +: Email
+ salesman_fax +: Fax
+ salesman_name +: voller Name
+ salesman_signature +: Signatur
+ salesman_taxnumber +: Steuernummer
+ salesman_tel +: Telefonnummer

3.2.7.5. Variablen für die einzelnen Steuern

+ tax +: Steuer
+ taxbase +: zu versteuernder Betrag
+ taxdescription +: Name der Steuer
+ taxrate +: Steuersatz

3.2.8. Variablen in Rechnungen

3.2.8.1. Allgemeine Variablen

+ creditremaining +: Verbleibender Kredit
+ currency +: Währung
+ cusordnumber +: Bestellnummer beim Kunden
+ deliverydate +: Lieferdatum
+ duedate +: Fälligkeitsdatum
+ globalprojectnumber +: Projektnummer des ganzen Beleges
+ globalprojectdescription +: Projekbeschreibung des ganzen Beleges
+ intnotes +: Interne Bemerkungen
+ invdate +: Rechnungsdatum
+ invnumber +: Rechnungsnummer
+ invtotal +: gesamter Rechnungsbetrag
+ notes +: Bemerkungen der Rechnung
+ orddate +: Auftragsdatum
+ ordnumber +: Auftragsnummer, wenn die Rechnung aus einem Auftrag + erstellt wurde
+ payment_description +: Name der Zahlart
+ payment_terms +: Zahlungskonditionen
+ quodate +: Angebotsdatum
+ quonumber +: Angebotsnummer
+ shippingpoint +: Versandort
+ shipvia +: Transportmittel
+ subtotal +: Zwischensumme aller Posten ohne Steuern
+ total +: Restsumme der Rechnung (Summe abzüglich bereits + bezahlter Posten)
+ transaction_description +: Vorgangsbezeichnung
+ transdate +: Auftragsdatum wenn die Rechnung aus einem Auftrag + erstellt wurde

3.2.8.2. Variablen für jeden Posten auf der Rechnung

+ bin +: Stellage
+ description +: Artikelbeschreibung
+ discount +: Rabatt als Betrag
+ discount_sub +: Zwischensumme mit Rabatt
+ drawing +: Zeichnung
+ ean +: EAN-Code
+ image +: Grafik
+ linetotal +: Zeilensumme (Anzahl * Einzelpreis)
+ longdescription +: Langtext
+ microfiche +: Mikrofilm
+ netprice +: Nettopreis
+ nodiscount_linetotal +: Zeilensumme ohne Rabatt
+ nodiscount_sub +: Zwischensumme ohne Rabatt
+ number +: Artikelnummer
+ ordnumber_oe +: Auftragsnummer des Originalauftrags, wenn die Rechnung + aus einem Sammelauftrag erstellt wurde
+ p_discount +: Rabatt in Prozent
+ partnotes +: Die beim Artikel gespeicherten Bemerkungen
+ partsgroup +: Warengruppe
+ price_factor +: Der Preisfaktor als Zahl, sofern einer eingestellt + ist
+ price_factor_name +: Der Name des Preisfaktors, sofern einer eingestellt + ist
+ projectnumber +: Projektnummer
+ projectdescription +: Projektbeschreibung
+ qty +: Anzahl
+ reqdate +: Lieferdatum
+ runningnumber +: Position auf der Rechnung (1, 2, 3...)
+ sellprice +: Verkaufspreis
+ serialnumber +: Seriennummer
+ tax_rate +: Steuersatz
+ transdate_oe +: Auftragsdatum des Originalauftrags, wenn die Rechnung + aus einem Sammelauftrag erstellt wurde
+ unit +: Einheit
+ weight +: Gewicht

Für jeden Posten gibt es ein Unterarray mit den Informationen + über Lieferanten und Lieferantenartikelnummer. Diese müssen mit + einer foreach-Schleife ausgegeben werden, da + für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein + können. Die Variablen dafür lauten:

+ make +: Lieferant
+ model +: Lieferantenartikelnummer

3.2.8.3. Variablen für die einzelnen Zahlungseingänge

+ payment +: Betrag
+ paymentaccount +: Konto
+ paymentdate +: Datum
+ paymentmemo +: Memo
+ paymentsource +: Beleg

3.2.8.4. Benutzerdefinierte Kunden- und Lieferantenvariablen

Die vom Benutzer definierten Variablen für Kunden und + Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen + ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix + vc_cvar_ und dem vom Benutzer festgelegten + Variablennamen zusammen.

Beispiel: Der Benutzer hat eine Variable namens + number_of_employees definiert, die die Anzahl der + Mitarbeiter des Unternehmens enthält. Diese Variable steht dann + unter dem Namen vc_cvar_number_of_employees zur + Verfügung.

3.2.9. Variablen in Mahnungen und Rechnungen über Mahngebühren

3.2.9.1. Namen der Vorlagen

Die Namen der Vorlagen werden im System-Menü vom Benutzer + eingegeben. Wird für ein Mahnlevel die Option zur automatischen + Erstellung einer Rechnung über die Mahngebühren und Zinsen + aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem + Vorlagenname für diese Mahnstufe mit dem Zusatz + _invoice gebildet. Weiterhin werden die Kürzel + für die ausgewählte Sprache und den ausgewählten Drucker + angehängt.

3.2.9.2. Allgemeine Variablen in Mahnungen

Die Variablen des Verkäufers stehen wie gewohnt als + employee_... zur Verfügung. Die Adressdaten des + Kunden stehen als Variablen name, + street, zipcode, + city, country, + department_1, department_2, + und email zur Verfügung.

Weitere Variablen beinhalten:

+ dunning_date +: Datum der Mahnung
+ dunning_duedate +: Fälligkeitsdatum für diese Mahhnung
+ dunning_id +: Mahnungsnummer
+ fee +: Kummulative Mahngebühren
+ interest_rate +: Zinssatz per anno in Prozent
+ total_amount +: Gesamter noch zu zahlender Betrag als + fee + total_interest + + total_open_amount +
+ total_interest +: Zinsen per anno über alle Rechnungen
+ total_open_amount +: Summe über alle offene Beträge der Rechnungen

3.2.9.3. Variablen für jede gemahnte Rechnung in einer Mahnung

+ dn_amount +: Rechnungssumme (brutto)
+ dn_duedate +: Originales Fälligkeitsdatum der Rechnung
+ dn_dunning_date +: Datum der Mahnung
+ dn_dunning_duedate +: Fälligkeitsdatum der Mahnung
+ dn_fee +: Kummulative Mahngebühr
+ dn_interest +: Zinsen per anno für diese Rechnung
+ dn_invnumber +: Rechnungsnummer
+ dn_linetotal +: Noch zu zahlender Betrag (ergibt sich aus + dn_open_amount + dn_fee + + dn_interest)
+ dn_netamount +: Rechnungssumme (netto)
+ dn_open_amount +: Offener Rechnungsbetrag
+ dn_ordnumber +: Bestellnummer
+ dn_transdate +: Rechnungsdatum
+ dn_curr +: Währung, in der die Rechnung erstellt wurde. (Die + Rechnungsbeträge sind aber immer in der Hauptwährung)

3.2.9.4. Variablen in automatisch erzeugten Rechnungen über + Mahngebühren

Weitere Variablen beinhalten:

+ duedate +: Fälligkeitsdatum der Rechnung
+ dunning_id +: Mahnungsnummer
+ fee +: Mahngebühren
+ interest +: Zinsen
+ invamount +: Rechnungssumme (ergibt sich aus fee + + interest)
+ invdate +: Rechnungsdatum
+ invnumber +: Rechnungsnummer

3.2.10. Variablen in anderen Vorlagen

3.2.10.1. Einführung

Die Variablen in anderen Vorlagen sind ähnlich wie in der + Rechnung. Allerdings heißen die Variablen, die mit + inv beginnen, jetzt anders. Bei den Angeboten + fangen sie mit quo für "quotation" an: + quodate für Angebotsdatum etc. Bei Bestellungen + wiederum fangen sie mit ord für "order" an: + ordnumber für Bestellnummer etc.

Manche Variablen sind in anderen Vorlagen hingegen gar nicht + vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies + sind Variablen, die vom Geschäftsablauf her in der entsprechenden + Vorlage keine Bedeutung haben oder noch nicht belegt sein + können.

Im Folgenden werden nur wichtige Unterschiede zu den Variablen + in Rechnungen aufgeführt.

3.2.10.2. Angebote und Preisanfragen

+ quonumber +: Angebots- bzw. Anfragenummer
+ reqdate +: Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei + Preisanfragen)
+ transdate +: Angebots- bzw. Anfragedatum

3.2.10.3. Auftragsbestätigungen und Lieferantenaufträge

+ ordnumber +: Auftragsnummer
+ reqdate +: Lieferdatum
+ transdate +: Auftragsdatum

3.2.10.4. Lieferscheine (Verkauf und Einkauf)

+ cusordnumber +: Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer + des Lieferanten (im Einkauf)
+ donumber +: Lieferscheinnummer
+ transdate +: Lieferscheindatum

Für jede Position eines Lieferscheines gibt es ein Unterarray + mit den Informationen darüber, von welchem Lager und Lagerplatz aus + die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen + Lagerplatz sie eingelagert wurden. Diese müssen mittels einer + foreach-Schleife ausgegeben werden. Diese + Variablen sind:

+ si_bin +: Lagerplatz
+ si_chargenumber +: Chargennummer
+ si_bestbefore +: Mindesthaltbarkeit
+ si_number +: Artikelnummer
+ si_qty +: Anzahl bzw. Menge
+ si_runningnumber +: Positionsnummer (1, 2, 3 etc)
+ si_unit +: Einheit
+ si_warehouse +: Lager

3.2.10.5. Variablen für Sammelrechnung

+ c0total +: Gesamtbetrag aller Rechnungen mit Fälligkeit < 30 + Tage
+ c30total +: Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30 + und < 60 Tage
+ c60total +: Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60 + und < 90 Tage
+ c90total +: Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90 + Tage
+ total +: Gesamtbetrag aller Rechnungen

Variablen für jede Rechnungsposition in Sammelrechnung:

+ invnumber +: Rechnungsnummer
+ invdate +: Rechnungsdatum
+ duedate +: Fälligkeitsdatum
+ amount +: Summe der Rechnung
+ open +: Noch offener Betrag der Rechnung
+ c0 +: Noch offener Rechnungsbetrag mit Fälligkeit < 30 + Tage
+ c30 +: Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und + < 60 Tage
+ c60 +: Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und + < 90 Tage
+ c90 +: Noch offener Rechnungsbetrag mit Fälligkeit >= 90 + Tage

3.2.11. Blöcke, bedingte Anweisungen und Schleifen

3.2.11.1. Einfürhung

Der Parser kennt neben den Variablen einige weitere + Konstrukte, die gesondert behandelt werden. Diese sind wie + Variablennamen in spezieller Weise markiert: + <%anweisung%> ... <%end%> +

Anmerkung zum <%end%>: Der besseren + Verständlichkeit halber kann man nach dem end + noch beliebig weitere Wörter schreiben, um so zu markieren, welche + Anweisung (z.B. if oder + foreach) damit abgeschlossen wird.

Beispiel: Lautet der Beginn eines Blockes z.B. + <%if type == "sales_quotation"%>, so könnte + er mit <%end%> genauso abgeschlossen werden + wie mit <%end if%> oder auch + <%end type == "sales_quotation"%>.

3.2.11.2. Der if-Block

<%if variablenname%>
+...
+<%end%>

Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if" + und dem "end" werden nur ausgegeben, wenn die Variable + variablenname gesetzt und ungleich 0 ist.

Die Bedingung kann auch negiert werden, indem das Wort + not nach dem if verwendet + wird. Beispiel:

<%if not cp_greeting%>
+...
+<%end%>

Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist + oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt + einer Variablen mit einer festen Zeichenkette oder einer anderen + Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette + oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob + die rechte Seite des Vergleichsoperators in Anführungszeichen + gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit + anderer Variablen). Zwei Beispiele, die beide Vergleiche + zeigen:

<%if var1 == "Wert"%>

Testet die Variable var1 auf + übereinstimmung mit der Zeichenkette Wert. + Mittels != anstelle von == + würde auf Ungleichheit getestet.

%if var1 == var2%>

Testet die Variable var1 auf + übereinstimmung mit der Variablen var2. Mittel + != anstelle von == würde + auf Ungleichheit getestet.

Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit + auch Tests auf übereinstimmung mit regulären Ausdrücken ohne + Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient + dieselbe Syntax wie oben nur mit =~ und + !~ als Vergleichsoperatoren.

Beispiel für einen Test, ob die Variable + intnotes (interne Bemerkungen) das Wort + schwierig enthält:

<%if intnotes =~ "schwierig"%>

3.2.11.3. Der foreach-Block

<%foreach variablenname%>
+...
+<%end%>

Fügt die Zeilen zwischen den beiden Anweisungen so oft ein, + wie das Perl-Array der Variablen variablenname + Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen + Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern + benutzt. In jedem Durchlauf werden die zeilenbezogenen + Variablen jeweils auf den Wert für die aktuelle Position + gesetzt.

Die Syntax sieht normalerweise wie folgt aus:

<%foreach number%>
+Position: <%runningnumber%>
+Anzahl: <%qty%>
+Artikelnummer: <%number%>
+Beschreibung: <%description%>
+...
+<%end%>

Besonderheit in OpenDocument-Vorlagen: Tritt ein + <%foreach%>-Block innerhalb einer + Tabellenzelle auf, so wird die komplette Tabellenzeile so oft + wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der + Inhalt zwischen <%foreach%> und + <%end%> wiederholt, nicht aber die + komplette Zeile, in der er steht.

3.2.12. Markup-Code zur Textformatierung innerhalb von + Formularen

Wenn der Benutzer innhalb von Formularen in Lx-Office Text + anders formatiert haben möchte, so ist dies begrenzt möglich. + Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags. + Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung + Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird + dann automatisch in Anweisungen für das ausgewählte Vorlagenformat + (HTML oder PDF über LaTeX) umgesetzt.

Die unterstützen Formatierungen sind:

Text: Text wird in Fettdruck gesetzt.
Text: Text wird kursiv gesetzt.
Text: Text wird unterstrichen.
<s>Text</s>: Text wird durchgestrichen. Diese Formatierung ist nicht + bei der Ausgabe als PDF über LaTeX verfügbar.
<bullet>: Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe + unten).

Der Befehl <bullet> funktioniert + momentan auch nur in Latex-Vorlagen.

Zurück	Nach oben	Weiter
Kapitel 3. Features und Funktionen	Zum Anfang	3.3. Excel-Vorlagen

\ No newline at end of file diff --git a/doc/html/ch03s03.html b/doc/html/ch03s03.html new file mode 100644 index 000000000..f4133e9f2 --- /dev/null +++ b/doc/html/ch03s03.html @@ -0,0 +1,36 @@ + + + 3.3. Excel-Vorlagen

3.3. Excel-Vorlagen
Zurück	Kapitel 3. Features und Funktionen	Weiter

3.3. Excel-Vorlagen

3.3.1. Zusammenfassung

Dieses Dokument beschreibt den Mechanismus, mit dem + Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit + einhergehen.

3.3.2. Bedienung

Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert + werden. Die Konfigurationsoption heißt excel_templates = + 1 im Abschnitt [print_templates].

Eine Excelvorlage kann dann unter dem Namen einer beliebigen + anderen Vorlage mit der Endung .xls gespeichert + werden. In den normalen Verkaufsmasken taucht nun + Excel als auswählbares Format auf und kann von da + an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.

Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls + eine Angebotsvorlage und wird unter dem internen Namen der Angebote + sales_quotation.xls gespeichert.

3.3.3. Variablensyntax

Einfache Syntax: + <<varname>> +

Dabei sind << und + >> die Delimiter. Da Excel auf festen + Breiten besteht, kann der Tag künstlich verlängert werden, indem + weitere < oder > + eingefügt werden. Der Tag muss nicht symmetrisch sein. + Beispiel:

<<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

Um die Limitierung der festen Breite zu reduzieren, können + weitere Variablen in einem Block interpoliert werden. Whitespace wird + dazwishen dann erhalten. Beispiel:

<<<<<varname1 varname2   varname3>>>>>>>>>>>>>>>>>>>>>>>>>>

Die Variablen werden interpoliert, und linksbündig mit + Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu + lang, werden überzählige Zeichen abgeschnitten.

Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn + der Block mit einem Leerzeichen anfängt. Beispiel:

<<<<<<            varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger + Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende + entfernt.

3.3.4. Einschränkungen

Das Excelformat bis 2002 ist ein binäres Format, und kann nicht + mit vertretbarem Aufwand editiert werden. Der Templatemechanismus + beschränkt sich daher darauf, Textstellen exakt durch einen anderen + Text zu ersetzen.

Aus dem gleichen Grund sind die Kontrolllstrukturen + <%if%> und + <%foreach%> nicht vorhanden. Der Delimiter + <% %> kommt in den Headerinformationen + evtl. vor. Deshalb wurde auf den sichereren Delimiter + << und >> + gewechselt.

Zurück	Nach oben	Weiter
3.2. Dokumentenvorlagen und verfügbare Variablen	Zum Anfang	Kapitel 4. Entwicklerdokumentation

\ No newline at end of file diff --git a/doc/html/ch04.html b/doc/html/ch04.html new file mode 100644 index 000000000..2936deae8 --- /dev/null +++ b/doc/html/ch04.html @@ -0,0 +1,153 @@ + + + Kapitel 4. Entwicklerdokumentation

Kapitel 4. Entwicklerdokumentation
Zurück		Weiter

Kapitel 4. Entwicklerdokumentation

4.1. Globale Variablen

4.1.1. Wie sehen globale Variablen in Perl aus?

Globale Variablen liegen in einem speziellen namespace namens + "main", der von überall erreichbar ist. Darüber hinaus sind bareword + globs global und die meisten speziellen Variablen sind... + speziell.

Daraus ergeben sich folgende Formen:

+ $main::form +: expliziter Namespace "main"
+ $::form +: impliziter Namespace "main"
+ open FILE, "file.txt" +: + FILE ist global
+ $_ +: speziell

Im Gegensatz zu PHP™ gibt es kein + Schlüsselwort wie "global", mit dem man + importieren kann. my, our + und local machen was anderes.

+ my $form +: lexikalische Variable, gültig bis zum Ende des + Scopes
+ our $form +: + $form referenziert ab hier + $PACKAGE::form.
+ local $form +: Alle Änderungen an $form werden am Ende + des scopes zurückgesetzt

4.1.2. Warum sind globale Variablen ein Problem?

Das erste Problem ist FCGI™.

+ SQL-Ledger™ hat fast alles im globalen + namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist. + Unter FCGI™ müssen diese Sachen auch wieder + aufgeräumt werden, damit sie nicht in den nächsten Request kommen. + Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel + Datenbankverbindungen, weil die ne Ewigkeit zum initialisieren + brauchen.

Das zweite Problem ist strict. Unter + strict werden alle Variablen die nicht explizit + mit Package, my oder + our angegeben werden als Tippfehler angemarkert, + was einen vor so mancher Stunde suchen nach einem Bug erspart. Da + globale Variablen aber implizit mit Package angegeben werden, werden + die nicht geprüft, und ein Tippfehler da fällt niemandem auf.

4.1.3. Kanonische globale Variablen

Um dieses Problem im Griff zu halten gibt es einige wenige + globale Variablen, die kanonisch sind, und alles andere sollte + anderweitig umhergereicht werden.

Diese Variablen sind im Moment die folgenden neun:

+ $::form +
+ %::myconfig +
+ $::locale +
+ $::lxdebug +
+ $::auth +
+ $::lx_office_conf +
+ $::instance_conf +
+ $::dispatcher +
+ $::request +

Damit diese nicht als Müllhalde misbrauch werden, im Folgenden + eine kurze Erläuterung was man von denn erwarten kann.

4.1.3.1. $::form

Ist ein Objekt der Klasse + "Form"
Wird nach jedem Request gelöscht
Muss auch in Tests und Konsolenscripts vorhanden + sein.
Enthält am Anfang eines Requests die Requestparameter vom + User
Kann zwar intern über Requestgrenzen ein Datenbankhandle + cachen, das wird aber momentan absichtlich zerstört

+ $::form wurde unter SQL + Ledger™ als Gottobjekt für alles misbraucht. Sämtliche + alten Funktionen unter SL/ mutieren $::form, das + heißt, alles was einem lieb ist, sollte man vor einem Aufruf von zum + Beispiel IS->retrieve_customer() in + Sicherheit bringen.

Das Objekt der Klasse Form hat leider im Moment noch viele + zentrale Funktionen Gdie vom internen Zustand abhängen, deshalb + bitte nie einfach zerstören oder überschreiben. Es geht ziemlich + sicher etwas kaputt.

+ $::form ist gleichzeitig der Standard Scope + in den Template::Toolkit™ Templates + außerhalb der Controller: der Ausdruck [% var + %] greift auf $::form->{var} zu. + Unter Controllern ist der Standard Scope anders, da lautet der + Zugriff [% FORM.var %]. In Druckvorlagen sind + normale Variablen ebenfall im $::form Scope, d.h. + <%var%> zeigt auf + $::form->{var}. Innerhalb von Schleifen wird + $::form->{TEMPLATE_ARRAYS}{var}[$index] + bevorzugt, wenn vorhanden.

4.1.3.2. %::myconfig

Das einzige Hash unter den globalen Variablen
Wird spätestens benötigt wenn auf die Datenbank + zugegriffen wird
Wird bei jedem Request neu erstellt.
Enthält die Userdaten des aktuellen Logins
Sollte nicht ohne Filterung irgendwo gedumpt werden oder + extern serialisiert werden, weil da auch der Datenbankzugriff + für diesenuser drinsteht.
Enthält unter anderem Listenbegrenzung vclimit, + Datumsformat dateformat und Nummernformat numberformat
Enthält Datenbankzugriffinformationen

+ %::myconfig ist im Moment der Ersatz für + ein Userobjekt. Die meisten Funktionen, die etwas anhand des + aktuellen Users entscheiden müssen, befragen + %::myconfig.

4.1.3.3. $::locale

Objekt der Klasse "Locale"
Wird pro Request erstellt
Muss auch für Tests und Scripte immer verfügbar + sein.
Cached intern über Requestgrenzen hinweg benutzte + Locales

Lokalisierung für den aktuellen User. Alle Übersetzungen, + Zahlen- und Datumsformatierungen laufen über dieses Objekt.

4.1.3.4. $::lxdebug

Objekt der Klasse "LXDebug"
Wird global gecached
Muss immer verfügbar sein, in nahezu allen + Funktionen

+ $::lxdebug stellt Debuggingfunktionen + bereit, wie "enter_sub" und + "leave_sub", mit denen in den alten Modulen ein + brauchbares Tracing gebaut ist, "log_time", mit + der man die Wallclockzeit seit Requeststart loggen kann, sowie + "message" und "dump" mit + denen man flott Informationen ins Log packen kann.

4.1.3.5. $::auth

Objekt der Klasse "SL::Auth"
Wird global gecached
Hat eine permanente DB Verbindung zur Authdatenbank
Wird nach jedem Request resettet.

+ $::auth stellt Funktionen bereit um die + Rechte des aktuellen Users abzufragen. Obwohl diese Informationen + vom aktuellen User abhängen wird das Objekt aus + Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem + Request kurz resettet.

4.1.3.6. $::lx_office_conf

Objekt der Klasse + "SL::LxOfficeConf"
Global gecached
Repräsentation der + config/lx_office.conf[.default]-Dateien

Globale Konfiguration. Configdateien werden zum Start gelesen, + und nicht mehr angefasst. Es ist derzeit nicht geplant, dass das + Programm die Konfiguration ändern kann oder sollte.

Für die folgende Konfigurationsdatei:

[debug]
+file = /tmp/lxoffice_debug_log.txt

ist der Key file im Programm als + $::lx_office_conf->{debug}{file} + erreichbar.

	Warnung
	Zugriff auf die Konfiguration erfolgt im Moment über + Hashkeys, sind also nicht gegen Tippfehler abgesichert.

4.1.3.7. $::instance_conf

Objekt der Klasse + "SL::InstanceConfiguration"
wird pro Request neu erstellt

Funktioniert wie $::lx_office_conf, + speichert aber Daten die von der Instanz abhängig sind. Eine Instanz + ist hier eine Mandantendatenbank. Prominentestes Datum ist "eur", + die Information ob Bilanz oder Einnahmenüberschussrechnung gemacht + wird.

4.1.3.8. $::dispatcher

Objekt der Klasse + "SL::Dispatcher"
wird pro Serverprozess erstellt.
enthält Informationen über die technische Verbindung zum + Server

Der dritte Punkt ist auch der einzige Grund warum das Objekt + global gespeichert wird. Wird vermutlich irgendwann in einem anderen + Objekt untergebracht.

4.1.3.9. $::request

Hashref (evtl später Objekt)
Wird pro Request neu initialisiert.
Keine Unterstruktur garantiert.

+ $::request ist ein generischer Platz um + Daten "für den aktuellen Request" abzulegen. Sollte nicht für action + at a distance benutzt werden, sondern um lokales memoizing zu + ermöglichen, das garantiert am Ende des Requests zerstört + wird.

Vieles von dem, was im moment in $::form + liegt, sollte eigentlich hier liegen. Die groben + Differentialkriterien sind:

Kommt es vom User, und soll unverändert wieder an den User? Dann $::form, steht da eh schon
Sind es Daten aus der Datenbank, die nur bis zum Ende des Requests gebraucht werden? Dann + $::request +
Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann $::request, aber Zugriff über + Wrappermethode

4.1.4. Ehemalige globale Variablen

Die folgenden Variablen waren einmal im Programm, und wurden + entfernt.

4.1.4.1. $::cgi

war nötig, weil cookie Methoden nicht als + Klassenfunktionen funktionieren
Aufruf als Klasse erzeugt Dummyobjekt was im + Klassennamespace gehalten wird und über Requestgrenzen + leaked
liegt jetzt unter + $::request->{cgi} +

4.1.4.2. $::all_units

war nötig, weil einige Funktionen in Schleifen zum Teil + ein paar hundert mal pro Request eine Liste der Einheiten + brauchen, und de als Parameter durch einen Riesenstack von + Funktionen geschleift werden müssten.
Liegt jetzt unter + $::request->{cache}{all_units} +
Wird nur in + AM->retrieve_all_units() gesetzt oder + gelesen.

4.1.4.3. %::called_subs

wurde benutzt um callsub deep recursions + abzufangen.
Wurde entfernt, weil callsub nur einen Bruchteil der + möglichen Rekursioenen darstellt, und da nie welche + auftreten.
komplette recursion protection wurde entfernt.

Zurück		Weiter
3.3. Excel-Vorlagen	Zum Anfang	4.2. Entwicklung unter FastCGI

\ No newline at end of file diff --git a/doc/html/ch04s02.html b/doc/html/ch04s02.html new file mode 100644 index 000000000..e8b7b7b85 --- /dev/null +++ b/doc/html/ch04s02.html @@ -0,0 +1,42 @@ + + + 4.2. Entwicklung unter FastCGI

4.2. Entwicklung unter FastCGI
Zurück	Kapitel 4. Entwicklerdokumentation	Weiter

4.2. Entwicklung unter FastCGI

4.2.1. Allgemeines

Wenn Änderungen in der Konfiguration von Lx-Office gemacht + werden, muss der Webserver neu gestartet werden.

Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu + achten. Dadurch, dass das Programm in einer Endlosschleife läuft, + müssen folgende Aspekte beachtet werden.

4.2.2. Programmende und Ausnahmen

Betrifft die Funktionen warn, + die, exit, + carp und confess.

Fehler, die dass Programm normalerweise sofort beenden (fatale + Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm + am Laufen zu halten. Man kann mit die, + confess oder carp Fehler + ausgeben, die dann vom Dispatcher angezeigt werden. Die Lx-Office + eigene $::form-error()> tut im Prinzip das + Gleiche, mit ein paar Extraoptionen. warn und + exit hingegen werden nicht abgefangen. + warn wird direkt nach STDERR, also in Server Log + eine Nachricht schreiben (sofern in der Konfiguration nicht die + Warnungen in das Lx-Office Log umgeleitet wurden), und + exit wird die Ausführung beenden.

Prinzipiell ist es kein Beinbruch, wenn sich der Prozess + beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die + Ausnahme sein. Quintessenz: Bitte kein exit + benutzen, alle anderen Exceptionmechanismen sind ok.

4.2.3. Globale Variablen

Um zu vermeiden, dass Informationen von einem Request in einen + anderen gelangen, müssen alle globalen Variablen vor einem Request + sauber initialisiert werden. Das ist besonders wichtig im + $::cgi und $::auth Objekt, weil + diese nicht gelöscht werden pro Instanz, sondern persistent gehalten + werden.

In SL::Dispatcher gibt es einen sauber + abgetrennten Block, der alle kanonischen globalen Variablen listet und + erklärt. Bitte keine anderen einführen ohne das sauber zu + dokumentieren.

Datenbankverbindungen wird noch ein Guide verfasst werden, wie + man sicher geht, dass man die richtige erwischt.

4.2.4. Performance und Statistiken

Die kritischen Pfade des Programms sind die Belegmasken, und + unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der + Rechnungsmaske in Lx-Office 2.4.3 stable dauert auf einem Core2duo mit + 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0 + sind es je nach Menge der definierten Variablen 1-2s. Ab der + Moose/Rose::DB Version sind es 5-6s.

Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in + den kritischen Pfaden, unter 0,15 sonst.

4.2.5. Bekannte Probleme

4.2.5.1. Encoding Awareness

UTF-8 kodierte Installationen sind sehr anfällig gegen + fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln + falsch kodierte Zeichen eher unwissend, und geben sie einfach + weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand + das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu + beseitigen.

Zurück	Nach oben	Weiter
Kapitel 4. Entwicklerdokumentation	Zum Anfang	4.3. SQL-Upgradedateien

\ No newline at end of file diff --git a/doc/html/ch04s03.html b/doc/html/ch04s03.html new file mode 100644 index 000000000..41d3b50b1 --- /dev/null +++ b/doc/html/ch04s03.html @@ -0,0 +1,96 @@ + + + 4.3. SQL-Upgradedateien

4.3. SQL-Upgradedateien
Zurück	Kapitel 4. Entwicklerdokumentation	Weiter

4.3. SQL-Upgradedateien

4.3.1. Einführung

+ Der alte Mechanismus für SQL-Upgradescripte, der auf einer Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für + diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele Entwicklung im stable- und unstable-Baum betrifft. +

+ Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert. Es werden weiterhin alle Scripte aus sql/Pg-upgrade + ausgeführt. Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In diesem Verzeichnis muss pro Datenbankupgrade eine + Datei existieren, die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige Kontrollinformationen enthält. +

+ Neu sind die Kontrollinformationen, die Abhängigkeiten und Prioritäten definieren können werden, sodass Datenbankscripte zwar in + einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE" + angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern mehr braucht. +

+ Lx-Office merkt sich dabei, welches der Upgradescripte in sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht erneut + aus. Dazu dient die Tabelle "schema_info", die bei der Anmeldung automatisch angelegt wird. +

4.3.2. Format der Kontrollinformationen

+ Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält, + hat dabei das folgende Format: +

+ Für SQL-Upgradedateien: +

-- @key: value

+ Für Perl-Upgradedateien: +

# @key: value

+ Leerzeichen vor "value" werden entfernt. +

+ Die folgenden Schlüsselworte werden verarbeitet: +

+ tag +

+ Wird zwingend benötigt. Dies ist der "Name" des Upgrades. Dieser "tag" kann von anderen Kontrolldateien in ihren Abhängigkeiten + verwendet werden (Schlüsselwort "depends"). Der "tag" ist auch der Name, der in der Datenbank eingetragen wird. +

+ Normalerweise sollte die Kontrolldatei genau so heißen wie der "tag", nur mit der Endung ".sql" bzw. "pl". +

+ Ein Tag darf nur aus alphanumerischen Zeichen sowie den Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht erlaubt und + sollten stattdessen mit Unterstrichen ersetzt werden. +

+ charset +

+ Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "UTF-8". Aus + Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags der Zeichensatz "ISO-8859-15" + angenommen. +

+ description +

+ Benötigt. Eine Beschreibung, was in diesem Update passiert. Diese wird dem Benutzer beim eigentlichen Datenbankupdate + angezeigt. Während der Tag in englisch gehalten sein sollte, sollte die Beschreibung auf Deutsch erfolgen. +

+ depends +

+ Optional. Eine mit Leerzeichen getrennte Liste von "tags", von denen dieses Upgradescript abhängt. Lx-Office stellt sicher, dass + die in dieser Liste aufgeführten Scripte bereits durchgeführt wurden, bevor dieses Script ausgeführt wird. +

+ Abhängigkeiten werden rekursiv betrachtet. Wenn also ein Script "b" existiert, das von Änderungen in "a" abhängt, und eine neue + Kontrolldatei für "c" erstellt wird, die von Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den Tag "b" als + Abhängigkeit zu definieren. +

+ Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu definieren (z.B. "a" -> "b", + "b" -> "c" und "c" -> "a"). +

+ priority +

+ Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in der Scripte ausgeführt werden, die die gleichen Abhängigkeitstiefen + besitzen. Fehlt dieser Parameter, so wird der Wert 1000 benutzt. +

+ Dies ist reine Kosmetik. Für echte Reihenfolgen muss "depends" benutzt werden. Lx-Office sortiert die auszuführenden Scripte + zuerst nach der Abhängigkeitstiefe (wenn "z" von "y" abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von 2, "y" von 1 + und "x" von 0. "x" würde hier zuerst ausgeführt, dann "y", dann "z"), dann nach der Priorität und bei gleicher Priorität + alphabetisch nach dem "tag". +

4.3.3. Hilfsscript dbupgrade2_tool.pl

+ Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern, existiert ein Hilfsscript namens + "scripts/dbupgrade2_tool.pl". Es muss aus dem Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses + Tool liest alle Datenbankupgradescripte aus dem Verzeichnis sql/Pg-upgrade2 aus. Es benutzt dafür die gleichen + Methoden wie Lx-Office selber, sodass alle Fehlersituationen von der Kommandozeile überprüft werden können. +

+ Wird dem Script kein weiterer Parameter übergeben, so wird nur eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann + sich aber auch Informationen auf verschiedene Art ausgeben lassen: +

Listenform: "./scripts/dbupgrade2_tool.pl --list"
+ Gibt eine Liste aller Scripte aus. Die Liste ist in der Reihenfolge sortiert, in der Lx-Office die Scripte ausführen würde. Es + werden neben der Listenposition der Tag, die Abhängigkeitstiefe und die Priorität ausgegeben. +
Baumform: "./scripts/dbupgrade2_tool.pl --tree"
+ Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von denen keine + anderen abhängen. Die Unterknoten sind Scripte, die beim übergeordneten Script als Abhängigkeit eingetragen sind. +
Umgekehrte Baumform: "./scripts/dbupgrade2_tool.pl --rtree"
+ Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit der geringsten + Abhängigkeitstiefe. Die Unterknoten sind Scripte, die das übergeordnete Script als Abhängigkeit eingetragen haben. +
Baumform mit Postscriptausgabe: "./scripts/dbupgrade2_tool.pl --graphviz"
+ Benötigt das Tool "graphviz", um mit seiner Hilfe die umgekehrte Baumform in eine Postscriptdatei namens + "db_dependencies.ps" auszugeben. Dies ist vermutlich die übersichtlichste Form, weil hierbei jeder Knoten nur + einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben werden. +
+ Scripte, von denen kein anderes Script abhängt: "./scripts/dbupgrade2_tool.pl --nodeps" +
+ Listet die Tags aller Scripte auf, von denen keine anderen Scripte abhängen. +

Zurück	Nach oben	Weiter
4.2. Entwicklung unter FastCGI	Zum Anfang	4.4. Translations and languages

\ No newline at end of file diff --git a/doc/html/ch04s04.html b/doc/html/ch04s04.html new file mode 100644 index 000000000..e744c4f12 --- /dev/null +++ b/doc/html/ch04s04.html @@ -0,0 +1,81 @@ + + + 4.4. Translations and languages

4.4. Translations and languages
Zurück	Kapitel 4. Entwicklerdokumentation	Weiter

4.4. Translations and languages

4.4.1. Introduction

	Anmerkung
	Dieser Abschnitt ist in Englisch geschrieben, um + internationalen Übersetzern die Arbeit zu erleichtern.

This section describes how localization packages in Lx-Office + are built. Currently the only language fully supported is German, and + since most of the internal messages are held in English the English + version is usable too.

A stub version of French is included but not functunal at this + point.

4.4.2. File structure

The structure of locales in Lx-Office is:

lx-office/locale/<langcode>/

where <langcode> stands for an abbreviation of the + language package. The builtin packages use two letter ISO 639-1 codes, + but the actual name is not relevant for the program and can easily be + extended to IETF language + tags (i.e. "en_GB"). In fact the original language packages + from SQL Ledger are named in this way.

In such a language directory the following files are + recognized:

LANGUAGE

This file is mandatory.

The LANGUAGE file contains the self + descripted name of the language. It should contain a native + representation first, and in parenthesis an english translation + after that. Example:

Deutsch (German)

charset

This file should be present.

The charset file describes which + charset a language package is written in and applies to all + other language files in the package. It is possible to write + some language packages without an explicit charset, but it is + still strongly recommended. You'll never know in what + environment your language package will be used, and neither + UTF-8 nor Latin1 are guaranteed.

The whole content of this file is a string that can be + recognized as a valid charset encoding. Example:

UTF-8

all

This file is mandatory.

The central translation file. It is essentially an inline + Perl script autogenerated by locales.pl. To + generate it, generate the directory and the two files mentioned + above, and execute the following command:

scripts/locales.pl <langcode>

Otherwise you can simply copy one of the other languages. + You will be told how many are missing like this:

$ scripts/locales.pl en
+English - 0.6% - 2015/2028 missing

A file named "missing" will be + generated and can be edited. You can also edit the + "all" file directly. Edit everything you + like to fit the target language and execute + locales.pl again. See how the missing words + get fewer.

Num2text

Legacy code from SQL Ledger. It provides a means for + numbers to be converted into natural language, like + 1523 => one thousand five hundred twenty + three. If you want to provide it, it must be inlinable + Perl code which provides a num2text sub. If + an init sub exists it will be executed + first.

Only used in the check and receipt printing module.

special_chars

Lx-Office comes with a lot of interfaces to different + formats, some of which are rather picky with their accepted + charset. The special_chars file contains a + listing of chars not suited for different file format and + provides substitutions. It is written in "Simple Ini" style, + containing a block for every file format.

First entry should be the order of substitution for + entries as a whitespace separated list. All entries are + interpolated, so \n, \x20 + and \\ all work.

After that every entry is a special char that should be + translated when writing text into such a file.

Example:

[Template/XML]
+order=& < > \n
+&=&amp;
+<=&lt;
+>=&gt;
+\n=<br>

Note the importance of the order in this example. + Substituting < and > befor & would lead to $gt; become + &gt;

For a list of valid formats, see the German + special_chars entry. As of this writing the + following are recognized:

HTML
+URL@HTML
+Template/HTML
+Template/XML
+Template/LaTeX
+Template/OpenDocument
+filenames

The last of which is very machine dependant. Remember that + a lot of characters are forbidden by some filesystems, for + exmaple MS Windows doesn't like ':' in its files where Linux + doesn't mind that. If you want the files created with your + language pack to be portable, find all chars that could cause + trouble.

missing

This file is not a part of the language package + itself.

This is a file generated by + scripts/locales.pl while processing your + locales. It's only to have the missing entries singled out and + does not belong to a language package.

lost

This file is not a part of the language package + itself.

Another file generated by + scripts/locales.pl. If for any reason a + translation does not appear anymore and can be deleted, it gets + moved here. The last 50 or so entries deleted are saved here in + case you made a typo, so that you don't have to translate + everything again. If a tranlsation is missing, the lost file is + checked first. If you maintain a language package, you might + want to keep this safe somewhere.

Zurück	Nach oben	Weiter
4.3. SQL-Upgradedateien	Zum Anfang	4.5. Stil-Richtlinien

\ No newline at end of file diff --git a/doc/html/ch04s05.html b/doc/html/ch04s05.html new file mode 100644 index 000000000..442f3e05b --- /dev/null +++ b/doc/html/ch04s05.html @@ -0,0 +1,134 @@ + + + 4.5. Stil-Richtlinien

4.5. Stil-Richtlinien
Zurück	Kapitel 4. Entwicklerdokumentation	Weiter

4.5. Stil-Richtlinien

+ Die folgenden Regeln haben das Ziel, den Code möglichst gut les- und wartbar zu machen. Dazu gehört zum Einen, dass der Code + einheitlich eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden wird (Stichworte "Klammern" oder "Hash-Keys"). +

+ Diese Regeln sind keine Schikane sondern erleichtern allen das Leben! +

+ Jeder, der einen Patch schickt, sollte seinen Code vorher überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere + nicht. +

+ Es werden keine echten Tabs sondern Leerzeichen verwendet. +

+ Die Einrückung beträgt zwei Leerzeichen. Beispiel: +

foreach my $row (@data) {
+  if ($flag) {
+    # do something with $row
+  }
+
+  if ($use_modules) {
+    $row->{modules} = MODULE->retrieve(
+      id   => $row->{id},
+      date => $use_now ? localtime() : $row->{time},
+    );
+  }
+
+  $report->add($row);
+}

Öffnende geschweifte Klammern befinden sich auf der gleichen Zeile wie der letzte Befehl. Beispiele:
```
sub debug {
+  ...
+}
```
oder
```
if ($form->{item_rows} > 0) {
+  ...
+}
```
+ Schließende geschweifte Klammern sind so weit eingerückt wie der Befehl / die öffnende schließende Klammer, die den Block gestartet + hat, und nicht auf der Ebene des Inhalts. Die gleichen Beispiele wie bei 3. gelten. +
+ Die Wörter "else", "elsif", "while" befinden sich auf der gleichen + Zeile wie schließende geschweifte Klammern. Beispiele: +
```
if ($form->{sum} > 1000) {
+  ...
+} elsif ($form->{sum} > 0) {
+  ...
+} else {
+  ...
+}
+
+do {
+  ...
+} until ($a > 0);
```
+ Parameter von Funktionsaufrufen müssen mit runden Klammern versehen werden. Davon nicht betroffen sind interne Perl-Funktionen, + und grep-ähnliche Operatoren. Beispiel: +
```
$main::lxdebug->message("Could not find file.");
+%options = map { $_ => 1 } grep { !/^#/ } @config_file;
```

+ Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen: +

+ Generell gilt: Hashkeys und Arrayindices sollten nicht durch Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig, + Blöcke schon. Beispiel: +

if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
+  ...
+}
+
+$array[$i + 1]             = 4;
+$form->{sum}              += $form->{"row_$i"};
+$form->{ $form->{index} } += 1;
+
+map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;

+ Mehrzeilige Befehle +
1. + Werden die Parameter eines Funktionsaufrufes auf mehrere Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt + werden, in der die ersten Funktionsparameter in der ersten Zeile stehen. Beispiel: +
```
$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
+                    $form->{some_col_value});
```
2. + Ein Spezialfall ist der ternäre Oprator "?:", der am besten in einer übersichtlichen Tabellenstruktur organisiert + wird. Beispiel: +
```
my $rowcount = $form->{"row_$i"} ? $i
+             : $form->{oldcount} ? $form->{oldcount} + 1
+             :                     $form->{rowcount} - $form->{rowbase};
```
+ Kommentare +
1. Kommentare, die alleine in einer Zeile stehen, sollten soweit wie der Code eingerückt sein.
2. Seitliche hängende Kommentare sollten einheitlich formatiert werden.
3. + Sämtliche Kommentare und Sonstiges im Quellcode ist bitte auf Englisch zu verfassen. So wie ich keine Lust habe, französischen + Quelltext zu lesen, sollte auch der Lx-Office Quelltext für nicht-Deutschsprachige lesbar sein. Beispiel: +
```
my $found = 0;
+while (1) {
+  last if $found;
+
+  # complicated check
+  $found = 1 if //
+}
+
+$i  = 0        # initialize $i
+$n  = $i;      # save $i
+$i *= $const;  # do something crazy
+$i  = $n;      # recover $i
```
+ Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation gewünscht ist. Beispiel: +
```
$form->{sum}      = 0;
+$form->{"row_$i"} = $form->{"row_$i"} - 5;
+$some_hash{42}    = 54;
```
+ Die maximale Zeilenlänge ist nicht bescränkt. Zeilenlängen unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber + wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in grossen Tabellen), dann ist Lesbarkeit vorzuziehen. +
+ Als Beispiel sei die Funktion print_options aus bin/mozilla/io.pl angeführt. +
+ Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die + diffs verfälschen. +
+ Emacs und vim haben beide recht einfache Methoden zur Entfernung von trailing whitespace. Emacs kennt das Kommande + nuke-trailing-whitespace, vim macht das gleiche manuell über :%s/\s\+$//e Mit :au + BufWritePre * :%s/\s\+$//e wird das an Speichern gebunden. +
+ Es wird kein perltidy verwendet. +
+ In der Vergangenheit wurde versucht, perltidy zu verwenden, um einen einheitlichen Stil zu erlangen. Es hat + sich aber gezeigt, dass perltidys sehr eigenwilliges Verhalten, was Zeilenumbrüche angeht, oftmals gut + formatierten Code zerstört. Für den Interessierten sind hier die perltidy-Optionen, die grob den + beschriebenen Richtlinien entsprechen: +
```
-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
+-aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
+-lp -vt=1 -vtc=1
```
+ + STDERR ist tabu. Unkonditionale Debugmeldungen auch. +
+ Lx-Office bietet mit dem Modul LXDebug einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen + Grund, nach STDERR zu schreiben. +
+ Die LXDebug-Methode "message" nimmt als ersten Paramter außerdem eine Flagmaske, für + die die Meldung angezeigt wird, wobei "0" immer angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden und werden in + den meisten Fällen auch vom Repository zurückgewiesen. +
+ Alle neuen Module müssen use strict verwenden. +
+ + $form, $auth, $locale, $lxdebug und + %myconfig werden derzeit aus dem main package importiert (siehe Globale Variablen. Alle anderen + Konstrukte sollten lexikalisch lokal gehalten werden. +

Zurück	Nach oben	Weiter
4.4. Translations and languages	Zum Anfang	4.6. Dokumentation erstellen

\ No newline at end of file diff --git a/doc/html/ch04s06.html b/doc/html/ch04s06.html new file mode 100644 index 000000000..2c152a51c --- /dev/null +++ b/doc/html/ch04s06.html @@ -0,0 +1,39 @@ + + + 4.6. Dokumentation erstellen

4.6. Dokumentation erstellen
Zurück	Kapitel 4. Entwicklerdokumentation

4.6. Dokumentation erstellen

4.6.1. Einführung

+ Diese Dokumentation ist in DocBook™ XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein + Text-Editor. Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen Editor nutzt, der spezielle Unterstützung für + DocBook™ mitbringt. Wir empfehlen dafür den XMLmind XML + Editor, der bei nicht kommerzieller Nutzung kostenlos ist. +

4.6.2. Benötigte Software

+ Bei DocBook™ ist Prinzip, dass ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden dann + mit entsprechenden Stylesheets andere Formate wie PDF oder HTML erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script + scripts/build_doc.sh. +

+ Das Script benötigt zur Konvertierung verschiedene Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht benötigt werden: +

+ + Java in einer halbwegs aktuellen Version +
+ Das Java-Build-System Apache Ant + +
+ Das Dokumentations-System Dobudish für DocBook™ 4.5, eine Zusammenstellung diverser Stylesheets und + Grafiken zur Konvertierung von DocBook™ XML in andere Formate. Das Paket, das benötigt wird, ist zum + Zeitpunkt der Dokumentationserstellung dobudish-nojre-1.1.4.zip, aus auf code.google.com bereitsteht. +

+ Apache Ant sowie ein dazu passendes Java Runtime Environment sind auf allen gängigen Plattformen verfügbar. Beispiel für + Debian/Ubuntu: +

apt-get install ant openjdk-7-jre

+ Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis doc/build entpackt werden. Beispiel unter der + Annahme, das Dobudish™ in $HOME/Downloads heruntergeladen wurde: +

cd doc/build
+unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip

4.6.3. PDFs und HTML-Seiten erstellen

+ Die eigentliche Konvertierung erfolgt nach Installation der benötigten Software mit einem einfachen Aufruf direkt aus dem + Lx-Office-Installationsverzeichnis heraus: +

./scripts/build_doc.sh

4.6.4. Einchecken in das Git-Repository

+ Sowohl die XML-Datei als auch die erzeugten PDF- und HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass nach + Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut und alles zusammen in einem Commit eingecheckt werden sollten. +

+ Die "dobudish"-Verzeichnisse bzw. symbolischen Links gehören hingegen nicht in das Repository. +

Zurück	Nach oben
4.5. Stil-Richtlinien	Zum Anfang

\ No newline at end of file diff --git a/doc/html/images/admon/blank.png b/doc/html/images/admon/blank.png new file mode 100644 index 000000000..764bf4f0c Binary files /dev/null and b/doc/html/images/admon/blank.png differ diff --git a/doc/html/images/admon/caution.png b/doc/html/images/admon/caution.png new file mode 100644 index 000000000..5b7809ca4 Binary files /dev/null and b/doc/html/images/admon/caution.png differ diff --git a/doc/html/images/admon/caution.svg b/doc/html/images/admon/caution.svg new file mode 100644 index 000000000..dd84f3fe3 --- /dev/null +++ b/doc/html/images/admon/caution.svg @@ -0,0 +1,25 @@ + + + + + + + + +]> + diff --git a/doc/html/images/admon/draft.png b/doc/html/images/admon/draft.png new file mode 100644 index 000000000..59673fe1c Binary files /dev/null and b/doc/html/images/admon/draft.png differ diff --git a/doc/html/images/admon/home.png b/doc/html/images/admon/home.png new file mode 100644 index 000000000..cbb711de7 Binary files /dev/null and b/doc/html/images/admon/home.png differ diff --git a/doc/html/images/admon/home.svg b/doc/html/images/admon/home.svg new file mode 100644 index 000000000..e803a3178 --- /dev/null +++ b/doc/html/images/admon/home.svg @@ -0,0 +1,26 @@ + + + + + + + + +]> + diff --git a/doc/html/images/admon/important.png b/doc/html/images/admon/important.png new file mode 100644 index 000000000..12c90f607 Binary files /dev/null and b/doc/html/images/admon/important.png differ diff --git a/doc/html/images/admon/important.svg b/doc/html/images/admon/important.svg new file mode 100644 index 000000000..dd84f3fe3 --- /dev/null +++ b/doc/html/images/admon/important.svg @@ -0,0 +1,25 @@ + + + + + + + + +]> + diff --git a/doc/html/images/admon/next.png b/doc/html/images/admon/next.png new file mode 100644 index 000000000..45835bf89 Binary files /dev/null and b/doc/html/images/admon/next.png differ diff --git a/doc/html/images/admon/next.svg b/doc/html/images/admon/next.svg new file mode 100644 index 000000000..75fa83ed8 --- /dev/null +++ b/doc/html/images/admon/next.svg @@ -0,0 +1,19 @@ + + + + + + +]> + diff --git a/doc/html/images/admon/note.png b/doc/html/images/admon/note.png new file mode 100644 index 000000000..d0c3c645a Binary files /dev/null and b/doc/html/images/admon/note.png differ diff --git a/doc/html/images/admon/note.svg b/doc/html/images/admon/note.svg new file mode 100644 index 000000000..648299d26 --- /dev/null +++ b/doc/html/images/admon/note.svg @@ -0,0 +1,33 @@ + + + + + + + + + + + + +]> + diff --git a/doc/html/images/admon/prev.png b/doc/html/images/admon/prev.png new file mode 100644 index 000000000..cf24654f8 Binary files /dev/null and b/doc/html/images/admon/prev.png differ diff --git a/doc/html/images/admon/prev.svg b/doc/html/images/admon/prev.svg new file mode 100644 index 000000000..6d88ffdd0 --- /dev/null +++ b/doc/html/images/admon/prev.svg @@ -0,0 +1,19 @@ + + + + + + +]> + diff --git a/doc/html/images/admon/tip.png b/doc/html/images/admon/tip.png new file mode 100644 index 000000000..5c4aab3bb Binary files /dev/null and b/doc/html/images/admon/tip.png differ diff --git a/doc/html/images/admon/tip.svg b/doc/html/images/admon/tip.svg new file mode 100644 index 000000000..4a64a1500 --- /dev/null +++ b/doc/html/images/admon/tip.svg @@ -0,0 +1,31 @@ + + + + + + + + +]> + diff --git a/doc/html/images/admon/toc-blank.png b/doc/html/images/admon/toc-blank.png new file mode 100644 index 000000000..6ffad17a0 Binary files /dev/null and b/doc/html/images/admon/toc-blank.png differ diff --git a/doc/html/images/admon/toc-minus.png b/doc/html/images/admon/toc-minus.png new file mode 100644 index 000000000..abbb020c8 Binary files /dev/null and b/doc/html/images/admon/toc-minus.png differ diff --git a/doc/html/images/admon/toc-plus.png b/doc/html/images/admon/toc-plus.png new file mode 100644 index 000000000..941312ce0 Binary files /dev/null and b/doc/html/images/admon/toc-plus.png differ diff --git a/doc/html/images/admon/up.png b/doc/html/images/admon/up.png new file mode 100644 index 000000000..07634de26 Binary files /dev/null and b/doc/html/images/admon/up.png differ diff --git a/doc/html/images/admon/up.svg b/doc/html/images/admon/up.svg new file mode 100644 index 000000000..d31aa9c80 --- /dev/null +++ b/doc/html/images/admon/up.svg @@ -0,0 +1,19 @@ + + + + + + +]> + diff --git a/doc/html/images/admon/warning.png b/doc/html/images/admon/warning.png new file mode 100644 index 000000000..1c33db8f3 Binary files /dev/null and b/doc/html/images/admon/warning.png differ diff --git a/doc/html/images/admon/warning.svg b/doc/html/images/admon/warning.svg new file mode 100644 index 000000000..fc8d7484c --- /dev/null +++ b/doc/html/images/admon/warning.svg @@ -0,0 +1,23 @@ + + + + + + + + +]> + diff --git a/doc/html/images/aquadot.jpg b/doc/html/images/aquadot.jpg new file mode 100644 index 000000000..853a0d812 Binary files /dev/null and b/doc/html/images/aquadot.jpg differ diff --git a/doc/html/images/callouts/1.png b/doc/html/images/callouts/1.png new file mode 100644 index 000000000..7d473430b Binary files /dev/null and b/doc/html/images/callouts/1.png differ diff --git a/doc/html/images/callouts/10.png b/doc/html/images/callouts/10.png new file mode 100644 index 000000000..997bbc824 Binary files /dev/null and b/doc/html/images/callouts/10.png differ diff --git a/doc/html/images/callouts/2.png b/doc/html/images/callouts/2.png new file mode 100644 index 000000000..5d09341b2 Binary files /dev/null and b/doc/html/images/callouts/2.png differ diff --git a/doc/html/images/callouts/3.png b/doc/html/images/callouts/3.png new file mode 100644 index 000000000..ef7b70047 Binary files /dev/null and b/doc/html/images/callouts/3.png differ diff --git a/doc/html/images/callouts/4.png b/doc/html/images/callouts/4.png new file mode 100644 index 000000000..adb8364eb Binary files /dev/null and b/doc/html/images/callouts/4.png differ diff --git a/doc/html/images/callouts/5.png b/doc/html/images/callouts/5.png new file mode 100644 index 000000000..4d7eb4600 Binary files /dev/null and b/doc/html/images/callouts/5.png differ diff --git a/doc/html/images/callouts/6.png b/doc/html/images/callouts/6.png new file mode 100644 index 000000000..0ba694af6 Binary files /dev/null and b/doc/html/images/callouts/6.png differ diff --git a/doc/html/images/callouts/7.png b/doc/html/images/callouts/7.png new file mode 100644 index 000000000..472e96f8a Binary files /dev/null and b/doc/html/images/callouts/7.png differ diff --git a/doc/html/images/callouts/8.png b/doc/html/images/callouts/8.png new file mode 100644 index 000000000..5e60973c2 Binary files /dev/null and b/doc/html/images/callouts/8.png differ diff --git a/doc/html/images/callouts/9.png b/doc/html/images/callouts/9.png new file mode 100644 index 000000000..a0676d26c Binary files /dev/null and b/doc/html/images/callouts/9.png differ diff --git a/doc/html/images/draft.png b/doc/html/images/draft.png new file mode 100644 index 000000000..1c9d23ceb Binary files /dev/null and b/doc/html/images/draft.png differ diff --git a/doc/html/images/out.png b/doc/html/images/out.png new file mode 100644 index 000000000..c3ae8766b Binary files /dev/null and b/doc/html/images/out.png differ diff --git a/doc/html/images/quoleft.gif b/doc/html/images/quoleft.gif new file mode 100644 index 000000000..b16218b04 Binary files /dev/null and b/doc/html/images/quoleft.gif differ diff --git a/doc/html/images/skr04-update-3804/konto3804.png b/doc/html/images/skr04-update-3804/konto3804.png new file mode 100644 index 000000000..e66b66a2e Binary files /dev/null and b/doc/html/images/skr04-update-3804/konto3804.png differ diff --git a/doc/html/images/skr04-update-3804/konto4315.png b/doc/html/images/skr04-update-3804/konto4315.png new file mode 100644 index 000000000..d9971cfb9 Binary files /dev/null and b/doc/html/images/skr04-update-3804/konto4315.png differ diff --git a/doc/html/images/skr04-update-3804/steuer3803.png b/doc/html/images/skr04-update-3804/steuer3803.png new file mode 100644 index 000000000..361c0b3de Binary files /dev/null and b/doc/html/images/skr04-update-3804/steuer3803.png differ diff --git a/doc/html/images/skr04-update-3804/steuer3804.png b/doc/html/images/skr04-update-3804/steuer3804.png new file mode 100644 index 000000000..fad59869a Binary files /dev/null and b/doc/html/images/skr04-update-3804/steuer3804.png differ diff --git a/doc/html/images/skr04-update-3804/steuerliste.png b/doc/html/images/skr04-update-3804/steuerliste.png new file mode 100644 index 000000000..2c4945c90 Binary files /dev/null and b/doc/html/images/skr04-update-3804/steuerliste.png differ diff --git a/doc/html/images/somerights.png b/doc/html/images/somerights.png new file mode 100644 index 000000000..1792d8b65 Binary files /dev/null and b/doc/html/images/somerights.png differ diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 000000000..e045d1838 --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,5 @@ + + + Lx-Office: Installation, Konfiguration, Entwicklung

Lx-Office: Installation, Konfiguration, Entwicklung
		Weiter

Lx-Office: Installation, Konfiguration, Entwicklung

Inhaltsverzeichnis

1. Aktuelle Hinweise

2. Installation und Grundkonfiguration

2.1. Benötigte Software und Pakete

2.1.1. Betriebssystem
2.1.2. Pakete

2.2. Manuelle Installation des Programmpaketes

2.3. Lx-Office-Konfigurationsdatei

2.3.1. Einführung
2.3.2. Abschnitte und Parameter
2.3.3. Versionen vor 2.6.3

2.4. Anpassung der PostgreSQL-Konfiguration

2.4.1. Zeichensätze/die Verwendung von UTF-8
2.4.2. Änderungen an Konfigurationsdateien
2.4.3. Erweiterung für servergespeicherte Prozeduren
2.4.4. Datenbankbenutzer anlegen

2.5. Webserver-Konfiguration

2.5.1. Grundkonfiguration mittels CGI
2.5.2. Konfiguration für FastCGI/FCGI

2.6. Der Task-Server

2.6.1. Verfügbare und notwendige Konfigurationsoptionen
2.6.2. Automatisches Starten des Task-Servers beim Booten
2.6.3. Wie der Task-Server gestartet und beendet wird

2.7. Benutzerauthentifizierung und Administratorpasswort

2.7.1. Grundlagen zur Benutzerauthentifizierung
2.7.2. Administratorpasswort
2.7.3. Authentifizierungsdatenbank
2.7.4. Passwortüberprüfung
2.7.5. Name des Session-Cookies
2.7.6. Anlegen der Authentifizierungsdatenbank

2.8. Benutzer- und Gruppenverwaltung

2.8.1. Zusammenhänge
2.8.2. Datenbanken anlegen
2.8.3. Gruppen anlegen
2.8.4. Benutzer anlegen
2.8.5. Gruppenmitgliedschaften verwalten
2.8.6. Migration alter Installationen

2.9. Drucken mit Lx-Office

2.10. OpenDocument-Vorlagen

2.11. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR

2.11.1. Einführung
2.11.2. Konfigurationsparameter
2.11.3. Festlegen der Parameter
2.11.4. Bemerkungen zu Bestandsmethode
2.11.5. Bekannte Probleme

2.12. Lx-Office ERP verwenden

3. Features und Funktionen

3.1. Wiederkehrende Rechnungen

3.1.1. Einführung
3.1.2. Konfiguration
3.1.3. Auflisten
3.1.4. Erzeugung der eigentlichen Rechnungen
3.1.5. Erste Rechnung für aktuellen Monat erstellen

3.2. Dokumentenvorlagen und verfügbare Variablen

3.2.1. Einführung
3.2.2. Variablen ausgeben
3.2.3. Verwendung in Druckbefehlen
3.2.4. Anfang und Ende der Tags verändern
3.2.5. Zuordnung von den Dateinamen zu den Funktionen
3.2.6. Sprache, Drucker und E-Mail
3.2.7. Allgemeine Variablen, die in allen Vorlagen vorhanden + sind
3.2.8. Variablen in Rechnungen
3.2.9. Variablen in Mahnungen und Rechnungen über Mahngebühren
3.2.10. Variablen in anderen Vorlagen
3.2.11. Blöcke, bedingte Anweisungen und Schleifen
3.2.12. Markup-Code zur Textformatierung innerhalb von + Formularen

3.3. Excel-Vorlagen

3.3.1. Zusammenfassung
3.3.2. Bedienung
3.3.3. Variablensyntax
3.3.4. Einschränkungen

4. Entwicklerdokumentation

4.1. Globale Variablen

4.1.1. Wie sehen globale Variablen in Perl aus?
4.1.2. Warum sind globale Variablen ein Problem?
4.1.3. Kanonische globale Variablen
4.1.4. Ehemalige globale Variablen

4.2. Entwicklung unter FastCGI

4.2.1. Allgemeines
4.2.2. Programmende und Ausnahmen
4.2.3. Globale Variablen
4.2.4. Performance und Statistiken
4.2.5. Bekannte Probleme

4.3. SQL-Upgradedateien

4.3.1. Einführung
4.3.2. Format der Kontrollinformationen
4.3.3. Hilfsscript dbupgrade2_tool.pl

4.4. Translations and languages

4.4.1. Introduction
4.4.2. File structure

4.5. Stil-Richtlinien

4.6. Dokumentation erstellen

4.6.1. Einführung
4.6.2. Benötigte Software
4.6.3. PDFs und HTML-Seiten erstellen
4.6.4. Einchecken in das Git-Repository

		Weiter
		Kapitel 1. Aktuelle Hinweise

\ No newline at end of file diff --git a/doc/html/style.css b/doc/html/style.css new file mode 100644 index 000000000..b001aba85 --- /dev/null +++ b/doc/html/style.css @@ -0,0 +1,453 @@ +ï»¿/* Basic Settings: */ + +body { + background-color: White; /* black foreground */ + color: Black; /* center the body content in browser window */ + margin: auto; /* padding ("inner margin") leaves space between */ + padding: 24px; /* set width according to browser window width */ + width: auto; /* text alignment */ + text-align: justify; /* text-align: left; */ +} + +/* para */ +p { + /* font size, line height, font */ + /* list of fonts provides fallbacks if a font is not present */ + font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; + + /* margin (top - right - bottom - left) */ + margin: 0 15px 6px 15px; +} + + + + +/* NEEDS TO BE CLEARED UP */ + + +p, td, li, dt, dd +{ + /* font size, line height, font */ + /* list of fonts provides fallbacks if a font is not present */ + font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; +} + + + +/* set font for most elements */ +/* p: paragraphs (regular text, docbook ) */ +/* (...) */ +/* body: anything else */ +body, p, td, li, dt, dd, +{ +/* set font size and line height */ +/* list of fonts provides fallbacks if a font is not present */ +font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; +} + +/* images */ +/* docbook: */ +img { +/* no margin */ +margin: 0; + +/* no padding ("inner margin") */ +padding: 0; + +/* no border */ +border: 0; +} + + +/* emphasized text, can occur in most places */ +/* docbook: */ +em { +/* bold face, higher number is more bold */ +font-weight: 600; +/* italic */ +font-style: italic; +} + + +/* sect(ion)1 title */ +h2 { + font-family: Georgia, Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 125%; /* bold face, higher number is more bold */ + font-weight: 600; /* underlined text */ + text-decoration: none; /* foreground color: dark blue */ + color: Black; /* background color: gray */ + background-color: Orange; /* margin settings are top - right - bottom - left (think clockwise) */ + margin: 15px 0 15px 0; /* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ + padding: 8px 15px 8px 15px; + /* border: 1px solid #000; */ +} + + +/* sect(ion)2 title */ +h3 { + font-family: Georgia, Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 110%; /* bold face, higher number is more bold */ + font-weight: 600; /* underlined text */ + text-decoration: none; /* foreground color: dark blue */ + color: Black; /* background-color is a very light grey */ + background-color: #fefefe; /* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ + padding: 0 0 0 15px; +} + + +/* sect(ion)3 title */ +h4 { + font-family: Georgia, Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 100%; /* bold face, higher number is more bold */ + font-weight: 600; /* underlined text */ + text-decoration: none; /* foreground color: dark blue */ + color: Black; /* background-color is a very light grey */ + background-color: #fefefe; /* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ + padding: 0 0 0 15px; +} + + +/* sect(ion)4 title */ +h5 { + font-family: Georgia, Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 100%; /* bold face, higher number is more bold */ + font-weight: 300; /* not underlined */ + text-decoration: none; /* foreground color: dark blue */ + color: Black; /* background-color is a very light grey */ + background-color: #fefefe; /* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ + padding: 0 0 0 15px; +} + +/* the following formats refer to the docbook tags of the same name */ +/* for more information, see the docbook reference at */ +/* http://www.docbook.org/tdg/en/html/docbook.html */ + +.mediaobject +{ +/* center */ +text-align: center; +} + + +/* */ +.calloutlist, .figure, .table +{ +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 15px 30px 15px 30px; +} + + +/* */ +.itemizedlist, .variablelist { +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 15px 30px 15px 15px; +} + +/* blockquote formatting is a little more complex */ +/* because block quotes are rendered as a html table */ + +/* blockquote block */ +.blockquote +{ +/* override bottom margin, the other margins are inherited */ +margin-bottom: 30px; +} + +.blockquote p, .blockquote td +{ +/* set font size and line height */ +/* list of fonts provides fallbacks if a font is not present */ +font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; + +/* bold face, higher number is more bold */ +font-weight: 450; +} + + +.epigraph +{ +/* override bottom margin, the other margins are inherited */ +margin-bottom: 30px; +} + +.epigraph p, .epigraph td +{ +/* set font size and line height */ +/* list of fonts provides fallbacks if a font is not present */ +font: 10px/14px Verdana, Arial, Helvetica, Sans-Serif; + +/* bold face, higher number is more bold */ +font-weight: 600; +} + + + +/* custom header and footer that are displayed on all pages */ +#customheader, #customfooter +{ +/* list of fonts provides fallbacks if a font is not present */ +font-family: Verdana, Arial, Helvetica, Sans-Serif; + +/* font size, relative to body font size */ +font-size: 80%; + +/* line height, relative to body font size */ +line-height: 200%; + + +text-align: center; +vertical-align: middle; +color: #fff; +background-color: #009; +} + + +/* leave more space between last paragraph and footer */ +/* some browser do not add up the bottom margin of the prior element */ +/* and the top margin of the footer */ +#customfooter { +margin-top: 15px; +} + + + +/* table { margin: 0 15px 6px 15px; } */ + + +/* title and navigation links in header and footer */ +.navheader th, .navheader td, .navfooter th, .navfooter td +{ +font-size: 11px; +font-weight: 450; +} + + +/* table of contents, list of figures and list of tables */ +.toc, .list-of-figures, .list-of-tables, .list-of-examples +{ +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 15px 30px 15px 15px; +} + + +/* the "headings" are rendered as paragraphs */ +.toc p, .list-of-figures p, .list-of-tables p, .list-of-examples p +{ +/* no margin */ +margin: 0; +} + + +.figure +{ +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 5px 5px 5px 5px; + +/* no padding ("inner border") */ +padding: 0; + +/* no border */ +border: 0; + +/* center text */ +text-align: center; +} + + +/* figure title */ +.figure p, .table p, .example p +{ +font-size: 80%; +} + + +/* +acronym { + border-bottom: 1px dashed #00cc00; + cursor: help; +} +*/ + + +/* admonition headings */ +div.note, div.important, div.warning, div.caution, div.tip +{ +padding: 0px 15px 0px 0px; +} + +div.note th, div.important th, div.warning th, div.caution th, div.tip th +{ +/* set font size and line height */ +/* list of fonts provides fallbacks if a font is not present */ +font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; + +font-weight: 600; + +text-decoration: underline; + +/* left align */ +text-align: left; +} + +.note p, .important p, .warning p, .caution p, .tip p +{ +margin: 0; +} + +.note img, .important img, .warning img, .caution img, .tip img +{ +margin: 0px 15px 0px 15px; +} + + +/* programlisting */ +pre.programlisting +{ +/* non-proportional font */ +/* list of fonts provides fallbacks if a font is not present */ +font-family: "Courier New", Courier, Monospace; + +/* color: black */ +color: #000; + +/* background color: gray */ +background-color: #eee; + +/* no margin */ +margin: 0; + +/* gray dotted border, 1 px wide */ +border: 1px dotted #ddd; + +/* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ +padding: 6px 6px 6px 6px; +} + + +/* title page */ + + +/* heading1 is used for document title */ +h1 +{ + font-family: Georgia,Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 150%; /* bold face, higher number is more bold */ + font-weight: 600; /* line height, relative to body line height */ + line-height: 250%; /* center */ + text-align: center; /* foreground color: dark blue */ + color: Black; /* background color: gray */ + background-color: Orange; /* margin settings are top - right - bottom - left (think clockwise) */ + margin: 15px 0 15px 0; /* no padding ("inner margin") */ + padding: 15; + border: 1px solid #000; +} + + + +/* author on title page is formatted as h3 */ +/* these settings overwrite the regular h3 settings */ +h3.author { +/* set font size and line height */ +/* list of fonts provides fallbacks in case selected fonts are not present */ +font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; + +/* bold face, higher number is more bold */ +font-weight: 600; + +/* do not underline */ +text-decoration: none; + +/* center text */ +text-align: center; + +/* color: black */ +color: #000; + +/* background-color is a very light grey */ +/* alternative: #fff = white */ +background-color: #fefefe; + +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 0 15px 15px 15px; + +/* no padding */ +padding: 0; + +/* no border */ +border: 0; +} + + +/* copyright and date */ +.copyright, .pubdate +{ +/* list of fonts provides fallbacks if a font is not present */ +font-family: Verdana, Arial, Helvetica, Sans-Serif; + +/* font size, relative to body font size */ +font-size: 90%; + +/* center */ +text-align: center; + +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 15px 15px 15px 15px; + +/* no padding ("inner margin") */ +padding: 0; + +/* no border */ +border: 0; +} + + +/* legal notice box */ +div.legalnotice +{ + font-family: Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 90%; /* color: black */ + color: #000; /* background color: gray */ + background-color: Orange; /* margin settings are top - right - bottom - left (think clockwise) */ + margin: 10px 45px 10px 45px; /* padding ("inner margin") settings are top - right - bottom - left */ + padding: 5px 5px 5px 5px; /* solid black border, 1px wide */ + border: 1px solid #000; +} + + +table { + /* border: thin solid orange; */ + border-spacing: 0pt; + margin-top: 5; + margin-bottom: 5; +} + +td { + font-family: SansSerif, Arial, Helvetica, sans-serif; + padding-left: 1; + padding-right: 1; + padding-top: 1; + padding-bottom: 1 +} + +th { + /* border: thin solid orange; */ + padding-left: 1; + padding-right: 1; + padding-top: 1; + padding-bottom: 1 +} + +.informaltable { + border-collapse: collapse; + table-layout: auto; +} + +.revhistory { + border-collapse: collapse; + table-layout: auto; +} \ No newline at end of file diff --git a/scripts/build_doc.sh b/scripts/build_doc.sh index 1e15d298d..ce96ffe43 100755 --- a/scripts/build_doc.sh +++ b/scripts/build_doc.sh @@ -11,6 +11,26 @@ if [[ ! -d doc ]]; then exit 1 fi +html=1 +pdf=1 + +if [[ ! -z $1 ]] ; then + html=0 + pdf=0 + while [[ ! -z $1 ]] ; do + case $1 in + html) html=1 ;; + pdf) pdf=1 ;; + *) + echo "Unknown parameter $1" + exit 1 + ;; + esac + + shift + done +fi + dobudish=$(ls -d doc/build/dobudish* 2> /dev/null) if [[ -z $dobudish ]] || [[ ! -d ${dobudish} ]]; then @@ -29,16 +49,21 @@ input=${base}/input output=${base}/output custom=${base}/custom-cfg -rm -f ${input}/*.xml -cp ../../dokumentation.xml ${input}/ +rm -rf ${input} ${custom} +mkdir ${input} ${input}/copy_to_output ${custom} -rm -f ${custom}/* +cp ../../dokumentation.xml ${input}/ +cp -R ../../images ${input}/copy_to_output/ cp -R ../custom-cfg/* ${custom}/ -./generator.sh dokumentation pdf -cp ${output}/pdf/dokumentation.pdf ../../ +if [[ $pdf = 1 ]] ; then + ./generator.sh dokumentation pdf + cp ${output}/pdf/dokumentation.pdf ../../ +fi -./generator.sh dokumentation html -rm -rf ../../html -mkdir ../../html -cp -R ${output}/html ../../html +if [[ $html = 1 ]]; then + ./generator.sh dokumentation html + rm -rf ../../html + mkdir ../../html + cp -R ${output}/html ../../ +fi