home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / s / syread03.zip / FILDOR10.ZIP / SLSYSOP.DOC < prev    next >
Text File  |  1980-01-01  |  17KB  |  445 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.         ╔═══════════════════════════════════════════════════════════╗
  11.         ║      S Y N E R G Y   A L L F I L E S   D O O R   v1.0     ║
  12.         ║             a door for Searchlight BBS systems            ║
  13.         ║       Sysop documentation for "Synergy Allfiles Door"     ║
  14.         ║                    Copyright(c), 1992                     ║
  15.         ║                 Synergy Computer Systems                  ║
  16.         ║                   Cocoa Beach, Florida                    ║
  17.         ╚═══════════════════════════════════════════════════════════╝
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32. ╔═══════╗
  33. ║ INDEX ║
  34. ╚═══════╝
  35.  
  36.       General Information  ............................ 1
  37.       Quick Setup  .................................... 2
  38.       Warning  ........................................ 3
  39.       Batch File Utilities  ........................... 3
  40.       Heart of the Door  .............................. 3
  41.       Advanced Setup  ................................. 4
  42.       ANSI Tips  ................................... Appendix
  43.                Screen Size Conflict  .................. i
  44.                Practice "Safe ANSI"  .................. i
  45.                ANSI Commands  ......................... ii
  46.                No more Jerky ANSI Screens  ............ iii
  47.                BE CAREFUL  ............................ iii
  48.  
  49.  
  50.  
  51.                                    - 1 -
  52.  
  53.  
  54. ╔═════════════════════╗
  55. ║ GENERAL INFORMATION ║
  56. ╚═════════════════════╝
  57.  
  58. Cost:
  59.          $0.00
  60.  
  61. Guarantee:
  62.           Money Back.  It will work if you follow the instructions.
  63.  
  64. Tech-Support:
  65.           None.
  66.  
  67. Praise/Donations:
  68.           Always accepted, Who knows, with enough of them
  69.           I might be able to put my board back on-line.
  70.  
  71.           Send blank checks to:
  72.           Ron Ryan
  73.           Synergy Computer Systems
  74.           524 S.  Atlantic Ave. #3
  75.           Cocoa Beach, Florida, 32931
  76.  
  77. Special Thanks To:
  78.            A good friend and fellow Searchlight SysOp, Genie Bohn.
  79.            Frank LaRosa for writing such a wonderful BBS package.
  80.  
  81. Acknowledgements:
  82.           SLBBS, SLDIR and Searchlight are trademarks of Searchlight Software.
  83.           Turbo Pascal is a trademark of Borland International Inc.
  84.           TheDraw is a trademark of TheSoft Programming Services.
  85.           DSZ is a trademark of Omen Technology Inc.
  86.           PKZIP is a trademark of PKWARE Inc.
  87.  
  88.  
  89. Copyright(c) Notice:
  90.           Though "Synergy Allfiles Door" is FreeWare, it is also Copyrighted
  91.           (c) material, with all rights reserved by Synergy Computer Systems
  92.           of Cocoa Beach, Florida.  Synergy Computer Systems grants you the
  93.           right to freely modify "Synergy Allfiles Door v1.0" and use for an
  94.           indefinite period of time at no cost to you, but you may NOT
  95.           distribute modified copies of "Synergy Allfiles Door", nor may you
  96.           distribute "FILDOR10.ZIP"  unless it is in its original archive
  97.           form and packaged as a child archive of SYREADxx.ZIP.
  98.  
  99.           The rights, exclusions herein stated pertain only to  the files
  100.           included in "FILDOR10.ZIP"  and do NOT grant you any rights to
  101.           SYREADxx.ZIP. For your rights to SYREADxx.ZIP see the "Usage
  102.           Agreement" at the  end of "DOCUMENT.LST" inside the original
  103.           SYREADxx.ZIP.
  104.  
  105.  
  106.  
  107.                                    - 2 -
  108.  
  109. ╔═════════════╗
  110. ║ QUICK SETUP ║
  111. ╚═════════════╝
  112.  
  113. from DOS log into your BBS drive and type:
  114.  
  115. MD \SLBBS\FILEDOOR
  116.     /│\
  117.      └─── edit as required for your BBS directory.
  118.  
  119. go to where ever this zip is and type:
  120.  
  121. PKUNZIP FILDOR10.ZIP d:\SLBBS\FILEDOOR
  122.                     /│\
  123. d:  <────────────────┴─── whatever drive your BBS is on.
  124. CD \SLBBS\FILEDOOR
  125. PKUNZIP FILEDOOR
  126. COPY *.EXE \[anywhere in your path statement]
  127. DEL *.EXE
  128. COPY FILEDOOR.DEF ..  <──┬─── copies the files to the parent directory,
  129. COPY FILEDOOR.BAT ..  <──┘    [SL]BBS if you followed the instructions so far.
  130. DEL FILEDOOR.*
  131.  
  132.   If your BBS text directory is not a child directory of your BBS
  133.   or it is not named "TEXT" you will need to edit both of the following:
  134.            READRON.BAT
  135.            READROFF.BAT
  136.   so that they copy the appropriate .ANS and .TXT files to your text
  137.   directory.  If you are unsure of what a "child directory" is, go to
  138.   the next step and if you don't see 4 lines of "1 file(s) copied"
  139.   come back to here, edit the two batch files then repeat the next step.
  140.  
  141.   Run either of the above batch files from the DOS command line one time -
  142.   this will initialize a "Toggle Setting".  What the toggle setting is
  143.   will become apparent from inside the door.
  144.  
  145. CD ..
  146.  
  147.   Okay, now that the hard part is done, fire up your favorite ASCII text
  148.   editor and enter the following line in your DOORS.DEF (or a sub menu):
  149.  
  150.   9;0;0;0;Allfiles List Door;.;FILEDOOR.DEF
  151.  
  152.   Find the SYREADxx.ZIP that FILDOR10.ZIP came in and copy MAKEIDX.EXE  to
  153.   anywhere in your path.  Copy SYREADER.EXE to d:\SLBBS\FILEDOOR.
  154.   Log back into your BBS directory and type "MAKEIDX" (without the quotes).
  155.   Fire up your editor again  and edit MAKEIDX.CFG (it was just created by
  156.   MAKEIDX.EXE).  Be sure you have DSZ.COM and PKZIP somewhere in your path.
  157.  
  158.   log into your BBS and check out the new door.
  159.  
  160.   Now that wasn't so hard, was it?
  161.  
  162.  
  163.  
  164.                                    - 3 -
  165.  
  166. ******************************** WARNING ************************************
  167.   SL Doesn't provide a way to pass security attributes via Meta-Strings,
  168.   and I don't have Frank's FILEDEF Units to access the system files, So . . .
  169.   If you use this package as a door -AND- are using attributes to secure
  170.   certain file areas I recommend that you go back into your SETUP and raise
  171.   the access to any restricted file areas to an access level greater than
  172.   that of any user you don't want to have access to a copy of the directory
  173.   listing of the above said file areas <Grin>... Did you get that?
  174. *****************************************************************************
  175.  
  176.    If you don't care about the trivial and the tech you can pass up this
  177.    section and go straight to the "ADVANCED SETUP" section that follows.
  178.  
  179. ╔══════════════════════╗
  180. ║ BATCH FILE UTILITIES ║
  181. ╚══════════════════════╝
  182.  
  183.    The early releases of v2 SLDIR had a bug (I have no idea if it has been
  184.    fixed yet) that required entering two carriage returns if you ran SLDIR
  185.    from inside a batch file.  ENTER.EXE is a little public domain utility
  186.    that was written for the old XT's... it places two carriage returns in the
  187.    heap and returns them right after the next command is run from inside
  188.    a batch file (originally to get passed the TIME/DATE annoyance of the old
  189.    A: drive systems).  Well, it's just what the doctor ordered for SLDIR.
  190.  
  191.    I do most of my programing in Turbo Pascal 4.0 (yea, it's old, but I can't
  192.    afford a new one), and it has a faulty DOS unit (i.e . . . Exec is
  193.    non-existent) so running a command.com /c just plain old doesn't work.
  194.    so you are stuck with this flimsy Batch door until you write a REAL one,
  195.    or I win the Lotto.
  196.  
  197.    LN.EXE is assigned to a null file with DirectVideo:=False, so it should
  198.    have no problem transmitting over a com port or being redirected.  LN.EXE
  199.    is my solution to the cruddy DOS echo command that returns an OFF or ON
  200.    pending on it's status unless you put something on the line with it.  I
  201.    think a blank line with "." or something looks tacky.  LN.EXE is just
  202.    a WriteLn statement assigned as stated above.
  203.  
  204.    WAIT A MINUTE!! I know it use to work, ^G inside a batch file
  205.    used to send a BEEP, I don't know what happened, if it's my system, or the
  206.    new DOS but ^G no longer works on my system, I am going to assume it is
  207.    the new DOS and therefore BEEP.EXE is just plain old there unless you want
  208.    to dump it.
  209.  
  210. ╔═══════════════════╗
  211. ║ HEART OF THE DOOR ║
  212. ╚═══════════════════╝
  213.  
  214.    If you are interested in figuring out how this batch door works, just
  215.    print FILEDOOR.DEF and FILEDOOR.BAT.  The "Toggle"  works through
  216.    READRON.BAT, READROFF.BAT. and a batch file they copy each other to -
  217.    TOGGLE.BAT which is called by selection 1) on the door menu - I call
  218.    this process "Oaky Boolean".
  219.  
  220.                                    - 4 -
  221.  
  222.  
  223.    The first 3 parameters in FILEDOOR.DEF are standard SL Meta-Strings
  224.    (%K = First Name, %F = File Access Level, %P = Com Port) the forth
  225.    parameter is the batch file prefix for the requested transfer protocol,
  226.    see the forth line up from the bottom of FILEDOOR.BAT.
  227.  
  228. ╔════════════════╗
  229. ║ ADVANCED SETUP ║
  230. ╚════════════════╝
  231.  
  232. FILEDOOR.BAT
  233.    ── line 6: ──
  234.    Remember - %2 is the second parameter from the FILEDOOR.DEF
  235.    file so %2 is equivalent to the user file access level of who ever is
  236.    in the door.  For more information on the usage of SLDIR.EXE line refer
  237.    to SLDIR.DOC (it's in SLDIR.ZIP on one of your SLBBS disks).
  238.  
  239.    ── line 24 ──
  240.    The default zip name is SYNERGY.ZIP, you may want to change "SYNERGY"
  241.    to a legal DOS prefix (8 characters) that is representative of your BBS.
  242.  
  243.    ── line 31 ──
  244.    You may need to change the path statement at the end of this line.
  245.    If you change line 21 then also change this line to "prefix.ZIP".
  246.    It should look like this:
  247.         CALL %4 %3 prefix.ZIP C:\SLBBS\FILEDOOR
  248.  
  249.    ──  Idea ──
  250.    If you would like the door to default back to Toggle On -or- Off after
  251.    someone has used the door add either of the following lines to the end
  252.    of FILEDOOR.BAT:  CALL READRON  -or- CALL READROFF
  253.  
  254. READRON.LST & READROFF.LST
  255.  
  256.    TOGGLE.BAT copies one of the above stated files to ZIPPING.LST
  257.  
  258.    This file contains the file names required as per the usage agreement
  259.    for SYNERGY.EXE.  The 24th line of FILEDOOR.BAT assigns this file for
  260.    PKZIP's use . . .  PKZIP looks inside this file for the names of the
  261.    file to zip up in the download packet,  you may add additional files
  262.    to this list if you so desire, but they must be available in
  263.    d:\SLBBS\FILEDOOR or there full DOS path declared in ZIPPING.LST
  264.    (see PKZIP.DOC for more information).
  265.  
  266. READRON.ANS & READROFF.ANS
  267.  
  268.    TOGGLE.BAT copies one of the above stated files to ..\TEXT\FILEDOOR.ANS
  269.               along with its respective .TXT file.
  270.    NOTE: if you edit these files PLEASE read "ANSI TIPS".
  271.  
  272.  
  273. Appendix                            - i -
  274.  
  275. ╔═══════════╗
  276. ║ ANSI TIPS ║
  277. ╚═══════════╝
  278.  
  279.    NOTE: For best results, always save .ANS drawings with a Clear Screen,
  280.    unless you plan on using small drawings for "Signature Macros" via your
  281.    INCLUDE file directory and the %%FILENAME directive.  For further
  282.    information on the %%FILENAME directive  see  your SL manual (7-13
  283.    for v1.7? users and 9-13 for 2.?? users).
  284.  
  285.                       ╓──────────────────────╖
  286.                    ───╢ Screen Size Conflict ╟───
  287.                       ╙──────────────────────╜
  288.  
  289.    Now, if you redrew the .ANS menu, do me and your users a BIG favor . . .
  290.    Edit out all of those extra lines at the end installed by TheDraw
  291.    so we can have CLEAN screen transitions.  If you don't know how to do
  292.    this read on -  I'll try and make it as simple as possible -
  293.    The ANSI standard file is 25 lines long (one full screen).
  294.  
  295.    We need a line for the status bar, a space, a command line and another
  296.    space (whops, that's backwards... from the bottom up) count them:
  297.  
  298.    1 bar + 1 space = 2 + 1 command line = 3 + 1 space = 4.
  299.  
  300.    Our screen is only 25 lines.
  301.    A 25 line ANSI screen + 4 lines for the BBS = 29.
  302.    Sounds like a lousy <MORE> prompt to me, or at the least a jerky screen
  303.    scroll.
  304.  
  305.    So FIX IT!!!
  306.  
  307.    How?
  308.  
  309.                       ╓──────────────────────╖
  310.                    ───╢ Practice "Safe ANSI" ╟───
  311.                       ╙──────────────────────╜
  312.  
  313.     First of all, as a general rule leave your top line blank - many
  314.    com programs have a status bar on the top as well as the bottom.  Second,
  315.    to simplify later editing in an ASCII editor I always save ANSI files
  316.    with maximum line lengths of 80 (not TheDraw's default of 255).  Never
  317.    put anything in your ANSI drawing beyond line 21.  One more point, I
  318.    have on two occasions had users tell me that they get a "Word Wrap" type
  319.    effect on some of my full-screen width drawings - this is a problem with
  320.    there ANSI driver or com program, not the images - There ANSI driver was
  321.    for some reason warping at around 78 characters.  I'm not sure what driver
  322.    they where using (they didn't know).  I solved this problem by NEVER
  323.    writing in the 1st or 79th column.
  324.  
  325.  
  326. Appendix                           - ii -
  327.  
  328.    Let's go over this again:
  329.  
  330.    1) Top line Blank.
  331.    2) Last Line 21 (maximum).
  332.    3) 1st column 2.
  333.    4) Last column 78.
  334.    5) save as 80 for line length.
  335.    6) Save Clear Screen.
  336.  
  337.    To use an ANSI "Signature Macro" with the %%FILENAME directive ignore
  338.    rules 1 and 6.
  339.  
  340.                           ╓───────────────╖
  341.                        ───╢ ANSI Commands ╟───
  342.                           ╙───────────────╜
  343.  
  344.    All of the typical ANSI editors I've seen pad the end of the ANSI files
  345.    to line 25 in order to conform with ANSI standards.  If for example your
  346.    last character is a "╝" on line 20 the  end of your file may look
  347.    something like this:
  348.  
  349.                                      . . .═══╝ *[0m*[21;1H*[22;1H*[23;1H*[A
  350.    *[24;1H*[25;1H*[0m*[255D
  351.  
  352. NOTE: To facilitate printing, I used an astrik (*) to represent the ASCII
  353.       character #27 (left arrow).
  354.  
  355.    The "*" (left arrow) is an  Esc. code.  The combination "*[" signifies
  356.    an ANSI terminal code (or an upcoming command).  Each terminal code is
  357.    followed by a number, or a series of numbers separated by semi-colons,
  358.    then a letter.  The letter is the command.  The numbers are the variables
  359.    to the command.  i.e . . .
  360.  
  361.    In "COPY FILDOR10.ZIP",  "COPY" is the command,  while "FILDOR10.ZIP" is
  362.    the variable (yes, ANSI  does it backwards to!).
  363.  
  364.    The four commands you'll most likely see at the end of an ANSI file are:
  365.    m, H, A,  and D.
  366.  
  367.    m sets the color.  *[0m sets the color back to default.
  368.  
  369.    H controls the cursor position.
  370.  
  371.    A is simply an "End of Line" marker or "word wrap" command.  When ANSI *[A
  372.      encounters the *[A
  373.      command it stops reading on the current line *[A
  374.      and starts again on the next line.
  375.  
  376.      NOTE: This has no bearing on the output, it is just a pointer inside the
  377.            file being read.
  378.  
  379.    D moves the cursor to the left one count for each number (*[255D moves the
  380.      cursor left 255 columns).
  381.  
  382.  
  383.  
  384. Appendix                           - iii -
  385.  
  386.  
  387.    The ANSI command you need to worry about is the "H" command.
  388.    The first number is the row, the second number is the column, i.e . . .
  389.    *[21;1H says move the cursor to the beginning (column 1)  of line (row) 21,
  390.    *[22;1H says move the cursor to the beginning of line 22,  Etc . . .
  391.    until you are finally at line 25.
  392.  
  393.                       ╓────────────────────────────╖
  394.                    ───╢ No More Jerky ANSI Screens ╟───
  395.                       ╙────────────────────────────╜
  396.  
  397.    The fix for this annoyance?
  398.  
  399.    Simple...
  400.  
  401.    After you exit your favorite ANSI editor enter your favorite ACSII editor
  402.    and delete all of the *[##;#H commands  AFTER the last character in your
  403.    drawing.
  404.  
  405.    NOTE:  Out of habit, I always stop my drawings by line 20 and leave in
  406.           the first "H" command in for prosperity, though theoretically
  407.           this is not necessary, I've yet to have bad results.  For
  408.           Signature Macros, you need to follow this process, or any
  409.           subsequent text (i.e . . . P.S ...) will continue on the same
  410.           row and column as the last character in the macro.  The end of
  411.           one of my files would look something like this:
  412.  
  413.    . . .═══╝ *[0m*[21;1H*[0m*[255D
  414.                  - OR -
  415.                     . . . ═══╝ *[0m*[21;1H*[A
  416.     *[0m*[255D
  417.  
  418.           both of the above examples are legal, but this is not:
  419.  
  420.    . . .═══╝ *[0m*[21;1H*[A*[0m*[255D
  421.  
  422.          ANSI would reset the color, move the cursor, then read from the
  423.          next line and find that it was at the end of the file . . .
  424.          without ever resetting the terminal.
  425.  
  426.          Remember - the original looked like this:
  427.  
  428.                                      . . .═══╝ *[0m*[21;1H*[22;1H*[23;1H*[A
  429.      *[24;1H*[25;1H*[0m*[255D
  430.  
  431.                              ╓────────────╖
  432.                          ────╢ BE CAREFUL ╟────
  433.                              ╙────────────╜
  434.  
  435.    Don't take out any of the other ANSI commands, or parts of
  436.    them, or you might have some weird things happen to your screen colors
  437.    or cursor positioning, nothing permanent, but it can sure mess up a nice
  438.    piece of art!
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.