X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentenvorlagen-und-variablen.html;h=e1dac111be62efa5429a829f9ed122474fcf2c84;hb=6caa57e2e994c8f99c209ce18379305eb01d1676;hp=38be045c8d552476a86103f6bd75f262bf34ba82;hpb=4cb733c6576bffb1fbe8ce6257bd63ee769f6819;p=kivitendo-erp.git diff --git a/doc/dokumentenvorlagen-und-variablen.html b/doc/dokumentenvorlagen-und-variablen.html index 38be045c8..e1dac111b 100644 --- a/doc/dokumentenvorlagen-und-variablen.html +++ b/doc/dokumentenvorlagen-und-variablen.html @@ -48,6 +48,12 @@ td {
foreach
-Schleifepagebreak
-BlockEinige Zahlenwerte werden auch in unformatierter Form zur Verfügung + gestellt (also z.B. 35 statt 35,00 oder 12.3 statt 12,30). Der Dezimaltrenner + ist dabei also immer ein Punkt unabhaengig vom eingestellten Zahlenformat. + Diese Variabelen kann man mit der Erweiterung _nofmt (für no-format) aufrufen + (also z.B. netprice = 12,30 -- netprice_nofmt = 12.3). Variabeln die zusätzlich + unformatiert zur Verfügung stehen sind unten als variable[_nofmt] gelistet. + Die Eckigen Klammern weisen also auf eine optionale Verwändung der Erweiterung hin. +
+Früher wurde hier nur über LaTeX gesprochen. Inzwischen
unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern
es nicht ausdrücklich eingeschränkt wird, gilt das im
@@ -182,6 +195,68 @@ td {
zum Inhaltsverzeichnis
Um eine Variable auszugeben, müssen sie einfach nur zwischen die
+ Tags geschrieben werden, also
+ z.B. <%variablenname%>
.
+ Optional kann man auch mit Leerzeichen getrennte Flags angeben, die
+ man aber nur selten brauchen wird. Die Syntax sieht also so
+ aus: <%variablenname FLAG1 FLAG2%>
. Momentan werden
+ die folgenden Flags unterstützt:
+
NOFORMAT
gilt nur für Zahlenwerte und gibt den Wert
+ ohne Formatierung, also ohne Tausendertrennzeichen mit mit einem
+ Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn damit in der
+ Vorlage z.B. von LaTeX gerechnet werden soll.
+ NOESCAPE
unterdrückt das Escapen von Sonderzeichen für
+ die Vorlagensprache. Wenn also in einer Variablen bereits gültiger
+ LaTeX-Code steht und dieser von LaTeX auch ausgewertet und nicht
+ wortwörtlich angezeigt werden soll, so ist dieses Flag sinnvoll.
+
+ Beispiel: <%quototal NOFORMAT%>
+
+ In der Admininstration können Drucker definiert werden. Auch im dort
+ eingebbaren Druckbefehl können die hier aufgelisteten Variablen und
+ Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach den
+ Regeln der gängigen Shells formatiert, sodass Sonderzeichen
+ wie `...`
nicht zu unerwünschtem Verhalten führen.
+
+ Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl, für + das die Telefonnummer eines Ansprechpartners als Teil der + Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das + z.B. wie folgt aussehen: +
+ +
+ send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%>
+
<!-- config: tag-style=($ $)>
<!-- config: tag-style=($ $) -->
Angeforderte Sprache und Druckerkürzel in den Dateinamen mit eingearbeitet. So wird aus der Vorlage sales_order.ext
bei Sprache de
und Druckerkürzel lpr2
der Vorlagenname sales_order_de_lpr2.ext
. Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese bekommen dann noch das Kürzel _email
, der vollständige Vorlagenname wäre dann sales_order_email_de_lpr2.ext
. In allen Fällen kann eine Standarddatei default.ext
hinterlegt werden. Diese wird verwendet, wenn keine der anderen Varianten gefunden wird.
Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF verschickt wird, ist:
++
Reihenfolge der möglichen Vorlagennamen |
---|
sales_order_email_de_lpr2.tex |
sales_order_de_lpr2.tex |
sales_order.tex |
default.tex |
Die kurzen Varianten dieser Vorlagentitel müssen dann entweder Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten, siehe dazu Metadaten in Vorlagen
+ zum InhaltsverzeichnisDiese Variablen liefern Informationen darüber welche Variante einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen Formulare einbinden möchten.
+ ++
Variablenname | Bedeutung |
---|---|
template_meta.formname |
+ Basisname der Vorlage. Identisch mit der Zurordnung zu den Dateinamen ohne die Erweiterung. Ein Verkaufsauftrag enthält hier sales_order . |
+
template_meta.language.description |
+ Beschreibung der verwendeten Sprache | +
template_meta.language.template_code |
+ Vorlagenürzel der verwendeten Sprache, identisch mit dem Kürzel das im Dateinamen verwendetet wird. | +
template_meta.language.output_numberformat |
+ Zahlenformat der verwendeten Sprache in der Form "1.000,00". Experimentell!. Nur interessant für Vorlagen die mit unformatierten Werten arbeiten. | +
template_meta.language.output_dateformat |
+ Datumsformat der verwendeten Sprache in der Form "dd.mm.yyyy". Experimentell!. Nur interessant für Vorlagen die mit unformatierten Werten arbeiten. | +
template_meta.format |
+ Das angeforderte Format. Kann im Moment die Werte pdf , postscript , html , opendocument , opendocument_pdf und excel enthalten. |
+
template_meta.extension |
+ Dateierweiterung, wie im Dateinamen. Wird aus format entschieden. |
+
template_meta.media |
+ Ausgabemedium. Kann zur Zeit die Werte screen für Bildschirm, email für E-Mmail (triggert das _email Kürzel im Dateinamen), printer für Drucker, und queue für Warteschlange enthalten. |
+
template_meta.printer.description |
+ Beschreibung des ausgewählten Druckers | +
template_meta.printer.template_code |
+ Vorlagenürzel des ausgewählten Druckers, identisch mit dem Kürzel das im Dateinamen verwendetet wird. | +
name
payment_description
payment_terms
taxnumber
ustid
vendoremail
ordnumber
payment_description
payment_terms
subtotal
subtotal[_nofmt]
sumcarriedforward
pagebreak
-Block verwendet werden.total
discount
discount[_nofmt]
discount_sub
discount_sub[_nofmt]
linetotal
linetotal[_nofmt]
netprice
netprice[_nofmt]
nodiscount_linetotal
nodiscount_linetotal[_nofmt]
nodiscount_sub
nodiscount_sub[_nofmt]
qty
qty[_nofmt]
sellprice
sellprice[_nofmt]
serialnumber
tax_rate
transdate_oe
dn_transdate
dn_curr
Für jede Position eines Lieferscheines gibt es ein Unterarray mit
+ den Informationen darüber, von welchem Lager und Lagerplatz aus die
+ Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
+ Lagerplatz sie eingelagert wurden. Diese müssen mittels
+ einer foreach
-Schleife ausgegeben werden. Diese
+ Variablen sind:
Für jede Position eines Lieferscheines gibt es ein Unterarray mit den Informationen darüber, von welchem Lager und Lagerplatz aus die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen @@ -1247,6 +1414,81 @@ td {
++
Variablenname | Bedeutung |
---|---|
c0total |
+ Gesamtbetrag aller Rechnungen mit Fälligkeit < 30 Tage | +
c30total |
+ Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30 und < 60 Tage | +
c60total |
+ Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60 und < 90 Tage | +
c90total |
+ Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90 Tage | +
total |
+ Gesamtbetrag aller Rechnungen | +
+
Variablenname | Bedeutung |
---|---|
invnumber |
+ Rechnungsnummer | +
invdate |
+ Rechnungsdatum | +
duedate |
+ Fälligkeitsdatum | +
amount |
+ Summe der Rechnung | +
open |
+ Noch offener Betrag der Rechnung | +
c0 |
+ Noch offener Rechnungsbetrag mit Fälligkeit < 30 Tage | +
c30 |
+ Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und < 60 Tage | +
c60 |
+ Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und < 90 Tage | +
c90 |
+ Noch offener Rechnungsbetrag mit Fälligkeit >= 90 Tage | +
Anmerkung zum <%end%>
: Der besseren
- Verständlichkeit halber kann man nach dem end
noch
- beliebig weitere Wörter schreiben, um so zu markieren, welche
+ Verständlichkeit halber kann man nach dem end
noch
+ beliebig weitere Wörter schreiben, um so zu markieren, welche
Anweisung (z.B. if
oder foreach
) damit
abgeschlossen wird.
Beispiel: Lautet der Beginn eines Blockes
z.B. <%if type ==
- "sales_quotation"%>
, so könnte er mit
+ "sales_quotation"%>, so könnte er mit
<%end%>
genauso abgeschlossen werden
wie mit
<%end if%>
oder auch
@@ -1290,33 +1532,33 @@ td {
wird. Beispiel: <%if not
cp_greeting%>
Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist - oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt +
Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist + oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt einer Variablen mit einer festen Zeichenkette oder einer anderen Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette - oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob - die rechte Seite des Vergleichsoperators in Anführungszeichen + oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob + die rechte Seite des Vergleichsoperators in Anführungszeichen gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit anderer Variablen). Zwei Beispiele, die beide Vergleiche zeigen:
<%if var1 == "Wert"%>
- testet die Variable "var1" auf Ãbereinstimmung mit der
+ testet die Variable "var1" auf Übereinstimmung mit der
Zeichenkette "Wert". Mittels "!=" anstelle von
- "==" würde auf Ungleichheit getestet.
<%if var1 == var2%>
testet die
- Variable "var1" auf Ãbereinstimmung mit der Variablen
+ Variable "var1" auf Übereinstimmung mit der Variablen
"var2". Mittels "!=" anstelle von "=="
- würde auf Ungleichheit getestet.
Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit auch - Tests auf Ãbereinstimmung mit regulären Ausdrücken ohne - Berücksichtung der GroÃ- und Kleinschreibung durchführen. Dazu dient +
Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit auch + Tests auf Übereinstimmung mit regulären Ausdrücken ohne + Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient dieselbe Syntax wie oben nur mit "=~" und "!~" als Vergleichsoperatoren.
-Beispiel für einen Test, ob die Variable "intnotes" - (interne Bemerkungen) das Wort "schwierig" enthält: +
Beispiel für einen Test, ob die Variable "intnotes"
+ (interne Bemerkungen) das Wort "schwierig" enthält:
<%if intnotes =~
"schwierig"%>
<%foreach%>
und <%end%>
wiederholt, nicht aber die komplette Zeile, in der er steht.
- pagebreak
-Block<%pagebreak ZpZ ZeS ZzS%>
- ...
- <%end%>
Dieser Block existiert nur in LaTeX-Vorlagen.
- -Dieser Block legt das Verhalten beim manuellen Einfügen eines
- Seitenumbruchs fest. Normalerweise bricht LaTeX die Seiten selber um. Beim
- Rechnungsdruck ist das oft nicht gewünscht, oder man möchte im
- Falle eines Seitenumbruchs den Übertrag etc. mit ausgeben. Deswegen
- versucht der Parser, manuell Seitenumbrüche einzufügen,
- während er einen foreach
-Block auswertet, weil hier die
- manuellen Seitenumbrüche erforderlich werden. Dafür benötigt
- der Parser aber drei Informationen:
-
Diese Parameter sind drei Zahlen, die manuell durch Verwendung von langen - Warenbezeichnungen und Rechnungen mit vielen Posten bestimmt werden - müssen.
- -Üblicherweise wird in diesem Block zuerst die aktuelle Tabelle - geschlossen, eventuell Text eingefügt (z.B. "Fortsetzung auf der - nächsten Seite"), dann ein Seitenumbruch erzwungen, eventuell Text - eingefügt (z.B. "Übertrag von der vorherigen Seite: - <%sumcarriedforward%> EUR") und die Tabelle wieder geöffnet.
- -Wird kein manueller Seitenumbruch gewüscht, so kann dieser Block - komplett entfallen.
- zum Inhaltsverzeichnis<pagebreak>
<bullet>
Eine Besonderheit ist der Befehl <pagebreak>
,
der nur in LaTeX-Vorlagen funktioniert und in anderen Vorlagen
- einfach gelöscht wird. Dieser erzwingt unabhängig von der
- im pagebreak-Block
- voreingestellten Werte einen Seitenumbruch nach der aktuellen
- Rechnungsposition. Dementsprechend funktioniert er nur innerhalb von
+ einfach gelöscht wird. Dieser erzwingt einen Seitenumbruch nach
+ der aktuellen Rechnungsposition. Dementsprechend funktioniert er nur
+ innerhalb von
<%foreach...%>
-Schleifen. Weiterhin benötigt
er kein Endtag.
Auch <bullet>
funktioniert momentan auch nur in Latex-Vorlagen.