|
|
 |
FAQ Manager User Guide
Requirements
Configuration
Installation
License and Disclaimer
Getting Started / Adding Categories
Summary Page
Printer Friendly pages
Search forms
Custom forms
Changing your password
Settings
Collapsed Answers
Requirements
This script requires Perl on either a UNIX or WINDOWS server.
Configuration
This Script requires no Configuration, however if you have trouble installing the Script, you can hard code some values in the _key.cgi file.
Installation - Linux/Unix/Mac Servers
[script] refers to the first portion of the name of the CGI Scripts you purchased.
- Setting the Path to Perl. Open all CGI Scripts (except [script]_key.cgi) in a Plain Text Editor and make sure the first line of the CGI Script is the Path Perl for your server. Most Users can skip this step being the default Path to Perl shipped in the CGI Script is very common.
NB: if you do not you a Plain Text editor such as Windows NotePad or Mac Textedit (in Plain Text Mode), your Text/HTML editor will add extraneous code to the CGI Script when you save it which will result in a server 500 Error.
- Upload all CGI Scripts to your cgi-bin or any cgi enabled
directory and CHMOD
all the CGI Scripts to 755. It is imperative that you upload (transfer) all CGI Scripts to your server in ASCII mode.
If you forget to CHMOD all CGI Scripts to 755, Step 3 will
yield a Server 500 Error.
If you do NOT upload (transfer) all CGI Scripts to your
server in ASCII mode, Step 3 will yield a Server 500 Error.
- Load your Browser, point it to the [script]_setup.cgi file and follow the on-screen instructions for installation. For example, in your browser, type :
http://www.yourdomainname.com/cgi-bin/[script]_setup.cgi
- Enter a Username and Password. This will be your Username and Password for the Administration Section. If the Setup Routine is successfully processed a link to the Administration Section will appear on the resulting page. Click the link to access the Administration Section with the Username and Password you just entered in the Setup Script.
Should you encounter any Permission problems with the Setup Routine follow the instructions returned by the Script.
Upon successful completion of the Setup Routine the [script]_setup.cgi_setup.cgi script attempts to delete itself. This ensures the Setup Routine can not be repeated by another Surfer who would effectively reset your Administration Section Username and Password. Manually delete the [script]_setup.cgi
CGI Script you uploaded if the Setup Routine could not automatically
delete it (Refresh your FTP directory listing to check).
Should you ever forget your Administration Section Username and Password you can repeat this Step to set a new Username and Password.
Common Installation Problems - Linux/Unix/Mac Servers
NB: Shared Secure Servers, VPS, SBOX and Free Servers.
- Server 500 Error. This most often occurs because Step 2 was not followed precisely. Make sure the CGI Scripts you are uploaded are CHMOD to 755, the folder the CGI Scripts reside in is also CHMOD to 755, and the CGI Scripts were transferred in ASCII Mode. Auto-Detect only detects the extensions you specify in your FTP client's Settings.
- I can initially load the Setup Script and punch in my Username and Password, but when I submit the Form, I receive 404 Error Page or an alternate Error Page stating "Page Cannot be found".
This suggests your Server is operated by a very nervous System Administrator employing strict security measures, you're using a Shared Secure Server which dynamically sets your domain name to something other than the a standard Top Level Domain (www.yourdomainname.com) or sbox is employed by your server.
In any case, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and enter the URL to the folder you uploaded the CGI Scripts to in the $SecureServer Variable. If you uploaded the CGI Scripts to your cgi-bin, then you'd set the following:
$SecureServer = "http://www.yourdomainname.com/cgi-bin";
DO NOT enter the CGI Script name, DO NOT enter a trailing slash. After setting the Variable refresh the Setup Routine's Page that asks you to enter your Username and Password. Unless you refresh the initial Setup Page, the Form's URL will not be updated to reflect your Variable value.
- I cannot find the correct path to my WebSpace or the required Data Directories and/or Password file cannot be created.
You need to find that Path. Ask your host, or Download a copy of our free E-Vars CGI Script and install it on your server. CHMOD it to 755 then load it in your Web Browser which will print your Server's environment variables and other useful information. Determine your Server's Document_ROOT or Absolute Server Path to the folder your home page (index.html) resides in. You may need to append "/www" or "/httpdocs" to your Document_ROOT or Absolute Server Path to complete the path to your Writable WebSpace.
Once you've determined your Absolute Server Path, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and set the $DefaultData Variable. For example:
$DefaultData = "/var/username/www/htdocs";
Finally, on some Server's it's necessary to CHMOD the folder just above your WebSpace to 777 granting permission to the CGI Script to create the Required Directories at WebSpace Level. In the example above, the "htdocs" folder would need to have it's permissions set to 777.
- We offer a very reasonably priced Custom Installation Service. We'll Setup the CGI Script for you and send you the Log in details which you can update at your own leisure. If we cannot successfully Setup the CGI Script we will refund both the Installation fee and the purchase price of the CGI Script. To Order Custom Installation, please fill in our Secure Installation Order Form, entering your Server Information where prompted.
Installation - Windows Servers
[script] refers to the first portion of the name of the CGI Scripts you purchased.
- Your Windows Server may not execute CGI scripts even if Perl is Supported. Many Server Administrators do not modify the Registry to accommodate Scripts with a .cgi extension. In this case, contact us for a copy PL Version.
- Setting the Path to Perl. Your Server may or may not require the Path to Perl. It's highly likely you don't need it, and you can ignore this Step. However you may want to check with your Host if you can not load the Setup Script in your web Browser.
NB: if you do not you a Plain Text editor such as Windows NotePad or Mac Textedit (in Plain Text Mode), your Text/HTML editor will add extraneous code to the CGI Script when you save it which will result in a server 500 Error.
- Upload all CGI Scripts to your cgi-bin or any cgi enabled directory. It is imperative that you upload (transfer) all CGI Scripts to your server in ASCII mode.
If you do NOT upload (transfer) all CGI Scripts to your
server in ASCII mode, Step 3 will yield a Server 500 Error.
- Load your Browser, point it to the [script]_setup.cgi file and follow the on-screen instructions for installation. For example, in your browser, type :
http://www.yourdomainname.com/cgi-bin/[script]_setup.cgi
- Enter a Username and Password. This will be your Username and Password for the Administration Section. If the Setup Routine is successfully processed a link to the Administration Section will appear on the resulting page. Click the link to access the Administration Section with the Username and Password you just entered in the Setup Script.
Should you encounter any Permission problems during the Setup Routine, you need to contact your Host and request "Full Read/Write Permissions" be applied to at least one folder on your Server. Many Servers have at least one writable folder, often named "database". See Common Installation Problems below for more information.
Upon successful completion of the Setup Routine the [script]_setup.cgi_setup.cgi script attempts to delete itself. This ensures the Setup Routine can not be repeated by another Surfer who would effectively reset your Administration Section Username and Password. Manually delete the [script]_setup.cgi
CGI Script you uploaded if the Setup Routine could not automatically
delete it (Refresh your FTP directory listing to check).
Should you ever forget your Administration Section Username and Password you can repeat this Step to set a new Username and Password.
Common Installation Problems - Windows Servers
NB: Shared Secure Servers, VPS, SBOX and Free Servers.
- Server 500 Errors are usually misleading on Windows Servers. It seems to be the default error page for just about every error. Make sure you typed in the correct Website Address (URL) to the CGI Scripts on your server. Make sure the CGI Scripts were transferred in ASCII Mode. Auto-Detect only detects the extensions you specify in your FTP client's Settings.
- I can initially load the Setup Script and punch in my Username and Password, but when I submit the Form, I receive 404 Error Page or an alternate Error Page stating "Page Cannot be found".
This suggests your Server is operated by a very nervous System Administrator employing strict security measures, you're using a Shared Secure Server which dynamically sets your domain name to something other than the a standard Top Level Domain (www.yourdomainname.com) or sbox is employed by your server.
In any case, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and enter the URL to the folder you uploaded the CGI Scripts to in the $SecureServer Variable. If you uploaded the CGI Scripts to your cgi-bin, then you'd set the following:
$SecureServer = "http://www.yourdomainname.com/cgi-bin";
DO NOT enter the CGI Script name, DO NOT enter a trailing slash. After setting the Variable refresh the Setup Routine's Page that asks you to enter your Username and Password. Unless you refresh the initial Setup Page, the Form's URL will not be updated to reflect your Variable value.
- I cannot find the correct path to my WebSpace or the required Data Directories and/or Password file cannot be created.
You need to find that Path. Ask your host, or Download a copy of our free E-Vars CGI Script and install it on your server. You will need to rename the E-Vars CGI Script to "myserver.pl" if your Server only executes Scripts with .pl extensions. Upload it to your cgi-bin or any cgi executable folder then load it in your Web Browser which will print your Server's environment variables and other useful information. Determine your Server's Document_ROOT or Absolute Server Path to the folder your home page (index.html) resides in. You may need to append "\\www" or "\\httpdocs" to your Document_ROOT or Absolute Server Path to complete the path to your Writable WebSpace.
Once you've determined your Absolute Server Path, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and set the $DefaultData Variable. Be sure to separate folder names with two backslashes, not one slash. For example:
$DefaultData = "C:\\html\\username\\htdocs";
- We offer a very reasonably priced Custom Installation Service. We'll Setup the CGI Script for you and send you the Log in details which you can update at your own leisure. If we cannot successfully Setup the CGI Script we will refund both the Installation fee and the purchase price of the CGI Script. To Order Custom Installation, please fill in our Secure Installation Order Form, entering your Server Information where prompted.
Installation - Linux/Unix/Mac Servers
[script] refers to the first portion of the name of the CGI Scripts you purchased.
- Setting the Path to Perl. Open all CGI Scripts (except [script]_key.cgi) in a Plain Text Editor and make sure the first line of the CGI Script is the Path Perl for your server. Most Users can skip this step being the default Path to Perl shipped in the CGI Script is very common.
NB: if you do not you a Plain Text editor such as Windows NotePad or Mac Textedit (in Plain Text Mode), your Text/HTML editor will add extraneous code to the CGI Script when you save it which will result in a server 500 Error.
- Upload all CGI Scripts to your cgi-bin or any cgi enabled
directory and CHMOD
all the CGI Scripts to 755. It is imperative that you upload (transfer) all CGI Scripts to your server in ASCII mode.
If you forget to CHMOD all CGI Scripts to 755, Step 3 will
yield a Server 500 Error.
If you do NOT upload (transfer) all CGI Scripts to your
server in ASCII mode, Step 3 will yield a Server 500 Error.
- Load your Browser, point it to the [script]_setup.cgi file and follow the on-screen instructions for installation. For example, in your browser, type :
http://www.yourdomainname.com/cgi-bin/[script]_setup.cgi
- Enter a Username and Password. This will be your Username and Password for the Administration Section. If the Setup Routine is successfully processed a link to the Administration Section will appear on the resulting page. Click the link to access the Administration Section with the Username and Password you just entered in the Setup Script.
Should you encounter any Permission problems with the Setup Routine follow the instructions returned by the Script.
Upon successful completion of the Setup Routine the [script]_setup.cgi_setup.cgi script attempts to delete itself. This ensures the Setup Routine can not be repeated by another Surfer who would effectively reset your Administration Section Username and Password. Manually delete the [script]_setup.cgi
CGI Script you uploaded if the Setup Routine could not automatically
delete it (Refresh your FTP directory listing to check).
Should you ever forget your Administration Section Username and Password you can repeat this Step to set a new Username and Password.
Common Installation Problems - Linux/Unix/Mac Servers
NB: Shared Secure Servers, VPS, SBOX and Free Servers.
- Server 500 Error. This most often occurs because Step 2 was not followed precisely. Make sure the CGI Scripts you are uploaded are CHMOD to 755, the folder the CGI Scripts reside in is also CHMOD to 755, and the CGI Scripts were transferred in ASCII Mode. Auto-Detect only detects the extensions you specify in your FTP client's Settings.
- I can initially load the Setup Script and punch in my Username and Password, but when I submit the Form, I receive 404 Error Page or an alternate Error Page stating "Page Cannot be found".
This suggests your Server is operated by a very nervous System Administrator employing strict security measures, you're using a Shared Secure Server which dynamically sets your domain name to something other than the a standard Top Level Domain (www.yourdomainname.com) or sbox is employed by your server.
In any case, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and enter the URL to the folder you uploaded the CGI Scripts to in the $SecureServer Variable. If you uploaded the CGI Scripts to your cgi-bin, then you'd set the following:
$SecureServer = "http://www.yourdomainname.com/cgi-bin";
Do NOT enter the CGI Script name, do NOT enter a trailing slash. After setting the Variable refresh the Setup Routine's Page that asks you to enter your Username and Password. Unless you refresh the initial Setup Page, the Form's URL will not be updated to reflect your Variable value.
- I cannot find the correct path to my WebSpace or the required Data Directories and/or Password file cannot be created.
You need to find that Path. Ask your host, or Download a copy of our free E-Vars CGI Script and install it on your server. CHMOD it to 755 then load it in your Web Browser which will print your Server's environment variables and other useful information. Determine your Server's Document_ROOT or Absolute Server Path to the folder your home page (index.html) resides in. You may need to append "/www" or "/httpdocs" to your Document_ROOT or Absolute Server Path to complete the path to your Writable WebSpace.
Once you've determined your Absolute Server Path, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and set the $DefaultData Variable. For example:
$DefaultData = "/var/username/www/htdocs";
Finally, on some Server's it's necessary to CHMOD the folder just above your WebSpace to 777 granting permission to the CGI Script to create the Required Directories at WebSpace Level. In the example above, the "htdocs" folder would need to have it's permissions set to 777.
- We offer a very reasonably priced Custom Installation Service. We'll Setup the CGI Script for you and send you the Log in details which you can update at your own leisure. If we cannot successfully Setup the CGI Script we will refund both the Installation fee and the purchase price of the CGI Script. To Order Custom Installation, please fill in our Secure Installation Order Form.
Installation - Windows Servers
[script] refers to the first portion of the name of the CGI Scripts you purchased.
- Your Windows Server may not execute CGI scripts even if Perl is Supported. Many Server Administrators do not modify the Registry to accommodate Scripts with a .cgi extension. In this case, contact us for a copy PL Version.
- Setting the Path to Perl. Your Server may or may not require the Path to Perl. It's highly likely you don't need it, and you can ignore this Step. However you may want to check with your Host if you can not load the Setup Script in your web Browser.
NB: if you do not you a Plain Text editor such as Windows NotePad or Mac Textedit (in Plain Text Mode), your Text/HTML editor will add extraneous code to the CGI Script when you save it which will result in a server 500 Error.
- Upload all CGI Scripts to your cgi-bin or any cgi enabled directory. It is imperative that you upload (transfer) all CGI Scripts to your server in ASCII mode.
If you do NOT upload (transfer) all CGI Scripts to your
server in ASCII mode, Step 3 will yield a Server 500 Error.
- Load your Browser, point it to the [script]_setup.cgi file and follow the on-screen instructions for installation. For example, in your browser, type :
http://www.yourdomainname.com/cgi-bin/[script]_setup.cgi
- Enter a Username and Password. This will be your Username and Password for the Administration Section. If the Setup Routine is successfully processed a link to the Administration Section will appear on the resulting page. Click the link to access the Administration Section with the Username and Password you just entered in the Setup Script.
Should you encounter any Permission problems during the Setup Routine, you need to contact your Host and request "Full Read/Write Permissions" be applied to at least one folder on your Server. Many Servers have at least one writable folder, often named "database". See Common Installation Problems below for more information.
Upon successful completion of the Setup Routine the [script]_setup.cgi_setup.cgi script attempts to delete itself. This ensures the Setup Routine can not be repeated by another Surfer who would effectively reset your Administration Section Username and Password. Manually delete the [script]_setup.cgi
CGI Script you uploaded if the Setup Routine could not automatically
delete it (Refresh your FTP directory listing to check).
Should you ever forget your Administration Section Username and Password you can repeat this Step to set a new Username and Password.
Common Installation Problems - Windows Servers
NB: Shared Secure Servers, VPS, SBOX and Free Servers.
- Server 500 Errors are usually misleading on Windows Servers. It seems to be the default error page for just about every error. Make sure you typed in the correct Website Address (URL) to the CGI Scripts on your server. Make sure the CGI Scripts were transferred in ASCII Mode. Auto-Detect only detects the extensions you specify in your FTP client's Settings.
- I can initially load the Setup Script and punch in my Username and Password, but when I submit the Form, I receive 404 Error Page or an alternate Error Page stating "Page Cannot be found".
This suggests your Server is operated by a very nervous System Administrator employing strict security measures, you're using a Shared Secure Server which dynamically sets your domain name to something other than the a standard Top Level Domain (www.yourdomainname.com) or sbox is employed by your server.
In any case, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and enter the URL to the folder you uploaded the CGI Scripts to in the $SecureServer Variable. If you uploaded the CGI Scripts to your cgi-bin, then you'd set the following:
$SecureServer = "http://www.yourdomainname.com/cgi-bin";
Do NOT enter the CGI Script name, do NOT enter a trailing slash. After setting the Variable refresh the Setup Routine's Page that asks you to enter your Username and Password. Unless you refresh the initial Setup Page, the Form's URL will not be updated to reflect your Variable value.
- I cannot find the correct path to my WebSpace or the required Data Directories and/or Password file cannot be created.
You need to find that Path. Ask your host, or Download a copy of our free E-Vars CGI Script and install it on your server. You will need to rename the E-Vars CGI Script to "myserver.pl" if your Server only executes Scripts with .pl extensions. Upload it to your cgi-bin or any cgi executable folder then load it in your Web Browser which will print your Server's environment variables and other useful information. Determine your Server's Document_ROOT or Absolute Server Path to the folder your home page (index.html) resides in. You may need to append "\\www" or "\\httpdocs" to your Document_ROOT or Absolute Server Path to complete the path to your Writable WebSpace.
Once you've determined your Absolute Server Path, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and set the $DefaultData Variable. Be sure to separate folder names with two backslashes, not one slash. For example:
$DefaultData = "C:\\html\\username\\htdocs";
- We offer a very reasonably priced Custom Installation Service. We'll Setup the CGI Script for you and send you the Log in details which you can update at your own leisure. If we cannot successfully Setup the CGI Script we will refund both the Installation fee and the purchase price of the CGI Script. To Order Custom Installation, please fill in our Secure Installation Order Form.
License and Disclaimer
The following constitutes an agreement between you (the end user/purchaser) and us, PerlScripts JavaScripts.com (a wholly owned subsidiary of InterActive Scripts). By purchasing and using our software, products or services you agree to and accept the licensing agreement stated on this page. All documentation, goods and services are provided "as is" and without warranty. We hereby disclaim all warranties relating to any documentation, goods and services, whether express or implied, including warranties of suitability. In no event shall we be liable for any direct, indirect or consequential damages resulting in loss of revenue or data, incurred by you or any of our products, information or services. We reserve the right to revise the terms and conditions stated on this page at any time without notice. You agree to be bound by such revisions, and you are encouraged to periodically revisit this page to review the then current terms and conditions.
We grant you the right to use one copy of the software, product or service purchased, for testing and familiarization purposes. We also grant you the right to implement, install and use one copy of the software, product or service purchased on a single web site domain for use by one entity once the evaluation copy is removed / deleted.
By purchasing a product you are also subscribing to our periodic newsletter which will notify you of new software releases, updates and special offers. In accordance with United States and International anti-spamming laws, an unsubscribe link that removes you from all future mailings will accompany each e-mail notification.
For taxation purposes, we must keep accurate transaction and installation records. At the time of software installation, you will be asked to enter information such as your web site's domain name and your product's serial number. This information is used to validate copies of our software.
We reserve all rights. Written permission must be obtained from us before you may copy, reproduce, publish, modify or alter in any way, any media, software, documents or products, in part or in whole, contained within our web site or traded by us. All media, software, documents and products are the property of PerlScriptsJavaScripts.com. We retain ownership and copyright of software products purchased from us and all copies of the software. As a licensee you may make one copy of the software product solely for backup purposes. Removal of any copyright messages, publicly visible or otherwise without prior written permission from us is expressly forbidden. Unauthorized reproduction of any of our software, documents or products is prohibited by Federal and International laws and subject to criminal prosecution.
Any use of software and accompanying documentation on our Web site is subject to the terms of a software license agreement between you and us. You must read this license agreement in it's entirety and agree to it's terms prior to installing or using the software. All ownership rights and rights not implied are reserved. We reserve the right to revoke these permissions and terminate this agreement at anytime or at it's own discretion without reasonable notice. We reserve the right temporarily or permanently discontinue any software product or the support associated the product at anytime or at it's own discretion without reasonable notice. You agree and accept that we shall not be liable to you or to any third party for any such cessation.
You agree that any issue or dispute that may arise between PerlScriptsJavaScripts.com and yourself in respect to this web site or it's goods or services will be resolved and governed by and within the courts and laws of Melbourne Australia. If your local laws do not allow for such an agreement, you must delete all copies of products supplied to you by us and you are hereby notified of the termination of this license.
Getting Started / Adding Categories
Once you have installed and set up the script, log in to the program using the username and password you entered during the set up process and click on the "Settings" link in the admin control panel. Click on each of the gray colored links for a description of it's purpose. Enter your preferred settings (your FAQ Folder will be created for you if it does not exist), enter or edit the header and footer and press the "Save Settings" button. You can edit your settings, header and footer at any time (all existing FAQ pages will be updated) so just enter something simple for the moment.
Click on the "Summary" link in the control panel. If you chose to "Go to Manager after edits", you will already be on the Summary Page. To create your first Category / Page enter any name, a short description of what your visitor might find on that page and press the "Add new" button. See Figure 1 below.
The page will reload and the FAQ manager table will be in view. See Figure 2.
Summary Page
Exhibits the Category Manager and avenue to Question / Answer Manager. See Figure 1 and 2.
Sorting Categories
By default categories are sorted alphabetically left to right. While the second column (header of "P" for position) of the Category Manager has no values, categories will be sorted in the default order. To force a preferred order, enter numbers in the second column. Numbers entered do not need to be in sequence. You can enter multiples of 10 or leave large gaps between one number and the next.
Deleting Categories
Deleting a category will delete the file from your server. Questions contained within that category will no longer be visible on the web. Place a check mark (in column one Figure 2) beside all categories you wish to delete and press the "Submit" button. The script will detect any categories you have marked for deletion and ask you to confirm the action. See figure 3
Renaming Categories
On the "Summary" page, all existing categories are displayed in the Category Manager. Both category names and descriptions are displayed in form fields which can be edited. Type in your desired edits and press the "Submit" button. See Figure 2. All edits and deletions will be processed simultaneously.
Editing Categories
The Category Manager displays each existing category as a clickable link in column 3. Beside each name is the number of current questions contained within that category. See Figure 2. Click on the category you wish to edit to be taken to the Question Manager. All edits or changes and deletions will be processed simultaneously.
Sorting Questions
Questions can be sorted by entering a number in the small box provided in the left column of the Question Manager. See Figure 4 below. Numbers do not need to be entered in sequence. Enter number in multiples of 10 to make rearranging or inserting new questions an easier task.
Figure 4
Deleting Questions
Deleting a question will remove that question and it's answer from file. To delete a question, place a check mark in the small checkbox (see Figure 4) beside all questions you wish to delete and press the "Submit" button. There is no confirmation screen. All edits or changes and deletions will be processed simultaneously.
Resetting Feedback Stats
A summary of user feedback statistics is displayed on the "Summary" Page. To reset the Yes / No figures to 0 - 0, click on a category name. You will be taken to the Question Manager, where in the first row of the table you will see : The Category name, the category's statistics and a "Reset" link. Clicking on the Reset link will reset both the Yes and No figures to zero (0-0).
Editing / Adding Questions
From the "Summary" page, if you have created any categories, click on a Category name (column 3, see Figure 2). You will be taken to the Question Manager. To add a new question, type it in the first large rectangle under the gray link that reads "Add New Question". Type in an answer in the large box beneath it and press the button labelled "Click here to Add These questions", see Figure 4. Each time you add a new question, the page will be refreshed with an option to add another. Editing questions and answers is just as easy. Apply any edits or corrections to all questions and answers and press the button at the bottom of the form.
This program uses indexable static HTML files. The files are not created on the fly. This means your files and their content can be read and indexed by search engine spiders (robots), allowing your sites popularity to flourish. At the very top of the question manager, you may optionally enter a title, keywords and a description (meta tags). These are the most important factors, behind page content, to a spider. Choose your words carefully.
Printer Friendly Pages
To link to printer friendly pages, use the following link :
http://www.yourserver.com/path/faq.cgi?printit
Replace "yourserver" with your domain name and add the path to your copy of the faq.cgi script. The bold text is necessary. You can place this link your header so that it is printed to every page generated by the Build a FAQ Plus. It will know which page is to be printed by reading the "Referrer". It will even print search results.
In your "Settings", you can enter a header that should be used on all pages to be printed. You might want to add your logo or your web site address to the template. You can also enter the font that should be used to render the text.
Each Category also allows you to insert copy relevant to that category. You have the option to include this "header insert" in the printer versions.
Search Forms
The built in search engine accepts three types of searches. They are :
any
all
exact
with "any" being the default. You can change the default search type, by adding a hidden form field to your search form. Below is an example of a simple search form, with the default search set to "any" word. You could add this form to your "Header" in the "Settings" so that it's printed to every Build A FAQ Plus generated page.
<form action="http://www.yourserver.com/path/faq.cgi?search" method="post">
Search our FAQs <input type="Hidden" name="type" value="any">
<input type="Text" name="search" size="20">
<input type="Submit" value="Go" style="cursor:hand;font-weight:bold;">
</form>
Note the Hidden form field that sets the default search type. Note also, the field where search terms are entered must be named "search". Below is a more advanced search form, you might want to place this form in your "No matches" template. The "No matches" template is displayed if the search yielded no matches. This form gives the user the option to select the search type by way of radio buttons :
<form action="http://www.yourserver.com/path/faq.cgi?search" method="post">
Refined FAQ Search
<input type="Text" name="search" style="width:223px;">
<input type="Radio" name="type" value="any"> Any word
<input type="Radio" name="type" value="all"> All words
<input type="Radio" name="type" value="exact"> Exact phrase
<input type="Submit" value="Search" style="cursor:hand;font-weight:bold;width:223px;">
</form>
Custom Forms
Build a FAQ Plus allows you to create and use your own custom forms, as well as linking to the Built in Submit a Question Form. To link to the Built in form, point your browser to "faq.cgi?submit". E.g.
http://www.yourserver.com/cgi-bin/faq.cgi?submit
Be sure to enter your domain name and the correct path to the faq.cgi script. The path is the folder you uploaded the scripts to.
To use your own custom forms, load the Built in form in a browser and then view the source code. Use this source code as a starting base for your custom form. The required fields / attributes are :
a) The form's action
b) All the field names (must remain the same as the built in form) and
c) The hidden action tag ( <input type="Hidden" name="action" value="submit"> )
After you have created your custom form and optionally added your own additional custom form fields, save it as a HTML file (or what ever you like), upload it to your server and load it in a browser (such as Internet Explorer). Then test it.
Tip use the following format to name your custom fields :
<input type="Hidden" name="Date_of_Birth">
The above format uses underscores _ to separate words. Your custom fields are listed in the admin section underneath each question submitted. Build A FAQ will automatically replace the underscores with spaces, making the field name easier to read when reviewing questions.
N.B. Once a question has been dealt with, the custom data is lost. If you wish to retain custom data, we suggest you add it to the answer as either visible or HTML commented text.
Changing your password
Enables you to update or change the administration login details. Enter your current login details, enter your new login details and press the button labelled "Change Pass".
Settings
Controls file types, list types and folder files are housed in. Any edits made to this page update all existing files. To change the list type, select your preferred option from the menu and press the "Save Settings" button at the bottom of the page. All existing files will be automatically updated. Editing your header and footer templates will also update all existing files.
Changing the file extension, or renaming the folder will also updated all files. The web page that lists all categories will also be updated. However if you are linking to any of the files externally (from a page not generated by the program) you must manually update those links.
Collapsed Answers
FAQ pages can be displayed as either Exposed, Questions and Answers in full view, or as Collapsed, Answers hidden to save space on the page. To set your FAQ's display, while in the Admin section, click Settings and scroll down to the FAQ Page rendering sub-section.
Select your preferred display. If using Collapsed FAQs, you can define the bullet displayed to left of each Question and Answer. Both the Question Bullet and Answer Bullet fields accept HTML code, enabling you to use regular text or <img> tags. Here are some examples that can be used in either or both fields.
none would display a space if used in either one of the fields or flush both the Questions and Answers to the left if used in both fields.
<b>Q:</b> would display a bold Q:
<img src="/images/img.gif" border="0"> would display an image of your choice
or a space would left align the Answer with the Question if the Question had a bullet of any type. That is, there would be a space equal to the Question's bullet, on the left of the Answer.
In all cases, bullets, questions and answers are vertically aligned to the top of the table cell.
|
|
|
