home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbsdoor / library.zip / LIBRARY.DOC < prev    next >
Text File  |  1993-07-31  |  17KB  |  374 lines
  1.  
  2.  
  3.  
  4.                              Online Library
  5.                  Copyright (c) 1993 by Mark Williamson
  6.                            Software Solutions
  7.                         PO Box 1233, Lemoore CA
  8.                                92345-1233
  9.                            BBS: (209)997-0224
  10.                              Fido 1:214/54
  11.  
  12.  
  13. ╒═════════════════════════════════════════════════════════════════════════════╕
  14. │░░░░░░ LICENSING INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  15. ╘═════════════════════════════════════════════════════════════════════════════╛
  16.  
  17. This program is not Freeware.  This is SHAREWARE which means it is user-
  18. supported software.  If you use this program for more than 30 days, you are
  19. required to register or remove it from your system.  The registration fee is
  20. a mere $10.00 and is not a lot to ask.
  21.  
  22. The concept works only with your support.  If you find that you can use this
  23. program, then a registration fee of $10.00 U.S. funds will help defray the
  24. development cost and encourage the authorship of other programs that might be
  25. useful to you.  A  Registration Form for this purpose is included with the
  26. distribution archive and is called REGISTER.DOC.
  27.  
  28. Online Library is Copyrighted (c) 1993 by Mark A. Williamson and all
  29. rights are reserved.  You may copy this program and documentation for
  30. backup purposes. You also may copy and share UNMODIFIED copies of the
  31. program package, providing that the copyright notice is reproduced and
  32. included on all copies.
  33.  
  34. You may not sell the product for a fee and/or distribute the product
  35. along with other products without expressed written permission from Mark
  36. Williamson, nor may you modify or remove the Copyright Notice from the
  37. program or the documentation.
  38.  
  39. Those who register this program within one year of its release by the author,
  40. will receive a registration key.  The key will be delivered either by personal
  41. upload, netmail or postal service.  Allow up to 6 weeks for delivery.
  42.  
  43. This program is not guaranteed to do anything except take up hard disk
  44. space.  This program was written with the intent to support as many BBS
  45. systems as possible.
  46.  
  47. Comments, suggestions and bug reports are welcome.  If you have any, you
  48. should contact Mark Williamson at Fidonet 1:214/54.
  49.  
  50. If you're reporting a bug, please give as much detail as possible about the
  51. problem you are experiencing so that it can be duplicated and fixed.
  52.  
  53.  
  54. ╒═════════════════════════════════════════════════════════════════════════════╕
  55. │░░░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  56. ╘═════════════════════════════════════════════════════════════════════════════╛
  57.  
  58. Online Library was written to provide System Operators (SySops) a means
  59. of letting their callers view ANSI/AVATAR screens, read online
  60. newsletters, text files, and any other text-based items of interest.
  61. The door was written in order to provide features not easily
  62. incorporated by simply creating a menu setup to display text files based
  63. on user input.
  64.  
  65. Online Library will provide the caller with a list of Sysop defined
  66. categories from which to choose.  Upon selecting a category, Online
  67. Library will begin displaying the descriptions of each file available
  68. within the current category.  Description files are maintained by the
  69. sysop using any ASCII compatible text editor.  Description files utilize
  70. the 'standard' FILES.BBS format so affectionally known by all
  71. QuickBBS/Remote Access sysops.  Description files may contain special
  72. color codes interpreted by Online Library prior to displaying to the
  73. caller.  This feature will enable the sysop to customize the output of
  74. Online Library.
  75.  
  76. Online Library stores all library files available to the caller in
  77. compressed files.  The library archive utility is sysop configurable.
  78. This may be PKZIP, ARJ or whatever the Sysop prefers.  Each file is
  79. unpacked from the archive prior to display/download.  A word of warning
  80. here:  When the user tags files, they may either (V)iew the files or
  81. (D)ownload the files that are tagged.  When Online Library prepares to
  82. send the tagged files, a special file named "send.lst" is created which
  83. contains each of the filenames to be sent, one per line.  Online Library
  84. will pass this filename to the archive utility to unpack the tagged
  85. files.  When using PKUNZIP, a sample command line to unpack files where
  86. the filenames are stored in a file, would be:  PKUNZIP <archive.zip>
  87. @SEND.LST
  88.  
  89. The @ symbol tells PKUNZIP to fetch the filenames from the filename that
  90. follows the @ symbol.  ARJ does not seem to support this feature.
  91. Therefore, we strongly suggest that you check the docs on the archive
  92. utility you decide to use to see if it supports this feature.
  93.  
  94. Additionally, when sending a list of tagged files, Online Library will
  95. correctly pass the send.lst to DSZ so DSZ will begin transmitting the
  96. files.  Remember, Xmodem does not support batch transfers!
  97.  
  98. Online Library enables the callers to download any file from the library
  99. which may interest them.   Callers may also upload files into the
  100. library, for others to enjoy.
  101.  
  102. ╒═════════════════════════════════════════════════════════════════════════════╕
  103. │░░░░░░ INSTALLATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  104. ╘═════════════════════════════════════════════════════════════════════════════╛
  105.  
  106. Online Library can be setup in minutes.  Just create a subdirectory for
  107. the program and unpack the distribution archive into this subdirectory.
  108. Next, run the configuration program, LIBCFG.EXE.  Each prompt is
  109. described below:
  110.  
  111. System Name:    Enter the name of your BBS as you want it to appear to
  112.                 the caller.
  113.  
  114. Sysop Name:     Enter your first and last name.  This information should
  115.                 be exactly the same as it would appear on your
  116.                 registration form.  Case is relevant.
  117.  
  118. Registration #: Enter your personal registration number.  If
  119.                 unregistered, enter zero (0).
  120.  
  121. Library Dir:    Enter the drive and path to where the library archive
  122.                 files will be stored.
  123.  
  124. Logfile Name:   Enter the full drive, path and filename where user
  125.                 activities should be recorded.
  126.  
  127. Archive Pack:   Enter the DOS command line to invoke your archive
  128.                 utility and cause it to ADD a file to an archive.
  129.  
  130. Archive Unpack: Enter the DOS command line to invoke your archive
  131.                 utility in the UNPACK mode.
  132.  
  133.                 Example:   PKZIP (pack):   ARJ -          :add
  134.  
  135.                            PKUNZIP (unpack):  PKUNZIP -e  :extract
  136.  
  137. Paging hours:   Starting and ending paging hours (24 hour format)
  138.  
  139. If you are using Remote Access 2.0, you must use the Exitinfo.bbs
  140. conversion utility included in this archive.  Therefore, you must run
  141. Online Library from a batch file.  You should place Online Library in
  142. your DOS path so you don't have to worry about where the executable
  143. files are located.  Online Library will search the DOS path to find its
  144. configuration file.  A sample batch file for Remote Access 2.0:
  145.  
  146. LIBRARY.BAT:
  147.  
  148.  CD \RA
  149.  EXITINFO
  150.  LIBRARY
  151.  EXITINFO /NEW
  152.  
  153. Here is a sample of a type 7 menu entry that might be used to execute
  154. Online Library from a batch file:
  155.  
  156. Type 7 command line:
  157.  
  158.  *C /C C:\RA\LIBRARY.BAT *M
  159.  
  160. Or, if you are not running Remote Access 2.0, you may run Online Library
  161. from the BBS system directory, provided Online Library resides in the
  162. DOS path:
  163.  
  164. Type 7 command line:
  165.  
  166.  LIBRARY.EXE *M
  167.  
  168. That's all there is to installing Online Library.
  169.  
  170. After you have your BBS setup to run Online Library, and you have your
  171. categories configured, you will now need to create some description
  172. files and create the archives.
  173.  
  174. Each category is identified by a number, 1 - 100.  Each archive
  175. file and description file also are identified using this number.
  176. This makes it easy to keep the archives and description files in sync.
  177. An archive filename begins with the word "LIB" and includes the
  178. category number, then the default extension of the archive utility.  It
  179. is important not to change the file extension of the archive, because
  180. your archive utility probably won't find the file if you do so.
  181.  
  182. Example archive filename (assuming PKZIP is the archive utility):  For
  183. category 1, the corresponding archive file would be LIB1.ZIP.
  184.  
  185. Description files also use this file naming convention.  A description
  186. filename begins with the word FILES plus the category number, then the
  187. extension "BBS".  For the above example for category 1, the
  188. corresponding description file would be FILES1.BBS
  189.  
  190. Each line in the description file is interpreted by Online Library
  191. according to the following rules:
  192.  
  193. If the first character of the line is a space ' ', then that line is
  194. consider to be a comment line.
  195.  
  196. If the first character is not a space, a filename is assumed.  Filenames
  197. may consist of up to 12 characters.  Filenames start in column one and
  198. end in column 13.
  199.  
  200. File descriptions begin at column 14 and continue up to column 75.
  201. Extra space is required for tag numbers inserted by Online Library.
  202.  
  203. Sample line from a FILESx.BBS:
  204.  
  205. LIBRARY.DOC  User's manual for the great library program Online Library
  206. ^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  207. 12 chars     start description at column # 14
  208.  
  209. ╒═════════════════════════════════════════════════════════════════════════════╕
  210. │░░░░░░ ADDING COLOR TO YOUR DESCRIPTION FILES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  211. ╘═════════════════════════════════════════════════════════════════════════════╛
  212.  
  213. Online Library supports a special color code system which you can use to
  214. add special flare to your file descriptions and comments.  To change the
  215. color, each color string must begin and end with the reverse single
  216. quotation mark.  For example, `bright green` would change the
  217. foreground color to bright green.  The following keywords and color
  218. codes are recognized by Online Library:
  219.  
  220.    Keyword               Action
  221.    -------               ------
  222.    Bright                Turns on high intensity
  223.    Flashing              Causes the text to flash/blink
  224.  
  225.    Foreground Colors     Background Colors
  226.    -----------------     -----------------
  227.    Black                 Black
  228.    Blue                  Blue
  229.    Green                 Cyan
  230.    Cyan                  Green
  231.    Red                   Magenta
  232.    Magenta               Brown
  233.    Brown                 White
  234.    White (grey)
  235.    Yellow
  236.  
  237. You can make the color codes more legible by placing extra words in
  238. between the single quotes.  For example:
  239.  
  240.    `Bright White on a Blue Background`
  241.  
  242.          is the same as..
  243.  
  244.    `bright white blue`
  245.  
  246. Case is not relevant.  Note, that each line of the description file must
  247. not exceed 150 characters.  This is the internal limit of Online
  248. Library.
  249.  
  250. ╒═════════════════════════════════════════════════════════════════════════════╕
  251. │░░░░░░ SUPPORT FILES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  252. ╘═════════════════════════════════════════════════════════════════════════════╛
  253.  
  254. The following is a list of files related to the operation of this program.
  255. It is noted whether or not the file is absolutely required in order for the
  256. program to run.
  257.  
  258.  Filename       Required   Description
  259.  ------------   --------   -------------------------------------------------
  260.  LIBRARY.EXE      Yes      The main executable.
  261.  LIBRARY.CFG      Yes      Configuration file - created by LIBCFG.EXE
  262.  LIBCFG.EXE       Yes      Used to configure Online Library and setup
  263.                            Categories.
  264.  EXITINFO.ARJ     Yes      Exitinfo.bbs conversion utility for Remote
  265.                            Access version 2.00
  266.  FILES.*          Yes      Description files read by Online Library.
  267.  LIB*.???         Yes      Archive files used by Online Library.
  268.  REGISTER.DOC     No       The program registration form.
  269.  LIBRARY.DOC      No       The User's Manual
  270.  
  271.  
  272. ╒═════════════════════════════════════════════════════════════════════════════╕
  273. │░░░░░░ USING ONLINE LIBRARY ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  274. ╘═════════════════════════════════════════════════════════════════════════════╛
  275.  
  276. Operation of Online Library is really straightforward.  When the caller
  277. enters the door, they will be presented with a category list.  At the
  278. left of each category is the category number.  At the bottom of the list
  279. is a menu of options.
  280.  
  281. From this menu, the caller can select a category or they may:
  282.  
  283. Quit to the BBS
  284. Log off the system
  285. Display the next 10 categories
  286. Display the previous 10 categories
  287.  
  288. When the user selects a category, Online Library will begin listing the
  289. contents of the appropriate description file.  File tag numbers will be
  290. listed to the left of each file name.  After each screen full, a menu
  291. prompt will appear at the bottom of the screen.  At this prompt, the
  292. user may:
  293.  
  294. (T)ag files for viewing.  Callers may Tag files in the current category
  295.                           for later viewing.  While viewing tagged
  296.                           files, each file is displayed one after the
  297.                           other, pausing between files.  If files have
  298.                           already been tagged, the user will be able to
  299.                           edit the existing list of tagged files.  Once
  300.                           the user returns to the category menu, the
  301.                           previously tagged files are untagged.
  302.  
  303. (V)iew file               If files have been tagged, then they will
  304.                           begin to be displayed in succession.  If no
  305.                           files are tagged, the caller will be prompted
  306.                           for to enter the Tag #s of the files to view.
  307.  
  308. (D)ownload file           Prompts the caller for a filename to download.
  309.  
  310. (U)pload file             Prompts the user for the filename and
  311.                           description of the file to be uploaded.  If
  312.                           the user does not enter a description, the
  313.                           upload will be aborted.
  314.  
  315. (N)ext page               Displays next page of file names/descriptions.
  316.  
  317. (P)rev page               Displays the previous page of file names/
  318.                           descriptions.
  319.  
  320. (Q)uit                    Returns to the category menu
  321.  
  322.  
  323.  ╒═════════════════════════════════════════════════════════════════════════════╕
  324.  │░░░░░░ NOTES FROM THE AUTHOR ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  325.  ╘═════════════════════════════════════════════════════════════════════════════╛
  326.  
  327. Online Library is distributed "AS IS" and no warranty or gaurantee is
  328. supplied.  The end user accepts all responsibility for the proper use
  329. and operation of Online Library.  Under no circumstances will Software
  330. Solutions be held liable for any damages or loss of resources either
  331. directly or indirectly resulting from the use or misuse of this
  332. software.
  333.  
  334. Online Library was written entirely in Turbo C++ 3.0 using the Open
  335. Doors library version 4.1 by Brian Pirie.
  336.  
  337. By using the Tag files feature, callers can create their own ANSI slide
  338. show.  Just put in your favorite ansi screens and let your callers check
  339. 'em out!
  340.  
  341. Online Library has an internal limit of 200 lines in each description
  342. file.  To increase search speed, Online Library reads the entire
  343. description file into memory when the user selects a category.
  344.  
  345. Online Library will swap to memory or disk when running the archive
  346. utility.  Many archive utilities need in excess of 300k to run, so
  347. Online Library will shrink itself to free up valuable memory.
  348.  
  349. Online Library was programmed and tested on a 386sx/33 computer with a
  350. Conner 120meg hard disk and 4 meg of ram.  The BBS software is Remote
  351. Access 2.00g1. Using SMARTDRV.EXE with a cache size of 1024k, the
  352. operation of Online Library is very quick.  The files are unpacked very
  353. rapidly, and the user doesn't realize what the system is doing.  Online
  354. Library will display a message to the caller that the files are being
  355. retrieved from the library.  This message flashes by so quick, the
  356. caller doesn't even realize that Online Library is running another
  357. program.
  358.  
  359. Online Library will work with any BBS software that produces one of the
  360. following Door Information Files:
  361.  
  362.        DOOR.SYS
  363.        DORINFOx.DEF
  364.        CALLINFO.BBS
  365.        SFDOORS.DAT
  366.        CHAIN.TXT
  367.        EXITINFO.BBS (Remote Access 1.11/QuickBBS)
  368.        (Use the supplied EXITINFO.BBS converter for Remote Access 2.00)
  369.  
  370. If you have any suggestions/comments, please feel free to netmail me
  371. your ideas.  If you don't have Fido Net, please feel free to log onto
  372. Software Solutions BBS, (209)997-0224.  Supporting speeds up to 14.4k,
  373. v42/32bis.
  374.