X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentation.xml;h=41125b83338ce3df6b06bea2e7ab1103311f1701;hb=45ff2497af0be84db6bf29613d1dfd54a1c7d91a;hp=ef9b24b65bcf796e1d1d7e98f988488a927a50e3;hpb=fa324fa596873b35d9d4cc4ef876e8c5b43046bc;p=kivitendo-erp.git
diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml
index ef9b24b65..41125b833 100644
--- a/doc/dokumentation.xml
+++ b/doc/dokumentation.xml
@@ -270,7 +270,8 @@ 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
(z.B. /var/www/html/, /srv/www/htdocs oder /var/www/) entpackt:
@@ -285,6 +286,10 @@ 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:
+
+ mkdir webdav
+
Die Verzeichnisse users, spool und webdav müssen für den Benutzer
beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu www-data, bei Fedora
@@ -484,7 +489,7 @@ exit
In der Datei pg_hba.conf, die im gleichen
Verzeichnis wie die postgresql.conf zu finden
sein sollte, müssen die Berichtigungen für den Zugriff geändert
- werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
+ werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
Datenbank zum Beispiel:
@@ -1291,6 +1296,28 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/
C gültig").
+
+ Drucker- und Systemverwaltung
+ Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.
+
+ Druckeradministration
+ Unter dem Menüpunkt Druckeradministration lassen sich beliebig viele "Druckbefehle" im System verwalten. Diese Befehle werden mandantenweise
+ zugeordnet. Unter Druckerbeschreibung wird der Namen des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs angezeigt wird.
+ Unter Druckbefehl definiert man den eigentlichen Druckbefehl, der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P meinDrucker' oder ein
+ kompletter Pfad zu einem Skript (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh).
+ Wird ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich ergänzt, ist
+ bspw. das Kürzel 'epson_drucker' definiert, so wird beim Ausdruck eines Angebots folgende Vorlage geparst: sales_quotation_epson_drucker.tex.
+
+
+ System sperren / entsperren
+
+ Unter dem Menüpunkt System gibt es den Eintrag 'Installation sperren/entsperren'. Setz man diese Sperre so ist der Zugang zu der gesamten kivitendo Installation gesperrt.
+ Falls die Sperre gesetzt ist, erscheint anstelle der Anmeldemaske die Information: 'kivitendo ist momentan zwecks Wartungsarbeiten nicht zugänglich.'.
+
+ Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo automatisch 'sperrt', falls es bei einem Versionsupdate zu einem Datenbankfehler kam. Somit kann hier nicht aus Versehen
+ mit einem inkonsistenten Datenbestand weitergearbeitet werden.
+
+ E-Mail-Versand aus kivitendo heraus
@@ -1381,7 +1408,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/
Drucken mit kivitendoDas 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 \
@@ -1419,7 +1446,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]
@@ -1441,7 +1468,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/
Feature-ÃbersichtKeine 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*)
@@ -1476,33 +1503,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
@@ -1514,17 +1541,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 PreisSprache 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)
@@ -1534,15 +1561,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.
@@ -1557,8 +1584,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)
@@ -1569,10 +1596,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.
@@ -1589,20 +1616,20 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/
- RB
+ Der Druckvorlagensatz RB
- Vollständiger Dokumentensatz mit alternativem Design
- Die konzeptionelle Idee wird Hierbei handelt es sich um einen vollständigen Dokumentensatz mit alternativem Design.
+ Die konzeptionelle Idee der Vorlagen wird hier
- auf Folie 5 bis 10 vorgestellt, Detaileinstellungen dann im Readme.tex im Vorlagenverzeichnis.
+ auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.
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:
@@ -2205,6 +2232,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:
@@ -2270,6 +2303,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%>
+
@@ -3414,7 +3613,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/
Beschreibung der Lieferbedingung
- delivery_term.long_description
+ delivery_term.description_longLangtext bzw. übersetzter Langtext der Lieferbedingung
@@ -3713,7 +3912,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.
@@ -3750,6 +3949,15 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/
+
+ donumber_do
+
+
+ Lieferscheinnummer desjenigen Lieferscheins, aus dem die Position stammt, sofern die Rechnung aus einem oder
+ mehreren Lieferscheinen erstellt wurde
+
+
+
p_discount