Credits & Lizenz-Information
Zurück zur Credits-SeiteHilfe für Formicula Version 1.0
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Formicula Documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<!-- $Id: manual.htm,v 1.16 2004/11/09 13:52:16 fschummertz Exp $ -->
<center>
<pre>
<table width="650" border="0" cellspacing="0" cellpadding="0">
<tr>
<td>
<font size="3" face="Arial, Helvetica, sans-serif">
Formicula v.2 == 6/21/2004<br>
User's Manual<br>
Authors:Jim Hadfield and Frank Schummertz<br>
<a href='http://www.snowbankih.tzo.com'>SnowbankIH Website</a><br>
<a href='http://www.snowbankih.tzo.com/modules.php?op=modload&name=phpBB_14&file=index&action=viewforum&forum=5'>Support Forums</a>
</font>
<hr>
<font size="3" face="Arial, Helvetica, sans-serif">
<b>Formicula</b> supports an infinite number of contact forms with an infinite number
of custom fields (ok, infinite as long as you have enough server memory).</font><br><br>
<font size="3" face="Arial, Helvetica, sans-serif">
<b>Installation</b><br>
-----------------<br>
If not done, upgrade to the latest version of Postnuke (0.726-3 as writing
this on 21th Jun 2004)<br><br>
Install the XTE (Xantha Theme Engine) incl. pnRender (you can download it from http://www.post-nuke.net or other PN related sites)<br><br>
Install the latest Mailer module (pnuserapi.php min. version 1.14!!) and activate it. This module is part of the coming Postnuke .8 and Postnuke .750 Gold and will work in .726-3 too.<br><br>
Extract the files to your Postnuke directory.<br><br>
Load, initialize and activate the module in the admin section.<br><br>
Create some contact names/topics with respective email adresses in the Formicula admin module.<br><br>
Change some settings in the contact configuration (i.e. activate/deactivate some extra fields or sending confirmation email to the user).<br><br>
Add a link to your main menu with: {formicula}<br>
(using [formicula] will not work)<br>
or somewhere else:
<font size="2" face="Times New Roman, Times, serif">
index.php?module=formicula&func=main </font><br><br>
If neccesary, change the language files to your needs.<br><br>
If you do not like the page layout: go to /pntemplates and change the files to fit your needs. This is Smarty!<br><br>
<b>Templates</b><br>
----------------<br>
The templates for the forms are named as follows:<br><br>
The form with the input fields: #_userform.html<br>
The page with the confirmation after submitting the data: #_userconfirm.html<br>
The page with error messages after submitting data: #_usererror.html<br>
The user's confirmation mail in text format: #_usermail.txt<br>
The user's confirmation mail in html format: #_usermail.html<br>
The admin mail in text format: #_adminmail.txt<br>
The admin mail in html format: #_adminmail.html<br>
This is the email that the admin gets after the user sends the mail.<br>
Note: the email format can be chosen by using the dropdown that we have in
our sample 0_userform.html<br><br>
<font size="2" face="Times New Roman, Times, serif">
<select name='userformat'><br>
<option value='html'><!--[ pnml name='_FOR_HTMLMAIL' ]--></option><br>
<option value='plain'><!--[ pnml name='_FOR_TEXTMAIL' ]--></option><br>
</select></font><br><br>
Or if you want to force the type of email, you can use a hidden field in the form.<br><br>
<font size="2" face="Times New Roman, Times, serif">
<input type='hidden' name='userformat' value='html'></font><br><br>
The '#' at the beginning of the template designates the number of form</font>
<p><font size="3" face="Arial, Helvetica, sans-serif">
You can call the specific form with a parameter
<font size="2" face="Times New Roman, Times, serif"> &form=# </font>in the url.
A link from the menu to call form #1 would look like:<br><br>
<font size="2" face="Times New Roman, Times, serif">
index.php?module=formicula&func=main&form=1 </font></p>
<p><font size="3" face="Arial, Helvetica, sans-serif">
In the distribution package you will find 2 sample forms 0 and 1,
0 is a normal contact form and form #1 is for online a job application.
If form is not mentioned in the url, the default is 0.
So if you want to use Formicula for only one contact form,
the link in the menu can be {formicula}</font></p>
<p><font size="3" face="Arial, Helvetica, sans-serif">
<b>Custom Fields</b><br>
----------------------<br>
You can add as many custom fields to your form as you want.
This makes it easy to create e.g. an online job application form if needed.
This makes it necessary to send certain information from the form page to the module.</font></p>
<p><font size="3" face="Arial, Helvetica, sans-serif">
These are:</font><br>
<font size="3" face="Arial, Helvetica, sans-serif">
numFields (hidden field) number of custom fields used<br>
custom#name (hidden field) name of the custom field<br>
custom#mandatory (hidden field) set to 1 if this is a mandatory field.
Formicula checks this and shows an errormessage when this field is not filled<br>
custom#data (any kind of input field) the data with #=number.</font></p>
<font size="3" face="Arial, Helvetica, sans-serif">Example:</font><br><br>
<font size="2" face="Times New Roman, Times, serif">
<tr width='100%'><br>
<td width='50%' align='right'><br>
<!--[ pnml name='_ONLINEAPPLYAS' html=1 ]-->&nbsp;<span style="color: red;">*</span><br>
</td><br>
<td width='50%' align='left'><br>
<input type='hidden' name='custom0name' value='<!--[ pnml name='_ONLINEAPPLYAS' ]-->'><br>
<input type='hidden' name='custom0mandatory' value=1><br>
<input type='text' name='custom0data' size='40' maxlength='80' value=''><br>
</td><br>
</tr><br><br>
<tr width='100%'><br>
<td width='50%' align='right'><br>
<!--[ pnml name='_ONLINESTREET' html=1 ]-->&nbsp;<span style="color: red;">*</span><br>
</td><br>
<td width='50%' align='left'><br>
<input type='hidden' name='custom1name' value='<!--[ pnml name='_ONLINESTREET' ]-->'><br>
<input type='hidden' name='custom1mandatory' value=1><br>
<input type='text' name='custom1data' size='40' maxlength='40' value=''><br>
</td><br>
</tr><br><br>
</font><font size="3" face="Arial, Helvetica, sans-serif">
This will create two custom fields 0 and 1 which are both mandatory.
In this case you also need:<br><br>
<font size="2" face="Times New Roman, Times, serif">
<input type='hidden' name='numFields' value=2></font><br><br>
Please note that the customfields have to start at 0!</font>
</p>
<br>
<p><font size="3" face="Arial, Helvetica, sans-serif">
Permissions<br>
------------------<br>
To use a form you need the right to COMMENT.<br>
<font size="2" face="Times New Roman, Times, serif">
<br>Unregistered | formicula:: | .* | comment<br></font><br>
all unregistered users are allowed to use all forms and write to all contacts<br>
<font size="2" face="Times New Roman, Times, serif">
<br>Unregistered | formicula:: | 0:: | comment<br></font><br>
all unregistered users are allowed to use form 0 with all existing contacts.<br>
<br><font size="2" face="Times New Roman, Times, serif">
Users | formicula:: | 1:(2|3): | comment<br></font><br>
all members of the group users are allowed to use form 1 and write to contact 2 and 3.<br>
</font></p>
</td>
</tr>
</table>
</pre>
</center>
</body>
</html>
<html>
<head>
<title>Formicula Documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<!-- $Id: manual.htm,v 1.16 2004/11/09 13:52:16 fschummertz Exp $ -->
<center>
<pre>
<table width="650" border="0" cellspacing="0" cellpadding="0">
<tr>
<td>
<font size="3" face="Arial, Helvetica, sans-serif">
Formicula v.2 == 6/21/2004<br>
User's Manual<br>
Authors:Jim Hadfield and Frank Schummertz<br>
<a href='http://www.snowbankih.tzo.com'>SnowbankIH Website</a><br>
<a href='http://www.snowbankih.tzo.com/modules.php?op=modload&name=phpBB_14&file=index&action=viewforum&forum=5'>Support Forums</a>
</font>
<hr>
<font size="3" face="Arial, Helvetica, sans-serif">
<b>Formicula</b> supports an infinite number of contact forms with an infinite number
of custom fields (ok, infinite as long as you have enough server memory).</font><br><br>
<font size="3" face="Arial, Helvetica, sans-serif">
<b>Installation</b><br>
-----------------<br>
If not done, upgrade to the latest version of Postnuke (0.726-3 as writing
this on 21th Jun 2004)<br><br>
Install the XTE (Xantha Theme Engine) incl. pnRender (you can download it from http://www.post-nuke.net or other PN related sites)<br><br>
Install the latest Mailer module (pnuserapi.php min. version 1.14!!) and activate it. This module is part of the coming Postnuke .8 and Postnuke .750 Gold and will work in .726-3 too.<br><br>
Extract the files to your Postnuke directory.<br><br>
Load, initialize and activate the module in the admin section.<br><br>
Create some contact names/topics with respective email adresses in the Formicula admin module.<br><br>
Change some settings in the contact configuration (i.e. activate/deactivate some extra fields or sending confirmation email to the user).<br><br>
Add a link to your main menu with: {formicula}<br>
(using [formicula] will not work)<br>
or somewhere else:
<font size="2" face="Times New Roman, Times, serif">
index.php?module=formicula&func=main </font><br><br>
If neccesary, change the language files to your needs.<br><br>
If you do not like the page layout: go to /pntemplates and change the files to fit your needs. This is Smarty!<br><br>
<b>Templates</b><br>
----------------<br>
The templates for the forms are named as follows:<br><br>
The form with the input fields: #_userform.html<br>
The page with the confirmation after submitting the data: #_userconfirm.html<br>
The page with error messages after submitting data: #_usererror.html<br>
The user's confirmation mail in text format: #_usermail.txt<br>
The user's confirmation mail in html format: #_usermail.html<br>
The admin mail in text format: #_adminmail.txt<br>
The admin mail in html format: #_adminmail.html<br>
This is the email that the admin gets after the user sends the mail.<br>
Note: the email format can be chosen by using the dropdown that we have in
our sample 0_userform.html<br><br>
<font size="2" face="Times New Roman, Times, serif">
<select name='userformat'><br>
<option value='html'><!--[ pnml name='_FOR_HTMLMAIL' ]--></option><br>
<option value='plain'><!--[ pnml name='_FOR_TEXTMAIL' ]--></option><br>
</select></font><br><br>
Or if you want to force the type of email, you can use a hidden field in the form.<br><br>
<font size="2" face="Times New Roman, Times, serif">
<input type='hidden' name='userformat' value='html'></font><br><br>
The '#' at the beginning of the template designates the number of form</font>
<p><font size="3" face="Arial, Helvetica, sans-serif">
You can call the specific form with a parameter
<font size="2" face="Times New Roman, Times, serif"> &form=# </font>in the url.
A link from the menu to call form #1 would look like:<br><br>
<font size="2" face="Times New Roman, Times, serif">
index.php?module=formicula&func=main&form=1 </font></p>
<p><font size="3" face="Arial, Helvetica, sans-serif">
In the distribution package you will find 2 sample forms 0 and 1,
0 is a normal contact form and form #1 is for online a job application.
If form is not mentioned in the url, the default is 0.
So if you want to use Formicula for only one contact form,
the link in the menu can be {formicula}</font></p>
<p><font size="3" face="Arial, Helvetica, sans-serif">
<b>Custom Fields</b><br>
----------------------<br>
You can add as many custom fields to your form as you want.
This makes it easy to create e.g. an online job application form if needed.
This makes it necessary to send certain information from the form page to the module.</font></p>
<p><font size="3" face="Arial, Helvetica, sans-serif">
These are:</font><br>
<font size="3" face="Arial, Helvetica, sans-serif">
numFields (hidden field) number of custom fields used<br>
custom#name (hidden field) name of the custom field<br>
custom#mandatory (hidden field) set to 1 if this is a mandatory field.
Formicula checks this and shows an errormessage when this field is not filled<br>
custom#data (any kind of input field) the data with #=number.</font></p>
<font size="3" face="Arial, Helvetica, sans-serif">Example:</font><br><br>
<font size="2" face="Times New Roman, Times, serif">
<tr width='100%'><br>
<td width='50%' align='right'><br>
<!--[ pnml name='_ONLINEAPPLYAS' html=1 ]-->&nbsp;<span style="color: red;">*</span><br>
</td><br>
<td width='50%' align='left'><br>
<input type='hidden' name='custom0name' value='<!--[ pnml name='_ONLINEAPPLYAS' ]-->'><br>
<input type='hidden' name='custom0mandatory' value=1><br>
<input type='text' name='custom0data' size='40' maxlength='80' value=''><br>
</td><br>
</tr><br><br>
<tr width='100%'><br>
<td width='50%' align='right'><br>
<!--[ pnml name='_ONLINESTREET' html=1 ]-->&nbsp;<span style="color: red;">*</span><br>
</td><br>
<td width='50%' align='left'><br>
<input type='hidden' name='custom1name' value='<!--[ pnml name='_ONLINESTREET' ]-->'><br>
<input type='hidden' name='custom1mandatory' value=1><br>
<input type='text' name='custom1data' size='40' maxlength='40' value=''><br>
</td><br>
</tr><br><br>
</font><font size="3" face="Arial, Helvetica, sans-serif">
This will create two custom fields 0 and 1 which are both mandatory.
In this case you also need:<br><br>
<font size="2" face="Times New Roman, Times, serif">
<input type='hidden' name='numFields' value=2></font><br><br>
Please note that the customfields have to start at 0!</font>
</p>
<br>
<p><font size="3" face="Arial, Helvetica, sans-serif">
Permissions<br>
------------------<br>
To use a form you need the right to COMMENT.<br>
<font size="2" face="Times New Roman, Times, serif">
<br>Unregistered | formicula:: | .* | comment<br></font><br>
all unregistered users are allowed to use all forms and write to all contacts<br>
<font size="2" face="Times New Roman, Times, serif">
<br>Unregistered | formicula:: | 0:: | comment<br></font><br>
all unregistered users are allowed to use form 0 with all existing contacts.<br>
<br><font size="2" face="Times New Roman, Times, serif">
Users | formicula:: | 1:(2|3): | comment<br></font><br>
all members of the group users are allowed to use form 1 and write to contact 2 and 3.<br>
</font></p>
</td>
</tr>
</table>
</pre>
</center>
</body>
</html>
