d2d804432b592e78db1f851f645f3fbd53d1deb6
[kivitendo-erp.git] / templates / print / marei / Readme.md
1
2 # Bemerkungen zum Vorlagensatz von
3 ### © 2020 by Marei Peischl (peiTeX TeXnical Solutions)
4
5 ## Aufbau:
6 Die Grundstruktur besteht je Dokumententyp aus einer Basisdatei und verschiedenen Setup-Dateien.
7
8 Die Basis wurde so überarbeitet, dass Dokumente nun generell auf der Dokumentenklasse *scrartcl.cls* basieren und das Paket *kiviletter.sty* benutzen.
9
10 Mandantenspezifische Konfiguration findet sich in der Datei *insettings.tex* und dem Ordner eines spezifischen Mandanten (default=*firma/*). 
11
12
13 ### Struktur der Basisdatei (je Dokumententyp eine)
14         1. Dokumentenklasse
15         2. *kiviletter.sty*
16         3. Einstellungen, die über Variablen gesetzt werden: Mandant, Währung, Sprache
17         4. `\input{insettings.tex}` Anteil der spezifischen Anpassungen, die von den Variablen unter 2. abhängig sind. Geladen werden darin die Dateien:
18                 - Sprache: lädt die entsprechende Sprachdatei, falls DE -> *deutsch.tex*, falls EN *englisch.tex* und setzt die babel Optionen. Die Datei enthält Übersetzungen von Einzelbegriffen und Textbausteinen.
19                 - Lädt die Konfigurationsdatei, ohne spezielle Mandanten ist der Suchpfad zur Konfiguration der Unterordner *firma/*
20                         * Lädt die Datei *ident.tex*, sowie die Abbildung Briefkopf.
21                 
22 Mandanten / Firma:
23     Um gleiche Vorlagen für verschiedene Firmen verwenden zu können, wird je
24     nach dem Wert der Kivitendo-Variablen <%kivicompany%> ein
25     Firmenverzeichnis ausgewählt (siehe 'insettings.tex'), in dem Briefkopf,
26     Identitäten und Währungs-/Kontoeinstellungen hinterlegt sind.
27     <%kivicompany%> enthält den Namen des verwendeten Mandantendaten.
28     Ist kein Firmenname eingetragen, so wird das
29     generische Unterverzeichnis 'firma' verwendet.
30
31 Identitäten:
32     In jedem Firmen-Unterverzeichnis soll eine Datei 'ident.tex'
33     vorhanden sein, die mit \newcommand Werte für \telefon, \fax,
34     \firma, \strasse, \ort, \ustid, \email und \homepage definiert.
35
36 Währungen / Konten:
37     Für jede Währung (siehe 'insettings.tex') soll eine Datei vorhanden
38     sein, die das Währungssymbol (\currency) und folgende Angaben für
39     ein Konto in dieser Währung enthält \kontonummer, \bank,
40     \bankleitzahl, \bic und \iban.
41     So kann in den Dokumenten je nach Währung ein anderes Konto
42     angegeben werden.
43     Nach demselben Schema können auch weitere, alternative Bankverbindungen
44     angelegt werden, die dann in insettings.tex als Variable im
45     unteren Abschnitt der Datei 'insettings.tex', Kommentar Fußzeile
46     (cfoot) eingefügt werden.
47    Briefbogen/Logos:
48     Eine Hintergrundgrafik oder ein Logo kann in Abhängigkeit vom
49     Medium (z.B. nur beim Verschicken mit E-Mail) eingebunden
50     werden. Dies ist im Moment auskommentiert.
51     
52     Desweiteren sind (auskommentierte) Beispiele enthalten für eine
53     Grafik als Briefkopf, nur ein Logo, oder ein komplettes DinA4-PDF
54     als Briefpapier.
55     
56     Fusszeile:
57     Die Tabelle im Fuß verwendet die Angaben aus firma/ident.tex und
58     firma/*_account.tex.
59         
60 ## Tabellen:
61
62
63  Quickstart (wo kann was angepasst werden?):
64     insettings.tex : Pfad zu Angaben über Mandanten (default: firma)
65                      Logo/Briefpapier
66                      Layout der Kopf/Fußzeile
67     firma/*        : Angaben über Mandanten
68  Es muß mindestens eine Sprache angelegt werden!
69     deutsch.tex    : Textschnipsel für Deutsch
70                      Dafür eine Sprache mit Vorlagenkürzel DE anlegen
71     english.tex    : Textschnipsel für Englisch
72                      Dafür eine Sprache mit Vorlagenkürzel EN anlegen
73