X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentenvorlagen-und-variablen.html;h=b9ca939c4392af36c3cbe2febee10cc557a230ef;hb=65573957980291104639ebe3ab16ecf2c4bef433;hp=4ca82e372ccb577ad93eee4dd417cd88c33816fe;hpb=8f2157619ac4656eabb16fa972846a0e38c98ad0;p=kivitendo-erp.git diff --git a/doc/dokumentenvorlagen-und-variablen.html b/doc/dokumentenvorlagen-und-variablen.html index 4ca82e372..b9ca939c4 100644 --- a/doc/dokumentenvorlagen-und-variablen.html +++ b/doc/dokumentenvorlagen-und-variablen.html @@ -48,6 +48,9 @@ td {
  • Zuordnung von Dateinamen zu den Funktionen
  • +
  • + Anfang und Ende der Tags verändern
  • +
  • Allgemeine Variablen, die in allen Vorlagen vorhanden sind
    @@ -55,6 +58,9 @@ td {
  • Stammdaten von Kunden und Lieferanten
  • +
  • + Informationen über den Bearbeiter
  • +
  • Informationen über den Verkäufer
  • @@ -78,6 +84,24 @@ td { +
  • + Variablen in Mahnungen und Rechnungen über Mahngebühren + +
      +
    1. + Namen der Vorlagen
    2. + +
    3. + Allgemeine Variablen in Mahnungen
    4. + +
    5. + Variablen für jede gemahnte Rechnung in einer Mahnung
    6. + +
    7. + Variablen in automatisch erzeugten Rechnungen über Mahngebühren
    8. +
    +
  • +
  • Variablen in anderen Vorlagen
  • @@ -85,15 +109,6 @@ td { Blöcke, bedingte Anweisungen und Schleifen
      -
    1. - Einschänkungen für Blöcke in LaTeX-Vorlagen
    2. - -
    3. - Einschänkungen für Blöcke in OpenDocument-Vorlagen
    4. - -
    5. - Die include-Anweisung
    6. -
    7. Der if not-Block
    8. @@ -121,7 +136,11 @@ td {

      Dies ist eine Auflistung der Standard-Dokumentenvorlagen und aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form - <%variablenname%> verwendet wird.

      + <%variablenname%> verwendet wird. Für LaTeX- + und HTML-Vorlagen kann man die Form dieser Tags auch + + verändern. +

      Früher wurde hier nur über LaTeX gesprochen. Inzwischen unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern @@ -156,6 +175,36 @@ td { zum Inhaltsverzeichnis


      +

      + Anfang und Ende der Tags verändern

      + +

      Der Standardstil für Tags sieht vor, dass ein Tag mit dem + Kleinerzeichen und einem Prozentzeichen beginnt und mit dem + Prozentzeichen und dem Größerzeichen endet, + beispielsweise <%customer%>. Da diese Form aber + z.B. in LaTeX zu Problemen führen kann, weil das Prozentzeichen + dort Kommentare einleitet, kann pro HTML- oder + LaTeX-Dokumentenvorlage der Stil umgestellt werden.

      + +

      Dazu werden in die Datei Zeilen geschrieben, die mit dem für + das Format gültigen Kommentarzeichen anfangen, + dann config: enthalten, die entsprechende Option setzen + und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen + enden. Beispiel für LaTeX:

      + +

      % config: tag-style=($ $)

      + +

      Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen, + wenn sie wie folgt aussehen: ($customer$). Das + äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so + aus:

      + +

      <!-- config: tag-stye=($ $)>

      + + + zum Inhaltsverzeichnis
      +
      +

      Zuordnung von den Dateinamen zu den Funktionen

      @@ -203,7 +252,7 @@ td { business - Kundentyp + Kunden-/Lieferantentyp city @@ -250,13 +299,25 @@ td { Kreditlimit - customernumber - Kundennummer; nur für Kunden + customeremail + Email des Kunden; nur für Kunden + + + customerfax + Faxnummer des Kunden; nur für Kunden customernotes Bemerkungen beim Kunden; nur für Kunden + + customernumber + Kundennummer; nur für Kunden + + + customerphone + Telefonnummer des Kunden; nur für Kunden + discount Rabatt @@ -281,6 +342,10 @@ td { name Firmenname + + payment_terms + Zahlungskonditionen + phone Telefonnummer @@ -348,10 +413,6 @@ td { taxnumber Steuernummer - - terms - Zahlungsziel - vendoremail Email des Lieferanten; nur für Lieferanten @@ -387,8 +448,8 @@ td { sondern schlicht Kopien der Lieferdatenvariablen sind (z.B. shiptocontact).

      -

      - Informationen über den Verkäufer:

      +

      + Informationen über den Bearbeiter:

      @@ -405,6 +466,14 @@ td { + + + + + + + + @@ -421,6 +490,10 @@ td { + + + + @@ -428,6 +501,59 @@ td {
      employee_company Firmenname
      employee_co_ustidUsatzsteuer-Identifikationsnummer
      employee_dunsDUNS-Nummer
      employee_email Emailemployee_signature Signatur
      employee_taxnumberSteuernummer
      employee_tel Telefonnummer

      +

      + Informationen über den Verkäfer (nur bei Verkaufsmasken):

      + +

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      VariablennameBedeutung
      salesman_addressAdressfeld
      salesman_businessnumberFirmennummer
      salesman_companyFirmenname
      salesman_co_ustidUsatzsteuer-Identifikationsnummer
      salesman_dunsDUNS-Nummer
      salesman_emailEmail
      salesman_faxFax
      salesman_namevoller Name
      salesman_signatureSignatur
      salesman_taxnumberSteuernummer
      salesman_telTelefonnummer
      +

      +

      Variablen für die einzelnen Steuern:

      @@ -484,6 +610,10 @@ td { duedate Fälligkeitsdatum + + globalprojectnumber + Projektnummer des ganzen Beleges + intnotes Interne Bemerkungen @@ -504,10 +634,22 @@ td { notes Bemerkungen der Rechnung + + orddate + Auftragsdatum + ordnumber Auftragsnummer, wenn die Rechnung aus einem Auftrag erstellt wurde + + payment_terms + Zahlungskonditionen + + + quodate + Angebotsdatum + quonumber Angebotsnummer @@ -534,6 +676,10 @@ td { total Restsumme der Rechnung (Summe abzüglich bereits bezahlter Posten) + + transaction_description + Vorgangsbezeichnung + transdate Auftragsdatum wenn die Rechnung aus einem Auftrag erstellt wurde @@ -599,6 +745,14 @@ td { partsgroup Warengruppe + + price_factor + Der Preisfaktor als Zahl, sofern einer eingestellt ist + + + price_factor_name + Der Name des Preisfaktors, sofern einer eingestellt ist + projectnumber Projektnummer @@ -667,6 +821,173 @@ td { zum Inhaltsverzeichnis

      +

      Variablen in Mahnungen und Rechnungen über Mahngebühren

      + +

      Namen der Vorlagen

      + +

      Die Namen der Vorlagen werden im System-Menü vom Benutzer + eingegeben. Wird für ein Mahnlevel die Option zur automatischen + Erstellung einer Rechnung über die Mahngebühren und Zinsen + aktiviert, so wird der Name der Vorlage für diese Rechnung aus + dem Vorlagenname für diese Mahnstufe mit dem + Zusatz _invoice gebildet. Weiterhin werden die + Kürzel für die ausgewählte Sprache und den + ausgewählten Drucker angehängt.

      + +

      Allgemeine Variablen in Mahnungen:

      + +

      Die Variablen des Verkäufers stehen wie gewohnt + als employee_... zur Verfügung. Die Adressdaten des + Kunden stehen als Variablen name, street, + zipcode, city, country, + department_1, department_2, und + email zur Verfügung. +

      + +

      Weitere Variablen beinhalten:

      + +

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      VariablennameBedeutung
      dunning_dateDatum der Mahnung
      dunning_duedateFälligkeitsdatum für diese Mahhnung
      feeKummulative Mahngebühren
      interest_rateZinssatz per anno in Prozent
      total_amountGesamter noch zu zahlender Betrag als fee + total_interest + total_open_amount
      total_interestZinsen per anno über alle Rechnungen
      total_open_amountSumme über alle offene Beträge der Rechnungen
      +

      + +

      + Variablen für jede gemahnte Rechnung in einer Mahnung:

      + +

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      VariablennameBedeutung
      dn_amountRechnungssumme (brutto)
      dn_duedateOriginales Fälligkeitsdatum der Rechnung
      dn_dunning_dateDatum der Mahnung
      dn_dunning_duedateFälligkeitsdatum der Mahnung
      dn_feeKummulative Mahngebühr
      dn_interestZinsen per anno für diese Rechnung
      dn_invnumberRechnungsnummer
      dn_linetotalNoch zu zahlender Betrag (ergibt sich aus dn_open_amount + dn_fee + dn_interest)
      dn_netamountRechnungssumme (netto)
      dn_open_amountOffener Rechnungsbetrag
      dn_ordnumberBestellnummer
      dn_transdateRechnungsdatum
      +

      + +

      Variablen in automatisch erzeugten + Rechnungen über Mahngebühren

      + +

      Die Variablen des Verkäufers stehen wie gewohnt + als employee_... zur Verfügung. Die Adressdaten des + Kunden stehen als Variablen name, street, + zipcode, city, country, + department_1, department_2, und + email zur Verfügung. +

      + +

      Weitere Variablen beinhalten:

      + +

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      VariablennameBedeutung
      duedateFälligkeitsdatum der Rechnung
      dunning_idMahnungsnummer
      feeMahngebühren
      interestZinsen
      invamountRechnungssumme (ergibt sich aus fee + interest)
      invdateRechnungsdatum
      invnumberRechnungsnummer
      +

      + + + zum Inhaltsverzeichnis
      +
      +

      Variablen in anderen Vorlagen

      @@ -693,47 +1014,11 @@ td { gesondert behandelt werden. Diese sind wie Variablennamen in spezieller Weise markiert: <%anweisung%>

      -

      - Einschänkungen für Blöcke in LaTeX-Vorlagen

      - -

      Achtung: Blöcke können in LaTeX-Vorlagen momentan nicht - verschachtelt werden. Das bedeutet, dass innerhalb einer - <%foreach%>-Schleife keine - <%if%>-Abfragen verwendet werden können. Dieses - kann man aber mit LaTeX-Bordmitteln selber nachgebildet werden. Dazu muss - im Vorspann das Paket ifthen eingebunden werden. Das Konstrukt - selber sieht dann wie folgt aus:

      - -

      \ifthenelse{\equal{<%variable%>}{}}{}{Dieser - Text erscheint nur, wenn <%variable%> nicht leer ist.}

      - -

      - Einschänkungen für Blöcke in OpenDocument-Vorlagen

      - -

      Die eben erwähnten Einschränkungen für - LaTeX-Vorlagen gelten in abgeschwächter Form auch für - OpenDocument-Vorlagen. Auch bei OpenDocument-Vorlagen können - Blöcke nicht verschachtelt werden. Einzige Ausnahme ist, dass - <if> und - <ifnot>-Blöcke innerhalb von - <foreach>-Blöcken auftreten - dürfen.

      - -

      Die include-Anweisung

      - -

      <%include dateiname.ext%>

      - -

      Dieser Block funktioniert nur in LaTeX- und HTML-Vorlagen.

      - -

      Fügt den Inhalt einer Datei an der entsprechenden Stelle ein. Der - eingefügte Text wird ganz normal durch den Parser behandelt und kann - Variablen und Blöcke enthalten.

      -

      Der if not-Block

      <%if not variablenname%>
      ...
      - <%end if>

      + <%end>

      Eine normale "if-not-then"-Bedingung. Die Zeilen zwischen dem "if not" und dem "end" werden nur ausgegeben, wenn die Variable "variablenname" nicht @@ -743,7 +1028,7 @@ td {

      <%if variablenname%>
      ...
      - <%end if>

      + <%end>

      Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if" und dem "end" werden nur ausgegeben, wenn die Variable "variablenname" gesetzt und @@ -753,7 +1038,7 @@ td {

      <%foreach variablenname%>
      ...
      - <%end foreach>

      + <%end>

      Fügt die Zeilen zwischen den beiden Anweisungen so oft ein, wie das Perl-Array der Variablen "variablenname" Elemente enthät. Dieses @@ -771,21 +1056,20 @@ td { Artikelnummer: <%number%>
      Beschreibung: <%description%>
      ...
      - <%end foreach>

      + <%end>

      Besonderheit in OpenDocument-Vorlagen: Tritt ein - <foreach>-Blcok innerhalb einer Tabellenzelle + <foreach>-Block innerhalb einer Tabellenzelle auf, so wird die komplette Tabellenzeile so oft wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der Inhalt - zwischen <foreach> und <end - foreach> wiederholt, nicht aber die komplette Zeile, in - der er steht.

      + zwischen <foreach> und <end> + wiederholt, nicht aber die komplette Zeile, in der er steht.

      Der pagebreak-Block

      <%pagebreak ZpZ ZeS ZzS%>
      ...
      - <%end pagebreak%>

      + <%end>

      Dieser Block existiert nur in LaTeX-Vorlagen.