Migration wiederkehrende_rechnungen.txt nach dokumentation.xml

diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml
index 6e7248b311c7f5e1c8ccaf87149135066e75e804..500201fdf6d3cd3f21e377d08a35598a5379c40a 100644 (file)
--- a/doc/dokumentation.xml
+++ b/doc/dokumentation.xml
@@ -29,7 +29,7 @@
     <!--  -->
   </chapter>
 
     <!--  -->
   </chapter>
 

-  <chapter>
+  <chapter id="config">

     <title>Installation und Grundkonfiguration</title>
 
     <sect1 id="Benötigte-Software-und-Pakete">
     <title>Installation und Grundkonfiguration</title>
 
     <sect1 id="Benötigte-Software-und-Pakete">


@@ -404,8 +404,9 @@ dbcharset = UTF-8</programlisting>
        </para>
 
        <para>
        </para>
 
        <para>

-        Nutzt man den Taskserver für wiederkehrende Rechnungen, muss unter <literal>[task_server]</literal> ein Login eines Benutzers
-        angegeben werden, mit dem sich der Taskserver an Lx-Office bei der Datenbank anmeldet, die dem Benutzer zugewiesen ist.
+        Nutzt man den <link linkend="config.task-server">Taskserver</link> für <link
+        linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>, muss unter <literal>[task_server]</literal> ein Login eines
+        Benutzers angegeben werden, mit dem sich der Taskserver an Lx-Office bei der Datenbank anmeldet, die dem Benutzer zugewiesen ist.

        </para>
 
        <para>
        </para>
 
        <para>


@@ -745,7 +746,7 @@ Alias       /web/path/to/lx-office-erp-fcgid/          /path/to/lx-office-erp/</
       </sect2>
     </sect1>
 
       </sect2>
     </sect1>
 

-    <sect1 id="Der-Task-Server">
+    <sect1 id="config.task-server">

       <title>Der Task-Server</title>
 
       <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
       <title>Der Task-Server</title>
 
       <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in


@@ -1394,6 +1395,158 @@ Alias       /web/path/to/lx-office-erp-fcgid/          /path/to/lx-office-erp/</
     </sect1>
   </chapter>
 
     </sect1>
   </chapter>
 

+    <chapter id="features" xreflabel="Features und Funktionen">
+    <title>Features und Funktionen</title>
+
+    <sect1 id="features.periodic-invoices" xreflabel="Wiedekehrende Rechnungen">
+     <title>Wiederkehrende Rechnungen</title>
+
+     <sect2 id="features.periodic-invoices.introduction" xreflabel="Einführung in wiederkehrende Rechnungen">
+      <title>Einführung</title>
+
+      <para>
+       Wiederkehrende Rechnungen werden als normale Aufträge definiert und konfiguriert, mit allen dazugehörigen Kunden- und
+       Artikelangaben. Die konfigurierten Aufträge werden später automatisch in Rechnungen umgewandelt, so als ob man den Workflow benutzen
+       würde, und auch die Auftragsnummer wird übernommen, sodass alle wiederkehrenden Rechnungen, die aus einem Auftrag erstellt wurden,
+       später leicht wiederzufinden sind.
+      </para>
+
+     </sect2>
+
+     <sect2 id="features.periodic-invoices.configuration" xreflabel="Konfiguration von wiederkehrenden Rechnungen">
+      <title>Konfiguration</title>
+
+      <para>
+       Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren, findet sich beim Bearbeiten des Auftrags ein neuer Knopf
+       "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen Parameter einstellen kann.  Hinter dem Knopf wird außerdem noch
+       angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist oder nicht.
+      </para>
+
+      <para>
+       Folgende Parameter kann man konfigurieren:
+      </para>
+
+      <variablelist>
+       <varlistentry>
+        <term>Status</term>
+        <listitem>
+         <para>
+          Bei aktiven Rechnungen wird automatisch eine Rechnung erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines neuen
+          Monats).
+         </para>
+
+         <para>
+          Ist ein Auftrag nicht aktiv, so werden für ihn auch keine wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
+          nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim nächsten Periodenwechsel für alle Perioden, seit der letzten aktiven
+          Periode, jeweils eine Rechnung erstellt. Möchte man dies verhindern, muss man vorher das Startdatum neu setzen.
+         </para>
+
+         <para>
+          Für gekündigte Aufträge werden nie mehr Rechnungen erstellt. Man kann sich diese Aufträge aber gesondert in den Berichten anzeigen
+          lassen.
+         </para>
+        </listitem>
+       </varlistentry>
+
+       <varlistentry>
+        <term>Periodizität</term>
+        <listitem>
+         <para>
+          Ob monatlich, quartalsweise oder jährlich auf neue Rechnungen überprüft werden soll. Für jede Periode seit dem Startdatum wird
+          überprüft, ob für die Periode (beginnend immer mit dem ersten Tag der Periode) schon eine Rechnung erstellt wurde. Unter Umständen
+          können bei einem Startdatum in der Vergangenheit gleich mehrere Rechnungen erstellt werden.
+         </para>
+        </listitem>
+       </varlistentry>
+
+       <varlistentry>
+        <term>Buchen auf</term>
+        <listitem>
+         <para>
+          Das Forderungskonto, in der Regel "Forderungen aus Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen
+          der betreffenden Waren.
+         </para>
+        </listitem>
+       </varlistentry>
+
+       <varlistentry>
+        <term>Startdatum</term>
+        <listitem>
+         <para>
+          ab welchem Datum auf Rechnungserstellung geprüft werden soll
+         </para>
+        </listitem>
+       </varlistentry>
+
+       <varlistentry>
+        <term>Enddatum</term>
+        <listitem>
+         <para>
+          ab wann keine Rechnungen mehr erstellt werden sollen
+         </para>
+        </listitem>
+       </varlistentry>
+
+       <varlistentry>
+        <term>Automatische Verlängerung um x Monate</term>
+        <listitem>
+         <para>
+          Sollen die wiederkehrenden Rechnungen bei Erreichen des eingetragenen Enddatums weiterhin erstellt werden, so kann man hier die
+          Anzahl der Monate eingeben, um die das Enddatum automatisch nach hinten geschoben wird.
+         </para>
+        </listitem>
+       </varlistentry>
+
+       <varlistentry>
+        <term>Drucken</term>
+        <listitem>
+         <para>
+          Sind Drucker konfiguriert, so kann man sich die erstellten Rechnungen auch gleich ausdrucken lassen.
+         </para>
+        </listitem>
+       </varlistentry>
+      </variablelist>
+
+      <para>
+       Nach Erstellung der Rechnungen kann eine E-Mail mit Informationen zu den erstellten Rechnungen verschickt werden. Konfiguriert wird
+       dies in der <link linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
+       <filename>config/lx_office.conf</filename> im Abschnitt <varname>[periodic_invoices]</varname>.
+      </para>
+     </sect2>
+
+     <sect2 id="features.periodic-invoices.reports">
+      <title>Auflisten</title>
+
+      <para>
+       Unter Verkauf-&gt;Berichte-&gt;Aufträge finden sich zwei neue Checkboxen, &quot;Wiederkehrende Rechnungen aktiv&quot; und
+       &quot;Wiederkehrende Rechnungen inaktiv&quot;, mit denen man sich einen Überglick über die wiederkehrenden Rechnungen verschaffen
+       kann.
+      </para>
+     </sect2>
+
+     <sect2 id="features.periodic-invoices.task-server">
+      <title>Erzeugung der eigentlichen Rechnungen</title>
+
+      <para>
+       Die zeitliche und periodische Überprüfung, ob eine wiederkehrende Rechnung automatisch erstellt werden soll, geschieht durch den
+       <link linkend="config.task-server">Taskserver</link>, einen externen Dienst, der automatisch beim Start des Servers gestartet
+       werden sollte.
+      </para>
+     </sect2>
+
+     <sect2 id="features.periodic-invoices.create-for-current-month">
+      <title>Erste Rechnung für aktuellen Monat erstellen</title>
+
+      <para>
+       Will man im laufenden Monat eine monatlich wiederkehrende Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum auf
+       den Monatsanfang und wartet ein paar Minuten, bis der Taskserver den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
+       generiert hat. Alternativ setzt man das Startdatum auf den Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
+       manuell über den Workflow.
+      </para>
+     </sect2>
+    </sect1>
+  </chapter>
+

   <chapter>
     <title>Entwicklerdokumentation</title>
 
   <chapter>
     <title>Entwicklerdokumentation</title>
 

diff --git a/doc/wiederkehrende_rechnungen.txt b/doc/wiederkehrende_rechnungen.txt
deleted file mode 100755 (executable)
index fe9a07c..0000000
--- a/doc/wiederkehrende_rechnungen.txt
+++ /dev/null
@@ -1,78 +0,0 @@
-Wiederkehrende Rechnungen werden als normale Aufträge definiert und\r
-konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben. Die\r
-konfigurierten Aufträge werden später automatisch in Rechnungen\r
-umgewandelt, so als ob man den Workflow benutzen würde, und auch die\r
-Auftragsnummer wird übernommen, sodass alle wiederkehrenden\r
-Rechnungen, die aus einem Auftrag erstellt wurden, später leicht\r
-wiederzufinden sind.\r
-\r
-Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren, findet sich beim\r
-Bearbeiten des Auftrags ein neuer Knopf "Konfigurieren", der ein neues Fenster\r
-öffnet, in dem man die nötigen Parameter einstellen kann.  Hinter dem Knopf\r
-wird außerdem noch angezeigt, ob der Auftrag als wiederkehrende Rechnung\r
-konfiguriert ist oder nicht.\r
-\r
-Folgende Parameter kann man konfigurieren:\r
-\r
-* Status:\r
- Bei aktiven Rechnungen wird automatisch eine Rechnung erstellt, wenn die\r
- Periodizität erreicht ist (z.B. Anfang eines neuen Monats).\r
-\r
- Ist ein Auftrag nicht aktiv, so werden für ihn auch keine wiederkehrenden\r
- Rechnungen erzeugt. Stellt man nach längerer nicht-aktiver Zeit einen Auftrag\r
- wieder auf aktiv, wird beim nächsten Periodenwechsel für alle Perioden, seit\r
- der letzten aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies\r
- verhindern, muss man vorher das Startdatum neu setzen.\r
-\r
- Für gekündigte Aufträge werden nie mehr Rechnungen erstellt. Man kann sich\r
- diese Aufträge aber gesondert in den Berichten anzeigen lassen.\r
-\r
-* Periodizität:\r
-  Ob monatlich, quartalsweise oder jährlich auf neue Rechnungen überprüft\r
-  werden soll. Für jede Periode seit dem Startdatum wird überprüft, ob für die\r
-  Periode (beginnend immer mit dem ersten Tag der Periode) schon eine Rechnung\r
-  erstellt wurde. Unter Umständen können bei einem Startdatum in der\r
-  Vergangenheit gleich mehrere Rechnungen erstellt werden.\r
-\r
-* Buchen auf:\r
-  Das Forderungskonto, in der Regel "Forderungen aus Lieferungen\r
-  und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen der\r
-  betreffenden Waren.\r
-\r
-* Startdatum: ab welchem Datum auf Rechnungserstellung geprüft werden soll\r
-\r
-* Enddatum: ab wann keine Rechnungen mehr erstellt werden sollen.\r
-\r
-* Automatische Verlängerung um x Monate:\r
-  Sollen die wiederkehrenden Rechnungen bei Erreichen des\r
-  eingetragenen Enddatums weiterhin erstellt werden, so kann man hier\r
-  die Anzahl der Monate eingeben, um die das Enddatum automatisch nach\r
-  hinten geschoben wird.\r
-\r
-* Drucken:\r
-  Sind Drucker konfiguriert, so kann man sich die erstellten Rechnungen auch\r
-  gleich ausdrucken lassen.\r
-\r
-Unter Verkauf->Berichte->Aufträge finden sich zwei neue Checkboxen,\r
-"Wiederkehrende Rechnungen aktiv" und "Wiederkehrende Rechnungen inaktiv", mit\r
-denen man sich einen Überglick über die wiederkehrenden Rechnungen verschaffen\r
-kann.\r
-\r
-Die zeitliche und periodische Überprüfung, ob eine wiederkehrende\r
-Rechnung automatisch erstellt werden soll, geschieht durch den\r
-Taskserver, einen externen Dienst, der automatisch beim Start des\r
-Servers gestartet werden sollte.\r
-\r
-Nach Erstellung der Rechnungen kann eine E-Mail mit Informationen zu\r
-den erstellten Rechnungen verschickt werden. Konfiguriert wird dies in\r
-der Konfigurationsdatei config/lx_office.conf im Abschnitt\r
-[periodic_invoices].\r
-\r
-Will man im laufenden Monat eine monatlich wiederkehrende Rechnung inkl. des\r
-laufenden Monats starten, stellt man das Startdatum auf den Monatsanfang und\r
-wartet ein paar Minuten, bis der Taskserver den neu konfigurieren Auftrag\r
-erkennt und daraus eine Rechnung generiert hat. Alternativ setzt man das\r
-Startdatum auf den Monatsersten des Folgemonats und erstellt die erste Rechnung\r
-direkt manuell über den Workflow.\r
-\r
-\r