How to Use Yform:
There is
only one required form input tag which must be specified in order for this
script to work with your existing forms. Other hidden configuration fields
can also be used to enhance the operation of Yform in your script. By default,
form fields are sorted as they appear in the form.
Forms may be created by
using whatever tool you have with form producing capability.
Please note: you will have problems with forms created with Microsoft
FrontPage; Neither the www.usna.edu or intranet.usna.edu supports
FrontPage Server Extensions. FrontPage assumes that the FrontPage Server
Extensions are available for processing forms.
The form must have one of the following lines (or close equivalent) at the
start of the form definition:
<FORM method="POST" action="http://www.usna.edu/cgi-bin/yform">
<FORM method="POST" action="https://www.usna.edu/cgi-bin/yform">
Form Options
Yform offers many ways to code your form to tailor the resulting HTML page
and the way the script performs. Below is a list of form fields you can
use and how to implement them.
Necessary Form Fields
There is only one form field that you must have in your form,
for Yform to work correctly. This is the recipient field.
| Field: |
recipient |
| Description: |
This form field allows you to specify to whom you wish for your form
results to be mailed. Most likely you will want to configure this option
as a hidden form field with a value equal to that of your e-mail address. |
| Syntax: |
<input type=hidden name="recipient" value="email@your.host.com"> |
Optional Form Fields
|
|
|
|
| Field: |
subject |
| Description: |
The subject field will allow you to specify the subject that you wish
to appear in the e-mail that is sent to you after this form has been filled
out. If you do not have this option turned on, then the script will default
to a message subject: WWW Form Submission |
| Syntax: |
If you wish to choose what the subject is:
<input type=hidden name="subject" value="Your Subject">
To allow the user to choose a subject:
<input type=text name="subject"> |
| Field: |
email |
| Description: |
This form field will allow the user to specify their return e-mail
address. If you want to be able to return e-mail to your user, I strongly
suggest that you include this form field and allow them to fill it in.
This will be put into the From: field of the message you receive. If you
want to require an email address with valid syntax, add this field name
to the 'required' field. |
| Syntax: |
<input type=text name="email"> |
| Field: |
redirect |
| Description: |
If you wish to redirect the user to a different URL, rather than having
them see the default response to the fill-out form, you can use this hidden
variable to send them to a pre-made HTML page. |
| Syntax: |
To choose the URL they will end up at:
<input type=hidden name="redirect" value="http://your.host.com/to/file.html">
To allow them to specify a URL they wish to travel to once the form
is filled out:
<input type=text name="redirect"> |
| Field: |
required |
| Description: |
You can now require for certain fields in your form to be filled in
before the user can successfully submit the form. Simply place all field
names that you want to be mandatory into this field. If the required fields
are not filled in, the user will be notified of what they need to fill
in, and a link back to the form they just submitted will be provided.
To use a customized error page, see 'missing_fields_redirect' |
| Syntax: |
If you want to require that they fill in the email and phone fields
in your form, so that you can reach them once you have received the mail,
use a syntax like:
<input type=hidden name="required" value="email,phone"> |
| Field: |
env_report |
| Description: |
Allows you to have Environment variables included in the e-mail message
you receive after a user has filled out your form. Useful if you wish to
know what browser they were using, what domain they were coming from or
any other attributes associated with environment variables. The following
is a short list of valid environment variables that might be useful:
REMOTE_HOST - Sends the hostname making the
request.
REMOTE_ADDR - Sends the IP address of the
remote host making the request.
REMOTE_USER - If server supports authentication
and script is protected, this is
the username they have
authenticated as. *This is not
usually set.*
HTTP_USER_AGENT - The browser the client is using
to send the request.
There are others, but these are a few of the most useful. For more information
on environment variables, see:
The
CGI Resource Index: Documentation: Environment Variables |
| Syntax: |
If you wanted to find the remote host and browser sending the request,
you would put the following into your form:
<input type=hidden name="env_report" value="REMOTE_HOST,HTTP_USER_AGENT"> |
| Field: |
sort |
| Description: |
This field allows you to choose the order in which you wish for your
variables to appear in the e-mail that Yform generates. You can choose
to have the field sorted alphabetically or specify a set order in which
you want the fields to appear in your mail message. By leaving this field
out, the order will simply default to the order in which the browsers sends
the information to the script (which is usually the exact same order as
they appeared in the form.) When sorting by a set order of fields, you
should include the phrase "order:" as the first part of your value for
the sort field, and then follow that with the field names you want to be
listed in the e-mail message, separated by commas. Version 1.6 allows a
little more flexibility in the listing of ordered fields, in that you can
include spaces and line breaks in the field without it messing up the sort.
This is helpful when you have many form fields and need to insert a line
wrap. |
| Syntax: |
To sort alphabetically:
<input type=hidden name="sort" value="alphabetic">
To sort by a set field order:
<input type=hidden name="sort" value="order:name1,name2,etc..."> |
| Field: |
print_config |
| Description: |
print_config allows you to specify which of the config variables you
would like to have printed in your e-mail message. By default, no config
fields are printed to your e-mail. This is because the important form fields,
like email, subject, etc. are included in the header of the message. However
some users have asked for this option so they can have these fields printed
in the body of the message. The config fields that you wish to have printed
should be in the value attribute of your input tag separated by commas. |
| Syntax: |
If you want to print the email and subject fields in the body of your
message, you would place the following form tag:
<input type=hidden name="print_config" value="email,subject"> |
| Field: |
print_blank_fields |
| Description: |
print_blank_fields allows you to request that all form fields are printed
in the return HTML, regardless of whether or not they were filled in. Yform
defaults to turning this off, so that unused form fields aren't e-mailed. |
| Syntax: |
If you want to print all blank fields:
<input type=hidden name="print_blank_fields" value="1"> |
| Field: |
title |
| Description: |
This form field allows you to specify the title and header that will
appear on the resulting page if you do not specify a redirect URL. |
| Syntax: |
If you wanted a title of 'Feedback Form Results':
<input type=hidden name="title" value="Feedback Form Results"> |
| Field: |
return_link_url |
| Description: |
This field allows you to specify a URL that will appear, as return_link_title,
on the following report page. This field will not be used if you have the
redirect field set, but it is useful if you allow the user to receive the
report on the following page, but want to offer them a way to get back
to your main page. |
| Syntax: |
<input type=hidden name="return_link_url" value="http://your.host.com/main.html"> |
| Field: |
return_link_title |
| Description: |
This is the title that will be used to link the user back to the page
you specify with return_link_url.
|
| Syntax: |
<input type=hidden name="return_link_title" value="Back to Main
Page"> |
| Field: |
missing_fields_redirect |
| Description: |
This form field allows you to specify a URL that users will be redirected
to if there are fields listed in the required form field that are not filled
in. This is so you can customize an error page instead of displaying the
default. |
| Syntax: |
<input type=hidden name="missing_fields_redirect" value="http://your.host.com/error.html"> |
| Field: |
background |
| Description: |
This form field allow you to specify a background image that will appear
if you do not have the redirect field set. This image will appear as the
background to the form results page. |
| Syntax: |
<input type=hidden name="background" value="http://your.host.xxx/image.gif"> |
| Field: |
bgcolor |
| Description: |
This form field allow you to specify a bgcolor for the form results
page in much the way you specify a background image. This field should
not be set if the redirect field is. |
| Syntax: |
For a background color of White:
<input type=hidden name="bgcolor" value="#FFFFFF"> |
| Field: |
text_color |
| Description: |
This field works in the same way as bgcolor, except that it will change
the color of your text. |
| Syntax: |
For a text color of Black:
<input type=hidden name="text_color" value="#000000"> |
| Field: |
link_color |
| Description: |
Changes the color of links on the resulting page. Works in the same
way as text_color. Should not be defined if redirect is. |
| Syntax: |
For a link color of Red:
<input type=hidden name="link_color" value="#FF0000"> |
| Field: |
vlink_color |
| Description: |
Changes the color of visited links on the resulting page. Works exactly
the same as link_color. Should not be set if redirect is. |
| Syntax: |
For a visited link color of Blue:
<input type=hidden name="vlink_color" value="#0000FF"> |
| Field: |
alink_color |
| Description: |
Changes the color of active links on the resulting page. Works exactly
the same as link_color. Should not be set if redirect is. |
| Syntax: |
For an active link color of Blue:
<input type=hidden name="alink_color" value="#0000FF"> |
| Field: |
name |
| Description: |
The name form field will allow the user to input their name. This field
is useful for identification purposes and will also be put into the From:
line of your message header. |
| Syntax: |
<input type=text name="your name"> |
| Field: |
mailtop |
| Description: |
The mailtop form field is usually hidden and is used to define text
that appears before the list of fields in the mail message. |
| Syntax: |
<input type=hidden name="mailtop" value "This text will be at
the top of your mail message"> |
| Field: |
mailbottom |
| Description: |
The mailbottom form field is usually hidden and is used to define text
that appears before the list of fields in the mail message. |
| Syntax: |
<input type=hidden name="mailbottom" value "This text will be
at the bottom of your mail message"> |
| Field: |
sendcourtesy |
| Description: |
The sendcourtesy form field will allow yform to send a courtesy reply
to the email address specified by your user. |
| Syntax: |
<input type=hidden name="sendcourtesy" value="yes"> |
| Field: |
courtext1 |
| Description: |
The courtext1 form field specifies a text string that will print first
in the courtesy relpy. This is the end user's equivalent of mailtop. |
| Syntax: |
<input type=hidden name="courtext1" value="Thank you for the
important information"> |
| Field: |
courfieldlist |
| Description: |
The courfieldlist form field is set to "yes" to include field values
in the email sent to users. |
| Syntax: |
<input type=hidden name="courfieldlist" value="yes"> |
| Field: |
courtext2 |
| Description: |
The courtext2 form field specifies a text string that will print after
any fields in the courtesy relpy. This is the end user's equivalent of
mailbottom. |
| Syntax: |
<input type=hidden name="courtext2" value="Please let us know
if there are problems."> |
| Field: |
courtclose |
| Description: |
The courtclose form field specifies a text string that will print after
the courtext2 value in the courtesy relpy. This is typically used with
the myname, myemail, and/or mywebsite fields. |
| Syntax: |
<input type=hidden name="courtclose" value="Sincerely."> |
| Field: |
myname |
| Description: |
The myname form field is used to include a name in the courtesy reply. |
| Syntax: |
<input type=hidden name="myname" value="Computer Help Desk"> |
| Field: |
myemail |
| Description: |
The myemail form field is used to include an email address in the courtesy
reply. |
| Syntax: |
<input type=hidden name="myemail" value="syshelp@usna.edu"> |
| Field: |
mywebsite |
| Description: |
The mywebsite form field is used to include a URL in the courtesy reply. |
| Syntax: |
<input type=hidden name="mywebsite" value="http://www.usna.edu"> |
| Field: |
database |
| Description: |
The database form field specifies the filename used for saving records
with users' input. The file must exist before yform will start using it.
You must use the 'sort/order:' value set to write your form submissions
to the database |
| Syntax: |
<input type=hidden name="database" value="formout.txt"> |
| Field: |
delimiter |
| Description: |
The delimiter form field is used to define a caracter or set of charactere
to separate fields in the database. The default is no delimiter which is
not very useful. |
| Syntax: |
<input type=hidden name="delimiter" value="|"> |
| Field: |
resptext1 |
| Description: |
The resptext1 form field specifies a text string will print first in
the HTML response given to the user. |
| Syntax: |
<input type=hidden name="resptext1" value="We appreciate your
time and response"> |
| Field: |
respfieldlist |
| Description: |
The respfieldlist form field must be set to "yes" if you wish to include
the form fields in the HTML response to the user. |
| Syntax: |
<input type=hidden name="respfieldlist" value="yes"> |
| Field: |
resptext2 |
| Description: |
The resptext2 form field specifies a text string will print after any
fields in the HTML response given to the user. |
| Syntax: |
<input type=hidden name="resptext2" value="If there are changes,
please try again.">
|
Sample Forms:
Sample Code
Sample Code in action
FAQ for sending output to a form
|