Dokumentationshinweis für HTML::Restrict unter Ubuntu
[kivitendo-erp.git] / doc / dokumentation.xml
index b7695c6..8f20ec5 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.1.0: Installation, Konfiguration, Entwicklung</title>
+  <title>kivitendo 3.2.0: Installation, Konfiguration, Entwicklung</title>
 
   <chapter id="Aktuelle-Hinweise">
     <title>Aktuelle Hinweise</title>
@@ -12,7 +12,7 @@
     <itemizedlist>
       <listitem>
         <para>im kivitendo-Forum: <ulink
-        url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
+        url="https://forum.kivitendo.org:32443">https://forum.kivitendo.org:32443</ulink></para>
       </listitem>
       <listitem>
         <para>in der doc/UPGRADE Datei im doc-Verzeichnis der Installation</para>
           <listitem><para><literal>YAML</literal></para></listitem>
         </itemizedlist>
 
+        <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen: <literal>GD</literal>, <literal>HTML::Restrict</literal>, <literal>Image::Info</literal></para>
         <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>
 
         <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
         <sect3>
           <title>Debian und Ubuntu</title>
 
-          <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
-          installiert werden:</para>
+          <para>Für Debian und Ubuntu stehen die meisten der benötigten Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden:</para>
 
           <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
   libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
   librose-db-perl librose-object-perl libsort-naturally-perl \
   libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
   libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
+  libimage-info-perl libgd-gd2-perl \
   libfile-copy-recursive-perl postgresql</programlisting>
+
+          <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies muß per CPAN installiert werden. Unter Ubuntu funktioniert das mit:</para>
+          <programlisting>apt-get install build-essential
+cpan HTML::Restrict</programlisting>
         </sect3>
 
         <sect3>
           <title>Fedora Core</title>
 
-          <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden:</para>
+          <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden:</para>
 
           <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
   perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
@@ -272,11 +277,11 @@ cpan Rose::Db::Object</programlisting>
       <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
+      <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.2.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.1.0.tgz</programlisting>
+tar xvzf kivitendo-erp-3.2.0.tgz</programlisting>
 
       <para>Wechseln Sie in das entpackte Verzeichnis:</para>
 
@@ -286,7 +291,7 @@ 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>
+      <para>Bei einer Neuinstallation von Version 3.1.0 oder Version 3.2.0 muß das WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
 
       <programlisting>mkdir webdav</programlisting>
 
@@ -629,6 +634,10 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/
             <listitem>
               <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
             </listitem>
+
+            <listitem>
+              <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
+            </listitem>
           </itemizedlist>
 
           <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
@@ -640,7 +649,7 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/
 
           <warning>
             <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
-            bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
+            bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer Installation gibt, muss zwingend Version 0.68 oder
             aber Version 0.72 und neuer eingesetzt werden.</para>
 
             <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
@@ -654,7 +663,7 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/
           <title>Konfiguration des Webservers</title>
 
           <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
-          laufen zu lassen, empfliehlt es sich die Installation ersteinmal
+          laufen zu lassen, empfiehlt es sich die Installation ersteinmal
           unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
           debuggen die beim ersten aufsetzen auftreten können. Sollte die
           Installation schon funktionieren, lesen Sie weiter.</para>
@@ -690,13 +699,23 @@ Alias       /url/for/kivitendo-erp/          /path/to/kivitendo-erp/
   Deny from All
 &lt;/DirectoryMatch&gt;</programlisting>
 
+          <warning>
+            <para>Im Vergleich zu Apache 2.2 hat sich in Apache 2.4 die Syntax der Directorydirektiven verändert. Statt</para>
+              <programlisting>
+  Order Allow,Deny
+  Allow from All </programlisting>
+            <para> muß man jetzt Folgendes einstellen:</para>
+              <programlisting>Require all granted</programlisting>
+          </warning>
+
           <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
           die maximale Größe eines Requests. Diese sollte wie folgt
           hochgesetzt werden:</para>
 
           <programlisting>FcgidMaxRequestLen 10485760</programlisting>
 
-          <para>Das ganze sollte dann so aussehen:</para>
+
+          <para>Das Ganze sollte dann so aussehen:</para>
 
           <programlisting>AddHandler fcgid-script .fpl
 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
@@ -1408,7 +1427,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
       <title>Drucken mit kivitendo</title>
 
       <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.  Um drucken zu können, braucht der Server ein geeignetes
-      LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
+      LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter debianoiden Betriebssystemen installiert man
       die Pakete mit:</para>
 
       <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
@@ -1446,7 +1465,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
 
         <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
            Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
-           Eventuell muessen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisistem unter
+           Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisystem unter
            <filename>./templates/[Neuer Name]</filename></para>
 
 
@@ -1468,7 +1487,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
           <title>Feature-Übersicht</title>
           <itemizedlist>
             <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
-            Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
+            Angebot, Rechnung, Proformarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
 
             <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
             eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
@@ -1503,33 +1522,33 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
             <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
           </itemizedlist>
 
-          <para>oder etwas Detaillierter:</para>
+          <para>oder etwas detaillierter:</para>
 
           <para>
             Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt.  Eigentlich
-            ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist.  Da die Einstiegshürde in LaTeX nicht ganz niedrig
-            ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
-            vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
-            <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
+            ist dies die Datei die für die firmenspezifischen Anpassungen gedacht ist.  Da die Einstiegshürde in LaTeX nicht ganz niedrig
+            ist, wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
+            vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung über eine
+            <filename>*.lco</filename>-Datei, die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
           </para>
 
           <para>
             Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
-            verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
-            <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
+            verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
+            <filename>sample_head.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
             Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
             verlinken.
           </para>
 
           <para>
-            letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
-            enthält. Bei Updates oder nach erneutem
+            Letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
+            enthält.
           </para>
 
           <para>
             Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
             ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
-            werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
+            werden. Die anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
           </para>
           <para>
             Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.  sollten über die Hintergrund-PDF-Datei oder die
@@ -1541,17 +1560,17 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
           <title>f-tex Funktionsübersicht</title>
           <para>
             Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
-            vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
+            vorzuhalten, dies ist sehr wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
             bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
             briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
-            Besonderheiten der jeweiligen Dokumente Berücksichtigt.
+            Besonderheiten der jeweiligen Dokumente berücksichtigt:
           </para>
 
           <itemizedlist>
             <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
             <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
             <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
-            <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
+            <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus gewerblicher
             Kunde)</para></listitem>
            </itemizedlist>
 
@@ -1561,15 +1580,15 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
              LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
              diesen Effekt noch einmal erheblich.  Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
              auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
-             schnell häftig in den Fuss schiessen.
+             schnell heftig in den Fuss schiessen.
            </para>
 
-           <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
-           mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
+           <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
+           mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen, wie sie
            ausgeliefert werden, erfreuen.
            </para>
 
-           <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
+           <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine, kontinuierliche Schritte gehen.</para>
 
         </sect3>
 
@@ -1584,8 +1603,8 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
               Zuordung einer Default-Preisgruppe handhaben)</para>
             </listitem>
             <listitem>
-              <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen.  (das ist in der Praxis wenn man sowohl
-              Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
+              <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses Häkchen zu setzen.  (Das ist in der Praxis, wenn man sowohl
+              Endverbraucher als auch Gewerbekunden beliefert, der eigentliche Knackpunkt)</para>
             </listitem>
           </itemizedlist>
 
@@ -1596,10 +1615,10 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
             an (einmal mit der Namensendung "_E"). Gewinn:</para>
 
           <itemizedlist>
-            <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
+            <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste verbunden.</para></listitem>
             <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
             Netto" auszuwählen.</para></listitem>
-            <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
+            <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken revidiert werden,
             ohne dass sich der Auftragswert ändert.</para></listitem>
           </itemizedlist>
         </sect3>
@@ -1627,9 +1646,9 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
 
       <sect2 id="allgemeine-hinweise-zu-latex">
         <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
-        <para>In den allermeisten Installationen sollte drucken jetzt schon
-        funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
-        Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
+        <para>In den allermeisten Installationen sollte das Drucken jetzt schon
+        funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
+        Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeile,
         die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
         Beispiel:</para>
 
@@ -3132,6 +3151,14 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
               </listitem>
             </varlistentry>
 
+            <varlistentry>
+              <term><varname>greeting</varname></term>
+
+              <listitem>
+                <para>Anrede</para>
+              </listitem>
+            </varlistentry>
+
             <varlistentry>
               <term><varname>homepage</varname></term>
 
@@ -3613,7 +3640,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
               <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
             </varlistentry>
             <varlistentry>
-              <term><varname>delivery_term.long_description</varname></term>
+              <term><varname>delivery_term.description_long</varname></term>
               <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
             </varlistentry>
           </variablelist>