From: Moritz Bunkus Date: Fri, 22 Mar 2019 11:55:56 +0000 (+0100) Subject: Dokumentation: HTML & PDF gebaut X-Git-Tag: release-3.5.4~88^2 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=42298d2ceb5206a3d8df0a5cd9989eff5ebb843e;p=kivitendo-erp.git Dokumentation: HTML & PDF gebaut --- diff --git a/doc/html/ch02s05.html b/doc/html/ch02s05.html index f464835af..d8703fa78 100644 --- a/doc/html/ch02s05.html +++ b/doc/html/ch02s05.html @@ -1,7 +1,13 @@ 2.5. Anpassung der PostgreSQL-Konfiguration
2.5. Anpassung der PostgreSQL-Konfiguration
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

2.5. Anpassung der PostgreSQL-Konfiguration

PostgreSQL muss auf verschiedene Weisen angepasst werden.

Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden. - Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):

2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8

kivitendo setzt zwingend voraus, dass die Datenbank + Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):

2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8

kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen braucht man hier meist nicht einzugreifen.

Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht diff --git a/doc/html/ch02s06.html b/doc/html/ch02s06.html index bf4786ec9..7ca08d098 100644 --- a/doc/html/ch02s06.html +++ b/doc/html/ch02s06.html @@ -1,6 +1,6 @@ - 2.6. Webserver-Konfiguration

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

2.6. Webserver-Konfiguration

2.6.1. Grundkonfiguration mittels CGI

[Anmerkung]Anmerkung

Für einen deutlichen Performanceschub sorgt die Ausführung + 2.6. Webserver-Konfiguration

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

2.6. Webserver-Konfiguration

2.6.1. Grundkonfiguration mittels CGI

[Anmerkung]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 @@ -106,13 +106,13 @@ AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispat Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/

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

2.6.3. Authentifizierung mittels HTTP Basic Authentication

+ FastCGI-Version.

2.6.3. Authentifizierung mittels HTTP Basic Authentication

Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt (siehe RFC 7617). Dazu ist es aber nötig, dass der dabei vom Client mitgeschickte Header Authorization vom Webserver an Kivitendo über die Umgebungsvariable HTTP_AUTHORIZATION weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die folgende Konfigurationsoption aktiviert werden: - 

SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1

2.6.4. Weitergehende Konfiguration

Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung + 

SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1

2.6.4. Weitergehende Konfiguration

Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung von kivitendo nur über https-verschlüsselten Verbindungen, sowie weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser diff --git a/doc/html/ch02s07.html b/doc/html/ch02s07.html index ded915adb..0dfca390a 100644 --- a/doc/html/ch02s07.html +++ b/doc/html/ch02s07.html @@ -39,7 +39,7 @@ 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.7.3.1. SystemV-basierende Systeme (z.B. ältere Debian, ältere + anstelle eines symbolischen Links verwendet werden können.

2.7.3.1. SystemV-basierende Systeme (z.B. ältere Debian, ältere openSUSE, ältere Fedora)

Kopieren Sie die Datei scripts/boot/system-v/kivitendo-task-server nach /etc/init.d/kivitendo-task-server. Passen @@ -47,12 +47,12 @@ DAEMON=....). Binden Sie das Script in den Boot-Prozess ein. Dies ist distributionsabhängig:

  • Debian-basierende Systeme:

    update-rc.d kivitendo-task-server defaults
 insserv kivitendo-task-server

  • Ältere openSUSE und ältere Fedora:

    chkconfig --add kivitendo-task-server

Danach kann der Task-Server mit dem folgenden Befehl gestartet - werden:

/etc/init.d/kivitendo-task-server start

2.7.3.2. Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)

Kopieren Sie die Datei + werden:

/etc/init.d/kivitendo-task-server start

2.7.3.2. Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)

Kopieren Sie die Datei scripts/boot/upstart/kivitendo-task-server.conf nach /etc/init/kivitendo-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 kivitendo-task-server start

2.7.3.3. systemd-basierende Systeme (z.B. neure openSUSE, neuere + werden:

service kivitendo-task-server start

2.7.3.3. systemd-basierende Systeme (z.B. neure openSUSE, neuere Fedora, neuere Ubuntu und neuere Debians)

Kopieren Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach /etc/systemd/system/. Passen Sie in der diff --git a/doc/html/ch02s13.html b/doc/html/ch02s13.html index 57b2b07fc..026b043e2 100644 --- a/doc/html/ch02s13.html +++ b/doc/html/ch02s13.html @@ -63,14 +63,14 @@ Verzeichnis umbenannt werden.

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.

2.13.1. OpenDocument (odt) Druckvorlagen mit Makros

OpenDocument Vorlagen können Makros enthalten, welche komplexere + überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.

2.13.1. OpenDocument (odt) Druckvorlagen mit Makros

OpenDocument Vorlagen können Makros enthalten, welche komplexere Aufgaben erfüllen.

Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit Schweizer Bank-Einzahlungsscheinen (BESR). Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung zu beachten ist (in fett sind nötige einmalige - Anpassungen aufgeführt):

2.13.1.1. Bezeichnung der Vorlagen

Rechnung: invoice_besr.odt, Auftrag: - sales_order_besr.odt

2.13.1.2. Vorbereitungen im Adminbereich

Damit beim Erstellen von Rechnungen und Aufträgen neben der + Anpassungen aufgeführt):

2.13.1.1. Bezeichnung der Vorlagen

Rechnung: invoice_besr.odt, Auftrag: + sales_order_besr.odt

2.13.1.2. Vorbereitungen im Adminbereich

Damit beim Erstellen von Rechnungen und Aufträgen neben der Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix ein Drucker eingerichtet werden:

  • Druckeradministration → Drucker hinzufügen

  • Mandant wählen

  • Druckerbeschreibung → aussagekräftiger Text: wird in der @@ -79,11 +79,11 @@ Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf aber nicht leer sein)

  • Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die zwischen - "invoice_" bzw. "sales_order_" und ".odt" steht.)

  • speichern

2.13.1.3. Benutzereinstellungen

Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung + "invoice_" bzw. "sales_order_" und ".odt" steht.)

  • speichern

    • 2.13.1.3. Benutzereinstellungen

    Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann dies persönlich für sich bei den Benutzereinstellungen konfigurieren:

    • Programm → Benutzereinstellungen → Druckoptionen

    • Standardvorlagenformat → OpenDocument/OASIS

    • Standardausgabekanal → Bildschirm

    • Standarddrucker → gewünschte Druckerbeschreibung auswählen - (z.B. mit Einzahlungsschein Bank xy)

    • Anzahl Kopien → leer

    • speichern

    2.13.1.4. Aufbau und nötige Anpassungen der Vorlagen

    In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die + (z.B. mit Einzahlungsschein Bank xy)

  • Anzahl Kopien → leer

  • speichern

    • 2.13.1.4. Aufbau und nötige Anpassungen der Vorlagen

    In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die aus dem von kivitendo erzeugten odt-Dokument die korrekte Referenznummer inklusive Prüfziffer sowie die Kodierzeile in OCRB-Schrift erzeugen und am richtigen Ort ins Dokument @@ -112,12 +112,12 @@ angepasst werden. Dabei ist darauf zu achten, dass sich die Positionen der Postkonto-Nummern der Bank, sowie der Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht - verschieben.

    2.13.1.5. Auswahl der Druckvorlage in kivitendo beim Erzeugen einer + verschieben.

    2.13.1.5. Auswahl der Druckvorlage in kivitendo beim Erzeugen einer odt-Rechnung (analog bei Auftrag)

    Im Fussbereich der Rechnungsmaske muss neben Rechnung, OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei den Benutzereinstellungen als persönlicher Standard gewählt - wurde.

    2.13.1.6. Makroeinstellungen in LibreOffice anpassen

    Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung + wurde.

    2.13.1.6. Makroeinstellungen in LibreOffice anpassen

    Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung die Meldung kommt, dass Makros aus Sicherheitsgründen nicht ausgeführt werden, so müssen folgende Einstellungen in LibreOffice angepasst werden:

    • Extras → Optionen → Sicherheit → Makrosicherheit

    • Sicherheitslevel auf "Mittel" einstellen (Diese diff --git a/doc/html/ch03s03.html b/doc/html/ch03s03.html index 9b0c68bf3..628bc9091 100644 --- a/doc/html/ch03s03.html +++ b/doc/html/ch03s03.html @@ -613,7 +613,7 @@ invdate

      Rechnungsdatum

      invnumber -

      Rechnungsnummer

    3.3.10. Variablen in anderen Vorlagen

    3.3.10.1. Einführung

    Die Variablen in anderen Vorlagen sind ähnlich wie in der +

    Rechnungsnummer

    3.3.10. Variablen in anderen Vorlagen

    3.3.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: diff --git a/doc/html/ch03s07.html b/doc/html/ch03s07.html index ba8e49374..cebc5337f 100644 --- a/doc/html/ch03s07.html +++ b/doc/html/ch03s07.html @@ -1,15 +1,15 @@ - 3.7. Artikelklassifizierung

    3.7. Artikelklassifizierung
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.7. Artikelklassifizierung

    3.7.1. Übersicht

    Die Klassifizierung von Artikeln dient einer weiteren + 3.7. Artikelklassifizierung

    3.7. Artikelklassifizierung
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.7. Artikelklassifizierung

    3.7.1. Übersicht

    Die Klassifizierung von Artikeln dient einer weiteren Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber auf mehrere Zeichen erweitert werden, falls zur Unterscheidung - notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.

    3.7.2. Basisklassifizierung

    Als Basisklassifizierungen gibt es

    • Einkauf

    • Verkauf

    • Handelsware

    • Produktion

    • - keine - (diese wird bei einer Aktualisierung für alle + notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.

    3.7.2. Basisklassifizierung

    Als Basisklassifizierungen gibt es

    • Einkauf

    • Verkauf

    • Handelsware

    • Produktion

    • - keine - (diese wird bei einer Aktualisierung für alle existierenden Artikel verwendet und ist gültig für Verkauf und Einkauf)

    Es können weitere Klassifizierungen angelegt werden. So kann es - z.B. für separat auszuweisende Artikel folgende Klassen geben:

    • Lieferung (Logistik, Transport) mit Kürzel L

    • Material (Verpackungsmaterial) mit Kürzel M

    3.7.3. Attribute

    Bisher haben die Klassifizierungen folgende Attribute, die auch + z.B. für separat auszuweisende Artikel folgende Klassen geben:

    • Lieferung (Logistik, Transport) mit Kürzel L

    • Material (Verpackungsmaterial) mit Kürzel M

    3.7.3. Attribute

    Bisher haben die Klassifizierungen folgende Attribute, die auch alle gleichzeitg gültig sein können

    • gültig für Verkauf - dieser Artikel kann im Verkauf genutzt werden

    • gültig für Einkauf - dieser Artikel kann im Einkauf genutzt werden

    • separat ausweisen - hierzu gibt es zur Dokumentengenerierung @@ -19,7 +19,7 @@ pro separat auszuweisenden Klassifizierungen die Variable< %separate_X_subtotal%>, wobei X das Kürzel der Klassifizierung ist.

      Im obigen Beispiel wäre das für Lieferkosten <%separate_L_subtotal%> und für Verpackungsmaterial - <%separate_M_subtotal%>.

    3.7.4. Zwei-Zeichen Abkürzung

    Der Typ des Artikels und die Klassifizierung werden durch zwei + <%separate_M_subtotal%>.

    3.7.4. Zwei-Zeichen Abkürzung

    Der Typ des Artikels und die Klassifizierung werden durch zwei Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware Erzeugnis oder Dienstleistung und ggf. weiterer Typen.

    Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig) diff --git a/doc/html/ch03s08.html b/doc/html/ch03s08.html index 2a6575d27..d3d3ecb78 100644 --- a/doc/html/ch03s08.html +++ b/doc/html/ch03s08.html @@ -1,10 +1,10 @@ - 3.8. Dateiverwaltung (Mini-DMS)

    3.8. Dateiverwaltung (Mini-DMS)
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.8. Dateiverwaltung (Mini-DMS)

    3.8.1. Übersicht

    Parallel zum alten WebDAV gibt es ein Datei-Management-System, + 3.8. Dateiverwaltung (Mini-DMS)

    3.8. Dateiverwaltung (Mini-DMS)
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.8. Dateiverwaltung (Mini-DMS)

    3.8.1. Übersicht

    Parallel zum alten WebDAV gibt es ein Datei-Management-System, das Dateien verschiedenen Typs verwaltet. Dies können

    1. aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,

    2. zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,

    3. per Scanner eingelesene PDF-Dateien,

    4. per E-Mail empfangene Dateianhänge unterschiedlichen - Formats,

    5. sowie speziel für Artikel hochgeladene Bilder sein.

    3.8.2. Struktur

    Über eine vom Speichermedium unabhängige Zwischenschicht werden + Formats,

  • sowie speziel für Artikel hochgeladene Bilder sein.

    • 3.8.2. Struktur

    Über eine vom Speichermedium unabhängige Zwischenschicht werden die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter können verschiedene Implementierungen (Backends) gleichzeitig existieren:

    • Dateisystem

    • WebDAV

    • Schnittstelle zu externen @@ -23,7 +23,7 @@ für "attachment" und "image" nur die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe - Datenbank-Konfigurierung).

    3.8.3. Anwendung

    Die Daten werden bei den ERP-Objekten als extra Reiter + Datenbank-Konfigurierung).

    3.8.3. Anwendung

    Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und "Dateianhänge".

    Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so @@ -39,13 +39,13 @@ so sind diese z.B. bei Einkaufsrechnungen sichtbar:

    Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend an ein anderes ERP-Objekt angehängt werden.

    Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie - sind bisher nur bei Bildern relevant.

    3.8.4. Konfigurierung

    3.8.4.1. Mandantenkonfiguration

    3.8.4.1.1. Reiter "Features"

    Unter dem Reiter Features + sind bisher nur bei Bildern relevant.

    3.8.4. Konfigurierung

    3.8.4.1. Mandantenkonfiguration

    3.8.4.1.1. Reiter "Features"

    Unter dem Reiter Features im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das Dateimangement generell zu- und abschaltbar, sowie die Zuordnung der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie die maximale Uploadgröße sind Backend-unabhängig

    Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier noch - ergänzbar.

    3.8.4.1.2. Reiter "Allgemeine Dokumentenanhänge"

    Unter dem Reiter Allgemeine + ergänzbar.

    3.8.4.1.2. Reiter "Allgemeine Dokumentenanhänge"

    Unter dem Reiter Allgemeine Dokumentenanhänge kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf ) allgemeingültige Anhänge hochgeladen werden.

    Diese Anhänge werden beim Generieren von PDF-Dateien an die diff --git a/doc/html/ch03s09.html b/doc/html/ch03s09.html index 41416a387..612816b57 100644 --- a/doc/html/ch03s09.html +++ b/doc/html/ch03s09.html @@ -1,13 +1,13 @@ - 3.9. Webshop-Api

    3.9. Webshop-Api
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.9. Webshop-Api

    Das Shopmodul bietet die Möglichkeit Onlineshopartikel und + 3.9. Webshop-Api

    3.9. Webshop-Api
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.9. Webshop-Api

    Das Shopmodul bietet die Möglichkeit Onlineshopartikel und Onlineshopbestellungen zu verwalten und zu bearbeiten.

    Es ist Multishopfähig, d.h. Artikel können mehreren oder unterschiedlichen Shops zugeordnet werden. Bestellungen können aus mehreren Shops geholt werden.

    Zur Zeit bietet das Modul nur einen Connector zur REST-Api von Shopware. Weitere Connectoren können dazu programmiert und eingerichtet - werden.

    3.9.1. Rechte für die Webshopapi

    In der Administration können folgende Rechte vergeben - werden

    • Webshopartikel anlegen und bearbeiten

    • Shopbestellungen holen und bearbeiten

    • Shop anlegen und bearbeiten

    3.9.2. Konfiguration

    Unter System->Webshops können Shops angelegt und konfiguriert - werden

    3.9.3. Webshopartikel

    3.9.3.1. Shopvariablenreiter in Artikelstammdaten

    Mit dem Recht "Shopartikel anlegen und bearbeiten" und des + werden.

    3.9.1. Rechte für die Webshopapi

    In der Administration können folgende Rechte vergeben + werden

    • Webshopartikel anlegen und bearbeiten

    • Shopbestellungen holen und bearbeiten

    • Shop anlegen und bearbeiten

    3.9.2. Konfiguration

    Unter System->Webshops können Shops angelegt und konfiguriert + werden

    3.9.3. Webshopartikel

    3.9.3.1. Shopvariablenreiter in Artikelstammdaten

    Mit dem Recht "Shopartikel anlegen und bearbeiten" und des Markers "Shopartikel" in den Basisdaten zeigt sich der Reiter "Shopvariablen" in den Artikelstammdaten. Hier können jetzt die Artikel mit @@ -16,11 +16,11 @@ Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet werden. Artikelbilder gelten für alle Shops.

    Die Artikelgruppen werden direkt vom Shopsystem geholt somit ist es möglich einen Artikel auch mehreren Gruppen - zuzuordenen

    3.9.3.2. Shopartikelliste

    Unter dem Menu Webshop->Webshop Artikel hat man nochmal + zuzuordenen

    3.9.3.2. Shopartikelliste

    Unter dem Menu Webshop->Webshop Artikel hat man nochmal eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel unter verschiedenen Kriterien <alles><nur Preis><nur Bestand><Preis und Bestand> an die jeweiligen Shops - hochzuladen.

    3.9.4. Bestellimport

    Unter dem Menupunkt Webshop->Webshop Import öffnet sich die + hochzuladen.

    3.9.4. Bestellimport

    Unter dem Menupunkt Webshop->Webshop Import öffnet sich die Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder einzeln als Auftrag zu transferieren. Die Liste kann nach @@ -52,7 +52,7 @@ auch der Grund für die Auftragssperre sein.

  • Die Buttons "Auftrag erstellen" und "Kunde mit Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde aus dem Listing ausgewählt ist.

  • Es ist aber möglich die Shopbestellung zu löschen.

  • Ist eine Bestellung schon übernommen, zeigen sich an dieser - Stelle, die dazugehörigen Belegverknüpfungen.

    • 3.9.5. Mapping der Daten

    Das Mapping der kivitendo Daten mit den Shopdaten geschieht in + Stelle, die dazugehörigen Belegverknüpfungen.

    3.9.5. Mapping der Daten

    Das Mapping der kivitendo Daten mit den Shopdaten geschieht in der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm z.B.:SL/ShopConnector/Shopware.pm

    In dieser Datei gibt es einen Bereich wo die Bestellpostionen, die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser diff --git a/doc/html/ch04.html b/doc/html/ch04.html index 6e8fd9f4a..8015de7ee 100644 --- a/doc/html/ch04.html +++ b/doc/html/ch04.html @@ -1,6 +1,6 @@ - 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 + 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:

    @@ -25,7 +25,7 @@ $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™.

    + 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 aber wieder @@ -39,7 +39,7 @@ dies hat, seit der Einführung, u.a. schon so manche langwierige Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package angegeben werden, werden die nicht geprüft, und somit kann sich - schnell ein Tippfehler einschleichen.

    4.1.3. Kanonische globale Variablen

    Um dieses Problem im Griff zu halten gibt es einige wenige + schnell ein Tippfehler einschleichen.

    4.1.3. Kanonische globale Variablen

    Um dieses Problem im Griff zu halten gibt es einige wenige globale Variablen, die kanonisch sind, d.h. sie haben bestimmte vorgegebenen Eigenschaften, und alles andere sollte anderweitig umhergereicht werden.

    Diese Variablen sind im Moment die folgenden neun:

    • @@ -62,7 +62,7 @@ $::request

    Damit diese nicht erneut als Müllhalde missbraucht werden, im Folgenden eine kurze Erläuterung der bestimmten vorgegebenen - Eigenschaften (Konventionen):

    4.1.3.1. $::form

    • Ist ein Objekt der Klasse + Eigenschaften (Konventionen):

      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 @@ -110,7 +110,7 @@ push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"}; push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"}; # ... -}

      4.1.3.2. %::myconfig

      • Das einzige Hash unter den globalen Variablen

      • Wird spätestens benötigt wenn auf die Datenbank +}

      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 diesen user drinsteht.

      • Enthält unter anderem Datumsformat dateformat und @@ -122,10 +122,10 @@ überwiegend die Daten, die sich unter Programm -> Einstellungen befinden, bzw. die Informationen über den Benutzer die über die - Administrator-Schnittstelle eingegeben wurden.

      4.1.3.3. $::locale

      • Objekt der Klasse "Locale"

      • Wird pro Request erstellt

      • Muss auch für Tests und Scripte immer verfügbar + Administrator-Schnittstelle eingegeben wurden.

      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 + 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 @@ -135,7 +135,7 @@ "message" und "dump" mit denen man flott Informationen ins Log (tmp/kivitendo-debug.log) packen kann.

      Beispielsweise so:

      $main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
-$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});

      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.

      +$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});

      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 @@ -144,7 +144,7 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ Dessen Einstellungen können über $::auth->client abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle - auth.clients.

      4.1.3.6. $::lx_office_conf

      • Objekt der Klasse + auth.clients.

      4.1.3.6. $::lx_office_conf

      • Objekt der Klasse "SL::LxOfficeConf"

      • Global gecached

      • Repräsentation der config/kivitendo.conf[.default]-Dateien

      Globale Konfiguration. Configdateien werden zum Start gelesen und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass @@ -154,16 +154,16 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ file_name = /tmp/kivitendo-debug.log

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

      [Warnung]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 + 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. Beispielsweise überprüft 

    $::instance_conf->get_inventory_system eq 'perpetual'

    - ob die berüchtigte Bestandsmethode zur Anwendung kommt.

    4.1.3.8. $::dispatcher

    • Objekt der Klasse + ob die berüchtigte Bestandsmethode zur Anwendung kommt.

    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.

    + 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 @@ -176,20 +176,20 @@ file_name = /tmp/kivitendo-debug.log

    ist der Key f $::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 + 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 +

    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 + 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.9. Webshop-Api 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 index 48f060de0..81e73c740 100644 --- a/doc/html/ch04s02.html +++ b/doc/html/ch04s02.html @@ -1,6 +1,6 @@ - 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 kivitendo gemacht + 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 kivitendo 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, @@ -34,4 +34,4 @@ 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.

    Zurück Nach oben Weiter
    Kapitel 4. Entwicklerdokumentation Zum Anfang 4.3. SQL-Upgradedateien
    \ No newline at end of file + den kritischen Pfaden, unter 0,15 sonst.

    Zurück Nach oben Weiter
    Kapitel 4. Entwicklerdokumentation Zum Anfang 4.3. Programmatische API-Aufrufe
    \ No newline at end of file diff --git a/doc/html/ch04s03.html b/doc/html/ch04s03.html index 6e6c589f1..2725dab0c 100644 --- a/doc/html/ch04s03.html +++ b/doc/html/ch04s03.html @@ -1,140 +1,37 @@ - 4.3. SQL-Upgradedateien
    4.3. SQL-Upgradedateien
    Zurück Kapitel 4. Entwicklerdokumentation Weiter

    4.3. SQL-Upgradedateien

    4.3.1. Einführung

    Datenbankupgrades werden über einzelne Upgrade-Scripte - gesteuert, die sich im Verzeichnis - sql/Pg-upgrade2 befinden. In diesem Verzeichnis - muss pro Datenbankupgrade eine Datei existieren, die neben den - eigentlich auszuführenden SQL- oder Perl-Befehlen einige - Kontrollinformationen enthält.

    Kontrollinformationen definieren Abhängigkeiten und Prioritäten, - 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 braucht.

    kivitendo 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 für SQL-Upgradedateien der Zeichensatz - "ISO-8859-15" angenommen. Perl-Upgradescripte - hingegen müssen immer in UTF-8 encodiert sein und sollten - demnach auch ein "use utf8;" - enthalten.

    - 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. kivitendo 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. kivitendo 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".

    - ignore -

    Optional. Falls der Wert auf 1 (true) steht, wird das - Skript bei der Anmeldung ignoriert und entsprechend nicht - ausgeführt.

    4.3.3. Format von in Perl geschriebenen - Datenbankupgradescripten

    In Perl geschriebene Datenbankscripte werden nicht einfach so - ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür - bekommen sie aber auch einige Komfortfunktionen bereitgestellt.

    Ein Upgradescript stellt dabei eine vollständige Objektklasse - dar, die vom Elternobjekt "SL::DBUpgrade2::Base" - erben und eine Funktion namens "run" zur Verfügung - stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser - Klasse erzeugt und darauf die erwähnte "run" - aufgerufen wird.

    Zu beachten ist, dass sich der Paketname der Datei aus dem Wert - für "@tag" ableitet. Dabei werden alle Zeichen, die - in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche - ersetzt. Insgesamt sieht der Paketname wie folgt aus: - "SL::DBUpgrade2::tag".

    Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in - der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit - "perldoc SL/DBUpgrade2/Base.pm".

    Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie - folgt aus:

    # @tag: beispiel-upgrade-file42
-# @description: Ein schönes Beispielscript
-# @depends: release_3_1_0
-package SL::DBUpgrade2::beispiel_upgrade_file42;
-
-use strict;
-use utf8;
-
-use parent qw(SL::DBUpgrade2::Base);
-
-sub run {
-  my ($self) = @_;
-
-  # hier Aktionen ausführen
-
-  return 1;
-}
-
-1;
-

    4.3.4. 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 - kivitendo-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 kivitendo 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 kivitendo 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 + 4.3. Programmatische API-Aufrufe
    4.3. Programmatische API-Aufrufe
    Zurück Kapitel 4. Entwicklerdokumentation Weiter

    4.3. Programmatische API-Aufrufe

    4.3.1. Einführung

    + Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass + Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung + oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant + übergeben werden. +

    4.3.2. Wahl des Mandanten

    + Der zu verwendende Mandant kann als Parameter {AUTH}client_id mit jedem Request mitgeschickt werden. Der Wert + muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen + übergeben wurde, Zugriff auf den angegebenen Mandanten hat. +

    + Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es + keinen solchen, kommt es zu einer Fehlermeldung. +

    4.3.3. HTTP-»Basic«-Authentifizierung

    + Für diese Methode muss jedem Request der bekannte HTTP-Header Authorization mitgeschickt werden (siehe RFC 7617). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und + Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen. +

    + Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob + dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat. +

    + Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt + erfolgen. +

    4.3.4. Authentifizierung mit Parametern

    + Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: {AUTH}login und + {AUTH}password. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei + Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat. +

    + Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt + erfolgen. +

    [Anmerkung]Anmerkung

    + Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden. +

    4.3.5. Beispiele

    + Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den + Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt. + 

    $ curl --silent --user 'jdoe:SecretPassword!' \
+  'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'
    Zurück Nach oben Weiter
    4.2. Entwicklung unter FastCGI Zum Anfang 4.4. SQL-Upgradedateien
    \ No newline at end of file diff --git a/doc/html/ch04s04.html b/doc/html/ch04s04.html index fd6f6d465..b5aaafe1f 100644 --- a/doc/html/ch04s04.html +++ b/doc/html/ch04s04.html @@ -1,100 +1,140 @@ - 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]Anmerkung

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

    This section describes how localization packages in kivitendo - 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.

    4.4.2. Character set

    All files included in a language pack must use UTF-8 as their - encoding.

    4.4.3. File structure

    The structure of locales in kivitendo is:

    kivitendo/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)
    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

    kivitendo 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 - &amp;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 - example 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.

    more/all

    This subdir and file is not a part of the language package - itself.

    If the directory more exists and contains a file called - all it will be parsed in addition to the mandatory all (see - above). The file is useful if you want to change some - translations for the current installation without conflicting - further upgrades. The file is not autogenerated and has the same - format as the all, but needs another key (more_texts). See the - german translation for an example or copy the following code: - 

    -#!/usr/bin/perl
-# -*- coding: utf-8; -*-
-# vim: fenc=utf-8
+   4.4. SQL-Upgradedateien
    4.4. SQL-Upgradedateien
    Zurück Kapitel 4. Entwicklerdokumentation Weiter
    4.4. SQL-Upgradedateien
    4.4.1. Einführung
    Datenbankupgrades werden über einzelne Upgrade-Scripte
+        gesteuert, die sich im Verzeichnis
+        sql/Pg-upgrade2 befinden. In diesem Verzeichnis
+        muss pro Datenbankupgrade eine Datei existieren, die neben den
+        eigentlich auszuführenden SQL- oder Perl-Befehlen einige
+        Kontrollinformationen enthält.
    Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
+        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 braucht.
    kivitendo 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.4.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 für SQL-Upgradedateien der Zeichensatz
+              "ISO-8859-15" angenommen. Perl-Upgradescripte
+              hingegen müssen immer in UTF-8 encodiert sein und sollten
+              demnach auch ein "use utf8;"
+              enthalten.
    
+                     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. kivitendo 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. kivitendo 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".
    
+                     ignore
+                  
    Optional. Falls der Wert auf 1 (true) steht, wird das
+              Skript bei der Anmeldung ignoriert und entsprechend nicht
+              ausgeführt.
    4.4.3. Format von in Perl geschriebenen
+        Datenbankupgradescripten
    In Perl geschriebene Datenbankscripte werden nicht einfach so
+        ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
+        bekommen sie aber auch einige Komfortfunktionen bereitgestellt.
    Ein Upgradescript stellt dabei eine vollständige Objektklasse
+        dar, die vom Elternobjekt "SL::DBUpgrade2::Base"
+        erben und eine Funktion namens "run" zur Verfügung
+        stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
+        Klasse erzeugt und darauf die erwähnte "run"
+        aufgerufen wird.
    Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
+        für "@tag" ableitet. Dabei werden alle Zeichen, die
+        in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
+        ersetzt. Insgesamt sieht der Paketname wie folgt aus:
+        "SL::DBUpgrade2::tag".
    Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
+        der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
+        "perldoc SL/DBUpgrade2/Base.pm".
    Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
+        folgt aus:
    # @tag: beispiel-upgrade-file42
+# @description: Ein schönes Beispielscript
+# @depends: release_3_1_0
+package SL::DBUpgrade2::beispiel_upgrade_file42;
 
+use strict;
 use utf8;
 
-# These are additional texts for custom translations.
-# The format is the same as for the normal file all, only
-# with another key (more_texts instead of texts).
-# The file has the form of 'english text'  => 'foreign text',
+use parent qw(SL::DBUpgrade2::Base);
 
-$self->{more_texts} = {
+sub run {
+  my ($self) = @_;
 
-  'Ship via'                    => 'Terms of delivery',
-  'Shipping Point'              => 'Delivery time',
+  # hier Aktionen ausführen
+
+  return 1;
 }
-              
    
-
    Zurück Nach oben Weiter
    4.3. SQL-Upgradedateien Zum Anfang 4.5. Die kivitendo-Test-Suite
    \ No newline at end of file + +1; +

    4.4.4. 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 + kivitendo-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 kivitendo 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 kivitendo 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.3. Programmatische API-Aufrufe Zum Anfang 4.5. Translations and languages
    \ No newline at end of file diff --git a/doc/html/ch04s05.html b/doc/html/ch04s05.html index c7c2a4c52..500007020 100644 --- a/doc/html/ch04s05.html +++ b/doc/html/ch04s05.html @@ -1,115 +1,100 @@ - 4.5. Die kivitendo-Test-Suite
    4.5. Die kivitendo-Test-Suite
    Zurück Kapitel 4. Entwicklerdokumentation Weiter

    4.5. Die kivitendo-Test-Suite

    4.5.1. Einführung

    kivitendo enthält eine Suite für automatisierte Tests. Sie - basiert auf dem Standard-Perl-Modul - Test::More.

    Die grundlegenden Fakten sind:

    • Alle Tests liegen im Unterverzeichnis - t/.

    • Ein Script (bzw. ein Test) in t/ - enthält einen oder mehrere Testfälle.

    • Alle Dateinamen von Tests enden auf .t. - Es sind selbstständig ausführbare Perl-Scripte.

    • Die Test-Suite besteht aus der Gesamtheit aller Tests, - sprich aller Scripte in t/, deren Dateiname - auf .t endet.

    4.5.2. Voraussetzungen

    Für die Ausführung werden neben den für kivitendo eh schon - benötigten Module noch weitere Perl-Module benötigt. Diese - sind:

    • - Test::Deep (Debian-Paketname: - libtest-deep-perl; Fedora: - perl-Test-Deep; openSUSE: - perl-Test-Deep)

    • - Test::Exception (Debian-Paketname: - libtest-exception-perl; Fedora: - perl-Test-Exception; openSUSE: - perl-Test-Exception)

    • - Test::Output (Debian-Paketname: - libtest-output-perl; Fedora: - perl-Test-Output; openSUSE: - perl-Test-Output)

    • - Test::Harness 3.0.0 oder höher. Dieses - Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und - kann für frühere Versionen aus dem CPAN bezogen werden.

    • - LWP::Simple aus dem Paket - libwww-perl (Debian-Panetname: - libwww-perl; Fedora: - perl-libwww-perl; openSUSE: - perl-libwww-perl)

    • - URI::Find (Debian-Panetname: - liburi-find-perl; Fedora: - perl-URI-Find; openSUSE: - perl-URI-Find)

    • - Sys::CPU (Debian-Panetname: - libsys-cpu-perl; Fedora und openSUSE: nicht - vorhanden)

    • - Thread::Pool::Simple (Debian-Panetname: - libthread-pool-simple-perl; Fedora und - openSUSE: nicht vorhanden)

    Weitere Voraussetzung ist, dass die Testsuite ihre eigene - Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu - müssen in der Konfigurationsdatei im Abschnit - testing/database Datenbankverbindungsparameter - angegeben werden. Der hier angegebene Benutzer muss weiterhin das - Recht haben, Datenbanken anzulegen und zu löschen.

    Der so angegebene Benutzer muss nicht zwingend über - Super-User-Rechte verfügen. Allerdings gibt es einige - Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall - kann man in diesem Konfigurationsabschnitt einen weiteren - Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und - mit dem die betroffenen Upgrades durchgeführt werden. In der - Beispiel-Konfigurationsdatei finden Sie die benötigten - Parameter.

    4.5.3. Existierende Tests ausführen

    Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder, - man lässt alle Tests auf einmal ausführen, oder man führt gezielt - einzelne Scripte aus. Für beide Fälle gibt es das Helferscript - t/test.pl.

    Will man die komplette Test-Suite ausführen, so muss man einfach - nur t/test.pl ohne weitere Parameter aus dem - kivitendo-Basisverzeichnis heraus ausführen.

    Um einzelne Test-Scripte auszuführen, übergibt man deren Namen - an t/test.pl. Beispielsweise:

    t/test.pl t/form/format_amount.t t/background_job/known_jobs.t

    4.5.4. Bedeutung der verschiedenen Test-Scripte

    Die Test-Suite umfasst Tests sowohl für Funktionen als auch für - Programmierstil. Einige besonders zu erwähnende, weil auch während der - Entwicklung nützliche Tests sind:

    • - t/001compile.t -- compiliert alle - Quelldateien und bricht bei Fehlern sofort ab

    • - t/002goodperl.t -- überprüft alle - Perl-Dateien auf Anwesenheit von 'use - strict'-Anweisungen

    • - t/003safesys.t -- überprüft Aufrufe von - system() und exec() auf - Gültigkeit

    • - t/005no_tabs.t -- überprüft, ob Dateien - Tab-Zeichen enthalten

    • - t/006spelling.t -- sucht nach häufigen - Rechtschreibfehlern

    • - t/011pod.t -- überprüft die Syntax von - Dokumentation im POD-Format auf Gültigkeit

    Weitere Test-Scripte überprüfen primär die Funktionsweise - einzelner Funktionen und Module.

    4.5.5. Neue Test-Scripte erstellen

    Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich - mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf - und soll ausdrücklich nachträglich mit Test-Scripten abgesichert - werden.

    4.5.5.1. Ideen für neue Test-Scripte, die keine konkreten Funktionen - testen

    Ideen, die abgesehen von Funktionen noch nicht umgesetzt - wurden:

    • Überprüfung auf fehlende symbolische Links

    • Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit - gewissen Einschränkungen wie das Erlauben von deutschen - Umlauten)

    • Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)

    • Überprüfung auf Leerzeichen am Ende von Zeilen

    • Test, ob alle zu übersetzenden Strings in - locale/de/all vorhanden sind

    • Test, ob alle Webseiten-Templates in - templates/webpages mit vom Perl-Modul - Template compiliert werden können

    4.5.5.2. Konvention für Verzeichnis- und Dateinamen

    Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu - benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten - und ihnen soweit es geht folgen:

    • Die Dateiendung muss .t - lauten.

    • Namen sind englisch, komplett klein geschrieben und - einzelne Wörter mit Unterstrichten getrennt (beispielsweise - bad_function_params.t).

    • Unterverzeichnisse sollten grob nach dem Themenbereich - benannt sein, mit dem sich die Scripte darin befassen - (beispielsweise background_jobs für Tests - rund um Hintergrund-Jobs).

    • Test-Scripte sollten einen überschaubaren Bereich von - Funktionalität testen, der logisch zusammenhängend ist (z.B. nur - Tests für eine einzelne Funktion in einem Modul). Lieber mehrere - Test-Scripte schreiben.

    4.5.5.3. Minimales Skelett für eigene Scripte

    Der folgenden Programmcode enthält das kleinstmögliche - Testscript und kann als Ausgangspunkt für eigene Tests verwendet - werden:

    use Test::More tests => 0;
+   4.5. Translations and languages
    4.5. Translations and languages
    Zurück Kapitel 4. Entwicklerdokumentation Weiter
    4.5. Translations and languages
    4.5.1. Introduction
    [Anmerkung]Anmerkung
    Dieser Abschnitt ist in Englisch geschrieben, um
+          internationalen Übersetzern die Arbeit zu erleichtern.
    This section describes how localization packages in kivitendo
+        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.
    4.5.2. Character set
    All files included in a language pack must use UTF-8 as their
+        encoding.
    4.5.3. File structure
    The structure of locales in kivitendo is:
    kivitendo/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)
    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
    kivitendo 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
+              &amp;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
+              example 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.
    more/all
    This subdir and file is not a part of the language package
+              itself.
    If the directory more exists and contains a file called
+              all it will be parsed in addition to the mandatory all (see
+              above). The file is useful if you want to change some
+              translations for the current installation without conflicting
+              further upgrades. The file is not autogenerated and has the same
+              format as the all, but needs another key (more_texts). See the
+              german translation for an example or copy the following code:
+              
    +#!/usr/bin/perl
+# -*- coding: utf-8; -*-
+# vim: fenc=utf-8
 
-use lib 't';
+use utf8;
 
-use Support::TestSetup;
+# These are additional texts for custom translations.
+# The format is the same as for the normal file all, only
+# with another key (more_texts instead of texts).
+# The file has the form of 'english text'  => 'foreign text',
 
-Support::TestSetup::login();
    Wird eine vollständig initialisierte kivitendo-Umgebung
-          benötigt (Stichwort: alle globalen Variablen wie
-          $::auth, $::form oder
-          $::lxdebug), so muss in der Konfigurationsdatei
-          config/kivitendo.conf im Abschnitt
-          testing.login ein gültiger Login-Name eingetragen
-          sein. Dieser wird für die Datenbankverbindung benötigt.
    Wir keine vollständig initialisierte Umgebung benötigt, so
-          kann die letzte Zeile 
    Support::TestSetup::login();
    
-          weggelassen werden, was die Ausführungszeit des Scripts leicht
-          verringert.
    Zurück Nach oben Weiter
    4.4. Translations and languages Zum Anfang 4.6. Stil-Richtlinien
    
\ No newline at end of file
+$self->{more_texts} = {
+
+  'Ship via'                    => 'Terms of delivery',
+  'Shipping Point'              => 'Delivery time',
+}
+

    +

    Zurück Nach oben Weiter
    4.4. SQL-Upgradedateien Zum Anfang 4.6. Die kivitendo-Test-Suite
    \ No newline at end of file diff --git a/doc/html/ch04s06.html b/doc/html/ch04s06.html index 015c1664e..d2bf93a4b 100644 --- a/doc/html/ch04s06.html +++ b/doc/html/ch04s06.html @@ -1,120 +1,115 @@ - 4.6. Stil-Richtlinien
    4.6. Stil-Richtlinien
    Zurück Kapitel 4. Entwicklerdokumentation Weiter

    4.6. 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.

    1. Es werden keine echten Tabs sondern Leerzeichen - verwendet.

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

      foreach my $row (@data) {
-  if ($flag) {
-    # do something with $row
-  }
+   4.6. Die kivitendo-Test-Suite
      4.6. Die kivitendo-Test-Suite
      Zurück Kapitel 4. Entwicklerdokumentation Weiter
      4.6. Die kivitendo-Test-Suite
      4.6.1. Einführung
      kivitendo enthält eine Suite für automatisierte Tests. Sie
+        basiert auf dem Standard-Perl-Modul
+        Test::More.
      Die grundlegenden Fakten sind:
      • Alle Tests liegen im Unterverzeichnis
+            t/.
      • Ein Script (bzw. ein Test) in t/
+            enthält einen oder mehrere Testfälle.
      • Alle Dateinamen von Tests enden auf .t.
+            Es sind selbstständig ausführbare Perl-Scripte.
      • Die Test-Suite besteht aus der Gesamtheit aller Tests,
+            sprich aller Scripte in t/, deren Dateiname
+            auf .t endet.
      4.6.2. Voraussetzungen
      Für die Ausführung werden neben den für kivitendo eh schon
+        benötigten Module noch weitere Perl-Module benötigt. Diese
+        sind:
      • 
+                     Test::Deep (Debian-Paketname:
+            libtest-deep-perl; Fedora:
+            perl-Test-Deep; openSUSE:
+            perl-Test-Deep)
      • 
+                     Test::Exception (Debian-Paketname:
+            libtest-exception-perl; Fedora:
+            perl-Test-Exception; openSUSE:
+            perl-Test-Exception)
      • 
+                     Test::Output (Debian-Paketname:
+            libtest-output-perl; Fedora:
+            perl-Test-Output; openSUSE:
+            perl-Test-Output)
      • 
+                     Test::Harness 3.0.0 oder höher. Dieses
+            Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
+            kann für frühere Versionen aus dem CPAN bezogen werden.
      • 
+                     LWP::Simple aus dem Paket
+            libwww-perl (Debian-Panetname:
+            libwww-perl; Fedora:
+            perl-libwww-perl; openSUSE:
+            perl-libwww-perl)
      • 
+                     URI::Find (Debian-Panetname:
+            liburi-find-perl; Fedora:
+            perl-URI-Find; openSUSE:
+            perl-URI-Find)
      • 
+                     Sys::CPU (Debian-Panetname:
+            libsys-cpu-perl; Fedora und openSUSE: nicht
+            vorhanden)
      • 
+                     Thread::Pool::Simple (Debian-Panetname:
+            libthread-pool-simple-perl; Fedora und
+            openSUSE: nicht vorhanden)
      Weitere Voraussetzung ist, dass die Testsuite ihre eigene
+        Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
+        müssen in der Konfigurationsdatei im Abschnit
+        testing/database Datenbankverbindungsparameter
+        angegeben werden. Der hier angegebene Benutzer muss weiterhin das
+        Recht haben, Datenbanken anzulegen und zu löschen.
      Der so angegebene Benutzer muss nicht zwingend über
+        Super-User-Rechte verfügen. Allerdings gibt es einige
+        Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
+        kann man in diesem Konfigurationsabschnitt einen weiteren
+        Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
+        mit dem die betroffenen Upgrades durchgeführt werden. In der
+        Beispiel-Konfigurationsdatei finden Sie die benötigten
+        Parameter.
      4.6.3. Existierende Tests ausführen
      Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
+        man lässt alle Tests auf einmal ausführen, oder man führt gezielt
+        einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
+        t/test.pl.
      Will man die komplette Test-Suite ausführen, so muss man einfach
+        nur t/test.pl ohne weitere Parameter aus dem
+        kivitendo-Basisverzeichnis heraus ausführen.
      Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
+        an t/test.pl. Beispielsweise:
      t/test.pl t/form/format_amount.t t/background_job/known_jobs.t
      4.6.4. Bedeutung der verschiedenen Test-Scripte
      Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
+        Programmierstil. Einige besonders zu erwähnende, weil auch während der
+        Entwicklung nützliche Tests sind:
      • 
+                     t/001compile.t -- compiliert alle
+            Quelldateien und bricht bei Fehlern sofort ab
      • 
+                     t/002goodperl.t -- überprüft alle
+            Perl-Dateien auf Anwesenheit von 'use
+            strict'-Anweisungen
      • 
+                     t/003safesys.t -- überprüft Aufrufe von
+            system() und exec() auf
+            Gültigkeit
      • 
+                     t/005no_tabs.t -- überprüft, ob Dateien
+            Tab-Zeichen enthalten
      • 
+                     t/006spelling.t -- sucht nach häufigen
+            Rechtschreibfehlern
      • 
+                     t/011pod.t -- überprüft die Syntax von
+            Dokumentation im POD-Format auf Gültigkeit
      Weitere Test-Scripte überprüfen primär die Funktionsweise
+        einzelner Funktionen und Module.
      4.6.5. Neue Test-Scripte erstellen
      Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
+        mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
+        und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
+        werden.
      4.6.5.1. Ideen für neue Test-Scripte, die keine konkreten Funktionen
+          testen
      Ideen, die abgesehen von Funktionen noch nicht umgesetzt
+          wurden:
      • Überprüfung auf fehlende symbolische Links
      • Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
+              gewissen Einschränkungen wie das Erlauben von deutschen
+              Umlauten)
      • Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)
      • Überprüfung auf Leerzeichen am Ende von Zeilen
      • Test, ob alle zu übersetzenden Strings in
+              locale/de/all vorhanden sind
      • Test, ob alle Webseiten-Templates in
+              templates/webpages mit vom Perl-Modul
+              Template compiliert werden können
      4.6.5.2. Konvention für Verzeichnis- und Dateinamen
      Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
+          benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
+          und ihnen soweit es geht folgen:
      • Die Dateiendung muss .t
+              lauten.
      • Namen sind englisch, komplett klein geschrieben und
+              einzelne Wörter mit Unterstrichten getrennt (beispielsweise
+              bad_function_params.t).
      • Unterverzeichnisse sollten grob nach dem Themenbereich
+              benannt sein, mit dem sich die Scripte darin befassen
+              (beispielsweise background_jobs für Tests
+              rund um Hintergrund-Jobs).
      • Test-Scripte sollten einen überschaubaren Bereich von
+              Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
+              Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
+              Test-Scripte schreiben.
      4.6.5.3. Minimales Skelett für eigene Scripte
      Der folgenden Programmcode enthält das kleinstmögliche
+          Testscript und kann als Ausgangspunkt für eigene Tests verwendet
+          werden:
      use Test::More tests => 0;
 
-  if ($use_modules) {
-    $row->{modules} = MODULE->retrieve(
-      id   => $row->{id},
-      date => $use_now ? localtime() : $row->{time},
-    );
-  }
+use lib 't';
 
-  $report->add($row);
-}

    3. Öffnende geschweifte Klammern befinden sich auf der gleichen - Zeile wie der letzte Befehl. Beispiele:

      sub debug {
-  ...
-}

      oder

      if ($form->{item_rows} > 0) {
-  ...
-}

    4. 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.

    5. 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 {
-  ...
-}
+use Support::TestSetup;
 
-do {
-  ...
-} until ($a > 0);

    6. 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;

    7. 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;

    8. 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 Operator "?:", 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};

    9. 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 kivitendo - 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

    10. 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;

    11. Die maximale Zeilenlänge ist nicht beschrä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.

    12. 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.

    13. 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

    14. - STDERR ist tabu. Unkonditionale - Debugmeldungen auch.

      kivitendo 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.

    15. 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.5. Die kivitendo-Test-Suite Zum Anfang 4.7. Dokumentation erstellen
    \ No newline at end of file +Support::TestSetup::login();

    Wird eine vollständig initialisierte kivitendo-Umgebung + benötigt (Stichwort: alle globalen Variablen wie + $::auth, $::form oder + $::lxdebug), so muss in der Konfigurationsdatei + config/kivitendo.conf im Abschnitt + testing.login ein gültiger Login-Name eingetragen + sein. Dieser wird für die Datenbankverbindung benötigt.

    Wir keine vollständig initialisierte Umgebung benötigt, so + kann die letzte Zeile 

    Support::TestSetup::login();

    + weggelassen werden, was die Ausführungszeit des Scripts leicht + verringert.

    Zurück Nach oben Weiter
    4.5. Translations and languages Zum Anfang 4.7. Stil-Richtlinien
    \ No newline at end of file diff --git a/doc/html/ch04s07.html b/doc/html/ch04s07.html index bfa530d64..d2be8b56a 100644 --- a/doc/html/ch04s07.html +++ b/doc/html/ch04s07.html @@ -1,38 +1,120 @@ - 4.7. Dokumentation erstellen
    4.7. Dokumentation erstellen
    Zurück Kapitel 4. Entwicklerdokumentation 

    4.7. Dokumentation erstellen

    4.7.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.7.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 kivitendo übernimmt diese Aufgabe das Shell-Script - scripts/build_doc.sh.

    Das Script benötigt zur Konvertierung verschiedene - Softwarekomponenten, die im normalen kivitendo-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.7.3. PDFs und HTML-Seiten erstellen

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

    ./scripts/build_doc.sh

    4.7.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.6. Stil-Richtlinien Zum Anfang 
    \ No newline at end of file + 4.7. Stil-Richtlinien
    4.7. Stil-Richtlinien
    Zurück Kapitel 4. Entwicklerdokumentation Weiter

    4.7. 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.

    1. Es werden keine echten Tabs sondern Leerzeichen + verwendet.

    2. 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);
+}

    3. Öffnende geschweifte Klammern befinden sich auf der gleichen + Zeile wie der letzte Befehl. Beispiele:

      sub debug {
+  ...
+}

      oder

      if ($form->{item_rows} > 0) {
+  ...
+}

    4. 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.

    5. 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);

    6. 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;

    7. 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;

    8. 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 Operator "?:", 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};

    9. 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 kivitendo + 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

    10. 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;

    11. Die maximale Zeilenlänge ist nicht beschrä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.

    12. 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.

    13. 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

    14. + STDERR ist tabu. Unkonditionale + Debugmeldungen auch.

      kivitendo 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.

    15. 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.6. Die kivitendo-Test-Suite Zum Anfang 4.8. Dokumentation erstellen
    \ No newline at end of file diff --git a/doc/html/ch04s08.html b/doc/html/ch04s08.html new file mode 100644 index 000000000..6c82a6d2d --- /dev/null +++ b/doc/html/ch04s08.html @@ -0,0 +1,38 @@ + + + 4.8. Dokumentation erstellen
    4.8. Dokumentation erstellen
    Zurück Kapitel 4. Entwicklerdokumentation 

    4.8. Dokumentation erstellen

    4.8.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.8.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 kivitendo übernimmt diese Aufgabe das Shell-Script + scripts/build_doc.sh.

    Das Script benötigt zur Konvertierung verschiedene + Softwarekomponenten, die im normalen kivitendo-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.8.3. PDFs und HTML-Seiten erstellen

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

    ./scripts/build_doc.sh

    4.8.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.7. Stil-Richtlinien Zum Anfang 
    \ No newline at end of file diff --git a/doc/html/index.html b/doc/html/index.html index 6f515c3b7..e95b09d28 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -2,8 +2,8 @@ kivitendo 3.5.3: Installation, Konfiguration, Entwicklung
    kivitendo 3.5.3: Installation, Konfiguration, Entwicklung
       Weiter

    kivitendo 3.5.3: Installation, Konfiguration, - Entwicklung

    Inhaltsverzeichnis

    1. Aktuelle Hinweise
    2. Installation und Grundkonfiguration
    2.1. Übersicht
    2.2. Benötigte Software und Pakete
    2.2.1. Betriebssystem
    2.2.2. Benötigte Perl-Pakete installieren
    2.2.3. Andere Pakete installieren
    2.3. Manuelle Installation des Programmpaketes
    2.4. kivitendo-Konfigurationsdatei
    2.4.1. Einführung
    2.4.2. Abschnitte und Parameter
    2.4.3. Versionen vor 2.6.3
    2.5. Anpassung der PostgreSQL-Konfiguration
    2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8
    2.5.2. Änderungen an Konfigurationsdateien
    2.5.3. Erweiterung für servergespeicherte Prozeduren
    2.5.4. Erweiterung für Trigram Prozeduren
    2.5.5. Datenbankbenutzer anlegen
    2.6. Webserver-Konfiguration
    2.6.1. Grundkonfiguration mittels CGI
    2.6.2. Konfiguration für FastCGI/FCGI
    2.6.3. Authentifizierung mittels HTTP Basic Authentication
    2.6.4. Weitergehende Konfiguration
    2.7. Der Task-Server
    2.7.1. Verfügbare und notwendige Konfigurationsoptionen
    2.7.2. Konfiguration der Mandanten für den Task-Server
    2.7.3. Automatisches Starten des Task-Servers beim Booten
    2.7.4. Wie der Task-Server gestartet und beendet wird
    2.8. Benutzerauthentifizierung und Administratorpasswort
    2.8.1. Grundlagen zur Benutzerauthentifizierung
    2.8.2. Administratorpasswort
    2.8.3. Authentifizierungsdatenbank
    2.8.4. Passwortüberprüfung
    2.8.5. Name des Session-Cookies
    2.8.6. Anlegen der Authentifizierungsdatenbank
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    2.9.1. Zusammenhänge
    2.9.2. Mandanten, Benutzer und Gruppen
    2.9.3. Datenbanken anlegen
    2.9.4. Gruppen anlegen
    2.9.5. Benutzer anlegen
    2.9.6. Mandanten anlegen
    2.10. Drucker- und Systemverwaltung
    2.10.1. Druckeradministration
    2.10.2. System sperren / entsperren
    2.11. E-Mail-Versand aus kivitendo heraus
    2.11.1. Versand über lokalen E-Mail-Server
    2.11.2. Versand über einen SMTP-Server
    2.12. Drucken mit kivitendo
    2.12.1. Vorlagenverzeichnis anlegen
    2.12.2. Der Druckvorlagensatz RB
    2.12.3. f-tex
    2.12.4. Der Druckvorlagensatz rev-odt
    2.12.5. Allgemeine Hinweise zu LaTeX Vorlagen
    2.13. OpenDocument-Vorlagen
    2.13.1. OpenDocument (odt) Druckvorlagen mit Makros
    2.14. Nomenklatur
    2.14.1. Datum bei Buchungen
    2.15. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: + Entwicklung

    Inhaltsverzeichnis

    1. Aktuelle Hinweise
    2. Installation und Grundkonfiguration
    2.1. Übersicht
    2.2. Benötigte Software und Pakete
    2.2.1. Betriebssystem
    2.2.2. Benötigte Perl-Pakete installieren
    2.2.3. Andere Pakete installieren
    2.3. Manuelle Installation des Programmpaketes
    2.4. kivitendo-Konfigurationsdatei
    2.4.1. Einführung
    2.4.2. Abschnitte und Parameter
    2.4.3. Versionen vor 2.6.3
    2.5. Anpassung der PostgreSQL-Konfiguration
    2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8
    2.5.2. Änderungen an Konfigurationsdateien
    2.5.3. Erweiterung für servergespeicherte Prozeduren
    2.5.4. Erweiterung für Trigram Prozeduren
    2.5.5. Datenbankbenutzer anlegen
    2.6. Webserver-Konfiguration
    2.6.1. Grundkonfiguration mittels CGI
    2.6.2. Konfiguration für FastCGI/FCGI
    2.6.3. Authentifizierung mittels HTTP Basic Authentication
    2.6.4. Weitergehende Konfiguration
    2.7. Der Task-Server
    2.7.1. Verfügbare und notwendige Konfigurationsoptionen
    2.7.2. Konfiguration der Mandanten für den Task-Server
    2.7.3. Automatisches Starten des Task-Servers beim Booten
    2.7.4. Wie der Task-Server gestartet und beendet wird
    2.8. Benutzerauthentifizierung und Administratorpasswort
    2.8.1. Grundlagen zur Benutzerauthentifizierung
    2.8.2. Administratorpasswort
    2.8.3. Authentifizierungsdatenbank
    2.8.4. Passwortüberprüfung
    2.8.5. Name des Session-Cookies
    2.8.6. Anlegen der Authentifizierungsdatenbank
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    2.9.1. Zusammenhänge
    2.9.2. Mandanten, Benutzer und Gruppen
    2.9.3. Datenbanken anlegen
    2.9.4. Gruppen anlegen
    2.9.5. Benutzer anlegen
    2.9.6. Mandanten anlegen
    2.10. Drucker- und Systemverwaltung
    2.10.1. Druckeradministration
    2.10.2. System sperren / entsperren
    2.11. E-Mail-Versand aus kivitendo heraus
    2.11.1. Versand über lokalen E-Mail-Server
    2.11.2. Versand über einen SMTP-Server
    2.12. Drucken mit kivitendo
    2.12.1. Vorlagenverzeichnis anlegen
    2.12.2. Der Druckvorlagensatz RB
    2.12.3. f-tex
    2.12.4. Der Druckvorlagensatz rev-odt
    2.12.5. Allgemeine Hinweise zu LaTeX Vorlagen
    2.13. OpenDocument-Vorlagen
    2.13.1. OpenDocument (odt) Druckvorlagen mit Makros
    2.14. Nomenklatur
    2.14.1. Datum bei Buchungen
    2.15. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR
    2.15.1. Einführung
    2.15.2. Konfigurationsparameter
    2.15.3. Festlegen der Parameter
    2.15.4. Bemerkungen zur Bestandsmethode
    2.15.5. Bekannte Probleme
    2.16. SKR04 19% Umstellung für innergemeinschaftlichen Erwerb
    2.16.1. Einführung
    2.16.2. Konto 3804 manuell anlegen
    2.17. Verhalten des Bilanzberichts
    2.18. Erfolgsrechnung
    2.19. Rundung in Verkaufsbelegen
    2.20. Einstellungen pro Mandant
    2.21. kivitendo ERP verwenden
    3. Features und Funktionen
    3.1. Wiederkehrende Rechnungen
    3.1.1. Einführung
    3.1.2. Konfiguration
    3.1.3. Spezielle Variablen
    3.1.4. Auflisten
    3.1.5. Erzeugung der eigentlichen Rechnungen
    3.1.6. Erste Rechnung für aktuellen Monat erstellen
    3.2. Bankerweiterung
    3.2.1. Einführung
    3.3. Dokumentenvorlagen und verfügbare Variablen
    3.3.1. Einführung
    3.3.2. Variablen ausgeben
    3.3.3. Verwendung in Druckbefehlen
    3.3.4. Anfang und Ende der Tags verändern
    3.3.5. Zuordnung von den Dateinamen zu den Funktionen
    3.3.6. Sprache, Drucker und E-Mail
    3.3.7. Allgemeine Variablen, die in allen Vorlagen vorhanden sind
    3.3.8. Variablen in Rechnungen
    3.3.9. Variablen in Mahnungen und Rechnungen über Mahngebühren
    3.3.10. Variablen in anderen Vorlagen
    3.3.11. Blöcke, bedingte Anweisungen und Schleifen
    3.3.12. Markup-Code zur Textformatierung innerhalb von - Formularen
    3.4. Excel-Vorlagen
    3.4.1. Zusammenfassung
    3.4.2. Bedienung
    3.4.3. Variablensyntax
    3.4.4. Einschränkungen
    3.5. Mandantenkonfiguration Lager
    3.6. Schweizer Kontenpläne
    3.7. Artikelklassifizierung
    3.7.1. Übersicht
    3.7.2. Basisklassifizierung
    3.7.3. Attribute
    3.7.4. Zwei-Zeichen Abkürzung
    3.8. Dateiverwaltung (Mini-DMS)
    3.8.1. Übersicht
    3.8.2. Struktur
    3.8.3. Anwendung
    3.8.4. Konfigurierung
    3.9. Webshop-Api
    3.9.1. Rechte für die Webshopapi
    3.9.2. Konfiguration
    3.9.3. Webshopartikel
    3.9.4. Bestellimport
    3.9.5. Mapping der Daten
    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.3. SQL-Upgradedateien
    4.3.1. Einführung
    4.3.2. Format der Kontrollinformationen
    4.3.3. Format von in Perl geschriebenen - Datenbankupgradescripten
    4.3.4. Hilfsscript dbupgrade2_tool.pl
    4.4. Translations and languages
    4.4.1. Introduction
    4.4.2. Character set
    4.4.3. File structure
    4.5. Die kivitendo-Test-Suite
    4.5.1. Einführung
    4.5.2. Voraussetzungen
    4.5.3. Existierende Tests ausführen
    4.5.4. Bedeutung der verschiedenen Test-Scripte
    4.5.5. Neue Test-Scripte erstellen
    4.6. Stil-Richtlinien
    4.7. Dokumentation erstellen
    4.7.1. Einführung
    4.7.2. Benötigte Software
    4.7.3. PDFs und HTML-Seiten erstellen
    4.7.4. Einchecken in das Git-Repository
       Weiter
       Kapitel 1. Aktuelle Hinweise
    \ No newline at end of file + Formularen
    3.4. Excel-Vorlagen
    3.4.1. Zusammenfassung
    3.4.2. Bedienung
    3.4.3. Variablensyntax
    3.4.4. Einschränkungen
    3.5. Mandantenkonfiguration Lager
    3.6. Schweizer Kontenpläne
    3.7. Artikelklassifizierung
    3.7.1. Übersicht
    3.7.2. Basisklassifizierung
    3.7.3. Attribute
    3.7.4. Zwei-Zeichen Abkürzung
    3.8. Dateiverwaltung (Mini-DMS)
    3.8.1. Übersicht
    3.8.2. Struktur
    3.8.3. Anwendung
    3.8.4. Konfigurierung
    3.9. Webshop-Api
    3.9.1. Rechte für die Webshopapi
    3.9.2. Konfiguration
    3.9.3. Webshopartikel
    3.9.4. Bestellimport
    3.9.5. Mapping der Daten
    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.3. Programmatische API-Aufrufe
    4.3.1. Einführung
    4.3.2. Wahl des Mandanten
    4.3.3. HTTP-»Basic«-Authentifizierung
    4.3.4. Authentifizierung mit Parametern
    4.3.5. Beispiele
    4.4. SQL-Upgradedateien
    4.4.1. Einführung
    4.4.2. Format der Kontrollinformationen
    4.4.3. Format von in Perl geschriebenen + Datenbankupgradescripten
    4.4.4. Hilfsscript dbupgrade2_tool.pl
    4.5. Translations and languages
    4.5.1. Introduction
    4.5.2. Character set
    4.5.3. File structure
    4.6. Die kivitendo-Test-Suite
    4.6.1. Einführung
    4.6.2. Voraussetzungen
    4.6.3. Existierende Tests ausführen
    4.6.4. Bedeutung der verschiedenen Test-Scripte
    4.6.5. Neue Test-Scripte erstellen
    4.7. Stil-Richtlinien
    4.8. Dokumentation erstellen
    4.8.1. Einführung
    4.8.2. Benötigte Software
    4.8.3. PDFs und HTML-Seiten erstellen
    4.8.4. Einchecken in das Git-Repository
       Weiter
       Kapitel 1. Aktuelle Hinweise
    \ No newline at end of file diff --git a/doc/kivitendo-Dokumentation.pdf b/doc/kivitendo-Dokumentation.pdf index 497a662a9..5d2864bde 100644 Binary files a/doc/kivitendo-Dokumentation.pdf and b/doc/kivitendo-Dokumentation.pdf differ