home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / HILITE3.ZIP / HILITE.DOC < prev    next >
Encoding:
Text File  |  1992-12-12  |  10.3 KB  |  215 lines
  1.                     Searchlight Bulletin Board System (t)
  2.                        HILITE Bulletin/Text/News Autodoor
  3.                                  Version 3.0
  4.  
  5. PRESIS
  6. ------
  7.  
  8. HILITE is a simple form of "News" door which allows the Sysop of an SLBBS to
  9. display a (series of) bulletin or "news" files in either text or ansi form,
  10. depending on the graphics setting of the caller.  "--More--" prompts are
  11. implemented which allow the user to continue or abort the display of long
  12. news files.  These more prompts correctly "reassemble" the display when the
  13. user chooses to continue, resulting in a clean, uninterupted, uncorrupted
  14. display of either ansi or text files.  Additionally, a "passthrough"
  15. technique has been implemented wherein a user will be automatically dropped
  16. into the news file on his first log in.  Thereafter, when the user
  17. calls again, he will be asked if he wishes to view the "news" again.
  18. The Sysop has control over what the "news" will be called in the prompt.
  19.  
  20. INTRODUCTION
  21. ------------
  22. This utility is intended to help you, as an SLBBS Sysop, to further extend
  23. your BBS and to bring you and your users a higher level of professionalism
  24. and enjoyment.  I wrote this utility for myself and my BBS, and have had
  25. it running with good effect for over one year.  I consider it to be
  26. fully tested and debugged.  I am, therefore, releasing it now for the use
  27. and enjoyment of the SLBBS community.  You will note that I have installed a
  28. "credit line" in the program, but this should not be too much of a bother,
  29. given the gratituity-free nature of this utility.  
  30.  
  31. This utility is distributed FREE of any obligation on the part of
  32. non-commercial users.  Absolutely no warranties, either express or implied,
  33. are made or given with respect to the fitness of this utilities for its 
  34. intended purpose, or for ANY purpose.  Side-Bar BBS and Shane Anderson
  35. hereby expressly disclaim any such warranties; further, by use of these
  36. utilities, you agree to indemnify and hold Side-Bar BBS and Shane Anderson
  37. harmless from damages, however constituted or plead, which might be
  38. attributed to use of these utilities.
  39.  
  40. Commercial users may contact the Sysop of Side-Bar BBS for inforamtion
  41. regarding the licensing of these utilities.  The number appears below.
  42.  
  43. INSTALLATION
  44. ------------
  45.  
  46. Please note that the archive should include the following files:
  47.  
  48. HILITE.EXE - Program Executable
  49. HILITE.DOC - This Document
  50. EG.ANS     - Example Ansi News File
  51. EG.ASC     - Example Text News File
  52. EG.BAT     - Batch to run demo
  53.  
  54. If you are concerned that you have not received a "clean" archive, you may 
  55. FREQ a source copy from my BBS at the address given at the end of this 
  56. document.  The "Magic Name" for the file is "HILITE."
  57.  
  58. You are, of course, welcome to log in and download it from my "SLBBS"
  59. file directory.
  60.  
  61. You may install Hilite in any directory you wish.  I happen to have a sort
  62. of "catch all" directory that holds all small door utilities that do not need
  63. to be placed in the SLBBS main directory.  Just make sure that, when you call
  64. HILITE from a batch file or otherwise, you either switch to the appropriate
  65. directory, have the directory in the path or specify the path when you call
  66. the .EXE.  As usual, I have tried to minimize the need for configs, etc.,
  67. and have tried very hard to keep the application BBS independent so that
  68. the levels of administration you need to deal with are lessened and so that
  69. this utility will remain useful throughout your SLBBS upgrade path.
  70.  
  71. HILITE.EXE
  72. ----------
  73. The syntax of HILITE is as follows:
  74.  
  75. HILITE [ansi] [ascii] [log] [u] [g] [color] [NEWS]
  76.  
  77. WHERE:
  78.  [ansi]    the filespec of the ansi screen, including extension
  79.  [ascii]   the filespec of the ascii_screen, including extension
  80.  [log]     the filespec of the user log
  81.  [u]       the SLBBS parameter for full name (%U)
  82.  [g]       the SLBBS parameter for graphics  (%G)
  83.  [color]  the numeric color value for the opening "(Y/N)" prompt
  84.  [NEWS]    a string supplied to describe the file viewed eg: "News that's fit"
  85.  
  86. This bears elaboration.  Each of the first two parameters support full path
  87. names.  These are the news or "display" files to be displayed based upon the
  88. user's graphics mode.
  89.  
  90. You must specify the full name of the ansi and text/ascii display file
  91. names, and must also specify their paths if HILITE is called from a
  92. directory other than that in which it resides, __OR__ if the display files
  93. are in a directory other than the directory from which HILITE is called. 
  94. This is basic and fundamental to every DOS utility that you have ever used.
  95.  
  96. The log file also supports a full path.  This is the file that the program
  97. uses to determine if the user has already viewed the display files.  The
  98. technique is actually so simple as to be almost idiotic.  When a user logs
  99. in for the first time in a given day, his name is logged after he has viewed
  100. the whole display file.  Thereafter, if the user logs in again he will be 
  101. prompted as to whether he wishes to view the display files
  102. again.  (The prompt incorporates SLBBS look-alike sliding Yes/No prompts, and
  103. the prompt itself can be somewhat modified by the Syop, as discussed
  104. further, below.)  This allows for a great deal of flexibility, actually. 
  105. Think about it... if you do not want the prompting to occur, simply delete
  106. the log each time a user exits the BBS.  This can easily be done by adding a
  107. single statement to your log off autodoor.  On the other hand, if you wish
  108. to have the display file shown to users once per day, you can delete the log
  109. in your nightly events.  In this way, every day, the first time a user logs
  110. in, he will be shown the display files.  Finally, you might only delete the
  111. log file whenever there is ___NEW___ news.  This way, the user does not have
  112. to bother with rereading to see if anything is new.  
  113.  
  114. I actually gave a lot of thought to this, and thought that this
  115. configuration would give the greatest flexibility and user "freindliness." 
  116. Hopefully, you will agree... 
  117.  
  118. The passing of the %U and %G parameters is, I think, self explanatory. 
  119. Sysops using this utility on other than SLBBS systems, please note that the
  120. graphics paprmeters passed must be C, M or N for Color, Mono or None,
  121. respectively.  Also note that the name paprameter must be the full name of
  122. the user.  Otherwise, BILL SMITH will get prompted on his first log in
  123. becuse BILL JONES logged in before him.
  124.  
  125. As for the color parameter, the following should help:
  126.  
  127.          Black       -  0         Dark Gray      -  8
  128.          Blue        -  1         Light Blue     -  9
  129.          Green       -  2         Light Green    -  10
  130.          Cyan        -  3         Light Cyan     -  11
  131.          Red         -  4         Light Red      -  12
  132.          Magenta     -  5         Light Magenta  -  13
  133.          Brown       -  6         Yellow         -  14
  134.          Light Gray  -  7         White          -  15
  135.  
  136. This is the color of the promt that a user will receive when he has already
  137. viewed the display files.
  138.  
  139. FInally, the [NEWS] parameter is used to customize the prompt the user
  140. receives when he has already viewed the display files.  The prompt appears
  141. in the following form:
  142.  
  143. You have already viewed the YOUR TEXT HERE!.
  144. Would you like to re-read it?  Yes  No
  145.  
  146. The "YOUR TEXT HERE!" corresponds to the string given in the [NEWS]
  147. parameter.  Please note that if you were to use YOUR TEXT HERE! as the
  148. string, you would need to enclose it in quotes to get it to in, eg.
  149.  
  150. HILITE my.ans my.asc my.log %U %G 14 "YOUR TEXT HERE!"
  151.  
  152. Well, that's it for how to run HILITE.  The file, itself is self-documenting
  153. and has a decent level of error handling.  If you type HILITE at the DOS
  154. prompt, it will show you a screen summarizing the parameters to use.  Also,
  155. if you specify a color that is out of range it will show you a "color
  156. chart."  Bad file names, etc. will result in appropriate error messages. 
  157. All of this should make it easier to install HILITE and test and debug your
  158. setup.
  159.  
  160. One very simple caveat:  If you use some sort of ANSI drawing program to
  161. make news flashes, etc., make sure that you set up the line length to be 78
  162. or 79 columns, and that the size of the drawing does not exceed that margin.
  163. The reason is simple.  If you draw an ANSI with a line length of 39 and the
  164. drawing is full screen, the --More-- prompt will appear more than once per
  165. page.  This is becuase, even though you are seeing a line like this:
  166.  
  167. ----------------------------------------------------------------------------
  168.  
  169. it is really a line like this:
  170.  
  171. --------------------------------------
  172. --------------------------------------
  173.  
  174. with a Line feed after the first part of the line, followed by an ansi code
  175. that positions the cursor back up at the end of the first part.  That line
  176. feed will be counted by HILITE, and therefore, in this case, you will get a
  177. --More-- prompt only half way down the page.  There is nothing that I can do
  178. about this save for adding a bunch more code to the program and then adding
  179. more command line parameters, etc.  It is better that you simply draw the
  180. screens correctly to begin with.
  181.  
  182.  
  183. MAKING IT ALL WORK FOR YOU
  184. --------------------------
  185.  
  186. Be inventive.  You can use the user's security level in your autodoors to
  187. present different news items to different people at different levels.  You
  188. can vary when they will view the display files, and you can send only mono
  189. output by hard coding the Graphics parameter.  I have built this utility as
  190. all others I write - to have the greatest degree of flexibility.  A little
  191. imagination and strong batch file technique can result in some very nice
  192. extensions to SLBBS.  Hopefully this will prove to be a part of your
  193. arsenal... 
  194.  
  195. If you like this utility, and plan to use it, be so kind as to give me a
  196. little feedback.  I am usually found lurking in the C_ECHO in Fido.  I also
  197. frequent SHAREWRE.
  198.  
  199. If you do send a message that way, please try again if you get no response.  
  200. I ALWAYS reply to any post to me, but sometimes I think that those echos are
  201. the bottomless echos, and I have better things to do with my hardware than
  202. import two thousand six hundred and eighty eight echo posts per night per
  203. echo  <grinning and ducking>.
  204.  
  205. You are always welcome to log in to my board, netmail me or crash me mail at
  206. my Fido address.  Thanks for your interest, support and comments...
  207.  
  208. Best wishes and enjoy.
  209.  
  210. Shane G. Anderson
  211. Sysop, Side-Bar BBS
  212. 818/783-2069
  213. FidoNet:  1:102/819 
  214. (Sherman Oaks, California)
  215.