Introduction to the Plug-in Scripts function
This is a feature for our customers who want to use pre-written CGI scripts such as FormMail or TextCounter. Plug-in scripts will be continuously added to the system.
Using Plug-in Scripts
To use a plug-in script, click the desired script. A script setup page will be displayed with several options. The options include mandatory and optional settings. Plug-in scripts cannot be used with FrontPage extensions.
When the script is setup, it will be placed in your cgi-bin directory. A new directory will be created to hold data files if necessary.
The FormMail script is a universal form to an email gateway. Use this script if you want to have a form's contents emailed to you, but aren't sure how to write the code for it.
Please note: You must already have a form on your website for the FormMail script to work.
After setting the desired values for the fields, click the "Install" button to complete the operation. The results of operation will be displayed. Follow the instructions on the results page to start using the FormMail script.
The following is the description of FormMail various configuration options. To use this script only the Mandatory field must be filled out.
Recipients email address: this field allows you to specify the email address you want your form results to be mailed to.
Your email subject: this field allows you to specify the subject that you wish to appear in the email that is sent to you after this form has been filled out. Enter your desired subject in the "Your email subject" textbox.
Allow user enter subject: this field allows you to include a textbox in your form for users to enter a subject. Click the "Allow user enter subject" textbox to include the subject textbox.
Allow User to enter their email address: this field allows you to include a field in your form for users to enter their return email address. Click the "Allow User to enter their email address" check box to include the email textbox.
Redirect url: this field allows you to specify a URL to redirect the users to after they submit the form. Enter your desired URL in the "Redirect url" textbox.
Example: If you want to redirect the users to the mycar.com domain after submitting the form you should enter the following in the "Redirect url" field:
If you leave this field blank, the user will see a default message.
Required fields: this field allows you to require certain fields in your form to be filled in before the user can successfully submit the form. 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 will be provided. Enter all field names that you want to be mandatory in the "Required fields" textbox separated by commas.
Title on result page: this field allows you to specify the title and header that will appear on the resulting page if you do not specify a redirect. Enter your desired title in the "Title on result page" textbox.
Sort order: this field allows you to choose the order in which you wish your variables to appear in the email that FormMail generates. You can sort the fields alphabetically by entering the word "alphabetic" in the "Sort order" textbox.
You can specify a set order in which you want the fields to appear in your mail message. Enter the phrase "order:" as the first part of your value in the "Sort order" textbox and then follow that with the comma separated field names you want to be listed in the email message
Example: order:name1, name2, etc...
Environment variables: this field allows you to have Environment variables included in the email message you receive after a user has filled out your form.
Print config: this field allows you to specify which of the config variables you would like to have printed in your email message. By default, no config fields are printed to your email. Enter the comma separated list of your desired config fields in the "Print config" textbox.
Print blank links: this field allows you to have all form fields printed in the return HTML, regardless of wether or not they were filled in. Click the "Print blank links" checkbox for turning this option on.
Return link url: this field allows you to specify a URL that will appear as your "Return link title", on the following report page. This field will not be used if you have the redirect field set. Enter your desired URL in the "Return link url" textbox. Return link title: this is the title that will be used to link the user back to the page you specify with "Return link url". Enter your desired title in the "Return link title".
Missing fields redirect: this field allows you to specify a URL that users will be redirected to if there are listed in the required form fields that are not filled in. This will enable you to customize an error page instead of displaying the default. Background image: this field allows you to specify a background image that will appear if you do not have the "Redirect url" field set. This image will appear as the background to the form result page. Enter the absolute path to the image in the "Background image" textbox.
Background color: this field allows you to specify a bgcolor for the form result page. This field should not be set if the "Redirect url" field is set. Enter your the color (e.g. Black) or a number sign (#) followed by the hexadecimal value of the color your want to set for the result page background.
Example: For a background color of white enter #FFFFFF
Text color: this field works in the same way as "Background color" field, except that it will change the color of your text.
Link color: this field allows you to change the color of links on the resulting page and it works the same way as "Text color" field.
Vlink color: changes the color of visited links on the result page and it works the same way as "Link color" field.
Alink color: changes the color of active links on the result page and it works the same way as "Vlink color" field.
Sending FormMail results to an outside email address
If you require FormMail to send to an address not belonging to your domain, we recommend using one of the procedures below. For demonstration purposes, assume that the customer's domain is mydomain.com and the address that the FormMail results are sent to is firstname.lastname@example.org. Setting up a forwarding email account Set up a forwarding email account with Easymail that forwards to the desired address. For example, use Easymail to set up email@example.com as a forward account which forwards to firstname.lastname@example.org.
Set up FormMail to send its results to email@example.com, which in turn will forward them to firstname.lastname@example.org. Editing the FormMail script's recipients list Advanced users can alter the "@recipients = @referers;" line in the
/cgi-bin/formmail script to send results to any email address. If you want to send FormMail results to an address not belonging to your domain, edit the "@recipients = @referers;" line to resemble the one below:
@recipients = ('^email@example.com');
Please note that the carat symbol "^" must precede the email address.
Further information on this subject can be found in the FormMail README file at: http://worldwidemart.com/scripts/readme/formmail.shtml.
TextCounter allows you to include a text counter on any page.
After setting the necessary fields, click the "Install" button from "Mandatory" or "Optional" pages to create the script. The results of the operation, values of counter and the code to be inserted in your page will be displayed. Cut and paste the code onto the pages in which you want to have a counter.
Click the "Reset" button to retrieve the original values.
Data directory path: this field allows you to specify the path to the directory under which TextCounter's files will be stored. A new data file will be created for each page you add your text counter to in the specified directory. The default for this field is the textcounter directory which will be created under your home directory after installation.
Show Link: this field allows you to link your text counter that appears on your page to a URL. Enter your desired URL in the "Show Link" textbox.
Auto Create: this field allows you to enable or disable Auto Create. When Auto Create is enabled which is the default, you will be able to create the counter on all your pages by copying and pasting the provided code after installing TextCounter. If you want to disable it uncheck the "Auto Create" check box.
Show Date: by clicking "Show Date", the date on which you started the counter will appear with the counter. Leave the "Show Date" check box unchecked if you don't want the date to appear on your page.
Lock Seconds: this field defines how long the program will wait for the lock file to be cleared before overwriting the current lock file. Locks are used to avoid simultaneous writing to the count file. Without a lock, simultaneous access to your site will result in overwriting the count file.
Pad Size: this field allows you to specify the number of digits displayed by the counter. To maintain the number you specified through "Pad Size" field, zeros will be added to the front of the current count.
The counter plugin script allows you to include a graphical counter on any page. With this script you have the option of including custom images for the counter digits.
In the "Fly Counter" page, click the "Mandatory" tab and enter your desired name and path for the counter directory in the "Data directory path" textbox or choose the default which is fly_counter.
In the "Fly Counter" page, click the "Optional" tab to change the default settings of the counter. The settings are:
Number of hits: This field allows you to choose the starting number of the counter which is zero by default. To change the default, choose another value from the drop-down menu.
Fly Counter Visible: You can make the counter invisible to the visitors of your site by unchecking the "Fly Counter Visible" checkbox.
Size of Image: Sets the size of images used for the counter. The size is 40x40 pixels by default. You can change the size by choosing a new value from the drop-down menu.
Frame Width: The counter images don't have any frame by default. You can choose your desired frame width from the drop-down menu.
Click the "Install" button from "Mandatory" or "Optional" pages to create the script. The results of the operation, values of counter and the code to be inserted in your page will be displayed. Cut and paste the code onto the pages in which you want to have a counter.
Click the "Reset" button to retrieve the original values.
If you want to include your own images for the counter, they should be named as the default images ( 0.gif, 1.gif, 2.gif,......, and 9.gif).
The Guestbook plugin script will allow you to add a guestbook to your site. To install the guestbook, choose the desired options from the "GuestBook" page and click the "Install" button.
Click the "Reset" button to restore the original setting.
After clicking the "Install" button the results of the operation including confirmation, location of the guestbook directory and its values as well as a link to your guestbook will be displayed.
There are three options that can be set:
Hyperlinked: clicking the "Hyperlinked" checkbox will make addresses in your guestbook become hyperlink.
Line Breaks: This option turns line breaks in the comment field into
Allow HTML: This option will allow you to turn on or off the use of HTML tags by guestbook users.
The Search Engine plugin script allows you to add an indexing and searching system to your domain. Both HTML documents and plain text files can be searched by this search engine.
To install the search engine, click on the "Install" tab on the "Search Engine" page and then click the "Next" button. The result of the installation will be displayed at the bottom of the page.
After installing the search engine, you need to index your domain . Click on the "Index" tab on the "Search Engine" page and then click the "next" button. The index information and a link to the search engine will be displayed at the bottom of the page Note: Every time you add content and new pages to your domain you have to re-index your domain from "Search Engine" page. Accessing the search page
To access your domain's search page, use the link supplied during the process. This page can be modified by hand to suit your needs.