Doku-Update: Hinweis auf github
[kivitendo-erp.git] / doc / dokumentation.xml
index 5bbc172..8349870 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 3.0.0: Installation, Konfiguration, Entwicklung</title>
+  <title>kivitendo 3.1.0: Installation, Konfiguration, Entwicklung</title>
 
   <chapter id="Aktuelle-Hinweise">
     <title>Aktuelle Hinweise</title>
         <para>im kivitendo-Forum: <ulink
         url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
       </listitem>
+      <listitem>
+        <para>in der doc/UPGRADE Datei im doc-Verzeichnis der Installation</para>
+      </listitem>
+      <listitem>
+        <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden kivitendo-Partner: <ulink
+        url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
+      </listitem>
     </itemizedlist>
   </chapter>
 
@@ -53,7 +60,7 @@
       </orderedlist>
 
       <para>
-        Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen
+        Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
         werden.
       </para>
     </sect1>
@@ -71,7 +78,7 @@
         ohne große Probleme auf den derzeit aktuellen verbreiteten
         Distributionen läuft.</para>
 
-        <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
+        <para>Anfang 2014 sind das folgende Systeme, von denen bekannt ist,
         dass kivitendo auf ihnen läuft:</para>
 
         <itemizedlist>
           </listitem>
 
           <listitem>
-            <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal" und 13.04 "Precise Pangolin"</para>
+            <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal", 13.04 "Precise Pangolin" und 14.04 "Trusty Tahr" LTS Alpha</para>
           </listitem>
 
           <listitem>
-            <para>openSUSE 12.2 und 12.3</para>
+            <para>openSUSE 12.2, 12.3 und 13.1</para>
           </listitem>
 
           <listitem>
@@ -263,12 +270,13 @@ cpan Rose::Db::Object</programlisting>
     <sect1 id="Manuelle-Installation-des-Programmpaketes"
            xreflabel="Manuelle Installation des Programmpaketes">
       <title>Manuelle Installation des Programmpaketes</title>
-
-      <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
+      <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>
 
       <programlisting>cd /var/www
-tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
+tar xvzf kivitendo-erp-3.1.0.tgz</programlisting>
 
       <para>Wechseln Sie in das entpackte Verzeichnis:</para>
 
@@ -351,15 +359,14 @@ tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
 
           <listitem><para><literal>system</literal></para></listitem>
 
-          <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
-
           <listitem><para><literal>paths</literal></para></listitem>
 
+          <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
+
           <listitem><para><literal>applications</literal></para></listitem>
 
           <listitem><para><literal>environment</literal></para></listitem>
 
-          <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
 
           <listitem><para><literal>print_templates</literal></para></listitem>
 
@@ -367,8 +374,14 @@ tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
 
           <listitem><para><literal>periodic_invoices</literal></para></listitem>
 
+          <listitem><para><literal>self_tests</literal></para></listitem>
+
           <listitem><para><literal>console</literal></para></listitem>
 
+          <listitem><para><literal>testing</literal></para></listitem>
+
+          <listitem><para><literal>testing/database</literal></para></listitem>
+
           <listitem><para><literal>debug</literal></para></listitem>
         </itemizedlist>
 
@@ -472,7 +485,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>
 
@@ -610,7 +623,7 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/
             </listitem>
 
             <listitem>
-              <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
+              <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
             </listitem>
           </itemizedlist>
 
@@ -1170,8 +1183,8 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
         Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
         <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
 
-        <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten: Stammdaten (Kunden, Lieferanten, Waren), Belege
-        (Angebote, Liferscheine, Rechnungen), Einstellungen. Diese werden in einer Mandantendatenbank gespeichert. Die
+        <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
+        (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
         Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
         anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
 
@@ -1179,16 +1192,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
         Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
         empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
         verwendet wird.</para>
-
-        <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
-        Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
-        mit kivitendo arbeiten zu können, muss eine Person einen
-        Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
-        Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
-        möglich und normal, dass mehreren Benutzern die selbe Datenbank
-        zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
-        können.</para>
-      </sect2>
+     </sect2>
 
       <sect2 id="Mandanten-Benutzer-Gruppen">
         <title>Mandanten, Benutzer und Gruppen</title>
@@ -1288,6 +1292,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,6 +1615,9 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
         <title>RB</title>
 
         <para>Vollständiger Dokumentensatz mit alternativem Design</para>
+        <para>Die konzeptionelle Idee 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>
 
       </sect2>
 
@@ -1981,7 +2010,47 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
         </screenshot>
       </sect2>
     </sect1>
-
+    <sect1 id="bilanz">
+     <title>Verhalten des Bilanzberichts</title>
+      <para>
+    Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das
+    Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies
+    zu falschen Werten.</para>
+    <para>In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man:</para>
+  <itemizedlist>
+   <listitem>
+    <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher)</para>
+  </listitem>
+   <listitem>
+    <para>immer den Jahresanfang nimmt (1.1. relativ zum Stichtag)</para>
+  </listitem>
+   <listitem>
+    <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
+       <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt</para>
+      <para>- oder mit "alle Buchungen" als Alternative"</para>
+   </listitem>
+   <listitem>
+     <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt </para>
+  </listitem>
+   <listitem>
+    <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
+  </listitem>
+  </itemizedlist>
+   Folgende Hinweise zu den Optionen:
+    Das "Bücher schließen Datum" ist sinnvoll, wenn man nur komplette Jahre
+    schließt. Bei Wirtschaftsjahr = Kalendarjahr entspricht dies aber auch
+    Jahresanfang.
+    "Alle Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
+    durchbucht.
+    Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. sinnvoll, wenn man
+    am sich Anfang des zweiten Buchungsjahres befindet, und noch keinen
+    Jahreswechsel und auch noch keine EB-Buchungen hat.
+    Bei den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. Tag
+    des Wirtschaftsjahres gebucht werden.
+    Zur Sicherheit wird das Startdatum im Bilanzbericht jetzt zusätzlich zum
+    Stichtag mit angezeigt. Das hilft auch bei der Kontrolle für den
+    Abgleich mit der GuV.
+    </sect1>
     <sect1 id="config.client">
       <title>Einstellungen pro Mandant</title>
 
@@ -2257,8 +2326,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
         manuell über den Workflow.</para>
       </sect2>
     </sect1>
-
-    <sect1 id="dokumentenvorlagen-und-variablen">
+        <sect1 id="dokumentenvorlagen-und-variablen">
       <title>Dokumentenvorlagen und verfügbare Variablen</title>
 
       <sect2 id="dokumentenvorlagen-und-variablen.einführung">
@@ -4803,6 +4871,41 @@ Beschreibung: &lt;%description%&gt;
         gewechselt.</para>
       </sect2>
     </sect1>
+    <sect1 id="features.warehouse">
+    <title>Mandantenkonfiguration Lager</title>
+        Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
+        Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
+        Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
+        jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
+        Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
+        Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
+        das Auswählen dieser Position zu einem Lager mit Lagerplatz.
+        Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
+        der Mandatenkonfiguration gesetzt werden.
+       <itemizedlist>
+          <listitem>
+            <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
+            in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
+            </para>
+          </listitem>
+          <listitem>
+            <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
+            die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
+            erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
+          </listitem>
+       </itemizedlist>
+        Zusätzliche Funktionshinweise:
+         <itemizedlist>
+          <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
+          Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
+          </para>
+          </listitem>
+          <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
+          keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
+          </para>
+          </listitem>
+       </itemizedlist>
+    </sect1>
   </chapter>
 
   <chapter>
@@ -5224,7 +5327,7 @@ $main::lxdebug-&gt;message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form-&gt;{
           verfügbar:</para>
 
           <programlisting>[debug]
-file = /tmp/kivitendo-debug.log</programlisting>
+file_name = /tmp/kivitendo-debug.log</programlisting>
 
           <para>ist der Key <varname>file</varname> im Programm als
           <varname>$::lx_office_conf-&gt;{debug}{file}</varname>
@@ -5637,7 +5740,7 @@ file = /tmp/kivitendo-debug.log</programlisting>
 
        <programlisting># @tag: beispiel-upgrade-file42
 # @description: Ein schönes Beispielscript
-# @depends: release_3_0_0
+# @depends: release_3_1_0
 package SL::DBUpgrade2::beispiel_upgrade_file42;
 
 use strict;