Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision dca78edd

Von Marei Peischl vor fast 5 Jahren hinzugefügt

  • ID dca78edda3cac77053efe72d16d2218dba513462
  • Vorgänger bb1179e3
  • Nachfolger 96b57865

cleanup Readme

Unterschiede anzeigen:

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

  
Readme.tex
1
%
2
% Bemerkungen zum Vorlagensatz RB von
3
% Richardson & Büren GmbH
4
%
5
% Hier wurden einige Ideen aufgegriffen, die in folgendem Vortrag
6
% erwähnt wurden:
7
% http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf
8
%
9
% Am Ende dieser Datei befindet sich ein Abschnitt "Quickstart", der die
10
% Vorbereitungsschritte beschreibt, die bei diesem Druckvorlagensatz nötig
11
% sind.
12
%
13
%
14
% Aufbau:
15
%   Die documentclass und alle usepackage-Anweisungen sind in
16
%   'inheaders.tex' ausgelagert. Diese werden von allen Vorlagen via
17
%   \input eingebunden.
18
%
19
%   Desweiteren sind einige Einstellungen und eigene Befehle, die alle
20
%   Vorlagen verwenden, in 'insetting.tex' untergebracht. Auch diese
21
%   werden mit \input eingebunden.
22
%   Da in eingebundenen Dateien die kivitendo-Variablen nicht aufgelöst
23
%   werden könnnen, werden die hier verwendeten Variablen in jedem
24
%   Dokument vorher mit \newcommand neu definiert.
25
%
26
% Sprachen:
27
%   In 'insettings.tex' wird anhand des verwendeten Sprachkürzels die
28
%   Sprache unterschieden und eine entsprechende Übersetzungsdatei geladen,
29
%   die Textbausteine  bzw. -Schnipsel enthält. Die Vorlagen verwenden nur
30
%   diese Schnipsel. Im Moment werden die Vorlagenkürzel DE und EN in
31
%   Benutzung mit den entsprechenden Übersetzungsdateien 'deutsch.tex'
32
%   und 'english.tex' unterschieden.
33
%
34
% Mandanten / Firma:
35
%   Um gleiche Vorlagen für verschiedene Firmen verwenden zu können, wird je
36
%   nach dem Wert der Kivitendo-Variablen <%kivicompany%> ein
37
%   Firmenverzeichnis ausgewählt (siehe 'insettings.tex'), in dem Briefkopf,
38
%   Identitäten und Währungs-/Kontoeinstellungen hinterlegt sind.
39
%   <%kivicompany%> enthält den Namen des verwendeten Mandantendaten.
40
%   Ist kein Firmenname eingetragen, so wird das
41
%   generische Unterverzeichnis 'firma' verwendet.
42
%
43
% Identitäten:
44
%    In jedem Firmen-Unterverzeichnis soll eine Datei 'ident.tex'
45
%    vorhanden sein, die mit \newcommand Werte für \telefon, \fax,
46
%    \firma, \strasse, \ort, \ustid, \email und \homepage definiert.
47
%
48
% Währungen / Konten:
49
%    Für jede Währung (siehe 'insettings.tex') soll eine Datei vorhanden
50
%    sein, die das Währungssymbol (\currency) und folgende Angaben für
51
%    ein Konto in dieser Währung enthält \kontonummer, \bank,
52
%    \bankleitzahl, \bic und \iban.
53
%    So kann in den Dokumenten je nach Währung ein anderes Konto
54
%    angegeben werden.
55
%    Nach demselben Schema können auch weitere, alternative Bankverbindungen
56
%    angelegt werden, die dann in insettings.tex als Variable im
57
%    unteren Abschnitt der Datei 'insettings.tex', Kommentar Fusszeile
58
%    (cfoot) eingefügt werden.
59
%
60
% Briefbogen/Logos:
61
%    Eine Hintergrundgrafik oder ein Logo kann in Abhängigkeit vom
62
%    Medium (z.B. nur beim Verschicken mit E-Mail) eingebunden
63
%    werden. Dies ist im Moment auskommentiert.
64
%
65
%    Desweiteren sind (auskommentierte) Beispiele enthalten für eine
66
%    Grafik als Briefkopf, nur ein Logo, oder ein komplettes DinA4-PDF
67
%    als Briefpapier.
68
%
69
% Fusszeile:
70
%    Die Tabelle im Fuß verwendet die Angaben aus firma/ident.tex und
71
%    firma/*_account.tex.
72
%
73
%
74
% Tabellen:
75
%    Als Tabellenumgebung wird longtable verwendet. Diese Umgebung
76
%    kann in einer Tabelle umbrechen. Da aber der Umbruch nicht von
77
%    kivitendo kontrolliert wird, kann man keinen Übertrag machen.
78
%    Innerhalb des Langtextes <%longdescription%> wird nicht umgebrochen. Um
79
%    dies zu erreichen kann z.B. per renewcommand das "\newline" umdefiniert
80
%    werden.
81

  
82
%
83
% Quickstart (wo kann was angepasst werden?):
84
%    insettings.tex : Pfad zu Angaben über Mandanten (default: firma)
85
%                     Logo/Briefpapier
86
%                     Seitenränder / Geometry
87
%                     Aussehen Kopf/Fußzeile
88
%    firma/*        : Angaben über Mandanten
89
% Es muß mindestens eine Sprache angelegt werden!
90
%    deutsch.tex    : Textschnipsel für Deutsch
91
%                     Dafür eine Sprache mit Vorlagenkürzel DE anlegen
92
%    english.tex    : Textschnipsel für Englisch
93
%                     Dafür eine Sprache mit Vorlagenkürzel EN anlegen
94
%

Auch abrufbar als: Unified diff