Kleine Ergaenzung

[form-email.git] / readme.htm

diff --git a/readme.htm b/readme.htm
index 910fd6c41f1267931e16c3293f8a4df317a4bf64..5d8a07990ec5e81dfb2857382e37ca962d5f98dd 100644 (file)
--- a/readme.htm
+++ b/readme.htm
@@ -507,36 +507,71 @@ Wie <i>Form E-Mail</i> diese Formularfelder behandelt, wird &uuml;ber verschiede
 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['min']</code></td>\r
-<td></td>\r
+<td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert mindestens sein muss</td>\r
 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['max']</code></td>\r
-<td></td>\r
+<td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert h&ouml;chstens sein darf</td>\r
 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['required']</code></td>\r
-<td></td>\r
+<td>Geben Sie hier den Wert 1 an, wenn das Formularfeld ausgef&uuml;llt sein muss. Wenn Sie hier eine 0 oder die Option weglassen, ist das Feld optional.</td>\r
 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['regex']</code></td>\r
-<td></td>\r
+<td>Geben Sie hier einen <a href="http://de.php.net/manual/de/book.pcre.php">Perl-kompatiblen regul&auml;ren Ausdruck</a> zur Pr&uuml;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>\r
 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['check']</code></td>\r
-<td></td>\r
+<td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, durch die der Wert gepr&uuml;ft werden soll.</td>\r
 </tr>\r
 </table>\r
 \r
-<pre>\r
-$user_fields['beruf']['prepare'] = 'prepare_beruf';\r
-$user_fields['beruf']['tpl_var'] = 'BERUF';\r
+<p>Weiterhin m&uuml;ssen Sie noch diverse Fehlermeldungen definieren (als Unter-Array). Das Definieren dieser Fehlermeldungen ist Pflicht (Sie m&uuml;ssen jedoch nur die Fehlermeldungen zu den Dingen definieren, die auch wirklich gepr&uuml;ft werden).</p>\r
 \r
-$user_fields['beruf']['errors']['too_short'] = 'Der Beruf muss mind. 5 Zeichen lang sein!';\r
-$user_fields['beruf']['errors']['too_long'] = 'Der Beruf darf höchstens 10 Zeichen lang sein!';\r
-$user_fields['beruf']['errors']['not_set'] = 'Sie haben keinen Beruf eingegeben!';\r
-$user_fields['beruf']['errors']['match_fail'] = 'Der Beruf darf nur aus Buchstaben bestehen!';\r
-$user_fields['beruf']['errors']['check_fail'] = 'Der Beruf sollte keine äöü haben!';\r
-</pre>\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['too_short']</code></td>\r
+<td>Der vom Benutzer eingegebene Wert ist nicht lang genug</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['too_long']</code></td>\r
+<td>Der vom Benutzer eingegebene Wert ist zu lang</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['not_set']</code></td>\r
+<td>Das Formularfeld ist ein Pflichtfeld und es wurde nicht ausgef&uuml;llt.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['match_fail']</code></td>\r
+<td>Die &Uuml;berpr&uuml;fung des Wertes durch den regul&auml;ren Ausdruck ist fehlgeschlagen.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['check_fail']</code></td>\r
+<td>Die &Uuml;berpr&uuml;fung des Wertes durch die PHP-Funktion ist fehlgeschlagen.</td>\r
+</tr>\r
+</table>\r
+\r
+<p>Zus&auml;tzlich sind noch die folgenden Einstellungen m&ouml;glich:</p>\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['prepare']</code></td>\r
+<td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, die den Wert des Formularfeldes nach den Pr&uuml;fungen noch ver&auml;ndern (bspw. kann man hier Funktionen angeben, die alle Buchstaben in Gro&szlig;buchstaben umwandelt).</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['tpl_var']</code></td>\r
+<td>Geben Sie hier die Template-Variable 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&auml;re das dann <code>USER_beruf</code>).</td>\r
+</tr>\r
+</table>\r
 \r
 <p class="upanddown"><a href="#top">Nach oben</a></p>\r
 \r
@@ -566,6 +601,7 @@ Die Fehlermeldung</li>
 <td><i>mail.txt</i></td>\r
 <td>Legt das Aussehen der Mail fest</td>\r
 <td>\r
+<!-- !!!UNVOLLSTAENDIG!!! -->\r
 <ul>\r
 <li><b>EMAIL</b><br />\r
 Die eingegebene E-Mail-Adresse</li>\r
@@ -579,13 +615,16 @@ Der eingegebene Mail-Text</li>
 Die formatierte Zeitangabe</li>\r
 </ul>\r
 \r
-Zus&auml;tzlich k&ouml;nnen Sie hier durch Variablen, die mit <b>ENV_</b> beginnen, Server-Umgebungsvariablen im Text einf&uuml;gen (siehe auch Konfigurationsvariable <code>$allowed_envs</code>.\r
+Zus&auml;tzlich k&ouml;nnen Sie hier durch Variablen, die mit <b>ENV_</b> beginnen, Server-Umgebungsvariablen im Text einf&uuml;gen (siehe auch Konfigurationsvariable <code>$allowed_envs</code>.<br />\r
+<br />\r
+<b>!!!TODO: Individuelle Formularfelder!!!</b>\r
 </td>\r
 </tr>\r
 <tr>\r
 <td><i>sent.htm</i></td>\r
 <td>Wird angezeigt, wenn die Mail erfolgreich versendet wurde</td>\r
 <td>\r
+<!-- !!!UNVOLLSTAENDIG!!! -->\r
 <ul>\r
 <li><b>EMAIL</b><br />\r
 Die eingegebene E-Mail-Adresse</li>\r
@@ -600,12 +639,14 @@ Der eingegebene Mail-Text</li>
 <li><b>TIME</b><br />\r
 Die formatierte Zeitangabe</li>\r
 </ul>\r
+<b>!!!TODO: Individuelle Formularfelder!!!</b>\r
 </td>\r
 </tr>\r
 <tr>\r
 <td><i>user_error.htm</i></td>\r
 <td>Wird angezeigt, wenn der Benutzer einen Fehler gemacht hat, der sich aber noch beheben l&auml;sst (zum Beispiel wenn ein Formularfeld nicht ausgef&uuml;llt wurde)</td>\r
 <td>\r
+<!-- !!!UNVOLLSTAENDIG!!! -->\r
 <ul>\r
 <li><b>EMAIL</b><br />\r
 Die eingegebene E-Mail-Adresse</li>\r
@@ -621,7 +662,9 @@ Der eingegebene Mail-Text</li>
 \r
 Zus&auml;tzlich ist es m&ouml;glich, einen Bereich, der nur angezeigt werden soll, wenn Captchas aktiviert sind, anzuzeigen, indem Sie diesen in folgenden Block einschlie&szlig;en (der <code>{ELSE}</code>-Teil ist optional):<br />\r
 <br />\r
-<code>{IF CAPTCHA}Captchas sind aktiviert{ELSE}Captchas sind nicht aktiviert{ENDIF}</code>\r
+<code>{IF CAPTCHA}Captchas sind aktiviert{ELSE}Captchas sind nicht aktiviert{ENDIF}</code><br />\r
+<br />\r
+<b>!!!TODO: Individuelle Formularfelder!!!</b>\r
 </td>\r
 </tr>\r
 </table>\r