X-Git-Url: https://git.p6c8.net/form-email.git/blobdiff_plain/5224fe74fba39cf1553cae3e423bb6677b08f378..dc796cb93a9ecbe5b7d9c3e0edaf51df9a8de9e9:/readme.htm?ds=sidebyside
diff --git a/readme.htm b/readme.htm
index 910fd6c..801fdc3 100644
--- a/readme.htm
+++ b/readme.htm
@@ -138,6 +138,8 @@ Auf diese Weise müssen Sie zum Beispiel nicht überall auf Ihrer Homepa
<p>Sie können außerdem noch ein Feld namens <i>subject</i> anlegen. Hier kann ein Betreff für die Mail eingegeben werden. Wenn Sie auf dieses Feld verzichten, erhalten die E-Mails automatisch den in <code>$default_subject</code> definierten Betreff (s.u.).<br />
Weiterhin ist noch ein Feld namens <i>recipient</i> möglich. Dieses Feld enthält einen Alias-Empfänger. Wie das funktioniert, können Sie bei der Beschreibung der Einstellung <code>$aliases</code> lesen.</p>
+<p>Zusätzlich können Sie die vorgegebenen Formularfelder mit <a href="#individuell">individuellen</a> ergänzen.</p>
+
<p>Wenn Sie Captchas (zufällige Zeichenfolgen, die der Benutzer vor dem Absenden des Formulars eingeben muss, um Spambots auszuschließen) benutzen wollen (siehe unten), müssen Sie im Formular die Datei <i>captcha.php</i> als Bild einbinden (<code><img></code>-Tag). Bedenken Sie, dass Sie diese Datei auch in den <a href="#templates">Templates</a> einbinden müssen!</p>
<p>Das Formular muss dann noch mit <tt>POST</tt> die Daten an die Datei <i>mailer.php</i> (oder wie Sie die Datei genannt haben) senden.</p>
@@ -150,7 +152,7 @@ Weiterhin ist noch ein Feld namens <i>recipient</i> möglich. Dieses Feld en
<p>Geben Sie zwischen den einfachen Anführungszeichen die Adresse an, an die die Mail gehen soll. Wenn die Mail an mehrere Empfänger gehen soll, so trennen Sie die einzelnen E-Mail-Adressen ganz einfach durch Semikolons.</p>
-<p>Das war es im Grunde genommen. Aber <i>Form E-Mail</i> lässt sich noch weiter konfigurieren. Mehr dazu finden Sie in den nächsten beiden Abschnitten.</p>
+<p>Sie haben nun <i>Form E-Mail</i> für die Standard-Nutzung konfiguriert. <i>Form E-Mail</i> lässt sich jedoch noch feiner konfigurieren. Mehr dazu finden Sie in den nächsten Abschnitten.</p>
<p class="upanddown"><a href="#top">Nach oben</a></p>
@@ -171,8 +173,8 @@ Weiterhin ist noch ein Feld namens <i>recipient</i> möglich. Dieses Feld en
<td><code>$aliases</code></td>
<td>Hier können Sie eine Alias-Namen für Empfänger angeben. Soll einem Alias mehrere Empfänger zugeordnet werden, gilt dasselbe wie für <code>$mailto</code>.<br />
Die Aliase werden mit Hilfe eines assoziativen PHP-Arrays definiert. Da es wohl einige gibt, die von so etwas keine Ahnung haben und ich es nicht gut erklären kann, hier ein Beispiel:<br /><br />
-<code>array('info' => 'info@IhreDomain.xyz', 'support' => 'support@IhreDomain.xyz',<br />
- 'alle' => 'info@IhreDomain.xyz; support@IhreDomain.xyz')</code></td>
+<code>array('info' => 'info@example.com', 'support' => 'support@example.com',<br />
+ 'alle' => 'info@example.com; support@example.com')</code></td>
</tr>
</table>
@@ -272,7 +274,7 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
</tr>
<tr>
<td><code>$referer_ok</code></td>
-<td>Geben Sie hier die Hosts an, von denen <i>Form E-Mail</i> aus aufgerufen werden darf (zum Beispiel <i>www.IhreDomain.xyz</i>). Trennen Sie mehrere Hosts durch Semikolons.<br />
+<td>Geben Sie hier die Hosts an, von denen <i>Form E-Mail</i> aus aufgerufen werden darf (zum Beispiel <i>www.example.com</i>). Trennen Sie mehrere Hosts durch Semikolons.<br />
<b style="color:#FF0000">Achtung:</b> Mit einer Referer-Prüfung kann man zwar unbedarfte Anwender abschrecken, aber wirklich zuverlässig ist diese Methode nicht, da sich der Referer fälschen lässt oder auch komplett fehlen kann.</td>
</tr>
</table>
@@ -507,36 +509,73 @@ Wie <i>Form E-Mail</i> diese Formularfelder behandelt, wird über verschiede
</tr>
<tr>
<td><code>$user_fields['beruf']['min']</code></td>
-<td></td>
+<td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert mindestens sein muss</td>
</tr>
<tr>
<td><code>$user_fields['beruf']['max']</code></td>
-<td></td>
+<td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert höchstens sein darf</td>
</tr>
<tr>
<td><code>$user_fields['beruf']['required']</code></td>
-<td></td>
+<td>Geben Sie hier den Wert 1 an, wenn das Formularfeld ausgefüllt sein muss. Wenn Sie hier eine 0 oder die Option weglassen, ist das Feld optional.</td>
</tr>
<tr>
<td><code>$user_fields['beruf']['regex']</code></td>
-<td></td>
+<td>Geben Sie hier einen <a href="http://de.php.net/manual/de/book.pcre.php">Perl-kompatiblen regulären Ausdruck</a> zur Prüfung des Wertes ein. Der Ausdruck wird direkt an <a href="http://de.php.net/manual/de/function.preg-match.php"><code>preg_match()</code></a> weitergegeben.</td>
</tr>
<tr>
<td><code>$user_fields['beruf']['check']</code></td>
-<td></td>
+<td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, durch die der Wert geprüft werden soll.</td>
</tr>
</table>
-<pre>
-$user_fields['beruf']['prepare'] = 'prepare_beruf';
-$user_fields['beruf']['tpl_var'] = 'BERUF';
+<p>Weiterhin müssen Sie noch diverse Fehlermeldungen definieren (als Unter-Array). Das Definieren dieser Fehlermeldungen ist Pflicht (Sie müssen jedoch nur die Fehlermeldungen zu den Dingen definieren, die auch wirklich geprüft werden).</p>
-$user_fields['beruf']['errors']['too_short'] = 'Der Beruf muss mind. 5 Zeichen lang sein!';
-$user_fields['beruf']['errors']['too_long'] = 'Der Beruf darf höchstens 10 Zeichen lang sein!';
-$user_fields['beruf']['errors']['not_set'] = 'Sie haben keinen Beruf eingegeben!';
-$user_fields['beruf']['errors']['match_fail'] = 'Der Beruf darf nur aus Buchstaben bestehen!';
-$user_fields['beruf']['errors']['check_fail'] = 'Der Beruf sollte keine äöü haben!';
-</pre>
+<table border="1">
+<tr>
+<td><b>Einstellung</b></td>
+<td><b>Beschreibung</b></td>
+</tr>
+<tr>
+<td><code>$user_fields['beruf']['errors']['too_short']</code></td>
+<td>Der vom Benutzer eingegebene Wert ist nicht lang genug</td>
+</tr>
+<tr>
+<td><code>$user_fields['beruf']['errors']['too_long']</code></td>
+<td>Der vom Benutzer eingegebene Wert ist zu lang</td>
+</tr>
+<tr>
+<td><code>$user_fields['beruf']['errors']['not_set']</code></td>
+<td>Das Formularfeld ist ein Pflichtfeld und es wurde nicht ausgefüllt.</td>
+</tr>
+<tr>
+<td><code>$user_fields['beruf']['errors']['match_fail']</code></td>
+<td>Die Überprüfung des Wertes durch den regulären Ausdruck ist fehlgeschlagen.</td>
+</tr>
+<tr>
+<td><code>$user_fields['beruf']['errors']['check_fail']</code></td>
+<td>Die Überprüfung des Wertes durch die PHP-Funktion ist fehlgeschlagen.</td>
+</tr>
+</table>
+
+<p>Zusätzlich sind noch die folgenden Einstellungen möglich:</p>
+
+<table border="1">
+<tr>
+<td><b>Einstellung</b></td>
+<td><b>Beschreibung</b></td>
+</tr>
+<tr>
+<td><code>$user_fields['beruf']['prepare']</code></td>
+<td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, die den Wert des Formularfeldes nach den Prüfungen noch verändern (bspw. kann man hier Funktionen angeben, die alle Buchstaben in Großbuchstaben umwandelt).</td>
+</tr>
+<tr>
+<td><code>$user_fields['beruf']['tpl_var']</code></td>
+<td>Geben Sie hier die <a href="#templates">Template-Variable</a> an, die in den Templates durch den Wert des Formularfeldes ersetzt werden soll. Wenn Sie hier nichts angeben, wird ein Standardwert verwendet (im Fall des Formularfeldes <b>beruf</b> wäre das dann <code>USER_beruf</code>).</td>
+</tr>
+</table>
+
+<p>Sie müssen die individuellen Formularfelder nun noch in Ihrem Mail-Formular und in den <a href="#templates">Templates</a> ergänzen.</p>
<p class="upanddown"><a href="#top">Nach oben</a></p>
@@ -579,6 +618,8 @@ Der eingegebene Mail-Text</li>
Die formatierte Zeitangabe</li>
</ul>
+Weiterhin können Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben) verwenden.<br />
+<br />
Zusätzlich können Sie hier durch Variablen, die mit <b>ENV_</b> beginnen, Server-Umgebungsvariablen im Text einfügen (siehe auch Konfigurationsvariable <code>$allowed_envs</code>.
</td>
</tr>
@@ -600,6 +641,8 @@ Der eingegebene Mail-Text</li>
<li><b>TIME</b><br />
Die formatierte Zeitangabe</li>
</ul>
+
+Weiterhin können Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben) verwenden.
</td>
</tr>
<tr>
@@ -619,6 +662,8 @@ Der Betreff der Mail</li>
Der eingegebene Mail-Text</li>
</ul>
+Weiterhin können Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben) verwenden.<br />
+<br />
Zusätzlich ist es möglich, einen Bereich, der nur angezeigt werden soll, wenn Captchas aktiviert sind, anzuzeigen, indem Sie diesen in folgenden Block einschließen (der <code>{ELSE}</code>-Teil ist optional):<br />
<br />
<code>{IF CAPTCHA}Captchas sind aktiviert{ELSE}Captchas sind nicht aktiviert{ENDIF}</code>