home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Media Share 9
/
MEDIASHARE_09.ISO
/
bbsdoor
/
library.zip
/
LIBRARY.DOC
< prev
next >
Wrap
Text File
|
1993-07-31
|
17KB
|
374 lines
Online Library
Copyright (c) 1993 by Mark Williamson
Software Solutions
PO Box 1233, Lemoore CA
92345-1233
BBS: (209)997-0224
Fido 1:214/54
╒═════════════════════════════════════════════════════════════════════════════╕
│░░░░░░ LICENSING INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
╘═════════════════════════════════════════════════════════════════════════════╛
This program is not Freeware. This is SHAREWARE which means it is user-
supported software. If you use this program for more than 30 days, you are
required to register or remove it from your system. The registration fee is
a mere $10.00 and is not a lot to ask.
The concept works only with your support. If you find that you can use this
program, then a registration fee of $10.00 U.S. funds will help defray the
development cost and encourage the authorship of other programs that might be
useful to you. A Registration Form for this purpose is included with the
distribution archive and is called REGISTER.DOC.
Online Library is Copyrighted (c) 1993 by Mark A. Williamson and all
rights are reserved. You may copy this program and documentation for
backup purposes. You also may copy and share UNMODIFIED copies of the
program package, providing that the copyright notice is reproduced and
included on all copies.
You may not sell the product for a fee and/or distribute the product
along with other products without expressed written permission from Mark
Williamson, nor may you modify or remove the Copyright Notice from the
program or the documentation.
Those who register this program within one year of its release by the author,
will receive a registration key. The key will be delivered either by personal
upload, netmail or postal service. Allow up to 6 weeks for delivery.
This program is not guaranteed to do anything except take up hard disk
space. This program was written with the intent to support as many BBS
systems as possible.
Comments, suggestions and bug reports are welcome. If you have any, you
should contact Mark Williamson at Fidonet 1:214/54.
If you're reporting a bug, please give as much detail as possible about the
problem you are experiencing so that it can be duplicated and fixed.
╒═════════════════════════════════════════════════════════════════════════════╕
│░░░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
╘═════════════════════════════════════════════════════════════════════════════╛
Online Library was written to provide System Operators (SySops) a means
of letting their callers view ANSI/AVATAR screens, read online
newsletters, text files, and any other text-based items of interest.
The door was written in order to provide features not easily
incorporated by simply creating a menu setup to display text files based
on user input.
Online Library will provide the caller with a list of Sysop defined
categories from which to choose. Upon selecting a category, Online
Library will begin displaying the descriptions of each file available
within the current category. Description files are maintained by the
sysop using any ASCII compatible text editor. Description files utilize
the 'standard' FILES.BBS format so affectionally known by all
QuickBBS/Remote Access sysops. Description files may contain special
color codes interpreted by Online Library prior to displaying to the
caller. This feature will enable the sysop to customize the output of
Online Library.
Online Library stores all library files available to the caller in
compressed files. The library archive utility is sysop configurable.
This may be PKZIP, ARJ or whatever the Sysop prefers. Each file is
unpacked from the archive prior to display/download. A word of warning
here: When the user tags files, they may either (V)iew the files or
(D)ownload the files that are tagged. When Online Library prepares to
send the tagged files, a special file named "send.lst" is created which
contains each of the filenames to be sent, one per line. Online Library
will pass this filename to the archive utility to unpack the tagged
files. When using PKUNZIP, a sample command line to unpack files where
the filenames are stored in a file, would be: PKUNZIP <archive.zip>
@SEND.LST
The @ symbol tells PKUNZIP to fetch the filenames from the filename that
follows the @ symbol. ARJ does not seem to support this feature.
Therefore, we strongly suggest that you check the docs on the archive
utility you decide to use to see if it supports this feature.
Additionally, when sending a list of tagged files, Online Library will
correctly pass the send.lst to DSZ so DSZ will begin transmitting the
files. Remember, Xmodem does not support batch transfers!
Online Library enables the callers to download any file from the library
which may interest them. Callers may also upload files into the
library, for others to enjoy.
╒═════════════════════════════════════════════════════════════════════════════╕
│░░░░░░ INSTALLATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
╘═════════════════════════════════════════════════════════════════════════════╛
Online Library can be setup in minutes. Just create a subdirectory for
the program and unpack the distribution archive into this subdirectory.
Next, run the configuration program, LIBCFG.EXE. Each prompt is
described below:
System Name: Enter the name of your BBS as you want it to appear to
the caller.
Sysop Name: Enter your first and last name. This information should
be exactly the same as it would appear on your
registration form. Case is relevant.
Registration #: Enter your personal registration number. If
unregistered, enter zero (0).
Library Dir: Enter the drive and path to where the library archive
files will be stored.
Logfile Name: Enter the full drive, path and filename where user
activities should be recorded.
Archive Pack: Enter the DOS command line to invoke your archive
utility and cause it to ADD a file to an archive.
Archive Unpack: Enter the DOS command line to invoke your archive
utility in the UNPACK mode.
Example: PKZIP (pack): ARJ - :add
PKUNZIP (unpack): PKUNZIP -e :extract
Paging hours: Starting and ending paging hours (24 hour format)
If you are using Remote Access 2.0, you must use the Exitinfo.bbs
conversion utility included in this archive. Therefore, you must run
Online Library from a batch file. You should place Online Library in
your DOS path so you don't have to worry about where the executable
files are located. Online Library will search the DOS path to find its
configuration file. A sample batch file for Remote Access 2.0:
LIBRARY.BAT:
CD \RA
EXITINFO
LIBRARY
EXITINFO /NEW
Here is a sample of a type 7 menu entry that might be used to execute
Online Library from a batch file:
Type 7 command line:
*C /C C:\RA\LIBRARY.BAT *M
Or, if you are not running Remote Access 2.0, you may run Online Library
from the BBS system directory, provided Online Library resides in the
DOS path:
Type 7 command line:
LIBRARY.EXE *M
That's all there is to installing Online Library.
After you have your BBS setup to run Online Library, and you have your
categories configured, you will now need to create some description
files and create the archives.
Each category is identified by a number, 1 - 100. Each archive
file and description file also are identified using this number.
This makes it easy to keep the archives and description files in sync.
An archive filename begins with the word "LIB" and includes the
category number, then the default extension of the archive utility. It
is important not to change the file extension of the archive, because
your archive utility probably won't find the file if you do so.
Example archive filename (assuming PKZIP is the archive utility): For
category 1, the corresponding archive file would be LIB1.ZIP.
Description files also use this file naming convention. A description
filename begins with the word FILES plus the category number, then the
extension "BBS". For the above example for category 1, the
corresponding description file would be FILES1.BBS
Each line in the description file is interpreted by Online Library
according to the following rules:
If the first character of the line is a space ' ', then that line is
consider to be a comment line.
If the first character is not a space, a filename is assumed. Filenames
may consist of up to 12 characters. Filenames start in column one and
end in column 13.
File descriptions begin at column 14 and continue up to column 75.
Extra space is required for tag numbers inserted by Online Library.
Sample line from a FILESx.BBS:
LIBRARY.DOC User's manual for the great library program Online Library
^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12 chars start description at column # 14
╒═════════════════════════════════════════════════════════════════════════════╕
│░░░░░░ ADDING COLOR TO YOUR DESCRIPTION FILES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
╘═════════════════════════════════════════════════════════════════════════════╛
Online Library supports a special color code system which you can use to
add special flare to your file descriptions and comments. To change the
color, each color string must begin and end with the reverse single
quotation mark. For example, `bright green` would change the
foreground color to bright green. The following keywords and color
codes are recognized by Online Library:
Keyword Action
------- ------
Bright Turns on high intensity
Flashing Causes the text to flash/blink
Foreground Colors Background Colors
----------------- -----------------
Black Black
Blue Blue
Green Cyan
Cyan Green
Red Magenta
Magenta Brown
Brown White
White (grey)
Yellow
You can make the color codes more legible by placing extra words in
between the single quotes. For example:
`Bright White on a Blue Background`
is the same as..
`bright white blue`
Case is not relevant. Note, that each line of the description file must
not exceed 150 characters. This is the internal limit of Online
Library.
╒═════════════════════════════════════════════════════════════════════════════╕
│░░░░░░ SUPPORT FILES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
╘═════════════════════════════════════════════════════════════════════════════╛
The following is a list of files related to the operation of this program.
It is noted whether or not the file is absolutely required in order for the
program to run.
Filename Required Description
------------ -------- -------------------------------------------------
LIBRARY.EXE Yes The main executable.
LIBRARY.CFG Yes Configuration file - created by LIBCFG.EXE
LIBCFG.EXE Yes Used to configure Online Library and setup
Categories.
EXITINFO.ARJ Yes Exitinfo.bbs conversion utility for Remote
Access version 2.00
FILES.* Yes Description files read by Online Library.
LIB*.??? Yes Archive files used by Online Library.
REGISTER.DOC No The program registration form.
LIBRARY.DOC No The User's Manual
╒═════════════════════════════════════════════════════════════════════════════╕
│░░░░░░ USING ONLINE LIBRARY ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
╘═════════════════════════════════════════════════════════════════════════════╛
Operation of Online Library is really straightforward. When the caller
enters the door, they will be presented with a category list. At the
left of each category is the category number. At the bottom of the list
is a menu of options.
From this menu, the caller can select a category or they may:
Quit to the BBS
Log off the system
Display the next 10 categories
Display the previous 10 categories
When the user selects a category, Online Library will begin listing the
contents of the appropriate description file. File tag numbers will be
listed to the left of each file name. After each screen full, a menu
prompt will appear at the bottom of the screen. At this prompt, the
user may:
(T)ag files for viewing. Callers may Tag files in the current category
for later viewing. While viewing tagged
files, each file is displayed one after the
other, pausing between files. If files have
already been tagged, the user will be able to
edit the existing list of tagged files. Once
the user returns to the category menu, the
previously tagged files are untagged.
(V)iew file If files have been tagged, then they will
begin to be displayed in succession. If no
files are tagged, the caller will be prompted
for to enter the Tag #s of the files to view.
(D)ownload file Prompts the caller for a filename to download.
(U)pload file Prompts the user for the filename and
description of the file to be uploaded. If
the user does not enter a description, the
upload will be aborted.
(N)ext page Displays next page of file names/descriptions.
(P)rev page Displays the previous page of file names/
descriptions.
(Q)uit Returns to the category menu
╒═════════════════════════════════════════════════════════════════════════════╕
│░░░░░░ NOTES FROM THE AUTHOR ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
╘═════════════════════════════════════════════════════════════════════════════╛
Online Library is distributed "AS IS" and no warranty or gaurantee is
supplied. The end user accepts all responsibility for the proper use
and operation of Online Library. Under no circumstances will Software
Solutions be held liable for any damages or loss of resources either
directly or indirectly resulting from the use or misuse of this
software.
Online Library was written entirely in Turbo C++ 3.0 using the Open
Doors library version 4.1 by Brian Pirie.
By using the Tag files feature, callers can create their own ANSI slide
show. Just put in your favorite ansi screens and let your callers check
'em out!
Online Library has an internal limit of 200 lines in each description
file. To increase search speed, Online Library reads the entire
description file into memory when the user selects a category.
Online Library will swap to memory or disk when running the archive
utility. Many archive utilities need in excess of 300k to run, so
Online Library will shrink itself to free up valuable memory.
Online Library was programmed and tested on a 386sx/33 computer with a
Conner 120meg hard disk and 4 meg of ram. The BBS software is Remote
Access 2.00g1. Using SMARTDRV.EXE with a cache size of 1024k, the
operation of Online Library is very quick. The files are unpacked very
rapidly, and the user doesn't realize what the system is doing. Online
Library will display a message to the caller that the files are being
retrieved from the library. This message flashes by so quick, the
caller doesn't even realize that Online Library is running another
program.
Online Library will work with any BBS software that produces one of the
following Door Information Files:
DOOR.SYS
DORINFOx.DEF
CALLINFO.BBS
SFDOORS.DAT
CHAIN.TXT
EXITINFO.BBS (Remote Access 1.11/QuickBBS)
(Use the supplied EXITINFO.BBS converter for Remote Access 2.00)
If you have any suggestions/comments, please feel free to netmail me
your ideas. If you don't have Fido Net, please feel free to log onto
Software Solutions BBS, (209)997-0224. Supporting speeds up to 14.4k,
v42/32bis.