EK-/VK-Preis bei Erzeugnissen
[kivitendo-erp.git] / doc / dokumentation.xml
index 79f7d50..0c41875 100644 (file)
@@ -2,7 +2,7 @@
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <book id="kivitendo-documentation" lang="de">
-  <title>kivitendo: Installation, Konfiguration, Entwicklung</title>
+  <title>kivitendo 3.0.0: Installation, Konfiguration, Entwicklung</title>
 
   <chapter id="Aktuelle-Hinweise">
     <title>Aktuelle Hinweise</title>
@@ -260,11 +260,11 @@ cpan Rose::Db::Object</programlisting>
            xreflabel="Manuelle Installation des Programmpaketes">
       <title>Manuelle Installation des Programmpaketes</title>
 
-      <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-2.6.3.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
+      <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
       (z.B.  <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
 
       <programlisting>cd /var/www
-tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
+tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
 
       <para>Wechseln Sie in das entpackte Verzeichnis:</para>
 
@@ -538,7 +538,7 @@ exit</programlisting>
         wird:</para>
 
         <programlisting>AddHandler cgi-script .pl
-Alias /kivitendo-erp/ /var/www/kiviteno-erp/
+Alias /kivitendo-erp/ /var/www/kivitendo-erp/
 
 &lt;Directory /var/www/kivitendo-erp&gt;
  Options ExecCGI Includes FollowSymlinks
@@ -1717,6 +1717,23 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
       Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
       sind.</para>
 
+      <note>
+        <para>
+          Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
+          dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
+          wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
+          festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
+        </para>
+
+        <para>
+          Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
+          z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
+          <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
+          leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
+          Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
+        </para>
+      </note>
+
       <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
       wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
       mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
@@ -2153,6 +2170,82 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
         <varname>[periodic_invoices]</varname>.</para>
       </sect2>
 
+      <sect2 id="features.periodic-invoices.variables">
+        <title>Spezielle Variablen</title>
+
+        <para>
+          Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
+          formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
+          Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal>&lt;%variablenname%&gt;</literal>.
+        </para>
+
+        <para>
+          Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
+        </para>
+
+        <itemizedlist>
+          <listitem><para>Bemerkungen</para></listitem>
+          <listitem><para>Interne Bemerkungen</para></listitem>
+          <listitem><para>Vorgangsbezeichnung</para></listitem>
+          <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
+        </itemizedlist>
+
+        <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
+
+        <variablelist>
+          <varlistentry>
+            <term><varname>&lt;%current_quarter%&gt;</varname>, <varname>&lt;%previous_quarter%&gt;</varname>, <varname>&lt;%next_quarter%&gt;</varname></term>
+
+            <listitem>
+              <para>
+                Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
+              </para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><varname>&lt;%current_month%&gt;</varname>, <varname>&lt;%previous_month%&gt;</varname>, <varname>&lt;%next_month%&gt;</varname></term>
+
+            <listitem>
+              <para>
+                Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
+              </para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><varname>&lt;%current_month_long%&gt;</varname>, <varname>&lt;%previous_month_long%&gt;</varname>, <varname>&lt;%next_month_long%&gt;</varname></term>
+
+            <listitem>
+              <para>
+                Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
+              </para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><varname>&lt;%current_year%&gt;</varname>, <varname>&lt;%previous_year%&gt;</varname>, <varname>&lt;%next_year%&gt;</varname></term>
+
+            <listitem>
+              <para>
+                Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
+              </para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><varname>&lt;%period_start_date%&gt;</varname>, <varname>&lt;%period_end_date%&gt;</varname></term>
+
+            <listitem>
+              <para>
+                Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
+                Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
+              </para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
+      </sect2>
+
       <sect2 id="features.periodic-invoices.reports">
         <title>Auflisten</title>
 
@@ -2671,6 +2764,22 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
               </listitem>
             </varlistentry>
 
+            <varlistentry>
+              <term><varname>c_vendor_id</varname></term>
+
+              <listitem>
+                <para>Lieferantennummer beim Kunden (nur Kunden)</para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term><varname>v_customer_id</varname></term>
+
+              <listitem>
+                <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
+              </listitem>
+            </varlistentry>
+
             <varlistentry>
               <term><varname>cp_email</varname></term>
 
@@ -5849,6 +5958,10 @@ filenames</programlisting>
         <itemizedlist>
           <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
           <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
+          <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
+          <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
+          <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
+          <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
           <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
           Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
           werden.</para></listitem>