RandText Pro 5.0 Installation Instructions
(last updated: February 22, 2008)
Please read these instructions
completely before beginning your installation. For
additional information about RandText Pro, please visit our FAQ
page.
Requirements
The RandText Pro scripts require the
below list. For additional information about SSI, please read
the Apache
SSI Tutorial. It contains lots of useful information, including
how to enable SSI on your server.
- Perl 5.0
- LWP:Simple module
- SSI enabled server
- JavaScript enabled
If you are upgrading from version 4.0
or earlier of RandText Pro, please be sure to read the instructions
in red. If you are installing RandText Pro for the first time, you
can skip the instructions in red.
The first step in converting
from any previous version of RandText (both Pro and Lite) is to create
a backup of all your *.dat files to your PC's hard drive. Don't delete
any of your current RandText scripts or folders until you are completely
satisfied with RandText Pro Ver 4.0.
If you are currently
using the free version of RandText (RandText Lite), you will
need to convert all *.dat files to the pro version. Instructions for
conversion can be found further down in this document.
If you are upgrading
from an earlier version of RandText Pro, it will NOT be necessary
to convert *.dat files. RandText Pro 5.0 accepts all version 4.0 (and
earlier) *.dat files.
Also, in order to take
advantage of all features associated with the upgraded html editor,
you will need to upload Fckeditor (Step 2 of the installation process).
RandText Pro version 5.0 has integrated the most current version of
FCKeditor (version 2.5.1) and is well worth using.
RandText Pro version
5.0 should always be installed on a new folder on your server. After
you are completely satisfied with the installation of version 5.0,
you can FTP your backed up *.dat files to the new (version 4.0) folder.
You can then either rename the version 5.0 folder to the previous
version name, or you can change all SSI references (in your html)
to point to the new version 5.0 folder. We recommend renaming folders,
as this takes less time and is more efficient. However, if you
rename the folder containing version 5.0, you will need to run the
rtinstall.pl script again and modify the first two variables to point
to the renamed folder. More on this later...
After unzipping the downloaded file,
you'll find three folders, "cgi-bin scripts", "FCKeditor"
and "userfiles". Please follow the following 2 step
installation process.
Step 1: Script
Installation
Folder "cgi-bin scripts" has
the following contents:
| File Name |
Description
|
Recommended Permissions
|
| randadmin.pl |
This is the admin center script. This script
is used to create, delete and edit the data files that will
contain the display text. |
755 |
| randtext.pl |
This is the display script that is called via
an SSI call from your web page. It analyzes the file being
passed and displays the correct text based on the file type |
755 |
| rthist.pl |
This is the Dynamic Dropdown Menu script that
is called via an SSI call from your web page. It analyzes the
file being passed and displays a dropdown menu that contains
a customized set of selection options. |
755 |
| rtinstall.pl |
This is the installation script that sets file
permissions, verifies that all scripts have been uploaded in
the proper format, and sets initial values for data paths, domain
names and headings. |
755 |
| rtsetup.lib |
Setup file that contains settings for above scripts |
644 |
| rtvariables.lib |
Setup file that contains customization information
for above scripts. This file is modified by rtinstall.pl
to define your server environment. |
644 |
| countdown.dat |
Sample countdown file |
644 |
| usdate.dat |
Sample U.S. format date file |
644 |
| intldate.dat |
Sample International format date file |
644 |
| altdays.txt |
Alternate day name file |
644 |
| altmonths.txt |
Alternate month name file |
644 |
-
Before FTP'ing, modify the location
of Perl in each of the *.pl files to point to perl on your server.
This is the first line in each *.pl file. Usually
this statement is in one of the following two formats. The
scripts are preset with the first format and our experience has
found that this format should work on the vast majority of servers.
(Please note: this is the only editing that any of the scripts
will require. All other script variables will be customized via
the rtinstall.pl script).
-
#!/usr/bin/perl
- #!/usr/local/bin/perl
-
You may need to rename the *.pl files
changing the file extensions from .pl to .cgi. This depends
on your server's requirements. If you need to make this change,
do it now.
-
Create a new folder in your cgi-bin
folder. This will be the folder that will contain your RandText
scripts. You could name it anything you want. After you have
created this folder, set the folder's permissions to 755.
-
FTP all of the scripts from the "cgi-bin
scripts" folder to the folder you created in step 3.
Be sure to FTP all scripts and files
in ASCII format.
-
Set the permission for the rtinstall.pl
script to 755
-
Run rtinstall.pl from your browser.
The URL to execute it will be
http://www.YOURDOMAIN.com/cgi-bin/MYFOLDER/rtinstall.pl.
All you need to do is replace YOURDOMAIN
with your domain name, and MYFOLDER
with the name of the new folder you created in step 3 (above).
-
If everything works properly, you should
be up and running in less than a minute.
-
If you have been using a free (RandText
Lite) version of RandText and have any existing *.dat files,
you can now upload these files to the folder created in step
3. After you complete the installation of
RandText Pro v5.0, you can convert the RandText Lite version files to
RandText Pro format one at a time via the randadmin.pl script. When
you edit an older file, the randadmin script will ask you if you
want to convert the file to the RandText Pro file format, or
if you would like to leave it in its current format.
- If you were upgrading from an earlier version of RandText Pro (4.0
or earlier), you can now upload your *.dat files to the folder created
in step 3. Any *.dat files created with a previous
version of RandText Pro do not need conversion.
- After you are satisfied with the installation, for security purposes,
be sure to delete the rtinstall.pl script from your server. The rtinstall.pl
script can be run as often as needed in order to correctly set up
the paths to the folders and scripts.
Step 2:
Html Editor (FCKeditor) Installation
In order to take advantage of the
WYSIWYG editor, you must be using one of the compatible browsers listed
below.
- IE 5.5+
- Firefox 1.5
- Safari 3+
- Opera 9.5+
Note for Opera: By default Opera is configured to not allow
scripts to receive right click events. The context menu will not work
because of this. To correct it, just enable this option in the Opera
settings: Tools (Menu) > Preferences... > Advanced (Tab) >
Content (Left List) > JavaScript Options... > Allow script to
receive right clicks (must be checked).
If you are using one of the compatible browsers, you
can install the html editor now. If you are not using a
compatible browser, you can either skip this step or you can
install it anyway. I would recommend installing FCKeditor,
regardless. Who knows, it might work anyway.
Installing FCKeditor requires the below three steps.
- FTP the FCKeditor folder directly to the root area of your web site.
If you're using CuteFTP or WS_FTP, all files and folder should be
automatically uploaded in the correct format (Ascii or Binary). There
is no need to "pre-create" a new folder in the root area,
as the FTP process should automatically create the FCKeditor folder
for you.
- FTP the userfiles folder directly to the root area of your web site.
Here again, there is no need to "pre-create" a new folder
in the root area, as the FTP process should automatically create the
userfiles folder for you.
- Activate the editor by setting the editor's customization variable
to ON. This can be done via the customization feature found
in the admin script. (see Customization section below).
That's it. The editor is now installed.
Miscellaneous Info about FCKeditor folders:
- FCKeditor folder- contains the JavaScript and miscellaneous
files that are needed to integrate a WYSIWYG html editor into RandText
Pro
- userfiles folder - contains folders that will be
needed to house uploaded images/flash for display in content files
The WYSIWYG editor will convert all standard <textarea>'s
used in the admin script into a WYSIWYG format, thereby simplifying
the process for creating dynamic html content. If you are not using
a compatible browser, all <textarea>'s will display as a standard
textarea.
Please note:
The html editor is not written by pointafter.com and is therefore not
maintained by us. It is written by www.fckeditor.net
and has been integrated into RandText Pro as a bonus feature without
any warranties as to its performance. According to the FCKeditor website,
Version 2.5.1 works with IE 5.5+, Firefox 1.5+, Safari 3+ and Opera
9.5+. If you're experiencing technical problems with the editor, we
will try to assist as much as possible to get the editor to work for
your installation, however, because the editor was not written by us,
we are limited beyond suggesting configuration options.
Installation problems/issues
| Problem: |
Admin script (randadmin.pl) repeatedly keeps asking
for your user id and password, even though you are certain that
the user id and password are correct. |
| Solution: |
This problem typically occurs immediately after you have completed
running rtinstall.pl. The most common cause is that you are running
a personal firewall (e.g., Norton Firewall). Please contact
us if you experience this problem and we will provide you
with a solution.
|
| |
|
Our experience has shown that installation
problems can vary. Checking your server's error logs can often
provide valuable information in terms of determining causes. Our experience
has show us that in some cases, tweaking file permissions will resolve
many issues, but we've also found situations where required perl modules
were not installed on servers.
If you are continuing to experience installation
problems, please contact
us and provide a detailed description of the problem you are experiencing.
We normally respond during the same business day, and always within
24 hours.
Or, if
you prefer, we will gladly install RandText Pro on your server at NO
extra charge. Once again, just contact
us and we will work with you to schedule your installation.
If you experience display problems or technical problems
when using the WYSIWYG html editor (FCKeditor), please verify that your
browser is included on the list of supported browsers for FCKeditor.
If after upgrading you continue to experience display problems, please
return to the Admin Center, select the Customize RandText option, and
set the html editor variable to OFF. We will try to assist as
much as possible to get the editor to work for your specific installation,
however, because the editor was not written by us, we are somewhat limited
beyond suggesting configuration options.
Customization
After you have RandText Pro up and running, you can customize
some of the visual aspects, such as background colors, table border
colors and table border sizes.
This customization is controlled via the
randadmin.pl script. At the bottom of the control panel is a radio button
for customization. Select this button and click submit.
The customization option will provide you with enough instructions and
information to complete your customization.
By default, the customization variable
for the html editor is set to OFF. If you installed the editor
and would like to use it, you must activate the editor by setting
this variable to ON. Otherwise, the admin script will display
standard <textarea>'s.
RTHIST.PL Script
- Display Historical Content
in a Dropdown Menu - This feature is a stand alone function
of the RTHIST.PL script. RTHIST.PL will dynamically create a dropdown
menu whose options are "click and go" links to previous
content. When an option is clicked on, RTHIST.PL will display the
selected record in a controlled popup window format. It can be used
with the following five file types (all of which are created by the
admin script) and will display text from previous days, weeks or months,
depending on the file type.
- Day of Week
- Day of Month
- Day of Year
- Week of Year
- Month of Year
The 'Day of Month' and 'Week of Year' menus will show month to date
and year to date elements. E.g., If the menu being created is for a
Day of Month file and you would like the menu to contain 10 elements,
the menu will not contain 10 elements until the 11th day of the month.
Prior to the 11th, the number of selection elements will be one less
than the current day of month. On the first of each month, a message
would be displayed to indicate that no historical data is available
The menus for the remaining file types will 'recycle' their data.
E.g., the Day of Year menu will always contain the number of elements
requested. In the case where you would like to display 10 menu elements
and the date is January 5th, the menu would display selections for January
4th through December 26th.
How to call the script:
The call to this script must must be inserted
twice in the html of your webpage, once in the <head> section,
and once in the <body> section. It performs two functions:
- When called with the type=head option, this script will
create the javascript function that is needed in the <head>
section of your webpage and controls the size, location and attributes
of the popup window. This javascript defines the following new browser
window parameters:
| Parameter |
Description |
Default Value
|
Required |
| width=nnn |
A numerical value that sets the width of the new window,
chrome and all |
200
|
no
|
| height=nnn |
A numerical value that sets the height of the new
window, chrome and all |
200
|
no
|
| scrollbars=yes/no |
Should the popup window scrollbars show? (Yes or No) |
no
|
no
|
| toolbar=yes/no |
Should the popup window toolbar menu show? (Yes or
No) |
no
|
no
|
| left=nn |
A numerical value that indicates popup window position
offset from the left of screen |
0
|
no
|
| top=nn |
A numerical value that indicates popup window position
offset from the top of screen |
0
|
no
|
An example of the correct format for this SSI call is:
<!--#include virtual="/cgi-bin/myfolder/rthist.pl?type=head&width=xx&height=xx&scrollbars=xx&toolbar=xx"-->
Browser window parameters that are not defined in the SSI call will
use their default values. Myfolder should be replaced with the name
of the folder that contains the RandText Pro scripts.
- When called with the type=menu option, this script will
create the dynamic dropdown menu that contains the "click and
go" links to prior content. This call must be placed in the <body>
of the html page at the location where the dropdown menu should appear.
The following table defines the parameters that apply when type=menu
is specified:
| Parameter |
Description |
Default Value
|
Required |
| file=yourfile.dat |
Identifies the file to use as input. File name must
be specified in filename.dat format and must be one of the valid
file types from the below table. |
None
|
Yes |
| links=nn |
This parameter overrides the default number of menu
options that will be created in the dropdown menu. The default varies
by file type. If the value specified in this parameter is greater
than the Max value in the below table, then the script will repace
the erroneous value with the max value. |
See below table
|
No |
| color=xxxxxx |
Defines the color of the font to use for the heading
in the popup. Colors can be specified by name or hex value. If hex
value is used, use the format color=ff0000. Do not put a
"#" in front of the hex value.
|
black
|
No |
| hfont=font face |
Defines the font to use for the heading in the popup |
Verdana
|
No |
| hsize=n |
Defines the size of the font to use for the heading
in the popup. The correct format for this parameter is hsize=xx,
where xx is the desired pixel size of font. |
14 px
|
No |
| bfont=font face |
Defines the font to use for the body section of the
popup. This will only be recognized if a font
is not specified in the RandText (*.dat) content file. |
Verdana
|
No |
| bsize=n |
Defines the size of the font to use for the body section
of the popup. The correct format for this
parameter is hsize=xx, where xx is the desired pixel size of font.
This will only be recognized if a font
is not specified in the RandText (*.dat) content file. |
10 px
|
No |
| bcolor=xxxxxx |
Defines the color of the font to use for the text
in the body of the popup. Colors can be specified by name or hex
value. If hex value is used, use the format color=ff0000.
Do not put a "#" in front of the hex value. |
blue
|
No |
| bkcolor=xxxxxx |
Defines the color of the font to use for the text
in the body of the popup. Colors can be specified by name or hex
value. If hex value is used, use the format color=ff0000.
Do not put a "#" in front of the hex value. |
white
|
No |
| Menu
Option Defaults by File Type |
| File Type |
Default Menu Options |
Max Menu Options |
Day of Week
(Dropdown menu will change daily)
|
6
|
6
|
Day of Month
(Dropdown menu will change daily)
|
10
|
31
|
Day of Year
(Dropdown menu will change daily) |
10
|
31
|
Week of Year
(Dropdown menu will change weekly)
|
10
|
25
|
Month of Year
(Dropdownmenu will change yearly)
|
11
|
11
|
An example of the correct format for the SSI call is:
<!--#include virtual="/cgi-bin/myfolder/rthist.pl?type=menu&file=yourfile.dat&links=nn&font=xxx&size=n&color=xxx"-->
Parameters that are not defined in the SSI call will use
their default values. Myfolder should
be replaced with the name of the folder that contains the RandText Pro
scripts.
* * *
For additional information about RandText Pro, please
see
our FAQ page.
Thank you for trying my product.
If I can be of any assistance to you regarding this script, its
installation or its use, please don't hesitate to contact
me.

George Prociuk
pointafter.com
|