home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_UTIL / BM0406_A.ZIP / DOCS.ZIP / AEDMRG.DOC next >
Text File  |  1991-02-16  |  10KB  |  270 lines
  1.  
  2.                             ANSIED Documentation
  3. |                               Version 2.44a
  4.                                by Tom Collins
  5. |                                 02-16-91
  6.  
  7. |    Changes from the ANSIED v2.44 DOCs are marked with a vertical bar in
  8. |    the leftmost column.
  9.  
  10.      What
  11.      ----
  12.  
  13.      ANSIED is a merge for RBBS-PC that adds a full-screen editor for
  14.      entering messages.  The editor supports a wide range of commands, is
  15.      compact in size, and installs easily in to RBBS.  All that you need is
  16. |    this file, the RBBS-PC source code (v17.3B recommended), Ken Goosens'
  17.      BLED utility, and a QuickBASIC compiler (v3.0 or v4.5).
  18.  
  19.      What's in this ZIP
  20.      ------------------
  21.  
  22.      AEDMRG.DOC    - What you're reading now.
  23.  
  24.      AED244.BAS    - Standalone version of ANSIED.BAS.  Can be loaded into
  25.                      the QuickBASIC v4.5 environment and run. I use this
  26.                      version to figure out bugs.
  27.  
  28.      ANSIED.HLP    - Editor help file.  Put this in the directory that all
  29.                      of your other RBBS help files are, and ANSIED will
  30.                      display this for it's internal help command.
  31.  
  32.      ANSIED.BAS    - The full-screen editor program source.
  33.  
  34.      ANSIED-3.BAS  - The full-screen editor program source,  compilable with
  35.                      QuickBASIC v3.0.
  36.  
  37.      FINDWORD.*    - Find word left/right subroutine.
  38.  
  39.      MOVCSTR.*     - Move cursor string subroutine.
  40.  
  41.      ANSIED.QLB    - Quick library for AED244.BAS
  42.  
  43.      UPGRADE4.BAT  - RBBS recompile batch file.  Uses QB v4.5.
  44.  
  45.      UPGRADE3.BAT  - RBBS recompile batch file.  Uses QB v3.0.
  46.  
  47.      *.MRG         - Merges to the RBBS-PC source code for the editor.
  48.  
  49.      VARMOD.*      - C program to create RBBS-VAR.MOD (used by ANSIED.BAS)
  50.                      from RBBS-VAR.BAS.  Used in the UPGRADEx.BAT batch
  51.                      files.
  52.  
  53. |    What's new in v2.44a
  54. |    --------------------
  55.  
  56. |    o  When deleting a block, VT-100ish arrow keys now work.  No, really
  57. |       this time...
  58.  
  59. |    o  Under certain circumstances, ANSIED would R)eflow or J)ustify a
  60. |       paragraph of text out of existance, and it couldn't be recovered.
  61. |       Fixed.
  62.  
  63. |    o  The UPGRADE3 batch file was misssing a goto.
  64.  
  65.      What's new in v2.44
  66.      -------------------
  67.  
  68.      o  When deleting a block, VT-100ish arrow keys now work.
  69.  
  70.      o  When typing into existing text, lines are wrapped more
  71.         intelligently.
  72.  
  73.      o  Highlighted subjects won't crash the editor.
  74.  
  75.      o  Local cursor keys never bring up RBBS functions now (i.e. Repeated
  76.         PgUp's sometimes caused the local user's profile to come up).
  77.  
  78.      o  Saving messages containing no text no longer saves 99 blank lines.
  79.  
  80.      o  The RBBS help entension is used for the help file.
  81.  
  82.      o  Importing a message can now be done from ANSIED.
  83.  
  84.      o  You can change the message subject from within ANSIED.
  85.  
  86.      o  Ctrl-T now deletes word right.
  87.  
  88.      o  Code completely rewritten, with assembly-language routines used in
  89.         a few places.
  90.  
  91.      With all of these changes, ANSIED v2.44 is still about 1K smaller in
  92.      EXE size than v2.43.  Amazing, isn't it?
  93.  
  94.      About Merges
  95.      ------------
  96.  
  97.      When modifications or fixes are made to the main RBBS program, rather
  98.      than releasing an entire new set of source code, changes are released
  99.      as "merges" - files that contain the DIFFERENCE between the original
  100.      RBBS version and the new RBBS version.  Ken Goosens' BLED program is
  101.      used to merge the new changes into the old version.  This new "merged"
  102.      RBBS-PC is then recompiled.  The ANSIED merges follow in this
  103.      tradition.
  104.  
  105.      Included in this archive are:
  106.  
  107.         R???EDIT.MRG
  108.         R???ETOG.MRG
  109.  
  110.      What's the difference?  Both merges include ANSIED in the final
  111.      RBBS-PC, but the EDIT merge prompts the user for each message as to
  112.      whether to use ANSIED ("Use the Screen Editor (Y,[N])?") while the
  113.      ETOG merges install ANSIED as a T)oggle in RBBS' utilities section.
  114.  
  115.      Now, why would you NOT want to use the ETOG merges?  Well, these
  116.      merges use a previously unused bit field in the RBBS users record to
  117.      record whether the fullscreen editor is turned on or not for a given
  118.      user.  In theory, future RBBS versions could use this bit for
  119.      something else.  So, be forewarned... if you use the ETOG merges, they
  120.      *may* not work with future RBBS versions.
  121.  
  122. |    Merging ANSIED into RBBS v17.3B
  123.      -------------------------------
  124.  
  125. |    To merge ANSIED into RBBS v17.3B, using QuickBASIC v4.5, follow these
  126.      steps:
  127.  
  128.      a) Figure out which set of merges you want to use (ETOG or EDIT).
  129.  
  130.      b) Put all of the R*.BAS files in a work directory, along with the
  131.         .OBJ version of all of the assembler routines.  The R*.BAS files
  132.         usually come from a file called RBBS-BAS.ZIP.  The .OBJs are
  133.         usually in RBBS-ASM.ZIP.  Also make sure that ANSIED.BAS and the
  134.         *.OBJ files from this ZIP (MOVCSTR.OBJ and FINDWORD.OBJ) are in
  135.         this directory.  Also, make sure that VARMOD.EXE is in this
  136.         directory.
  137.  
  138.      c) Edit UPGRADE4.BAT to reflect your paths.  UPGRADE4 assumes the
  139.         following paths:
  140.  
  141.         BC.EXE        (QuickBASIC v4.5 compiler)   - C:\QB45
  142.         BLED.EXE      (Goosen's merge program)     - C:\QB45
  143.         BCOM45.LIB    (QuickBASIC library)         - C:\QB45\LIB
  144.         LINK.EXE      (Microsoft linker)           - In the PATH
  145.         R*.BAS        (RBBS .BAS files)            - Current Directory
  146.         *.OBJ         (RBBS and ANSIED .OBJ files) - Current Directory
  147.         ANSIED.BAS    (Screen editor source)       - Current Directory
  148.         VARMOD.EXE    (RBBS-VAR.BAS converter)     - Current Directory
  149.  
  150.      d) Run UPGRADE4 as follows:
  151.  
  152.             upgrade4 edit y
  153.  
  154.                 -or-
  155.  
  156.             upgrade4 etog y
  157.  
  158.         Note:
  159.  
  160.         The generic form of the UPGRADE4 command line is:
  161.  
  162.             upgrade4 xxxx <y/n>
  163.                      ^      ^
  164.                      |      |
  165.                      |      +-- compile after merging?
  166.                      |
  167.                      +-- merges name ... R-PCxxxx.MRG or RSB2xxxx.MRG
  168.                                          will be merged. (4 chars)
  169.  
  170.         So, UPGRADE4 can be used for RBBS version/fix upgrades, as well as
  171.         for merging ANSIED.  Here's a command line for RBBS v17.3 -> v17.3A:
  172.  
  173.             upgrade4 173a y
  174.  
  175.         To just compile RBBS, without merging anything, specify a merge
  176.         name that doesn't exist.  Like this:
  177.  
  178.             upgrade4 junk y
  179.  
  180.      e) If all goes correctly, you should have a new RBBS-PC.EXE in your
  181.         current directory.  Copy this version on top of your old version,
  182.         (You backed it up first, right?) and copy ANSIED.HLP to your RBBS
  183.         help directory.
  184.  
  185.      You should be up and running with ANSIED!
  186.  
  187.      The "UGLY" Merges
  188.      -----------------
  189.  
  190.      Available in another ZIP file are my so-called "UGLY" merges, which
  191.      change the way that RBBS looks, and fix some problems with the PUI
  192.      code.  If you'd like to use the "UGLY" merges with ANSIED, extract the
  193.      R???UGLY.MRG files into the work directory (as above), and run
  194.      UPGRADE4 like this:
  195.  
  196.         upgrade4 ugly edit y
  197.  
  198.             - or -
  199.  
  200.         upgrade4 ugly etog y
  201.  
  202.      Note that if you use the EDIT or ETOG merges, the name has to be the
  203.      LAST one on the UPGRADE4 command line.
  204.  
  205.      Guarantees
  206.      ----------
  207.  
  208.      ANSIED is absolutely guaranteed to work exactly as you expect it to
  209.      all of the time.  It has no bugs and it's completely compatible with
  210.      all existing computers and their related software.  If ANSIED does not
  211.      in any way meet your expectations of it, simply return it with a
  212.      proof-of-purchase seal and we'll refund double your money.  Thank you
  213.      for purchasing ANSIED!
  214.  
  215.      Bugs
  216.      ----
  217.  
  218.      If you find any bugs, keep them to yourself!
  219.  
  220.      Getting the Latest Version
  221.      --------------------------
  222.  
  223.      ANSIED is not really a "product," so no effort is being undertaken to
  224.      distribute it widely.  In general, the latest version is available to
  225.      any FidoNet sysop who cares to request it.  To File request ANSIED,
  226.      send a file request to the MSFA BBS, Catonsville, MD, FidoNet node
  227.      1:261/1047, and request the magic name "ANSIED" (without the quotes).
  228.      If you're not a FidoNet sysop, and would like to obtain the latest
  229.      version, try the MSFA BBS (1-301-536-1935), under the P)ersonal
  230.      downloads.
  231.  
  232.      Reaching the Author
  233.      -------------------
  234.  
  235.      To reach the author, enter a message in the FidoNet RBBS-PC echomail
  236.      conference, or leave a message on the MSFA BBS.
  237.  
  238.      New RBBS Versions
  239.      -----------------
  240.  
  241.      When a new RBBS version is released, there's an excellent chance that
  242.      ANSIED can be recompiled with the new RBBS version.  Start off by
  243.      merging the "EDIT" merges, and if that works, try the "ETOG" merges.
  244.  
  245.      Other Compilers
  246.      ---------------
  247.  
  248.      ANSIED can be used with QuickBASIC v3.0, but you'll have to use
  249.      ANSIED-3.BAS. The easiest way to use ANSIED-3.BAS is to use the
  250.      UPGRADE3 batch file, which works just like UPGRADE4.BAT.
  251.  
  252.      You can't use ANSIED with QuickBASIC v2.01 or BASCOM v1.00, because it
  253.      uses some of the v3.0+ statements.  ANSIED should be compilable with
  254.      some of the newer MicroSoft BASIC compilers, though I won't swear to
  255.      it.
  256.  
  257. |    Other Merges
  258. |    ------------
  259.  
  260. |    ANSIED may or may not work in conjunction with other merges to
  261. |    RBBS-PC.  To determine if ANSIED's merges interfere with other .MRG
  262. |    files, examine similar files with a text editor.  If two similar merge
  263. |    files (files that affect the same RBBS-PC module) contain the same
  264. |    line numbers, then the merges are incompatible, and you'll have to
  265. |    look at the merges and merge the merges together, before merging the
  266. |    result into RBBS (!).
  267.  
  268.      -- Tom Collins, ANSIED author
  269.  
  270.