PriceSource: Keine Fehler werfen wenn best_price nicht existiert
[kivitendo-erp.git] / doc / dokumentation.xml
index ef9b24b..b7695c6 100644 (file)
@@ -270,7 +270,8 @@ cpan Rose::Db::Object</programlisting>
     <sect1 id="Manuelle-Installation-des-Programmpaketes"
            xreflabel="Manuelle Installation des Programmpaketes">
       <title>Manuelle Installation des Programmpaketes</title>
-
+      <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann
+ <ulink url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink> heruntergeladen werden.</para>
       <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.1.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>
 
@@ -285,6 +286,10 @@ tar xvzf kivitendo-erp-3.1.0.tgz</programlisting>
       Webserverkonfiguration benutzen, um auf das tatsächliche
       Installationsverzeichnis zu verweisen.</para>
 
+      <para>Bei einer Neuinstallation der Version 3.1.0 muß das WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
+
+      <programlisting>mkdir webdav</programlisting>
+
       <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
       beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
       Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
@@ -484,7 +489,7 @@ exit </programlisting>
         <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
         Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
         sein sollte, müssen die Berichtigungen für den Zugriff geändert
-       werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
+       werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
        nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
        Datenbank zum Beispiel:</para>
 
@@ -1291,6 +1296,28 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
         C gültig").</para>
       </sect2>
     </sect1>
+    <sect1 id="Drucker--Systemverwaltung">
+      <title>Drucker- und Systemverwaltung</title>
+      <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.</para>
+      <sect2 id="Druckeradministration">
+        <title>Druckeradministration</title>
+      <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig viele "Druckbefehle" im System verwalten. Diese Befehle werden mandantenweise
+      zugeordnet. Unter Druckerbeschreibung wird der Namen des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs angezeigt wird.</para>
+      <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl, der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P meinDrucker' oder ein
+      kompletter Pfad zu einem Skript (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh).
+      Wird ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich ergänzt, ist
+      bspw. das Kürzel 'epson_drucker' definiert, so wird beim Ausdruck eines Angebots folgende Vorlage geparst: sales_quotation_epson_drucker.tex.</para>
+     </sect2>
+      <sect2 id="System">
+        <title>System sperren / entsperren</title>
+
+        <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation sperren/entsperren'. Setz man diese Sperre so ist der Zugang zu der gesamten kivitendo Installation gesperrt.</para>
+        <para>Falls die Sperre gesetzt ist, erscheint anstelle der Anmeldemaske die Information: 'kivitendo ist momentan zwecks Wartungsarbeiten nicht zugänglich.'.
+        </para>
+        <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo automatisch 'sperrt', falls es bei einem Versionsupdate zu einem Datenbankfehler kam. Somit kann hier nicht aus Versehen
+        mit einem inkonsistenten Datenbestand weitergearbeitet werden.</para>
+     </sect2>
+    </sect1>
 
     <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
       <title>E-Mail-Versand aus kivitendo heraus</title>
@@ -1589,12 +1616,12 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
       </sect2>
 
       <sect2 id="Vorlagen-RB">
-        <title>RB</title>
+        <title>Der Druckvorlagensatz RB</title>
 
-        <para>Vollständiger Dokumentensatz mit alternativem Design</para>
-        <para>Die konzeptionelle Idee wird <ulink
+        <para>Hierbei handelt es sich um einen vollständigen Dokumentensatz mit alternativem Design.</para>
+        <para>Die konzeptionelle Idee der Vorlagen wird <ulink
           url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
-          auf Folie 5 bis 10 vorgestellt, Detaileinstellungen dann im Readme.tex im Vorlagenverzeichnis.</para>
+          auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.</para>
 
       </sect2>
 
@@ -2205,6 +2232,12 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
           Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal>&lt;%variablenname%&gt;</literal>.
         </para>
 
+        <para>
+         Sofern es sich um eine Datumsvariable handelt, kann das Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
+         Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus: <literal>&lt;%variablenname
+         FORMAT=Formatinformation%&gt;</literal>. Die zur verfügung stehenden Formatinformationen werden unten genauer beschrieben.
+        </para>
+
         <para>
           Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
         </para>
@@ -2270,6 +2303,172 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
             </listitem>
           </varlistentry>
         </variablelist>
+
+        <para>
+         Die invidiuellen Formatinformationen bestehen aus Paaren von Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
+         dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal> durch das viertstellige Jahr ersetzt. Alle möglichen
+         Platzhalter sind:
+        </para>
+
+
+        <variablelist>
+         <varlistentry>
+          <term><varname>%a</varname></term>
+
+          <listitem>
+           <para>Der abgekürzte Wochentagsname.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%A</varname></term>
+
+          <listitem>
+           <para>Der ausgeschriebene Wochentagsname.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%b</varname></term>
+
+          <listitem>
+           <para>Der abgekürzte Monatsname.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%B</varname></term>
+
+          <listitem>
+           <para>Der ausgeschriebene Monatsname.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%C</varname></term>
+
+          <listitem>
+           <para>Das Jahrhundert (Jahr/100) als eine zweistellige Zahl.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%d</varname></term>
+
+          <listitem>
+           <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%D</varname></term>
+
+          <listitem>
+           <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%e</varname></term>
+
+          <listitem>
+           <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%F</varname></term>
+
+          <listitem>
+           <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%j</varname></term>
+
+          <listitem>
+           <para>Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%m</varname></term>
+
+          <listitem>
+           <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%u</varname></term>
+
+          <listitem>
+           <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%U</varname></term>
+
+          <listitem>
+           <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%V</varname></term>
+
+          <listitem>
+           <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53 inklusive, wobei Woche 01 die erste Woche, von der mindestens vier Tage im Jahr liegen; Montag ist erster Tag der Woche.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%w</varname></term>
+
+          <listitem>
+           <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%W</varname></term>
+
+          <listitem>
+           <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%y</varname></term>
+
+          <listitem>
+           <para>Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%Y</varname></term>
+
+          <listitem>
+           <para>Das Jahr als vierstellige Zahl.</para>
+          </listitem>
+         </varlistentry>
+
+         <varlistentry>
+          <term><varname>%%</varname></term>
+
+          <listitem>
+           <para>Das Prozentzeichen selber.</para>
+          </listitem>
+         </varlistentry>
+        </variablelist>
+
+        <para>
+         Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode
+         dauert: <literal>Abrechnungszeitrum: &lt;%period_start_date FORMAT=%m/%Y%&gt; bis &lt;%period_end_date FORMAT=%m/%Y%&gt;</literal>
+        </para>
       </sect2>
 
       <sect2 id="features.periodic-invoices.reports">
@@ -3713,7 +3912,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
               <term><varname>netprice</varname></term>
 
               <listitem>
-                <para>Nettopreis</para>
+                <para>Alternative zu <varname>sellprice</varname>, aber <varname>netprice</varname> entspricht dem effektiven Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor. <varname>netprice</varname> wird rückgerechnet aus Zeilensumme / Menge. Diese Variable ist nützlich, wenn man den gewährten Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge * Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll. <varname>netprice</varname> hat nichts mit Netto/Brutto im Sinne von Steuern zu tun.</para>
               </listitem>
             </varlistentry>
 
@@ -3750,6 +3949,15 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
               </listitem>
             </varlistentry>
 
+            <varlistentry>
+              <term><varname>donumber_do</varname></term>
+
+              <listitem>
+                <para>Lieferscheinnummer desjenigen Lieferscheins, aus dem die Position stammt, sofern die Rechnung aus einem oder
+                mehreren Lieferscheinen erstellt wurde</para>
+              </listitem>
+            </varlistentry>
+
             <varlistentry>
               <term><varname>p_discount</varname></term>