The Devil's Doorknob BBS Capture (1996-2003)/devilsdoorknobbbscapture1996-2003.iso/MYBBS.ZIP/WINDOWS/DESKTOP/MYBBS/WEDIT/WWIVEDIT.HLP

Text File | 1991-08-16 | 24KB | 581 lines

This is the Help file for WWIVEdit V.2.2.
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
Keys
General
Colors
Macros
Exiting
Formating
Tag Lines
Block Commands
Extended Commands
Slash Commands
Technical Stuff
Spell Checker
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 2WWIV5Edit0!  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 1Enter0 over the topic you want to learn about.  To exit help,

you simply press 1ESC0, 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:
  1Control-2U 3: 0Up Arrow
  1Control-2J 3: 0Down Arrow
  1Control-2G3 :0 Left Arrow
  1Control-2Z3 : 0Right Arrow
.P
EOT

KEYS:
SOT
2WWIV5Edit0 Maps the following keys:
2^A0 : Control-A Macro                2^N0 : Non-Destructive backspace
^B : Page Down                      2^O0 : Help!
^C : Center Line                    2^P0 : WWIV Color
2^D0 : Control-D Macro                ^Q : Extended Command 2
^E : Word Right (moves cursor)      ^R : Redisplay Everything
2^F0 : Control-F Macro                ^S : Word Left (moves cursor)
^G : Move cursor left               ^T : Page Up
2^H0 : Backspace                      ^U : Move cursor up on line
2^I0 : Tab                            ^V : Toggle Insert Mode
^J : Move cursor down               2^W0 : Delete word to left of cursor
^K : Extended Command 1             2^X0 : Delete from cursor to start of line
^L : Insert a blank line            ^Y : Delete line cursor is on
2^M0 : Enter Key                      ^Z : Move Cursor Right
^] : Toggle between different Top Screens

Note: 1^R0 means press and hold the 1Control0 key, and then press 1R0.

Highlighted keys work, work in either the same, or almost the same way that

they do in the WWIV Line editor.
.P
2WWIV5Edit 0will 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
Note: 1ESC0 1[ 0may be replaced by 1ESC3 1O0.
.P
EOT

COLORS:
SOT
To insert a WWIV color into text, simply press 1^P0 followed by a number between

20 0and 270.

Color0  1Color10 1 2Color20 2 3Color3 0 4Color 40  5Color 56 0 6Color 60 7 Color 7 0Color 0
Grey    Cyan    Yellow  Magenta Reversed Green    Blinking Blue    Grey
.P
EOT

MACROS:
SOT
Macros are once again External to 2WWIV5Edit0.  To define a macro, you must go

into the defaults section of the BBS and select "Update Macros".  From there

you will choose 1M0ake, 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
2WWIV5Edit0 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 2ESC0, wait for a second, and then press

either 2S0 to 1Save0, or 2A0 to 1Abort0.
.P
EOT

FORMATING:
SOT
2WWIV5Edit 0provides a few different formatting commands.  The first is the

familiar 1/C:0 which will allow you to center whatever follows it.  The 1/C: 0must

be the first thing on the line in order for it to work properly.  An

alternative to this is to use 1^C0.  To use it, you first type the line that you

want centered, and then, on that line, you press 1^C0, and it will center the

line (by inserting /C: at the beginning of the line).

Paragraph reformatting is done almost completely automatically in 2WWIV5Edit0.

2WWIV5Edit 0keeps 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.

2WWIV5Edit0 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
2WWIV5Edit0 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
2WWIV5Edit0 supports virtually unlimited local macros!

To use local macros, you 1must0 have the following files in your 2WWIV5Edit

directory:
  1WWIVEDIT.KEY 3-0 Used to translate extended key codes to 3 letter

                 abbreviations.
  1MACROS.LCL   3-0 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 2WWIV5Edit0.  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:

     F1..F0   = F1 thru F10 (F1 and F10 are already in use though)
     $F1..$F0 = Shift-F1 thru Shift-F10
     ^F1..^F0 = Control-F1 thru Control-F10
     !F1..^F0 = Alt-F1 thru Alt-F10
     A..Z     = Alt-A thru Alt-Z (some of these can't be defined because they
                are defined as part of the editor, ALT-A for example)
     1..0     = Alt-1 thru Alt-0
.P
2. A 1~0 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 1~0 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.2 [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:
     F1..F0   =  8 (F1 = Help, F10 = Chat)
     $F1..$F0 = 10
     ^F1..^F0 = 10
     !F1..^F0 = 10
     A..Z     = 20 (A,C,I,P,S, and W are all in use)
     1..0     = 10
     ^A,^D,^F =  3
    ---------------
                71 Macros
.P
EOT

GENERAL:
SOT
2WWIV5Edit 0Version 723.22
2WWIV5Edit0 is the result of many many many long hours of work by one person:
Adam Caldwell
2The Emporer
1 @16401 [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@16401 Link, 1@6470 Net).

If you have access to an Internet/Bitnet account, I can be reached as:
  [e-mail]
  [e-mail]
  [e-mail]
  [e-mail]
.P
If none of those options work for you, you can send mail to:
  Adam Caldwell
  114 Grosvenor St
  Athens, Ohio 45701
OR
  Adam Caldwell
  16952 Nash Rd
  Middlefield, Ohio 44062

or you can call my BBS at 614-593-7836.
.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, and set me up an account on your BBS, the next

version of the Editor will be uploaded to your BBS for free as soon as it

becomes available (if you so request).  You will also get your name on the list

of People who have contributed money to the 2WWIV5Edit0 cause, and will also

recieve a larger (24,000) word dictionary.
     This program is BegWare.  No registration fee is required, and there are

no locked features (although there are some undocumented features, and the

dictionary for this version is only about 6000 words). 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).
.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 getting me involved in LINK, and for distributing my
                  editor
    Niloc       - For Beta testing this editor on my system
    Filo        - For running one helluva BBS [The Dragon's Den], my Net home
                  until just recently (when I joined Net myself)
    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 2WWIV5Edit0 that may have been disabled

by your sysop.
     To define a Tag Line, simply press ESC.  If 1T2aglines0 appears on the status

line, then you can enter a Tag line by pressing 1T0.  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 1M2ake0, and then enter the tag line.  Press Control-Z when you

are finished entering the Tag line.  2WWIV5Edit 0will then prompt you for the

number to save it under.  You should press the number of the desired slot, or

press 1Q2uit0.
     Once you have defined all of the Tag Lines that you want, you will next

press 1C2hoose0 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
     2WWIV5Edit0 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:
  2These block commands only work on 1whole2 lines.  They will not work on partial

2lines.
.P
EOT

CHAT MODE:
SOT
     2WWIV5Edit0 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 2WWIV5Edit0 while my interrupt vector is still in place.
.P
EOT

BBS TAG LINES:
SOT
     2WWIV5Edit0 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 2[Enter]
BBSxxxxx.TAG 2[Enter]
or, from DOS level enter 1WWIVEDIT BBS0xxxxx1.TAG
and then enter what you would like as you BBS Tag line.

2Notes3:
     1xxxxx0 can be replaced by anything you want.  This means that you can

create as many BBS*.TAG files as you want, and the 2WWIV5Edit0 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 be in Local Mode (ie, /L on

the command line). To insert the file press Alt-I, and it will prompt you for a

filename.
.P
EOT
EXTENDED COMMANDS:
SOT
     A number of Extended commands are now available with 2WWIV5Edit0.  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
  ## : Insert Box drawing character (first # beween 1 and 4, second between 1
       and 9)
.P
EOT
SLASH COMMANDS:
SOT
     2WWIV5Edit0 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    : 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 2WWIV5Edit
.P
EOT

SYSOP INFORMATION:
SOT
     Thank you for using 2WWIV5Edit0!  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 2WWIV5Edit3:
/L : Local Mode - Allows use of certain commands and keys on the keyboard.
     This should be on the "Local" Command line.
/T : Tag Lines - This turns off user Tag Lines.  By default, they are allowed.
/A : BBS Tag Line - This option turns off the BBS Tag line even if the file
     exists on the disk.
/C : Color Range Checking - This turns off the "Range" checking on colors.
     This is handy if you have installed a 128 color or some other color mod.
     See 2Special Setups0 for more information.
/MONO : If you are using a monochrome video card (not necessarily a monochrome
     monitor), you should use this option.  This tells 2WWIV5Edit0 to look at a
     different video segment when it tries to read the title from the screen
     (assuming that you have not installed the EDITOR.INF mod)
/K : Enable Direct Keyboard Buffer Writes (needed only on 8088/8086 computers)
/MCI : If you have installed the MCI mod, then use this switch.
     See 2Special Setups0 for more information.
/D:### : Sets minimum SL for adding new words to dictionary.  Only effects

     remote usage.
.P
/ANSI : Forces 2WWIV5Edit0 to output ANSI codes instead of WWIV codes.  This may

     fix MS-DOS 5.0's problem with changing colors.
/NOCOLOR : Removes all color from display.  Not recommended.
.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.HLP - The help file for 2WWIV5Edit0.
     TAGLINES.CMN - The "common" Tag Lines file.  This is created after the

                    first run of 2WWIV5Edit0.

Optional Files:
     MACROS  .LCL - The local macros file.  This is a text file that you can
                    edit with 2WWIV5Edit0 to create "Extended Key" macros.  See
                    Local Macros, and the file that came with 2WWIV5Edit0 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).  2WWIV5Edit 0will 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, 2WWIV5Edit0 will
                    put "-----".
.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.  If you do not see

that information, then you probably need to use the 2/MONO0 command line switch.
.P
EOT

SPECIAL SETUPS:
SOT
     2WWIV5Edit0 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
1MCI Commands3:
     2WWIV5Edit0 supports MCI commands through the command line switch 2/MCI0.  When

you use that switch, all 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.

1The xxx Color Mod3:
     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, use the 2/C0 command line parameter.  Alone,

the 2/C0 parameter allows 1Anything0 to follow 2^P0... This means that ^P^C, ^Pl, etc

are all "legal" colors.  This is a poor way of doing things, especially if you

only have added new colors for A thru F.  On the other hand, it works rather

nicely if you have installed the 128 color modification.
     If you want to be more restrictive on your color range, you may do

something like this:
  /C:A-F,a-f,0-9
This will allow A thru F, a thru f, and 0 thru 9.
or if you know the Ascii codes and want to restrict using those,
  /C:#1-#126,#128-#255
that will allow all but character #127 and character #0 as a "legal" color.
.P
1DOS 5.0 and Wayne Bell's DOS 5.0 Fix3:
     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 2ni_stack[100]0, and replace it with

1ni_stack[300]0.  Next, search for 2&ni_stack[98]0, and replace it with

1&ni_stack[298]0.  Then, go into EXTRN.C and repeat the same steps.  That will

fix 2WWIV5Edit0 and any other full screen editors you may be having problems with.
.P
EOT

TECHNICAL STUFF:
SOT
     2WWIV5Edit0 is written in Turbo Pascal 5.5.  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 2.2).
2     WWIV5Edit0 uses some advanced techniques to tweak some of the little things

out of the WWIV.  2WWIV5Edit0 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.
.P
EOT
SPELL CHECKER:
SOT
     To invoke the spell checker in 2WWIV5Edit0, you simply type /CHECK on a blank

line.  The Spell Checker is fairly self explainatory.  The only thing worth

mentioning is that <Add> is "restricted".  The exact security level needed to

use it is set by your sysop.
.P
EOT
EOF

Layout of this file:
Keywords : START END LOCAL SOT EOT EOF
Formatting: .P ^B ^C
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
  ^B (/C: in WWIVEdit) causes a line to be centered
  ^C (^P - WWIV Color) causes a color change (duh?)