home *** CD-ROM | disk | FTP | other *** search
/ The Devil's Doorknob BBS Capture (1996-2003) / devilsdoorknobbbscapture1996-2003.iso / MYBBS.ZIP / WINDOWS / DESKTOP / MYBBS / WEDIT / WWIVEDIT.DOC < prev    next >
Text File  |  1991-08-19  |  22KB  |  529 lines
  1.  
  2.  
  3.                                   WWIVEdit 2.2
  4.                                 By Adam Caldwell
  5.                     The Emporer #1@16401 (Link), @6470 (Net)
  6.  
  7.  
  8.                                    OVERVIEW
  9.  
  10.          WWIVEdit is a full screen editor designed for WWIV 4.xx BBS
  11.     systems.  WWIVEdit has many of the bells and whistles of a regular
  12.     word processor, plus it supports some WWIV specific things, such as
  13.     Colors, a Two-Way chat mode, and Macros.  WWIVEdit is fairly
  14.     "intelligent"; it can usually figure out where a message is going, and
  15.     will print an appropriate header when it can.
  16.  
  17.  
  18.                            INSTALLATION INSTRUCTIONS
  19.  
  20.          WWIVEdit is quite easy to install.  First, Unzip/move all of the
  21.     files into a directory.  It is recommended that you create a directory
  22.     off of you BBS directory called WWIVEDIT.  The following files are
  23.     required for proper operation:
  24.          WWIVEDIT.EXE, WWIVEDIT.OVR, WWIVEDIT.HLP, SPELL.DAT
  25.     The following files are "optional"  They activate certain features of
  26.     the editor.  Each of these files is described in detail later on.  They
  27.     are:
  28.          WWIVEDIT.KEY, MACROS.LCL, WWIVEDIT.DIV, BBS*.TAG
  29.     The following files are created after the first run of WWIVEdit:
  30.          TAGLINES.CMN
  31.  
  32.          Next, run the INIT program that comes with WWIV 4.xx and select
  33.     option "8. External editors (full screen)".  Then select "I:nsert".
  34.  
  35.          You now have to figure out what you need for the command lines.
  36.     There are a number of options available.  Almost all of these are
  37.     support for various modifications that people have installed in their
  38.     WWIV source code.
  39.     The following options are available:
  40.          /T     - Disable user Tag lines
  41.          /A     - Disable BBS Tag lines
  42.          /L     - Local mode (should always be put on local command line)
  43.          /MONO  - If you are using a monochrome CARD. Not necessarily a
  44.                   monochrome monitor.
  45.          /C     - Turn off color range checking - Not recommended
  46.          /C:Range-Specify specific color range (see example below)
  47.          /MCI   - Makes sure that MCI commands are not interpreted as
  48.                   colors.
  49.          /D:### - Set minimum SL for adding a word to the dictionary
  50.                   (defaults to 30)
  51.          /K     - Needed for XT's and some older AT's.  If you can't get
  52.                   the BBS macros to work using ^A, ^D, or ^F, add this
  53.                   switch.
  54.          /ANSI  - forces ANSI output instead of WWIV Output
  55.          /NOCOLOR - force No Color to be displayed.
  56.  
  57.     Notes:
  58.     ------
  59.          These parameters can be placed in any order, so long as the first
  60.     four parameters are the standard "%1 %2 %3 %4"
  61.  
  62.  
  63.  
  64.  
  65.                                      - 1 -
  66.  
  67.  
  68.  
  69.     Example REMOTE command lines:
  70.     -----------------------------
  71.     Recommended (assuming STOCK WWIV and directory called WWIVEdit):
  72.       WWIVEDIT\WWIVEDIT %1 %2 %3 %4 /D:80
  73.  
  74.     If you don't want/like User Taglines:
  75.       WWIVEDIT\WWIVEDIT %1 %2 %3 %4 /D:80 /T
  76.  
  77.     If you (sysop) have a monochrome card & Monitor:
  78.       WWIVEDIT\WWIVEDIT %1 %2 %3 %4 /D:80 /MONO
  79.  
  80.     Example LOCAL command lines:
  81.     ----------------------------
  82.     Recommended (if you unziped into a directory called WWIVEdit):
  83.       WWIVEDIT\WWIVEDIT %1 %2 %3 %4 /L
  84.  
  85.     If you have Monochrome card & Monitor:
  86.       WWIVEDIT\WWIVEDIT %1 %2 %3 %4 /L /MONO
  87.  
  88.     If you have installed the 8MORECLR mod:
  89.       WWIVEDIT\WWIVEDIT %1 %2 %3 %4 /L /C:0-9,A-F,a-f
  90.  
  91.          That's all you need for the standard configuration (although, see
  92.     Logon Event below).
  93.          If you have made any of the following changes to you BBS, you must
  94.     install the EDITINFO.MOD otherwise garbage will appear on your screen.
  95.       1) Modified your read/main menu prompt.
  96.       2) Modified any of the following "phrases", or changed the spacing of
  97.          them in the BBS:
  98.          "Title", "E-mail", "Post", "Multi-Mail", "Filename?"
  99.       3) You have added an option that allows a new user to select a full
  100.          screen editor before the "validation feedback"
  101.       4) You do not have and do not want to create a Logon Event
  102.  
  103.     Even if none of these applies to you and you have the WWIV Source code,
  104.     you are still encouraged to install EDITINFO.MOD.
  105.  
  106.     LOGON EVENT
  107.     -----------
  108.          For tag lines to properly function, you must always have an up-to-
  109.     date CHAIN.TXT file (or install EDITINFO.MOD).  This file is updated
  110.     when a user logs on only if you have a logon event, so you need to
  111.     create one if you do not yet have one.
  112.          If you don't have one, or you are not sure, do the following:
  113.     1.  Run INIT.EXE which came with WWIV.
  114.     2.  Select Option #6 (External Programs)
  115.     3.  Move down to Logon Event
  116.     4.  If there is nothing there, enter LOGON.BAT %1.  If there is
  117.         something already there, then you are all done.  Otherwise see #5
  118.     5.  Press ESC a few times to exit INIT.EXE, and then create a file
  119.         called LOGON.BAT.  It need not contain anything, just create it.
  120.         A simple way to do this is to type
  121.         COPY CON LOGON.BAT
  122.         @Echo Welcome to <Insert BBS name here> [Enter]
  123.         press Control-Z and then [Enter]
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.                                      - 2 -
  132.  
  133.  
  134.  
  135.     EDITINFO.MOD
  136.     ------------
  137.          EDITINFO.MOD is a modification that I wrote so that WWIVEdit can
  138.     more effectively communicate with the BBS.  EDITINFO.MOD communicates
  139.     with the BBS through two different files.  The first file is called
  140.     EDITOR.INF.  The BBS creates this file before invoking the editor.
  141.     This file contains information about the messages's destination, title,
  142.     and information about its author.
  143.          The second file is created by WWIVEdit.  This file contain the
  144.     "Anonymous" state of the message just saved, and its title.
  145.  
  146.     Enhancements enabled by this modification:
  147.          /TI  : Title Change
  148.          /ESN : Non-Anonymous save without that annoying Anonymous? prompt
  149.          /ESY : Anonymous save without prompt
  150.          "Title:" and "Dest:" will always be correct
  151.          Fixes problems that appear under special situations (//CHUSER)
  152.  
  153.     Disadvantages:
  154.          Slows down loading very slightly (for all full screen editors)
  155.          Requires that you have the BBS source code
  156.  
  157.     MS-DOS 5.0
  158.     ----------
  159.     If you are running MS-DOS 5.0 and Wayne Bell's DOS 5.0 fix for WWIV
  160.     4.12, you need to do some additional work.  Go into COM.C and search
  161.     for ni_stack[100].  Change it to ni_stack[200].  Next, search for
  162.     &ni_stack[98] and change it to &ni_stack[198].  Repeat these in
  163.     EXTRN.C, and that should fix everything (including problems with other
  164.     editors).
  165.  
  166.  
  167.                                  MISCELLANEOUS
  168.  
  169.     (Much of the information that follows is duplicated in the help file,
  170.     and is shown here, only for completeness/printing)
  171.  
  172.     USER MACROS
  173.     -----------
  174.     User Macros are once again External to WWIVEdit.  To define a macro,
  175.     you must go into the defaults section of the BBS and select "Update
  176.     Macros".  From there you will choose Make, and then select either the
  177.     Control-A, Control-D, or Control-F macro.  If user macros are not
  178.     working correctly, add the /K parameter to the command lines.
  179.  
  180.     LOCAL MACROS
  181.     ------------
  182.          Some sysops commented to me that they would like ALT-1 thru ALT-0
  183.     macros.  I took this to the extreme and allowed not only those, but
  184.     also Alt-F1 thru Alt-F10, Ctrl-F1 thru Ctrl-F10, Shift-F1 thru Shift-
  185.     F10, and the "unused" keys in the ranges Alt-A thru Alt-Z and F1 thru
  186.     F10.  So... If anyone needs more than 10 macros, they can have them.
  187.     Each macro is limited to approximately 1000 characters.  If anyone
  188.     requires more than this for a single macro, just say so, and I will
  189.     increase it for you.  If you edit the macro file with WWIVEdit, you are
  190.     limited to somewhere around 3000 lines of macros, depended on your
  191.     setup.  If you are editing the file from within the BBS, this limit
  192.     drops to 1000 or so lines.
  193.          Local macros are stored in a file called MACROS.LCL which is a
  194.     text file that can be edited with WWIVEdit.  An example file is
  195.     provided with the editor.
  196.  
  197.                                      - 3 -
  198.  
  199.  
  200.  
  201.          To specify a macro in it, you have to first figure out what the
  202.     "name" of it is.  The following naming conventions are used:
  203.        "A"   thru "Z"   relate to Alt-A thru Alt-Z
  204.        "1"   thru "0"   relate to Alt-1 thru Alt-0
  205.        "F1"  thru "F0"  relate to F1 thru F10
  206.        "$F1" thru "$F0" relate to Shift-F1 thru Shift-F10
  207.        "^F1" thru "^F0" relate to Control-F1 thru Control-F10
  208.        "!F1" thru "!F0" relate to Alt-F1 thru Alt-F10
  209.  
  210.     To specify a macro, you need to use the following layout:
  211.     NAME:
  212.     Macro Text Line 1
  213.     Macro Text Line 2
  214.     .
  215.     .
  216.     Macro Text Line N
  217.     :NAME
  218.  
  219.          The Tilde (~) has special meaning when it appears at the beginning
  220.     or end of a line.  When it appears at the beginning of a line, it
  221.     serves as a place holder and is ignored when the macro is executed.
  222.     This is very helpful if you want your macro to end with a "slash"
  223.     command.  For example, say you wanted to make an F2 macro that saved
  224.     your message.  If you simply Typed
  225.     "F2: [ENTER] /ES [ENTER]", it would save the Macros file (assuming you
  226.     are using WWIVEdit to edit the macros file).  On the other hand, this
  227.     macro would do what you want:
  228.  
  229.     F2:
  230.     ~/ES
  231.     :F2
  232.  
  233.     When a tilde appears at the end of a line, it means that no carriage
  234.     return should be sent during macro execution.  This is useful if you
  235.     don't want a new line to be started after the macro is done executing.
  236.     Extending the above macro's second line to ~/ES~ would make it so that
  237.     you would have to hit ENTER after pressing F2 to save the file, in case
  238.     you accidently hit F2.
  239.  
  240.     Or, perhaps you hate to type out the name of a particular board because
  241.     it is so long (for example, The First Galactic Empire (16401 Link, 6470
  242.     Net)), if you want this to be a macro that is executed when the ALT-B
  243.     key is pressed, you would put in the macro file:
  244.  
  245.     B:
  246.     The First Galactic Empire (16401 Link, 6470 Net)~
  247.     :B
  248.  
  249.     Also, there is no reason why you can't have colors or even use the ^N
  250.     keys (assuming that you are editing MACROS.LCL with WWIVEdit).  You can
  251.     even insert control characters, such as ESC by first hitting ^Q, and
  252.     then hitting ESC....
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.                                      - 4 -
  264.  
  265.  
  266.  
  267.     CHAT MODE
  268.     ---------
  269.          WWIVEdit supports a two-way color chat that looks very similar to
  270.     the Two-Way chat mode in WWIV 4.xx.  You can enter chat mode by
  271.     pressing both shift keys at the same time, or pressing F10 (on the
  272.     local keyboard only of course).  The chat mode is so similar to the BBS
  273.     chat mode that most of my users didn't notice the difference until I
  274.     pointed it out to them.
  275.          There is only one known problem with the Two-Way chat mode in
  276.     WWIVEdit.  If the user should happen to hang up/get disconnected while
  277.     in chat mode, the BBS will lock-up the next time a key is pressed on
  278.     the keyboard.  This shouldn't be a problem because the only way to get
  279.     into chat mode is for the sysop to be there, and if the user hangs up
  280.     in chat mode, the sysop will be there to reset the BBS (and computer).
  281.     There will be no ill effects if the user should hang up during normal
  282.     message entering because all keyboard I/O is done through normal BBS
  283.     means.
  284.  
  285.     TAG LINES
  286.     ---------
  287.          WWIVEdit supports two kinds of tag lines.  Personal Tag Lines, and
  288.     BBS Tag Lines.  Both are optional.  Personal Tag Lines are defined by
  289.     the user, and are appended to every message that the user posts unless
  290.     he saves it with /SY or /ESY.  These are fairly self explanatory to the
  291.     user.  The only thing that the sysop needs to know is that, at his
  292.     option, NO USER can have tag lines.  To invoke this power, add /T to
  293.     the REMOTE command line.
  294.          BBS Tag lines are definable by the Sysop.  To create BBS Tag
  295.     Line(s), create a file called BBS*.TAG.  The * can be anything you
  296.     want, and you can create as many of these files as you want.  If more
  297.     than one of them exists, WWIVEdit will select one at Random and append
  298.     it to the message.  If at some time you wish to disable these tag lines
  299.     without deleting the files, you can add /A to the command line, and
  300.     they will be ignored until you remove the /A switch.
  301.          A new feature in WWIVEdit 2.2 is the ability to disable Tag Lines
  302.     on selected message bases.  Edit the file in your WWIVEDIT directory
  303.     called NOTAG.  The default file that comes with WWIVEdit contains only
  304.     the symbol #.  What this does is disable Tag Lines on Non-Networked
  305.     personal E-Mail.  Here is how NOTAG works.
  306.          WWIVEdit will check each line in the NOTAG file to see if it is a
  307.     "substring" of the DEST: line.  Whenever personal E-Mail is sent on a
  308.     system the Dest: line will appear as "User Name #10" or whatever.  In
  309.     this case, the "#" in the NOTAG file matches the "#" in the "#10".
  310.          You are not limited to symbols though.  You can just as easily
  311.     type in a full message base name (these are CASE SENSITIVE).  For
  312.     Example, if you have a word association base and you don't want
  313.     Tag lines in it, your NOTAG file would look like this:
  314.     -----
  315.     #
  316.     Word Association
  317.     -----
  318.          If you have not installed the EDITINFO.MOD, then at times, the
  319.     DEST: line will be non-descript.  When WWIVEdit can't tell where a
  320.     message is going, it will simply say "Message Base".  You can add this
  321.     line to your NOTAG file if you are subscribed to a Sub that doesn't
  322.     allow Tag Lines because if you don't, when someone uses "W" or "P" to
  323.     post a message, its going to get a tag line attached to it.
  324.  
  325.  
  326.  
  327.  
  328.  
  329.                                      - 5 -
  330.  
  331.  
  332.  
  333.                                      FILES
  334.  
  335.     The following is a list of files created/used by WWIVEdit 2.2:
  336.     Filename      Description
  337.     ------------  ---------------------------------------------------------
  338.     WWIVEDIT.EXE  The Main Executable.  The location of this file defines
  339.                   the "Home" directory of WWIVEdit
  340.     WWIVEDIT.OVR  The Overlays for WWIVEdit.
  341.     WWIVEDIT.KEY  Used to translate scan codes to macro names.
  342.     MACROS  .LCL  The Local Macros File.
  343.     TAGLINES.CMN  The Taglines File. This file may also contain other
  344.                   information in this and future versions.
  345.     BBS*    .TAG  There can be as many of these files as you want
  346.                   (including 0).  One of these is appended to the end of
  347.                   each message posted with WWIVEdit (at random if there is
  348.                   more than one)
  349.     WWIVEDIT.DIV  If this file exists, it is put between body of the
  350.                   message and the user's tag line (if any).  This file may
  351.                   be at most one line long.  If this file does not exist,
  352.                   WWIVEdit will use its default of "-----".
  353.     NOTAG         If this file exists, then it is used to discriminate when
  354.                   tag lines are allowed, and when they aren't.  (See
  355.                   Tag lines above)
  356.  
  357.  
  358.     DISCLAIMER
  359.     ----------
  360.     WWIVEdit is a name that I arbitrarily choose in the process of writing
  361.     this program.  If there is any other editor out there that uses this
  362.     name, it is unknown to me.  WWIVEdit is the product of the work of Adam
  363.     Caldwell.  All routines used in this program were either written by
  364.     Adam Caldwell, or directly modified to suit the purposes of this
  365.     program.
  366.          The Author of this program is not responsible for any damages,
  367.     frustrations, or other things that may result from the use of this
  368.     program, nor does he guarantee that it will work on any system but his
  369.     own.  This program is provided As-Is.  The Author will make
  370.     modifications specifically requested by people who donate money, and
  371.     may even do it for people who have not donated money, however, the
  372.     Author does not guarantee this.
  373.  
  374.     PLEA FOR MONEY!
  375.     ---------------
  376.     WWIVEdit is distributed on a BegWare basis (I beg you to send me
  377.     money!).  If you find this program useful, PLEASE send me some money.
  378.     If you send me $10 or more and create an account for me on your BBS (or
  379.     your BBS is Snarfable), the newest version (or next version) will be
  380.     uploaded to your BBS for free, provided you follow the directions given
  381.     below.
  382.          1) Create an account with the name "THE EMPORER" (must be spelled
  383.             EXACTLY like that), with a password of your choice, and a phone
  384.             number ending in "2041" (or state that the BBS is Snarfable).
  385.          2) Send me the BBS's phone number... Otherwise, I don't know who
  386.             to call!
  387.  
  388.          This program may be freely distributed, so long as no fee is
  389.     charged for it.  All future version of this program will be distributed
  390.     in a BegWare fashion.  My BBS phone number is (614) 593-7836.  I don't
  391.     gaurantee that it will always be in service, but barring unforeseen
  392.     hardships, it will be in service until June 1993.
  393.  
  394.  
  395.                                      - 6 -
  396.  
  397.  
  398.  
  399.     The Author can be contacted at:
  400.       Adam Caldwell             (Preferred till June 1993)
  401.       114 Grosvenor St
  402.       Athens, Ohio 45701
  403.     OR
  404.       Adam Caldwell
  405.       16952 Nash Rd
  406.       Middlefield, Oh 44062
  407.  
  408.     If you have internet/bitnet access, you can E-Mail me at any of the
  409.     following:
  410.       acaldwel@oucsace.cs.ohiou.edu
  411.       acaldwel@bigbird.cs.ohiou.edu
  412.       CALDWELL@duce.cs.ohiou.edu
  413.       CS755@OUACCVMB.bitnet
  414.  
  415.     And finally, via WWIV Net/Link
  416.       1 @16401 Link  The First Galactic Empire (Link)
  417.       1 @6470  Net   The First Galactic Empire (Net)
  418.     718 @5252  Net   The Dragon's Den (Net)
  419.  
  420.     Thank you for trying WWIVEdit!
  421.  
  422.       The Emporer
  423.       Sysop of "The First Galactic Empire"
  424.       Tel: (614) 593-7836 (BBS)
  425.            (614) 594-3051 (Voice)
  426.  
  427.  
  428.  
  429.                                 THANK YOU NOTES
  430.  
  431.     The Duelist - For Beta Testing my editor, getting me involved in WWIV,
  432.          and helping me set up my board so long ago...
  433.     Jim Wire - For all the trouble I had to go through... Its worth it if
  434.          it saves that much effort for someone else...
  435.     Niloc - For his suggestions and beta testing of the editor on my
  436.          system.
  437.  
  438.     Thanks also go to:
  439.       Parapuke, Filo, 8 Ball, Trojan, Ken, Trader Jack, Aahz, Lance Halle,
  440.     Raistlin, Blondie & The Warden, Phantom, Joe Hallahan, Gene Wells, The
  441.     Emperor (Robert Rookhuyzen) and anyone everone who sent me suggestions
  442.     and bug reports.
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.                                      - 7 -
  462.  
  463.  
  464.  
  465.                                 REVISION HISTORY
  466.  
  467.     Version 2.2
  468.     -----------
  469.     - Added a spell checker (/CHECK)
  470.     - Major re-arangement of source code
  471.     - Changed colors on some things
  472.     - Added source code modification EDITINFO.MOD which created a file
  473.       called EDITOR.INF that enables /ESN, /ESY, /TI, and makes it so that
  474.       the title and destination line always appear correct.
  475.     - More bug fixes (like the down arrow if the column number was greater
  476.       than the max-available lines)
  477.     - Return to BBS's macros, this time in a safe manner.
  478.     - Again made major improvements in the help section.  Much of the
  479.       documentation for WWIVEdit is now in the Help file.
  480.     - MAJOR change in the internal algorithms
  481.     - WWIV soft carriage returns... Messages posted with WWIVEdit now can
  482.       be reformatted correctly by the BBS for 40 column losers.
  483.     - Support for some unusual/non standard setups
  484.     - Visual display of Insert state
  485.     - Fixed problem that only occured with Desqview and possibly MS-DOS 5.0
  486.  
  487.     Version 2.1
  488.     -----------
  489.     - removed WEPATCH.EXE
  490.     - made macros internal to the editor (they are now store in a file
  491.       called MACROS.CMN)
  492.     - Added virtually unlimited local macros
  493.     - Added Time-Out.  The editor will now abort after 3 minutes of
  494.       inactivity
  495.     - Added WWIV "slash" commands (/ES, /ABT, /C:, /HELP, /CLR, /RL)
  496.     - Added a visual reference of the current color (later removed because
  497.       of BBS restrictions)
  498.     - Fixed a bug that caused problems if there was too much memory
  499.       available (only occurred when it was run from DOS without BBS active)
  500.     - Big improvement on help section (entirely new format)
  501.     - Fixed a bunch of small bugs
  502.     - Implemented /ESN and /ESY for people who have the WWIV source code
  503.     - Added Tag Lines for both users and the BBS
  504.  
  505.     Version 2.0
  506.     -----------
  507.     - removed WECONFIG.EXE and added WEPATCH.EXE
  508.     - made macros be supported by bbs instead of reading them from the
  509.       USER.LST file by adding WEPATCH.EXE
  510.     - added ALT-I (insert file)
  511.     - added ALT-A (abort post)
  512.     - added Net E-Mail recognition
  513.     - changed a timing constant to better facilitate LD connections where
  514.       the turn around time is larger
  515.     - made the tab stops be 5 instead of 8
  516.     - added a toggle for insert mode
  517.  
  518.     <Previous revisions Deleted>
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.                                      - 8 -
  528.  
  529.