home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ftp.wwiv.com
/
ftp.wwiv.com.zip
/
ftp.wwiv.com
/
pub
/
EVENTS
/
RP_260.LZH
/
REGPRO.DOC
< prev
next >
Wrap
Text File
|
1992-11-15
|
52KB
|
1,093 lines
─────────────────────────────────────────────────────────────────────────────
The Definitive User Questionnaire/Online Entry Form Door!
▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄
▒▒█▀▒▒█ ▒▒█▀▀▀▀ ▒▒█▀▀▀▀ ▒▒█▀▒▒█ ▒▒█▀▒▒█ ▒▒█▀▒▒█
▒▒▒▒▒█▀ ▒▒▒▒▒▄ ▒▒█▒▒▒▄ ▒▒▒▒▒▒█ ▒▒▒▒▒█▀ ▒▒█ ▒▒█
▒▒█▀▒▒▄ ▒▒█▀▀▀ ▒▒█ ▒▒█ ▒▒█▀▀▀▀ ▒▒█▀▒▒▄ ▒▒█ ▒▒█
▒▒█ ▒▒█ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒█ ▒▒█ ▒▒█ ▒▒█ ▒▒▒▒▒▒█
▀▀ ▀▀ ▀▀▀▀▀▀ ▀▀▀▀▀▀ ▀▀ ▀▀ ▀▀ ▀▀▀▀▀▀
┌───────────────────────────────────────┐
▓███│ V E R S I O N 2 . 6 0 │▓███
│ │
▓███│ Release Date 14 Nov 1992 │▓███
└───────────────────────────────────────┘
(C) 1991, 1992 Cairo Research Labs
ALL RIGHTS RESERVED
─────────────────────────────────────────────────────────────────────────────
┌───────────────────────┐
▄│ Table of Contents │
█└───────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
1. INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . .
Words From the Authors . . . . . . . . . . . . . . . . . .
Features . . . . . . . . . . . . . . . . . . . . . . . . .
What's New in This Release?. . . . . . . . . . . . . . . .
Licensing and Distribution . . . . . . . . . . . . . . . .
The Demo Version . . . . . . . . . . . . . . . . . . . . .
Benefits of Registering. . . . . . . . . . . . . . . . . .
Ordering RegPRO. . . . . . . . . . . . . . . . . . . . . .
2. GETTING STARTED . . . . . . . . . . . . . . . . . . . . . .
System Requirements . . . . . . . . . . . . . . . . . . .
Installation . . . . . . . . . . . . . . . . . . . . . . .
3. OPERATION. . . . . . . . . . . . . . . . . . . . . . . . . .
Control File Options . . . . . . . . . . . . . . . . . . .
Basic Questionnaire Definitions. . . . . . . . . . . . . .
Field Flags and Settings . . . . . . . . . . . . . . . . .
Format Masks (Strings) . . . . . . . . . . . . . . . . . .
User Edit Keys . . . . . . . . . . . . . . . . . . . . . .
Sysop Keys . . . . . . . . . . . . . . . . . . . . . . . .
Command Line . . . . . . . . . . . . . . . . . . . . . . .
4. MISCELLANEOUS. . . . . . . . . . . . . . . . . . . . . . . .
Tips on Designing RegPRO Screens . . . . . . . . . . . . .
What's Next? . . . . . . . . . . . . . . . . . . . . . . .
Special Thanks . . . . . . . . . . . . . . . . . . . . . .
Upgrades and Information . . . . . . . . . . . . . . . . .
────────────────────────────────────────────────────────────────────────────
■ INTRODUCTION ■
────────────────────────────────────────────────────────────────────────────
RegPRO is a user questionnaire door for use with most major BBS systems.
Although there are several questionnaire doors available today, we think you
will find RegPRO to be quite a bit different.
┌───────────────────────────┐
▄│ Word From The Authors │
█└───────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
RegPRO started out as a wimpy little questionnaire door, which ran only in
line mode. Since it's creation, we have received quite a bit of positive
feedback from users around the world, and have done our best to incorporate
user suggestions and enhancements into the package.
Currently, the RegPRO Screen Designer (RSD) is under development. This is
but one of the many enhancements and additions planned for the RegPRO system.
Care to show your questionnaires off to the rest of the world? Send them
our way! If we like it, we may even include in the SAMPLE.ZIP archive, for
the next release of RegPRO!
Should you experience any problems with the RegPRO system, by all means,
get in touch with us! We can be found in the DOORWARE echo, as well as on
our support BBS (see end of this documentation for more information on how
to get in touch with us).
┌─────────────┐
▄│ Features │
█└─────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀
RegPRO didn't become the world's premier user questionnaire door for nothing!
It's features include:
* Custom entry forms, complete with custom fields, formatting masks,
and much more! (Requires ANSI)
* Complete support for ASCII users as well.
* Multinode Compatible!
* DESQview aware!
* The most configureable questionnaire door around!
┌────────────────────────────────┐
▄│ What's New in This Release? │
█└────────────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
* If you do not define your fields long enough to hold a metavariable
RegPRO would blow up with an error. The documentation and sample
.CTL files have been adjusted to cover this area.
* Added ability to "overlay" forms on top of ANSI screens, adding
dramatic effects to your forms. This is now demonstrated in the
sample enclosed in the distribution archive.
* Added ability to generate customized logfile names. The default
logfile name is still REGPROx.LOG.
* New BBS drop file formats supported:
- QBBS 2.75 EXITINFO.BBS
- Remote Access Extended EXITINFO.BBS
* Two new metavariables added: User's Handle (&HANDLE)
User's Password (&PASSWORD)
* RegPRO now stores the current directory upon entry, and will
restore it upon exit.
* RegPRO now makes use of its own environment variable to find its
data and system files (SET REGPRO=C:\DOORS\REGPRO, etc).
┌────────────────────────────────┐
▄│ Licensing and Distribution │
█└────────────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
This documentation, programs, and other files distributed in this software
package (the "Software") are the copyrighted property of Scott Burkett,
Christopher Brown, and Cairo Research Labs. All rights are reserved.
For use by corporations, institutions or goverment agencies, or for-profit
purposes, contact the Author for licensing information.
U.S. GOVERNMENT INFORMATION
The use, duplication, or disclosure by the U.S. Government of the Software
is subject to the restricted rights applicable to commercial software that
are specified in the subdivision (b.3.ii) of the 'Rights in Technical Data
and Computer Software' clause, document DFARS 52.227-7013.
DISTRIBUTION/USAGE
RegPRO can be freely distributed, provided that the original archive
is not changed in any way (other than changing the archive type) and no
amount of money is required. In no circumstance at all can RegPRO be
modified without written consent from the authors. It is prohibited too
to include this program, whole or in part, in other software. It is
expressly forbidden to distribute a registered key to unregistered users.
RegPRO can be used in commercial organizations only after regular
registration.
This license is considered accepted if the program is used. Its violation
will involve the withdrawal of the registration key and the rights to use
the program.
WARRANTY DISCLAIMER
The Author cannot and does not warrant that any functions contained in the
Software will meet your requirements, or that its operations will be error
free. The entire risk as to the Software performance or quality, or both,
is solely with the user and not the Author. You assume responsibility for
the selection of the program to achieve your intended results, and for the
installation, use, and results obtained from the Software.
The Author makes no warranty, either implied or expressed, including with-
out limitation any warranty with respect to this Software documented here,
its quality, performance, or fitness for a particular purpose. In no event
shall the Author be liable to you for damages, whether direct or indirect,
incidental, special, or consequential arising out the use of or any defect
in the Software, even if the Author has been advised of the possibility of
such damages, or for any claim by any other party.
All other warranties of any kind, either express or implied, including but
not limited to the implied warranties of merchantability and fitness for a
particular purpose, are expressly excluded.
LIMITATION OF REMEDIES
The information contained in the documentation for the Software is subject
to change without notice.
The Author's entire liability, and your exclusive remedy shall be: (1) the
replacement of an original Software diskette not meeting the above Limited
Warranty and which is returned to the Author along with proof of purchase,
or (2), if the Author is unable to deliver a replacement diskette which is
free of defects, you may terminate the License Agreement by returning this
Software and the corresponding license fee will be returned.
By using the Software, you acknowledge (1) to have read and understood all
parts of this document and (2) to have agreed with and accepted all of its
provisions without any reservation.
Scott Burkett
Christopher Brown,
Cairo Research Labs
┌──────────────────────────────┐
▄│ Benefits of Registration │
█└──────────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
Benefits of registering RegPRO:
o Extended Tech Support via the SPHINX echo (our support echo).
o You will also be entitled to free upgrades to newer versions of
RegPRO, as they become available. In addition to the great
many features and the quality that this version of RegPRO has
to offer, we are currently working on several additions and
enhancements for future versions.
o The price! Compared to the other, higher-priced, questionnaire
doors, You will find that RegPRO is quite a bit cheaper, and a lot
more powerful. Most of these doors range in price from $15 to $25,
and are no where near as powerful as RegPRO. For only $10, you
can outperform them all!
┌─────────────────────┐
▄│ Ordering RegPRO │
█└─────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
Below are detailed instructions for registering RegPRO. These
instructions are not intended to seem confusing or complicated; they are
simply meant to answer almost any question that you might have about
registering. If you have any questions or uncertainties about your
registration, please feel free to contact us. For information on how to
contact us, please see the section on "Upgrades and Information".
To order RegPRO, simply follow these three steps:
1.) Fill out the registration form. Information on filling out
the form is located in the next section.
2.) Enclose the appropriate payment ($10), Ten American Dollars,
payable in the form of cash, check or money order. Make all checks
or money orders payable to: SCOTT BURKETT
3.) Send the above two items to:
Cairo Research Labs
1113 29th Street
Columbus, GA 31904
FILLING OUT THE REGISTRATION FORM
--------------------------------------------------------------------------------
NO PRINTER? Alternatively, if you do not have a printer, simply send a
hand-drawn version of the order form. If you do not wish to
mail a registration form in, you may opt to upload it to our
support BBS at (706) 596-8126 (9600v.32). We will not present
you with a registration key, however, until proper payment
has been rendered.
If you have any special instructions for us, or anything that
you would like to say when you register, feel free to write
this down on the back of the registration form, or on a
separate piece of paper.
When filling out the RegPRO registration form, be sure to
indicate how you would prefer to receive your RegPRO
registration key. You will have the choice of receiving your
registration key by one of three means: A call to our BBS,
FidoNet CrashMail, or by a call to your BBS. If you have a
FidoNet Email address, FidoNet CrashMail is still by far the
quickest way to receive your order. Once you have decided
which means you would prefer to receive your order by, please
read the detailed instructions on your order method below.
--------------------------------------------------------------------------------
RECEIVING In order to receive your RegPRO registration key by a
BY CALL message and/or upload to your BBS, fill out the order form and
TO BBS mail it along with your payment as described below. Be sure to
include the phone number, baud rate, and our login and
password for the BBS to which you would like us to call. We
will cover any long distance costs. If, for some reason, we
are unable to connect to your BBS (not because it busy, but,
for example, if your BBS is no longer online), we will place
your key in a message on our support BBS.
--------------------------------------------------------------------------------
RECEIVING In order to receive your RegPRO registration key via
ORDER BY FidoNet CrashMail, simply fill out the order form and mail it
FIDONET along with your payment as described below. Be sure to
CRASHMAIL include the FidoNet node address to which you wish to have
your order sent.
────────────────────────────────────────────────────────────────────────────
■ GETTING STARTED ■
────────────────────────────────────────────────────────────────────────────
RegPRO is a snap to get up and running (as you will see).
┌────────────────────────┐
▄│ System Requirements │
█└────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
RegPRO was designed for use with IBM compatible personal computer systems,
with 640K minimum RAM. It will run under most popular BBS packages, to
include RemoteAccess, Maximus, SuperBBS, QuickBBS, GAP, PCBoard, WildCat!,
WWIV, and others.
┌─────────────────┐
▄│ Installation │
█└─────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
First things first:
Create a directory to hold the RegPRO system. We recommend using something
like C:\REGPRO. Next, copy the RP_260.EXE file into the directory
and type "RP_260" at the DOS prompt. The archive is self-extracting and will
come apart without much effort.
** Note: Your source for obtaining the RegPRO archive may have changed
the format of the archive to one suitable for use on their system (i.e. ZIP,
LZH, ARJ, etc).
Next thing on the list is to set the REGPRO environment variable to the path
of the RegPRO files. Place a SET command in your autoexec.bat file:
example: SET REGPRO=C:\REGPRO
The directory specified by the REGPRO environment variable is utilized by
RegPRO to find it's files (registration key, data files, questionnaire files,
etc). This environment variable must be set in order for RegPRO to operate
efficiently.
────────────────────────────────────────────────────────────────────────────
■ OPERATION ■
────────────────────────────────────────────────────────────────────────────
If the user is using ANSI mode, he will be presented with a full screen,
customized entry form. He will have full range of movement between fields
by using either TAB/SHIFT-TAB or his cursor keys to maneuver. While editing
in each field, he will have a complete range of editing keys at his disposal.
Of course, if the user is in ASCII mode, then RegPro 2.0 will operate in
much the same manner that v1.10 did, i.e. in line mode.
Each questionnaire you will design will require a separate .CTL file. Each
of these control files will include a complete form definition for your
custom entry forms and questionnaires. This is where RegPRO begins to shine
over other questionnaire doors.
┌──────────────────────────┐
▄│ Control File Options │
█└──────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
Here we will discuss each of the parameters and options in more detail:
LOGPATH This option simply specifies where each questionnaire answer
file will be placed. The logfile will be in the format of
"REGPROxx.LOG", where "xx" is the node number.
i.e. LOGPATH C:\BBS\LOGS
LOGNAME This option will specify the name of the questionnaire answer
file that will be created for this form. You may use the '#'
symbol to substitute the node number, thus allowing separate
log files for each node of your BBS. If this keyword isn't
specified, then the a default logfile name of REGPROx.LOG
will be created, with 'x' being the node number.
i.e. LOGNAME NEWUSER#.LOG
LINKFORM This keyword instructs RegPRO to go directly into another
entry form when the user is finished with the current one.
This is extremely handy for processing longer sets of entry
forms, or, if you have a lot of text associated with each
field, you can put each of the fields in a separate form!
i.e. LINKFORM NEWUSER2
** NOTE ** Do not put an extension on the end of the name of
the form to link to! RegPRO assumes .CTL with these forms,
just as it does with the primary form.
DOORTYPE This option will specify the type of dropfile your BBS is
using to call RegPRO. Valid parameters include:
DORINFO = DORINFO?.DEF (Standard DORINFOx.DEF Drop file)
EXITINFO = EXITINFO.BBS (RA v.01 - v.04)
RA1EXITINFO = EXITINFO.BBS (Extended (RA v1.0 or greater))
CHAIN = CHAIN.TXT (WWIV)
SFDOORS = SFDOORS.DAT (SpitFire BBS)
CALLINFO = CALLINFO.BBS (WildCat!)
DOORSYS = DOOR.SYS (GAP/PC-Board)
QBBS275 = EXITINFO.BBS (QBBS 2.75 or greater)
i.e. DOORTYPE CALLINFO
SHOWBEFORE These two keywords allow you to specify ANSI/ASCII screens
SHOWAFTER to display to the online user either before or after form
processing begins. You may have up to 5 each, per form.
Examples of these keywords can be found in the SAMPLE.ZIP
archive.
i.e. SHOWBEFORE WELCOME
i.e. SHOWAFTER THANKS
** NOTE ** Do not include an extension, as RegPRO will make
the determination of the extension based on the user's ANSI
setting. RegPRO will expect both an .ANS and an .ASC version
of the screens in the RegPRO directory.
OVERLAY This option will simply display an ANSI file to both the
local and remote screens, right before the form is displayed
and processed. This allows you to place "freetext" on the
screen, independant of the form fields themselves. By using
this method, you can create some rather elaborate screen
designs, as demonstrated in the RegPRO newuser sample setup.
i.e. OVERLAY TEMPLATE
** NOTE ** No .ANS extension is necessary, since this option
will only affect ANSI users.
USEBUTTONS When the user reaches the bottom of the form, a "button"
will appear. This button can contain whatever text you wish
to specify, and will serve as a last chance for the user to
make changes to his entries. ** BUTTONS ARE ONLY ACTIVE
IF THE USER IS IN ANSI MODE! **
Place the USEBUTTONS keyword in your .CTL file to enable
this option. If the user has skipped a field marked as
"unskippable", then pressing ENTER at the button will not
complete the form, rather, RegPRO will place the user at
the first skipped field. RegPRO will *NEVER* process a form
if there are unskippable fields which are empty.
Currently, the only place that RegPRO supports buttons is at
the end of your form (it is actually considered as the last
field of your form, internally). However, there are plans
to provide configureable buttons for your customization.
BUTTONTYPE This keyword specifies which style of buttons you wish to
use. Note that this (nor any of the other BUTTON keywords)
will have no effect unless the USEBUTTONS keyword is enabled.
1 -┌──────────┐
└──────────┘
2 -╒══════════╕
╘══════════╛
3 -╓──────────╖
╙──────────╜
4 -╔══════════╗
╚══════════╝
5 -Metallic Boxes (Try these!)
i.e. BUTTONSTYLE 3
BUTTONCOLORx This set of keywords will define the color attributes for
the button.
BUTTONCOLOR1 - Color of the border on the button
BUTTONCOLOR2 - Only used when Mettalic Boxes are in effect
BUTTONCOLOR3 - Normal Button Text Color
BUTTONHILITE - Highlighted Button Text Color
(examples:)
BUTTONCOLOR1 25
BUTTONCOLOR2 16
BUTTONCOLOR3 25
BUTTONHILITE 31
** The values for the colors are contained in the sample
control file! **
BUTTONTEXT This option specifies the text to display on the button
itself.
i.e. BUTTONTEXT Continue?
BUTTONROW These two keywords specify the row and column that the
BUTTONCOL button will appear when the user hits the bottom of the
form. It may appear anywhere on the display.
i.e. BUTTONROW 16
BUTTONCOL 25
┌────────────────────────────────┐
▄│ Basic Question Definitions │
█└────────────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
Each question (or field) you design for use with RegPRO can be completely
customized. Please note that most of these customizations will only be in
effect if the user is in ANSI mode. This is due to the fact that RegPRO
uses ANSI control sequences heavily in order to allow a full range of
movement within your form or questionnaire.
Each field definition begins with the FIELDDEF keyword and ends with the
ENDDEF keyword. All customization options will appear between the two
keywords (for each field).
QROW This specifies the physical row on the screen at which the
field will appear (normally 1 through 25).
i.e. QROW 5
QCOL This specifies the physical column on the screen at which
the field will appear (normally 1 through 80);
i.e. QCOL 1
QCOLOR This is the color of the question text for this field.
i.e. QCOLOR 14
QDESC This is the actual text associated with this field.
i.e. QDESC Enter your Real Name Please:
You may specify this keyword up to 20 times per field, to
provide multiline question descriptions.
i.e. QDESC Now, you must enter your real name!
QDESC Please be honest!
AROW These three keywords are used to determine the row and column
ACOL for the actual entry field. The AROW and ACOL keywords are
AFTER used in the same format as the QROW and QCOL keywords above.
The AFTER keyword is a little shortcut, which comes in handy.
Most of your fields will look something like this:
Enter your Name: ▒▒▒▒▒▒▒▒▒▒▒▒▒
By specifying the AFTER keyword, the actual entry field will
be placed one character following your field text, thus
saving you from having to figure out the coordinates
yourself.
ACOLOR This keyword designates the color of the user's answers,
while it is *NOT* the current field.
i.e. ACOLOR 10
HILITE This keyword designates the color of the entry field and
text while the user is editing a field.
i.e. HILITE 15
FILL This particular keyword allows you to specify the "fill"
character for each entry field. You can achieve some pretty
nifty efffects with this one. To get high speed entry fields
which look like:
City: ▒▒▒▒▒▒▒▒▒▒▒▒▒
Simply place:
FILL ▒
in your control file! ;-)
FORMAT This field is used to specify a "format mask" for the field.
You may have seen some BBS doors or DOS applications which
have entry fields like:
Home Phone: (123)456-7890
With this keyword, your online questionnaires can have them
too! Another section in the manual will cover this in a
bit more detail. But for now, just remember that it is
available for you.
┌──────────────────────────────┐
▄│ Field Flags and Settings │
█└──────────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
Each of your entry fields can have a certain number of "flags", or settings,
associated with them. Here they are:
NORMAL This keyword is the default setting, which specifies that no
other active flags are active. This is only useful if you
have only one field, since most entry forms will contain
several fields, which will be edited in an entry form style.
NOREDRAW When set, prevents RegPRO from re-drawing the input string
and field when it starts up and exits. If you set this flag,
the ACOLOR and HILITE color should contain the same value.
If your FILL character is not a space (default), you must
use this keyword on the field, so that RegPRO can draw the
background for you. Also, if you are using the EDITSTRING
keyword (allows you to specify default answers), you must
use this keyword so that RegPRO can display the text as the
user enters the field.
FIELDMODE Setting this flag specifies that RegPRO should operate in
"field" input mode. In field input mode, the user may finish
entering their input by pressing the previous field or next
field button (arrow keys, tab keys, etc.), as described later.
If you do not specify this field, then RegPRO will assume
that the current field is the ONLY field. Since most of
your entry forms will contain more than one field, you
really have no need for this one.
NOWIPEOUT This flag will stop RegPRO from "wiping" out fields as the
user moves back and forth between them. There is really
no practical reason to leave it out.
EDITEXISTING Setting this flag specifies that this field will contain a
pre-existing string, instead of starting with a blank string.
This string may contain whatever you like. The NOWIPEOUT
flag will have no effect on fields with this flag turned on,
since these fields are automatically set for "no wipeout".
i.e. EDITEXISTING Be Honest!
Starting with version 2.20, you may also use "metavariables"
with the EDITEXISTING flag. Metavariables provide a handy
way of stuffing your entry fields with default values from
your BBS. Currently the following metavariables are
supported:
Metavariable Meaning
-----------------------------------------
|
&NAME | Name of current online user
&LOCATION | Location of current online user
&SYSOP | Name of Sysop (you!)
&SYSTEMNAME | Name of your BBS
&PASSWORD | User's Current Password
&HANDLE | User's Handle or Alias
You use these metavariables just as you would any other
default string:
i.e. EDITEXISTING &SYSOP
** NOTE ** If the field format mask is not long enough to
contain the entire metavariable, then RegPRO will produce
an error message and exit. For example, if you had a field
called "City:", and its format was "*****", you would get
an error when the user moves into the field. As you can see,
5 characters (*****) is not long enough to hold a normal
user location field. Here are some recommended field
lengths:
&NAME - 39
&LOCATION - 25
&SYSOP - 39
&SYSTEMNAME - 39
&PASSWORD - 15
&HANDLE - 35
Note that these lengths correspond to the maximum length
allowed by RegPRO's dropfile handling system. Should you
deviate any shorter than these lengths, you may run into
a problem.
** NOTE ** Some of the metavariables may not be available
for your BBS type. This is dependant upon which type of
BBS drop file your BBS supports.
More metavariables will be added in future releases.
STRICTINPUT Setting this flag causes the field to operate in "strict"
input mode, which may be desirable if your input format
contains more than one type of input. Normally, if you
were inputting such a string, the user would be able to
move to the middle of the string, and insert any text.
Doing so would cause the rest of the input line to shift
right. However, in cases where your format string specifies
different types of characters to be permitted in different
positions, this can cause the input to be changed so that it
no longer conforms to the format string. In this case, the
user's input will no longer be valid, and the user will not
be able to exit the function by pressing [ENTER] until they
change their input. However, when strict input mode is
turned on, RegPRO will restrict the ways in which the user
is permitted to edit the string, to prevent just such a
case from occurring.
PASSWORDMODE Setting this flag causes the field to operate in password
mode. In password mode, the characters typed by the user
will be hidden, displayed instead as the blank character
specified in the FILL parameter.
FORCEFILL When set, this flag will force the user to enter a string
that fills the entire length of the format string. Normally,
the user will be able to enter a string of any length up to
the maximum length specified by the format string. However in
some cases, such as when inputting a date, you will want to
have the input field filled.
AUTODELETE When set, along with the EDITEXISTING flag, this flag will
activate the auto-delete feature of the field. When AUTODELETE
is active, if the first key pressed by the user is not an
edit control key, the existing text will be automatically
deleted, and a totally new string accepted from the user. This
could be useful when you are allowing the user to go back to
edit a previous input. If the user wishes to only change part
of the old entry, they can move the cursor to the location
where they wish to make the change, and perform their editing.
However, if the user wishes to completely replace the old
string with a new one, they can simply begin to type, and the
old string will automatically be deleted, and the new string
accepted.
NOSKIP This flag will inform RegPRO that this field should not be
skipped at all. In other words, the user will not be able
to exit the form, without entering data in this field. If
the users tries to leave the form, and there are skipped
fields with this flag set still empty, the user will be
placed in the first "unskippable" field.
KEEPBACKGROUND Normally, RegPRO will only display the input field background
FILL characters while the user is editing the string, and
will remove it when the user goes to the next field. However,
you may wish to continue having this field displayed after
input has taken place, and the next field has been called.
In this case, setting this flag will cause the background
characters to remain visible after input has finished.
PERMALITERAL When the format string contains literal characters (such as
forcing a ':' character to be added to a time input by using
the format string "##':'##':'##", the field can operate in
one of two modes. In the default mode, the literal characters
will only be displayed when they have been automatically
added to the string. For instance, if you were inputting the
current time using the above format string, this mode would
result in the input field initially being blank. When the
user types the first digit of the time, that number would
appear. When the user types the second digit of the time,
that number will appear, and then the colon character will
automatically be added by RegPRO. However, you can also set
field to operate in "Permaliteral" mode, by setting this
flag. When the PERMALITERAL flag is set, the input field
will initially contain the literal characters (ie, the colons
in our example), with the cursor still located at the
leftmost position in the input field. In this mode, the
literal characters become a permanent part of the input
field, and can not be moved or deleted by the user - instead
the cursor simply skips over the literal character's position.
┌────────────────────────────┐
▄│ Format Masks (Strings) │
█└────────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
In specifying the format string, not only do you specify the length of the
input field, but you can also force the user's input into certain formats.
For example, if you wished to input a North American style phone number, you
could use a format string of "###-###-####". Then regardless of whether the
user typed any dash character or not, their input would be converted, as they
type, to the format of the phone number 613-526-4466. You could also specify
a format string such of "MMMMMMMMMMMMMMMMMMMMMMMMMMMMMM", which would permit
the user to enter a name of up to 30 characters. RegPRO would then
automatically capitalize the name, so that the first character of each word
is capitalized, and the remaining characters of the word are in lower case.
Even if the user were to move the cursor to the middle of the string they
had entered, and add or delete a space (and thus either make one word two
or two words one), RegPRO will re-format the string to reflect the change.
The valid characters for the format string, along with their meanings, are
listed below. Note that the format string is NOT case sensitive (except for
literal strings delimited by the '' or "" characters), and space characters
can be added at any point to increase legibility.
# Indicates that numeric characters from '0' to '9' are valid
for this position.
% Indicates that numeric characters from '0' to '9', and the
space character (' ') are valid for this position.
9 Indicates that numeric characters from '0' to '9', along
with '.', '-' and '+' are valid for this position. This
format style is intended for floating-point numeric input.
? Indicates that any character is valid for this position.
* Indicates that any printable character, from ASCII 32 to
ASCII 127, is valid for this position.
A Indicates that alphabetical characters 'A' to 'Z', 'a' to
'z' and space (' ') are valid for this position.
C Indicates that city name characters are valid for this
position. As with the 'M' format character, words are
automatically capitalized so that the first letter is in
upper case, and all subsequent letters are in lower case. In
addition to permitting alphabetical characters and the space
(' ') character, the ',' and '.' characters are also
accepted in this position.
D Indicates that date characters '0' to '9', '-' and '/' are
valid for this position.
F Indicates that MS-DOS filename characters are valid for this
position.
H Indicates that hexidecimal character '0' to '9', 'A' to 'F'
and 'a' to 'f' are valid for this position.
L Indicates that only lower case alphabetical characters 'a'
to 'z', and the space (' ') character is valid for this
position. However, if the user attempts to enter an upper
case alphabetical character in this position, it will
automatically be converted to the lower case equivalent.
M Indicates that name characters are valid for this position.
These characters are the alphabetical characters 'A' to 'Z',
'a' to 'z', and the space character (' '). A character's
case is converted such that the first character of a word is
in upper case, and all other letters are in lower case.
T Indicates that telephone number character '0' to '9', '(',
')', '-' and ' ' are valid for this position.
U Indicates that only upper case alphabetical characters 'A'
to 'Z', and the space (' ') character is valid for this
position. However, if the user attempts to enter a lower
case alphabetical character in this position, it will
automatically be converted to the upper case equivalent.
W Indicates that MS-DOS filename characters are permitted in
this position, including the '*' and '?' wildcard
characters.
X Indicates that alphanumeric characters 'A' to 'Z', 'a' to
'z', '0' to '9' and ' ' are valid for this position.
Y Indicates that yes/no characters 'Y', 'N', 'y', 'n' are
valid for this position. The characters are automatically
converted to upper case.
' Single quotes can be used to specify sequences of
characters that should appear at the same location in the
input string (referred to elsewhere as "literal strings").
When the user is entering the string, these characters are
automatically supplied, and the user is not required to type
them. Literal strings must begin and end with the same quote
character.
┌────────────────────┐
▄│ User Edit Keys │
█└────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
As mentioned above, RegPRO provides advanced field editing, such as inputting
inputting and deleting text from the middle of the string. The edit keys are
are listed below. Note that some of these may or may not be available,
depending upon the capabilities of the user's terminal program. While there
is no single standard used for the transmission of special edit keys such as
the arrow keys, RegPRO makes as much effort as possible to make all of the
edit features available to most terminal programs. Many of the edit keys
can be accessed using either [CONTROL]-key combinations or special keys
such as the arrow keys, delete key, and so on. RegPRO will recognize most of
these special control keys when sent as either an ANSI control sequence
(which is sent by most terminal programs), or as a DoorWay style scan
code / ASCII code sequence (which is also available from many terminal
programs, but is not usually required). The RegPRO field edit keys are as
follows. Note that all edit functions are always available from the local
keyboard.
HOME - Moves the cursor to the beginning of the line being
edited. Press the [HOME] key, either in DoorWay mode or
from the local keyboard.
END - Moves the cursor to the end of the line being edited. Press
the [END] key, either in DoorWay mode or from the local
keyboard.
DELETE CHARACTER - Deletes the character under the cursor. Press
[DELete] on the local keyboard, in DoorWay mode, and
under many terminal programs without DoorWay mode.
Alternatively, press [CONTROL]-[G].
BACKSPACE - Deletes the character left of the cursor. Press
[BACKSPACE] or [CONTROL]-[H].
TOGGLE INSERT MODE - Switches RegPRO between between INSERT mode and
OVERWRITE mode. Press [INSert], either in DoorWay mode, or
from the local keyboard. Alternatively, press [CONTROL]-[V].
CURSOR LEFT - Moves the cursor left one character. Press [LEFT
ARROW] on the local keyboard, in DoorWay mode, and
under many terminal programs without DoorWay mode.
Alternatively, press [CONTROL]-[S].
CURSOR RIGHT - Moves the cursor right one character. Press [RIGHT
ARROW] on the local keyboard, in DoorWay mode, and
under many terminal programs without DoorWay mode.
Alternatively, press [CONTROL]-[D].
ERASE ENTIRE LINE - Press [CONTROL]-[Y].
ACCEPT INPUT - Press the [ENTER] / [RETURN] line to accept the
input. Alternatively, press [CONTROL]-[Z]. Note that
this key will only work when the current input is
"valid" (ie, it conforms to the format string, which is
described below)
NEXT FIELD - If enabled, allows the user to move to the next
field in a form. Press [DOWN ARROW] in DoorWay mode and
under many terminal programs without DoorWay mode.
Alternatively, press [TAB]. Note that the [DOWN ARROW]
key is NOT usually available from the local keyboard,
as it is usually used to adjust the user's remaining time.
PREVIOUS FIELD - If enabled, allows the user to move to the
previous field in a form. Press [UP ARROW]
in DoorWay mode and under many terminal programs
without DoorWay mode. Alternatively, press [SHIFT]-
[TAB] on the local keyboard or in DoorWay mode. Again,
note that the [UP ARROW] key is NOT usually available
from the local keyboard, as it is usually used to
adjust the user's remaining time.
┌────────────────┐
▄│ Sysop Keys │
█└────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
There are several options available to the Sysop while the user is in the
RegPRO Door. Keep in mind that not all of these keys may be useful under
certain BBS systems.
[UP]/[DOWN] - Use the arrow keys to increase or decrease the
amount of time which the user has left in the door.
[Alt]-[C] - Allows the sysop to break into chat with the user
at any time. [Alt]-[C] again, or [ESC] will end
chat mode. (Notice that the Want-Chat indicator
will also be turned off, if it was flashing. If
you are running under Apex, RemoteAccess or
QuickBBS, paging from within the door will even
cause the Want-Chat indicator to stay lit when the
user returns to the BBS)
[Alt]-[J] - Allows the sysop to shell to DOS, if enough memory
is available. Simply type EXIT to return to the
door again.
[Alt]-[H] - Hang up on the user. Plain and simple!
[Alt]-[L] - This key locks the user out of the BBS. It first
hangs up on the user, and then sets their security
level to 0, to prevent them from ever logging on
again. This feature may require use of the EXITINFO.BBS
file, depending on what system RegPRO is running under.
[Alt]-[K] - The "User Keyboard-Off" key allows the sysop to
temporarily prevent the user from typing anything
on their keyboard. This has no effect on the local
keyboard, but causes RegPRO to ignore any keystrokes
from remote.
[Alt]-[N] - The "Sysop Next" key, this function reserves the
system for use by the sysop after the user logs
off, if RegPRO is running under an Apex or RA
1.00 or later system.
[Alt]-[D] - "Drop to BBS" key. This function allows the sysop
to exit RegPRO and return the user to the BBS,
without hanging up.
[F1]..[F10] - The Function keys [F1] thru [F10] allows the sysop
access to various types of information on the
status line, or to turn the status line off. Note that
some of the information displayed will depend on the
type of BBS you are running, and may or may not be
available. These keys are as follows:
[F1] - Display basic user information (default)
[F2] - Display phone numbers and important dates
[F3] - Display security flags and up/download info
[F4] - Display system information and current time
[F5] - Display message info and user's settings
[F6] - Display chat reason and sysop's comment
[F9] - Display help information for sysop
[F10] - Turn off the status line
┌──────────────────┐
▄│ Command Line │
█└──────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
RegPRO accepts the following parameters:
-p(BBS Drop File Path)
-v(ideo Mode) 0 = Direct Screen Writes
1 = BIOS Screen Writes
-t(ask Number) (Node Number)
-d(atafile name) (.CTL File name, with no extension).
────────────────────────────────────────────────────────────────────────────
■ MISCELLANEOUS ■
────────────────────────────────────────────────────────────────────────────
┌──────────────────────────────────────┐
▄│ Tips on Designing RegPRO Screens │
█└──────────────────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
Although RegPRO is an extremely powerful entry form system, it may be a bit
overwhelming to some new users. Setting up nice entry forms takes a bit of
time and patience, but well worth the extra effort. Currently, a custom
screen designer is being developed which will make this process MUCH easier
on you, but for now, patience is still the key. Here are a few hints to
get you started:
The first thing to do is break out your favorite ASCII editor (Q-Edit works
nicely, although I prefer to work with TheDraw and save it in ASCII format).
Design the entire form, including fields, and field masks (format strings).
Next, split your ASCII editor into two windows, one for your newly designed
form, and the other for your RegPRO control file. If your editor has a nifty
feature which shows the current row and column on the status line of each
window, you're set! To get the row and column of each field, simply hop to
your ASCII "template" file, and move the cursor to the beginning of the field
text. Then, jump down into your RegPRO .CTL file window, and enter those
coordinates for the field. This is a bit kludgy, but seems to help out most
folks.
As I said, the Screen Designer should prove to be a lifesaver in designing
these things. Good luck!
┌───────────────────┐
▄│ What's Next?! │
█└───────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
The following are planned additions and changes for RegPRO:
* Full-Fledged Screen Designer to automatically generate the control
files!
* Script language to link forms together based on answers!
* Menus as well as forms!
* Special Effects!
* Customizeable buttons for use in form linking!
* Ability to store data directly into the user's BBS record!
┌────────────────────┐
▄│ Special Thanks │
█└────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
We would like to take time to offer our appreciation to the Cairo Research
Lab Beta Team. Thanks guys!
Thanks are also in order for Brian Pirie, Diane and Madeleine, Bob Kruger,
and countless others whose efforts and caveats seem to go unnoticed at times.
┌──────────────────────────────┐
▄│ Upgrades and Information │
█└──────────────────────────────┘
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
For the latest version of RegPRO, or for tech support by BBS, call:
Under The Nile! Backwoods BBS
(706) 596-8126 9600 v.32 (706) 561-6106 9600 USR-DS
1:3613/12@fidonet 1:3613/10@fidonet
Magic name REGPRO will get you the latest version!
────────────────────────────────────────────────────────────────────────────
■ END OF REGPRO 2.60 DOCUMENTATION ■
────────────────────────────────────────────────────────────────────────────