From: Marei Peischl Date: Sun, 12 Jan 2020 23:40:33 +0000 (+0100) Subject: cleanup Readme X-Git-Tag: release-3.5.6.1~272 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=dca78edda3cac77053efe72d16d2218dba513462;p=kivitendo-erp.git cleanup Readme --- diff --git a/Readme.md b/Readme.md new file mode 100644 index 000000000..d2d804432 --- /dev/null +++ b/Readme.md @@ -0,0 +1,73 @@ + +# Bemerkungen zum Vorlagensatz von +### © 2020 by Marei Peischl (peiTeX TeXnical Solutions) + +## Aufbau: +Die Grundstruktur besteht je Dokumententyp aus einer Basisdatei und verschiedenen Setup-Dateien. + +Die Basis wurde so überarbeitet, dass Dokumente nun generell auf der Dokumentenklasse *scrartcl.cls* basieren und das Paket *kiviletter.sty* benutzen. + +Mandantenspezifische Konfiguration findet sich in der Datei *insettings.tex* und dem Ordner eines spezifischen Mandanten (default=*firma/*). + + +### Struktur der Basisdatei (je Dokumententyp eine) + 1. Dokumentenklasse + 2. *kiviletter.sty* + 3. Einstellungen, die über Variablen gesetzt werden: Mandant, Währung, Sprache + 4. `\input{insettings.tex}` Anteil der spezifischen Anpassungen, die von den Variablen unter 2. abhängig sind. Geladen werden darin die Dateien: + - 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. + - Lädt die Konfigurationsdatei, ohne spezielle Mandanten ist der Suchpfad zur Konfiguration der Unterordner *firma/* + * Lädt die Datei *ident.tex*, sowie die Abbildung Briefkopf. + +Mandanten / Firma: + Um gleiche Vorlagen für verschiedene Firmen verwenden zu können, wird je + nach dem Wert der Kivitendo-Variablen <%kivicompany%> ein + Firmenverzeichnis ausgewählt (siehe 'insettings.tex'), in dem Briefkopf, + Identitäten und Währungs-/Kontoeinstellungen hinterlegt sind. + <%kivicompany%> enthält den Namen des verwendeten Mandantendaten. + Ist kein Firmenname eingetragen, so wird das + generische Unterverzeichnis 'firma' verwendet. + +Identitäten: + In jedem Firmen-Unterverzeichnis soll eine Datei 'ident.tex' + vorhanden sein, die mit \newcommand Werte für \telefon, \fax, + \firma, \strasse, \ort, \ustid, \email und \homepage definiert. + +Währungen / Konten: + Für jede Währung (siehe 'insettings.tex') soll eine Datei vorhanden + sein, die das Währungssymbol (\currency) und folgende Angaben für + ein Konto in dieser Währung enthält \kontonummer, \bank, + \bankleitzahl, \bic und \iban. + So kann in den Dokumenten je nach Währung ein anderes Konto + angegeben werden. + Nach demselben Schema können auch weitere, alternative Bankverbindungen + angelegt werden, die dann in insettings.tex als Variable im + unteren Abschnitt der Datei 'insettings.tex', Kommentar Fußzeile + (cfoot) eingefügt werden. + Briefbogen/Logos: + Eine Hintergrundgrafik oder ein Logo kann in Abhängigkeit vom + Medium (z.B. nur beim Verschicken mit E-Mail) eingebunden + werden. Dies ist im Moment auskommentiert. + + Desweiteren sind (auskommentierte) Beispiele enthalten für eine + Grafik als Briefkopf, nur ein Logo, oder ein komplettes DinA4-PDF + als Briefpapier. + + Fusszeile: + Die Tabelle im Fuß verwendet die Angaben aus firma/ident.tex und + firma/*_account.tex. + +## Tabellen: + + + Quickstart (wo kann was angepasst werden?): + insettings.tex : Pfad zu Angaben über Mandanten (default: firma) + Logo/Briefpapier + Layout der Kopf/Fußzeile + firma/* : Angaben über Mandanten + Es muß mindestens eine Sprache angelegt werden! + deutsch.tex : Textschnipsel für Deutsch + Dafür eine Sprache mit Vorlagenkürzel DE anlegen + english.tex : Textschnipsel für Englisch + Dafür eine Sprache mit Vorlagenkürzel EN anlegen + diff --git a/Readme.tex b/Readme.tex deleted file mode 100644 index ca15217bc..000000000 --- a/Readme.tex +++ /dev/null @@ -1,94 +0,0 @@ -% -% Bemerkungen zum Vorlagensatz RB von -% Richardson & Büren GmbH -% -% Hier wurden einige Ideen aufgegriffen, die in folgendem Vortrag -% erwähnt wurden: -% http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf -% -% Am Ende dieser Datei befindet sich ein Abschnitt "Quickstart", der die -% Vorbereitungsschritte beschreibt, die bei diesem Druckvorlagensatz nötig -% sind. -% -% -% Aufbau: -% Die documentclass und alle usepackage-Anweisungen sind in -% 'inheaders.tex' ausgelagert. Diese werden von allen Vorlagen via -% \input eingebunden. -% -% Desweiteren sind einige Einstellungen und eigene Befehle, die alle -% Vorlagen verwenden, in 'insetting.tex' untergebracht. Auch diese -% werden mit \input eingebunden. -% Da in eingebundenen Dateien die kivitendo-Variablen nicht aufgelöst -% werden könnnen, werden die hier verwendeten Variablen in jedem -% Dokument vorher mit \newcommand neu definiert. -% -% Sprachen: -% In 'insettings.tex' wird anhand des verwendeten Sprachkürzels die -% Sprache unterschieden und eine entsprechende Übersetzungsdatei geladen, -% die Textbausteine bzw. -Schnipsel enthält. Die Vorlagen verwenden nur -% diese Schnipsel. Im Moment werden die Vorlagenkürzel DE und EN in -% Benutzung mit den entsprechenden Übersetzungsdateien 'deutsch.tex' -% und 'english.tex' unterschieden. -% -% Mandanten / Firma: -% Um gleiche Vorlagen für verschiedene Firmen verwenden zu können, wird je -% nach dem Wert der Kivitendo-Variablen <%kivicompany%> ein -% Firmenverzeichnis ausgewählt (siehe 'insettings.tex'), in dem Briefkopf, -% Identitäten und Währungs-/Kontoeinstellungen hinterlegt sind. -% <%kivicompany%> enthält den Namen des verwendeten Mandantendaten. -% Ist kein Firmenname eingetragen, so wird das -% generische Unterverzeichnis 'firma' verwendet. -% -% Identitäten: -% In jedem Firmen-Unterverzeichnis soll eine Datei 'ident.tex' -% vorhanden sein, die mit \newcommand Werte für \telefon, \fax, -% \firma, \strasse, \ort, \ustid, \email und \homepage definiert. -% -% Währungen / Konten: -% Für jede Währung (siehe 'insettings.tex') soll eine Datei vorhanden -% sein, die das Währungssymbol (\currency) und folgende Angaben für -% ein Konto in dieser Währung enthält \kontonummer, \bank, -% \bankleitzahl, \bic und \iban. -% So kann in den Dokumenten je nach Währung ein anderes Konto -% angegeben werden. -% Nach demselben Schema können auch weitere, alternative Bankverbindungen -% angelegt werden, die dann in insettings.tex als Variable im -% unteren Abschnitt der Datei 'insettings.tex', Kommentar Fusszeile -% (cfoot) eingefügt werden. -% -% Briefbogen/Logos: -% Eine Hintergrundgrafik oder ein Logo kann in Abhängigkeit vom -% Medium (z.B. nur beim Verschicken mit E-Mail) eingebunden -% werden. Dies ist im Moment auskommentiert. -% -% Desweiteren sind (auskommentierte) Beispiele enthalten für eine -% Grafik als Briefkopf, nur ein Logo, oder ein komplettes DinA4-PDF -% als Briefpapier. -% -% Fusszeile: -% Die Tabelle im Fuß verwendet die Angaben aus firma/ident.tex und -% firma/*_account.tex. -% -% -% Tabellen: -% Als Tabellenumgebung wird longtable verwendet. Diese Umgebung -% kann in einer Tabelle umbrechen. Da aber der Umbruch nicht von -% kivitendo kontrolliert wird, kann man keinen Übertrag machen. -% Innerhalb des Langtextes <%longdescription%> wird nicht umgebrochen. Um -% dies zu erreichen kann z.B. per renewcommand das "\newline" umdefiniert -% werden. - -% -% Quickstart (wo kann was angepasst werden?): -% insettings.tex : Pfad zu Angaben über Mandanten (default: firma) -% Logo/Briefpapier -% Seitenränder / Geometry -% Aussehen Kopf/Fußzeile -% firma/* : Angaben über Mandanten -% Es muß mindestens eine Sprache angelegt werden! -% deutsch.tex : Textschnipsel für Deutsch -% Dafür eine Sprache mit Vorlagenkürzel DE anlegen -% english.tex : Textschnipsel für Englisch -% Dafür eine Sprache mit Vorlagenkürzel EN anlegen -%