Category : BBS Programs+Doors
Archive   : WED24B-A.ZIP
Filename : WWIVEDIT.HLP

For information on how to contact the author, request help on General.
For a description on the layout of this file, Look after the EOF

START
Help on Help
Default Keys
General
Colors
Macros
Exiting
Formating
Tag Lines
Block Commands
Extended Commands
Slash Commands
Technical Stuff
Spell Checker
Quoting
END

LOCAL
Local Keys
Local Macros
Inserting Files
BBS Tag Lines
Chat Mode
Sysop Information
Special Setups
END

HELP ON HELP:
SOT
Welcome to the Help system of WWIVEdit! This is a interactive help system
based on the idea "Help should be easy to use and informative at the same
time." All you need to do is use your Arrow keys to move around the shown
topics, and press Enter over the topic you want to learn about. To exit help,
you simply press ESC or Q, and it will exit.

If your arrow keys do not work properly (not at all that is), then you can use
the following keys instead of the arrow keys (unless your sysop has modified
them):
Control-U : Up Arrow
Control-J : Down Arrow
Control-G : Left Arrow
Control-Z : Right Arrow
.P
EOT

DEFAULT KEYS:
SOT
The settings file DEFAULT Maps the following keys:
^A : Control-A Macro ^N : Non-Destructive backspace
^B : Page Down ^O : Help!
^C : Center Line ^P : WWIV Color
^D : Control-D Macro ^Q : Extended Command 2
^E : Word Right (moves cursor) ^R : Redisplay Everything
^F : Control-F Macro ^S : Word Left (moves cursor)
^G : Move cursor left ^T : Page Up
^H : Backspace ^U : Move cursor up on line
^I : Tab ^V : Toggle Insert Mode
^J : Move cursor down ^W : Delete word to left of cursor
^K : Extended Command 1 ^X : Delete from cursor to start of line
^L : Insert a blank line ^Y : Delete line cursor is on
^M : Enter Key ^Z : Move Cursor Right
^] : Toggle between different Top Screens

Note: ^R means press and hold the Control key, and then press R.

Highlighted keys work, work in either the same, or almost the same way that
they do in the WWIV Line editor.
.P
WWIVEdit will also properly translate the arrow keys if they are mapped as
ESC[H=Home ESC[A=Up
ESC[D=Left ESC[C=Right
ESC[K=End ESC[B=Down
ESC[r=Toggle Insert/Overwrite mode ESC[s=Del Char

The DEFAULT mapping also supports Doorway mode on most keys (such as the arrows
and insert/delete).
.P
EOT

COLORS:
SOT
To insert a WWIV color into text, simply press ^P followed by a character
signifying the color.

The following table shows the legal colors:
.COLORTABLE

The Entry 1(49 ) is interpreted in the following way:
1 is the color character.
49 is the ASCII value of that character (for characters that don't have
printable characters).
.P
EOT

MACROS:
SOT
Macros are once again External to WWIVEdit. To define a macro, you must go
into the defaults section of the BBS and select "Update Macros". From there
you will choose Make, and then select either the Control-A, Control-D, or
Control-F macro.

You may enter special characters into your macros, such as those that change
colors. For example, to change colors in your macro, you will hit Control-P,
followed by a number between 0 and 7. On the screen, it will appear as ^P#.
.P
EOT

EXITING:
SOT
WWIVEdit provides many ways of exiting. The easiest and most familiar way to
WWIV users is /ES (or /S) on a blank line. This exits the editor and saves
what you have typed. The WWIV command of /ABT also works if you want to abort
what you have typed.

If you sysop has installed a modification to the WWIV source code, you can also
use /ESN and /ESY to save (Non/) Annonymously.
[ /S, /SN, and /SY are also properly interpreted ]

An alternative to this is to press ESC, wait for the status line to pop up,
and then press either S to Save, or A to Abort.
.P
EOT

FORMATING:
SOT
WWIVEdit provides a few different formatting commands. The first is the
familiar /C: which will allow you to center whatever follows it. The /C: must
be the first thing on the line in order for it to work properly. An
alternative to this is to use ^C. To use it, you first type the line that you
want centered, and then, on that line, you press ^C, and it will center the
line (by inserting /C: at the beginning of the line).

Paragraph reformatting is done almost completely automatically in WWIVEdit.
WWIVEdit keeps track of where you have hit Enter, and uses that information to
reformat paragraphs. The only real time that you will ever need to worry
about paragraph reformatting is if you want to join two lines (and this is
even done automatically sometimes.) In this case, the easiest way to do it is
to move to the beginning of the second line, and hit the backspace key, and
the line will be joined with the previous line, and the paragraph will be
reformatted.

WWIVEdit also now supports Non-Destructive Backspaces that are popular in many
users macros. It can be inserted into text using the ^N key, and will appear
as an inverse H on the screen (indicating that it is a control character). It
will appear correctly in the message that you are sending, even if it does
look a little bit unusual on the screen.
.P
EOT

LOCAL KEYS:
SOT
WWIVEdit provides a number of Local-Only keys. They are:
Center Line = Alt-C
WWIV Color = Alt-P
Insert File = Alt-I
Top of Doc = Ctrl-Home or Ctrl-PgUp
Bottom of Doc = Ctrl-End or Ctrl-PgDn
Word Left = Ctrl-Left Arrow
Word Right = Ctrl-Right Arrow
Toggle Insert = Insert key
Delete Char = Delete Key or Control-Backspace
Help = F1
Enter Chat Mode = F10
Abort Post = Alt-A (can be used while a user is on-line)
Save and Exit = Alt-S
Save and Continue = Alt-W
Left Shift-Right Shift = Enter Chat Mode
.P
EOT

LOCAL MACROS:
SOT
WWIVEdit supports virtually unlimited local macros!

To use local macros, you must have the following files in your WWIVEdit
directory:
WWIVEDIT.KEY - Used to translate extended key codes to 3 letter
abbreviations.
MACROS.LCL - This file contains the actual macros.

WWIVEDIT.KEY is NOT a text file and shouldn't need to be modified.
MACROS.LCL is a (WWIV) text file that you should edit with WWIVEdit. There are
certain conventions used with this file.

1. A macros is defined using N: and :N delimiters. The exact "N" varies
depending on which macro you want to define. The following table shows the
names for the macro keys:
"A" thru "Z" relate to Alt-A thru Alt-Z
"1" thru "0" relate to Alt-1 thru Alt-0
"F1" thru "F0" relate to F1 thru F10
"$F1" thru "$F0" relate to Shift-F1 thru Shift-F10
"^F1" thru "^F0" relate to Control-F1 thru Control-F10
"!F1" thru "!F0" relate to Alt-F1 thru Alt-F10
^IN and $IN are Control Insert and Shift Insert
^DL and $DL are Control Delete and Shift Delete

$TB is Shift Tab
HOM is the Home Key
END is the End Key
UP, RT, LF, and DN are the Arrow keys Up, Right, Left, and Down
PU and PD are Page Up and Page Down
INS and DEL are the insert and delete keys
^LF and ^RT are Control Left Arrow and Control Right Arrow
^PU and ^PD are Control Page Up and Control Page Down
^HO and ^EN are Control Home and Control End
- and = are Alt - and Alt =
.P
2. A ~ at the beginning of a line is ignored (so that you can use /ES in your
macro by putting ~/ES on a line by itself.)

3. A ~ at the end of a line means that the next line is part of this line, so:

This is a test ~
of this feature.

Would actually be equivilent to typing:

This is a test of this feature. [Enter]

This is useful if you have a long macro, or, you don't want enter pressed at
the end of the macro for some reason.
.P
Total Number of Macros:
A - Z : 26
1 - 0 : 10
F1 - F0 : 10
$F1 - $F0 : 10
^F1 - ^F0 : 10
!F1 - !F0 : 10
^IN, $IN, ^DL, $DL, $TB, HOM, END, UP, RT, LF, DN, PU, PD, INS, DEL : 15
^LF, ^RT, ^PU, ^PD, ^HO, ^EN, -, = : 8
99 Macros Possible. Of course most of the last 23 have bindings already in the
LOCAL.DEF, but they are here for completeness.
.P
EOT

GENERAL:
SOT
WWIVEdit Version %VERSION%
WWIVEdit is the result of many many many long hours of work by one person:
Adam Caldwell
aka The Emporer
1 @16470 [Link]
1 @6470 [Net]

Should you require to communicate with me, you should first attempt to send me
mail at The First Galactic Empire (1@16470 Link, 1@6470 Net).

If you have access to an Internet/Bitnet account, I can be reached as:
[email protected]
[email protected]

Note: I can not respond to UUCP mail, and its possible I won't even get it.
.P
If none of those options work for you, you can send mail to:
Adam Caldwell
114 Grosvenor St
Athens, Ohio 45701 (until June 1993)
OR
Adam Caldwell
16952 Nash Rd
Middlefield, Ohio 44062

or you can call my BBS at 614-593-7836.

If you are very desperate, I can be reached by voice at 614-594-3051.
Before resorting to a voice call though, PLEASE read the manual. Most problems
can be solved by just reading the manual.
.P
Plea for money:
Users, if you are reading this, encourage your sysop to send me money!
Sysops: Send me money!

Here's the deal:
If you send me $10 or more, you will get the next version of WWIVEdit sent
to you on disk for free. If you have a HST or V.32 modem running at 9600+, I
will also consider uploading it to your BBS.
This program is BegWare. No registration fee is required, and there are
no locked features (although there are some undocumented features)
What you see is what you get. If you like this program, please send me a
note saying so (at any of the above locations) and some money 🙂
.P
Thank You notes:
I would like to thank:
The Duelist - For getting me involved in WWIV, and Beta testing my editor
on his system
Parapuke - For Everything
Niloc - For Beta testing this editor on my system
Filo - For just being part of the who WWIV thing.
Wayne Bell - For providing one helluva BBS system

Miscellaneous thanx go to:
The Warden, Raistlin, Gene Wells, Joe Hallahan, Lance Halle, Aahz,
Phantom, Ken, Jim Wire, 8 Ball, and everyone else who sent me comments,
suggestions, bug reports, and the like...
.P
EOT

TAG LINES:
SOT
Tag Lines are an optional feature of WWIVEdit that may have been disabled
by your sysop.
To define a Tag Line, simply press ESC. If Taglines appears on the status
line, then you can enter a Tag line by pressing T. If it does not appear,
then your Sysop has disabled this feature.
You should then see on the screen a listing of your currently defined
taglines, as well as your choosen method of addition. To define a Tag line,
you first press Make, and then enter the tag line. Press Control-Z when you
are finished entering the Tag line. WWIVEdit will then prompt you for the
number to save it under. You should press the number of the desired slot, or
press Quit.
Once you have defined all of the Tag Lines that you want, you will next
press Choose to choose which method you want to use for appending you Tag Line
to your message. They are fairly self explainitory. Just remember to do it.
The following are interpreted in a Tag line:
^N : Non-Destructive backspace
^P : WWIV-Color
^C : WWIV-Color
^M : Enter
/C: : Center Line
^B : Center Line following ^B
.P
EOT

BLOCK COMMANDS:
SOT
WWIVEdit provides a few "crude" block management commands. These Block
commands allow you to Copy/Move/Delete lines in your message. The Block
Commands are accessed by first hitting Control-K, and then pressing another
letter.
The following block commands are available for marking off a block:
B : Mark Beginning of Block (hit this on the line of the start of the block)
E : Mark End of Block (hit on the line of the End of the block)
K : Same as E (for those who use Turbo Pascal)

The following commands allow you to manipulate blocks:
Y : Delete Block
C : Copy Block to current cursor line (which must be outside the block
range)
M : Move Block to current cursor line
V : Same as M
.P
Please note:
These block commands only work on whole lines. They will not work on partial
lines.
.P
EOT

CHAT MODE:
SOT
WWIVEdit has a built in two way chat mode that looks very similiar to the
two way chat mode of the BBS (except the colors are different). You enter
chat mode by pressing both shift keys the local keyboard, and exit by pressing
ESC on the local keyboard.
The Chat Mode has one undesireable side effect (the Desqview problem has
been fixed). The problem occurs if the user hangs up during the Two-Way chat
mode. Because of the way that WWIV mixes the input from the keyboard and the
modem, it was necessary to install an interrupt handler to seperate the
keyboard input before it was combined with the modem input. Unfortunately, if
the user hangs up, WWIV immediately terminates the program, not giving me a
chance to un-install my interrupt handler. The net effect is that the computer
goes to Never Never land the next time that you hit a key on the keyboard. The
solution is to reset the computer if a user hangs up/gets disconnected in chat
mode. This isn't really a problem because you will always be there if a user
hangs up in chat mode, but still, I am working on a way of keeping WWIV from
terminating the WWIVEdit while my interrupt vector is still in place.
.P
EOT

BBS TAG LINES:
SOT
WWIVEdit can add a BBS Tag line to every message posted with it, if you
create a file called BBSxxxxx.TAG. To do this, either type from within the
BBS
//EDIT [Enter]
BBSxxxxx.TAG [Enter]
or, from DOS level enter WWIVEDIT BBSxxxxx.TAG
and then enter what you would like as you BBS Tag line.


Notes:
xxxxx can be replaced by anything you want. This means that you can
create as many BBS*.TAG files as you want, and the WWIVEdit will randomly
select on of them and attach it to the message.
.P
EOT

INSERTING FILES:
SOT
To insert a file into your message, you must have a key bound to the
INSERT FILE function in the current Key Binding file. By default, it is bound
to ALT-I in LOCAL.DEF.
.P
EOT
EXTENDED COMMANDS:
SOT
A number of Extended commands are now available with WWIVEdit. The
Extended commands are accessed through Control-K and Control-Q. The Block
commands are discussed in a different portion of this Help.

Here are the extended commands available on ^K:
J : Jump to specified line number
S : Show block status
F : Find specified Text
U : Cursor up
D : Cursor Down
L : Cursor Left
R : Cursor Right
W : Show Cursor Status [Shows Cursor's Row, Column Coordinates] (Toggle)
B : Mark First Line of Block (Block Begin)
E or K : Mark Last line of Block (Block End)
M or V : Move marked block to current line
C : Copy marked block to current line
Y : Delete marked block
.P
Here are the extended commands available on ^Q:
F : Find Text
L : Repeat last find
Y : Delete to end of Line
.P
EOT
SLASH COMMANDS:
SOT
WWIVEdit now supports all of the WWIV line editor's "Slash" commands
(except /SU)
The Available commands are:
/ES, /S : Exit & Save
/ESY, /SY : Exit & Save, Anonymously if possible. *
/ESN, /SN : Exit & Save, Non-Anonymously *
/TI : Change Title *
/CLR : Clear message and start over
/ABT : Abort message
/HELP : Same as hitting Control-O
/RL : Replace last line
/LI : List message
/C: : Center everything following it (has to be at the beginning of
a line)
/CHECK, /SPELL : Invoke spell checker **

* Denotes commands that require a modification to the WWIV Source code, and
therefore are unavailable on un-registered WWIV boards, and boards that have
opted not to make the needed modifications.
** Denote feature unique to WWIVEdit
.P
EOT

SYSOP INFORMATION:
SOT
Thank you for using WWIVEdit! If you and your users use this Editor,
and you would like a larger dictionary file, send $10 to the Author. (See
Docummentation or "General" for the Address).

The following are the Valid command line switches for WWIVEdit:
-set: Specifies a setup file to load. If this parameter doesn't appear,
WWIVEdit will assume DEFAULT

-key: Specifies a keyboard file to load if the users hasn't specified one
in the defaults section. If none is specified, DEFAULT is assumed.
.P
Files: There are a number of files that are needed for proper operation
of WWIVEdit, and a number of files that are optional.

Needed files:
WWIVEDIT.EXE - For obvious reasons.
WWIVEDIT.OVR - The Overlays file.
WWIVEDIT.HLP - The help file for WWIVEdit.
TAGLINES.CMN - The "common" Tag Lines file. This is created after the
first run of WWIVEdit.
CONFIG\*.DEF - Definition files.
CONFIG\*.KEY - Key bindings files.
CONFIG\*.SET - Compiled *.DEF files.
CONFIG\*.KBD - compiled *.KEY files.
DICT\HASH - A Hash file used to index the dictionary.
DICT\WWIVEDIT.DIC
- The Dictionary file for WWIVEdit.
.P
Optional Files:
MACROS .LCL - The local macros file. This is a text file that you can
edit with WWIVEdit to create "Extended Key" macros. See
Local Macros, and the file that came with WWIVEdit for more
info.
WWIVEDIT.KEY - Required if you want to use local macros. This file is
used to translate scan codes into 1-3 character
abbreviations that are then looked up in MACROS.LCL.
BBSxxxxx.TAG - The BBS Tag File(s). WWIVEdit will randomly select one of
these and append it to the end of the current post.
WWIVEDIT.DIV - The Divider to put between the personal tag line and the
message text. If this file does not exist, WWIVEdit will
put "-----".
DICT\U###.DIC- User dictionary files
.P
Sysop Only Display:
At the bottom of the screen (on the same line as the Max Lines), there is
the Handle and Real Name of the current user. This information does not appear
to the user. That information is for the Sysop's reference.
.P
EOT

SPECIAL SETUPS:
SOT
WWIVEdit now supports a number of special modifications. The following
modifications are currently supported:
-------------------------------------------------------------------------------
MCI Commands
The xxx Color Modification
MS-DOS 5.0 With WWIV 4.12 and Wayne Bells DOS 5 fix
-------------------------------------------------------------------------------
If you would like to see others supported, please contact the Author (at
any of the addresses listed under General Help).
.P
MCI Commands:
WWIVEdit supports MCI commands through the setup file parameter MCI: []
When you set this to 1, Merlin06 MCI commands are enabled. For now, they will
be inserted as an inverted C and the letter of the MCI command. At a later
date, they may be implemented as Virtual Text.

The xxx Color Mod:
There are a lot of color mods out there, so I decided to try and support
some of them. This required a major re-write of some of the code, but it was
worth it, as the code is now a lot more flexible/efficient.
To use a color modification, you need to edit your *.DEF files to specify
the legal range of colors. See the CONFIG.DOC for further instructions.
.P
DOS 5.0 and Wayne Bell's DOS 5.0 Fix:
If you are running MS-DOS 5.0, and WWIV 4.12 with Wayne Bell's DOS 5.0
fix, then you need to do the following:
Go into COM.C and search for ni_stack[100], and replace it with
ni_stack[500]. Next, search for &ni_stack[98], and replace it with
&ni_stack[498]. Then, go into RETURN.C and repeat the same steps. That will
fix WWIVEdit and any other full screen editors you may be having problems
with.
.P
EOT

TECHNICAL STUFF:
SOT
WWIVEdit is written in Turbo Pascal 6.0 (and will not compile on anything
less.) The source code is distributed freely by the Author. In this version,
and most likely all future versions, the source code will be distributed in a
seperate file called WEDITSxx.ZIP, xx being the version number of the source
(at this writing %VERSION%).
WWIVEdit uses some advanced techniques to tweak some of the little things
out of the WWIV. WWIVEdit uses special techniques to determine where a message
is going. Because there are so many different WWIV setups, it is difficult to
tell for ceartain where something is going. Because of this, the Dest Line may
sometimes be Incomplete/Non-Descriptive. This is not important as it is
displayed only for cosmetic purposes.... It is unimportant to the actual
operation of the Editor (well, with the exception of the NOTAG feature).
.P
EOT
SPELL CHECKER:
SOT
To invoke the spell checker in WWIVEdit, you simply type /CHECK (or
/SPELL) on a blank line. The Spell Checker is fairly self explainatory. Your
Sysop may or may not have words which you add to the dictionary going to a
common dictionary. Ask him if you are unsure.
.P
EOT
QUOTING:
SOT
To quote with WWIVEdit type /QUOTE or /Q on a line by itself. You sysop
may have set up a quick key for this... If he has, he should put it here.

All color codes will be removed from the quoted text, as well as all ANSI
escape codes, and any taglines that we created with WWIVEdit.

Locally, Control-G will invoke the quoter.
.P
EOT
EOF

Layout of this file:
Keywords : START END LOCAL SOT EOT EOF
Formatting: .P ^B ^C .COLORTABLE
Anything that lies between two key words is ignored, with the following
exceptions:
Between START and END is the list of topics that a remote user will see.
Between LOCAL and END is an additional list of topics that a local user will
see.
Between SOT and EOT is a text of the topic preceeding the SOT.

A topic is specified using the form: "TOPIC (IN CAPS ONLY):"
It is possible to make more than one topic refer to the same thing, although
in the new menu based system, that's not needed.

Final comments: SOT stands for Start of Text, and EOT stands for End of Text.
EOF marks the End of File (or more like end of meaningful text)
.P causes the screen to [PAUSE] whenever it occurs in the message text
.COLORTABLE causes the Internal Colortable to be displayed
^B (/C: in WWIVEdit) causes a line to be centered
^C (^P - WWIV Color) causes a color change (duh?)