X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentation.xml;h=d11db124d62ae23b9d633a640c466c46a9a7edc3;hb=30756de3ea4e7ed2ac0f4382503891fa5d3b4aa1;hp=aeeb56fcef69655ba00ab4dda33d1db32f683127;hpb=fb03d191f53516cbf1022e755665556e7f1acb82;p=kivitendo-erp.git diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index aeeb56fce..d11db124d 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -2,7 +2,7 @@ - kivitendo 3.1.0: Installation, Konfiguration, Entwicklung + kivitendo 3.2.0: Installation, Konfiguration, Entwicklung Aktuelle Hinweise @@ -12,7 +12,7 @@ im kivitendo-Forum: https://forum.kivitendo.org/ + url="https://forum.kivitendo.org:32443">https://forum.kivitendo.org:32443 in der doc/UPGRADE Datei im doc-Verzeichnis der Installation @@ -182,6 +182,7 @@ YAML + Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen: GD, HTML::Restrict, Image::Info Seit v3.0.0 sind die folgenden Pakete hinzugekommen: File::Copy::Recursive. Seit v2.7.0 sind die folgenden Pakete hinzugekommen: Email::MIME, Net::SMTP::SSL, @@ -211,8 +212,7 @@ Debian und Ubuntu - Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl - installiert werden: + Für Debian und Ubuntu stehen die meisten der benötigten Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden: apt-get install apache2 libarchive-zip-perl libclone-perl \ libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \ @@ -222,13 +222,16 @@ librose-db-perl librose-object-perl libsort-naturally-perl \ libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \ libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \ + libimage-info-perl libgd-gd2-perl \ libfile-copy-recursive-perl postgresql + + Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies muß per CPAN installiert werden. Der entsprechende Befehl wird beim Aufruf von installation_check.pl angezeigt. Fedora Core - Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden: + Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden: yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \ perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \ @@ -272,11 +275,11 @@ cpan Rose::Db::Object Manuelle Installation des Programmpaketes Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann hier heruntergeladen werden. - Die kivitendo ERP Installationsdatei (kivitendo-erp-3.1.0.tgz) wird im Dokumentenverzeichnis des Webservers + Die kivitendo ERP Installationsdatei (kivitendo-erp-3.2.0.tgz) wird im Dokumentenverzeichnis des Webservers (z.B. /var/www/html/, /srv/www/htdocs oder /var/www/) entpackt: cd /var/www -tar xvzf kivitendo-erp-3.1.0.tgz +tar xvzf kivitendo-erp-3.2.0.tgz Wechseln Sie in das entpackte Verzeichnis: @@ -286,7 +289,7 @@ tar xvzf kivitendo-erp-3.1.0.tgz Webserverkonfiguration benutzen, um auf das tatsächliche Installationsverzeichnis zu verweisen. - Bei einer Neuinstallation der Version 3.1.0 muß das WebDAV Verzeichnis derzeit manuell angelegt werden: + Bei einer Neuinstallation von Version 3.1.0 oder Version 3.2.0 muß das WebDAV Verzeichnis derzeit manuell angelegt werden: mkdir webdav @@ -1408,7 +1411,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Drucken mit kivitendo Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes - LaTeX System. Am einfachsten ist dazu eine texlive Installation. Unter Debianoiden Betriebssystemen installiert man + LaTeX System. Am einfachsten ist dazu eine texlive Installation. Unter debianoiden Betriebssystemen installiert man die Pakete mit: aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \ @@ -1446,7 +1449,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden. - Eventuell muessen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisistem unter + Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisystem unter ./templates/[Neuer Name] @@ -1468,7 +1471,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Feature-Übersicht Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also - Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc.. + Angebot, Rechnung, Proformarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc.. Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*) @@ -1503,33 +1506,33 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Editiere den Bereich "" in der datei letter.lco. - oder etwas Detaillierter: + oder etwas detaillierter: Es wird eine Datei sample.lco erstellt und diese nach letter.lco verlinkt. Eigentlich - ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig - ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen - vorzunehmen und sample.lco unverändert zu lassen. Die die Anpassung über eine - *.lco-Datei die letztlich auf letter.lco verlinkt ist ist aber auch möglich. + ist dies die Datei die für die firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig + ist, wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen + vorzunehmen und sample.lco unverändert zu lassen. Die Anpassung über eine + *.lco-Datei, die letztlich auf letter.lco verlinkt ist ist aber auch möglich. Es wird eine Datei sample_head.pdf mit ausgeliefert, diese wird nach letter_head.pdf - verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei - sample_haed.pdf an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im + verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei + sample_head.pdf an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im Template Verzeichniss ablegen und statt sample_head.pdf nach letter_head.pdf verlinken. - letzlich muss letter_head.pdf auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf - enthält. Bei Updates oder nach erneutem + Letzlich muss letter_head.pdf auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf + enthält. Es wird eine Datei mydata.tex.example ausgeliefert, die nach mytdata.tex verlinkt ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst - werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig). + werden. Die anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig). Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die @@ -1541,17 +1544,17 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ f-tex Funktionsübersicht Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage - vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur + vorzuhalten, dies ist sehr wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die - Besonderheiten der jeweiligen Dokumente Berücksichtigt. + Besonderheiten der jeweiligen Dokumente berücksichtigt: Tabellen mit oder ohne Preis Sprache der Tabellenüberschriften etc. Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer) - Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher + Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus gewerblicher Kunde) @@ -1561,15 +1564,15 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei letter.tex ist sehr komplex und verstärkt damit diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr - schnell häftig in den Fuss schiessen. + schnell heftig in den Fuss schiessen. - Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der - mitglieferten Datei sample_head.pdf erstellen, und sich an der Form der dargestellten Tabellen wie sie + Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der + mitglieferten Datei sample_head.pdf erstellen, und sich an der Form der dargestellten Tabellen, wie sie ausgeliefert werden, erfreuen. - Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen. + Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine, kontinuierliche Schritte gehen. @@ -1584,8 +1587,8 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Zuordung einer Default-Preisgruppe handhaben) - man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl - Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt) + man darf beim Anlegen des Vorgangs nicht vergessen, dieses Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl + Endverbraucher als auch Gewerbekunden beliefert, der eigentliche Knackpunkt) @@ -1596,10 +1599,10 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ an (einmal mit der Namensendung "_E"). Gewinn: - Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden. + Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste verbunden. Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise Netto" auszuwählen. - Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden, + Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken revidiert werden, ohne dass sich der Auftragswert ändert. @@ -1627,9 +1630,9 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Allgemeine Hinweise zu LaTeX Vorlagen - In den allermeisten Installationen sollte drucken jetzt schon - funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange - Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite + In den allermeisten Installationen sollte das Drucken jetzt schon + funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange + Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum Beispiel: @@ -2232,6 +2235,12 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <%variablenname%>. + + Sofern es sich um eine Datumsvariable handelt, kann das Ausgabeformat weiter bestimmt werden, indem an den Variablennamen + Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus: <%variablenname + FORMAT=Formatinformation%>. Die zur verfügung stehenden Formatinformationen werden unten genauer beschrieben. + + Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt: @@ -2297,6 +2306,172 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ + + + Die invidiuellen Formatinformationen bestehen aus Paaren von Prozentzeichen und einem Buchstaben, welche beide zusammen durch den + dazugehörigen Wert ersetzt werden. So wird z.B. %Y durch das viertstellige Jahr ersetzt. Alle möglichen + Platzhalter sind: + + + + + + %a + + + Der abgekürzte Wochentagsname. + + + + + %A + + + Der ausgeschriebene Wochentagsname. + + + + + %b + + + Der abgekürzte Monatsname. + + + + + %B + + + Der ausgeschriebene Monatsname. + + + + + %C + + + Das Jahrhundert (Jahr/100) als eine zweistellige Zahl. + + + + + %d + + + Der Monatstag als Zahl zwischen 01 und 31. + + + + + %D + + + Entspricht %m/%d/%y (amerikanisches Datumsformat). + + + + + %e + + + Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt. + + + + + %F + + + Entspricht %Y-%m-%d (das ISO-8601-Datumsformat). + + + + + %j + + + Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive. + + + + + %m + + + Der Monat als Zahl zwischen 01 und 12 inklusive. + + + + + %u + + + Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht. + + + + + %U + + + Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist. + + + + + %V + + + Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53 inklusive, wobei Woche 01 die erste Woche, von der mindestens vier Tage im Jahr liegen; Montag ist erster Tag der Woche. + + + + + %w + + + Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht. + + + + + %W + + + Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist. + + + + + %y + + + Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive. + + + + + %Y + + + Das Jahr als vierstellige Zahl. + + + + + %% + + + Das Prozentzeichen selber. + + + + + + Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode + dauert: Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%> bis <%period_end_date FORMAT=%m/%Y%> + @@ -2960,6 +3135,14 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ + + greeting + + + Anrede + + + homepage @@ -3441,7 +3624,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Beschreibung der Lieferbedingung - delivery_term.long_description + delivery_term.description_long Langtext bzw. übersetzter Langtext der Lieferbedingung @@ -3740,7 +3923,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ netprice - Nettopreis + Alternative zu sellprice, aber netprice entspricht dem effektiven Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor. netprice wird rückgerechnet aus Zeilensumme / Menge. Diese Variable ist nützlich, wenn man den gewährten Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge * Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll. netprice hat nichts mit Netto/Brutto im Sinne von Steuern zu tun.