|
Embedding SpellChecker Support into Ultimate Bulletin Board
Revision 05-26-2000
Download these instructions as PDF Document
The SpellChecker.net system provides powerful web based spell and grammar checking with easy set up and integration. Follow the steps to add the specified code into Ultimate Bulletin Board and you will begin reaping the benefits our SpellChecker offers!
To add SpellChecker support to your website, please follow
four steps:
- Register and receive a Customer ID
- Download the customized JavaScript
file
- Download the SPROXY.CGI script
file
- Modify the Bulletin Board code
| Register and
receive a
customerID | To register, please
go to the Sign Up page and fill out our
short form. We will send you an e-mail containing your
customerID. Please save this ID, as it will be required for
the rest of the installation. Top of page
| Download
the Customized JavaScript File
|
To download JavaScript file please login to "My Account" Section of the SpellChecker.net site using customerid and password sent to you in the registration email.
Click on the "Download JavaScript file" link. In the page opened click "Download" button to download the spch.js JavaScript file (please select "save to Disk" if prompted).
The JavaScript file contains information that is specific to each customer's web site, so it should not be used on or obtained from another site.
Top of page
| Download the
SPROXY.CGI Script
File | The sproxy.cgi script file is used to return the data corrected by
SpellChecker to the text-box on your web page. Top of page
STEP 1
Download the file "sproxy.cgi". Please login to "My Account" Section of the SpellChecker.net site using customerid and password sent to you in the registration email.
Please open "Download SPROXY.CGI script" page for currently supported versions of the file. Click on the "Download SPROXY script" link.
Top of
page
STEP 2 Copy the
file sproxy.cgi to the directory on your web site that has
permissions for script execution (for example /cgi-bin or
/scripts). If you downloaded Perl version of sproxy.cgi, open
the file in edit mode and change its first line according to
your perl interpreter location. This file is created to run on
UNIX systems and the first line will be "#!/usr/bin/perl". Windows users
should alter this line to reflect the perl location, for
example "#!c:/perl/bin/perl.exe" (note the forward
slashes).
Top of page
Can I use FTP to upload the sproxy.cgi file
to my web site? (If you have a perl script as the
sproxy.cgi file then this information pertains to
you.) If you do choose this method, be sure the entire
process is carried out and completed in ASCII Mode. Top of page
What if my web site is hosted by Linux
(Unix)? No problem, just don't forget to set the files
for the attributes of the sproxy.cgi to 755 (chmod 755
sproxy.cgi). Top of
page
| Modify the
Bulletin Board code |
To embed SpellChecker support for the cgi file, please use the following steps:
1. Locate the file named "postings.cgi". It should reside in cgi-bin directory of your UBB installation. This file may be named differently in your system. Create a copy of this file BEFORE making any changes!
2. Once the copy is in place, open the file for editing.
3. Header in Reply Form:
Find the lines:
print <<REPLYFORM;
<HTML><HEAD><TITLE>$BBName - Reply to Topic</TITLE>
$HeaderInsert
Insert the following line after this, replacing the your_url parameter with the actual url of the
folder on your server where you uploaded the
spch.js file
<script type="text/javascript" language="javascript"
src=http://your_url/spch.js></script>
After making this change, please verify the line that follows is:
</HEAD>
4. Button in Reply Form:
Approximately 80 lines further down, find the lines:
<INPUT TYPE="Submit" NAME="SUBMIT" VALUE="Submit Reply"> <INPUT TYPE="RESET" NAME="RESET" VALUE="Clear Fields">
Insert the following button code BEFORE the previous lines:
<INPUT TYPE="BUTTON" VALUE="Spell
Check" onclick="var f = document.forms[0]; doSpell ('LANGUAGE', f.ReplyMessage,
document.location.protocol + '//' + document.location.host +
'/CGIBIN/sproxy.cgi', true);">
Replace the following parameters within
the code.
LANGUAGE defines the language which will be used by SpellCheck engine. Change this parameter to one of the following values:
"en" - American
English
"uk" - British English
"fr" - French
"ge" - German
"it" - Italian
"sp" - Spanish
"dk" - Danish
"br" - Brazilian Portuguese
"nl" -- Dutch
"no" -- Norwegian
"pt" - Portuguese
"se" - Swedish
CGIBIN is the name of your virtual directory that will contain the file sproxy.cgi. Replace this string with your virtual directory name.
* If your virtual directory is own cgi directory of UUB, replace CGIBIN with $CGIBIN (this parameter is defined in UBB source code) string. For example:
<INPUT TYPE="BUTTON" VALUE="Spell Check" onclick="var f = document.forms[0]; doSpell ('en', f.ReplyMessage, '$CGIBIN/sproxy.cgi', true);">
*Ensure that this string does not contain any "document.location" entries.
5. Header in New Message Form:
Find the lines:
print <<FORM;
<HTML>
<HEAD>
<TITLE>$BBName - Post New Topic</TITLE>
$HeaderInsert
Insert the following line after them:
<script type="text/javascript" language="javascript"
src=http://your_url/spch.js></script>
your_url should be
replaced with the actual url of the folder on your server
where you uploaded the spch.js file.
Verify that the next line is:
</HEAD>
6. Button in New Message Form:
Approximately 80 lines further down, find the lines:
<INPUT TYPE="SUBMIT" NAME="Submit" VALUE="Submit New Topic">
<INPUT TYPE="RESET" NAME="Reset" VALUE="Clear Fields">
Insert the following button code BEFORE the previous lines:
<INPUT TYPE="BUTTON" VALUE="Spell
Check" onclick="var f = document.forms[0]; doSpell ('LANGUAGE', f.Message,
document.location.protocol + '//' + document.location.host +
'/CGIBIN/sproxy.cgi', true);">
7. Header in Edit Post Form:
Find the lines:
print <<EditFORM;
<HTML><HEAD>
<TITLE>
$BBName - Edit this post
</TITLE>
$HeaderInsert
Insert the
following line after them:
<script
type="text/javascript" language="javascript" src=http://your_url/spch.js></script>
your_url should be
replaced with the actual url of the folder on your server
where you uploaded the spch.js file.
Verify that the next line is:
</HEAD>
8. Button in Edit Post Form:
Approximately 80 lines further down, find the lines:
<INPUT TYPE="Submit" NAME="SUBMIT" VALUE="Submit Now">
<INPUT TYPE="RESET" NAME="RESET" VALUE="Clear Fields">
Insert the following button code BEFORE the previous lines:
<INPUT TYPE="BUTTON" VALUE="Spell
Check" onclick="var f = document.forms[0]; doSpell ('LANGUAGE', f.EditedMessage,
document.location.protocol + '//' + document.location.host +
'/CGIBIN/sproxy.cgi', true);">
Top of page
|