ftp.wwiv.com/ftp.wwiv.com.zip/ftp.wwiv.com/pub/BBS/SNIPT401.ZIP/SNIPPET.DOC

Text File | 1992-09-05 | 20KB | 550 lines

                        >>   SNIPPET V4.01   <<
                           Revision:  920905

                  (C) Copyright 1988-92 By John Folsom
                           All Rights Reserved



                              BOILERPLATE

WARRANTY
--------
The author disclaims any and all warranties, express or implied,
including warranties of merchantability or fitness for any purpose,
and refuses to accept liability for any damages, direct or indirect,
attributable to the use of this program.

SNIPPET was written by a computer hobbyist for his own use and is
being released for free public distribution in the belief that others
may also find it of some value.  While it is believed to be bug-free,
the user of this program assumes all risk with respect to its quality
and performance.

DISTRIBUTION
------------
SNIPPET is being distributed as Freeware.  All program copyrights are
reserved by the author.  Users are licensed to operate this program
on their personal computers for any purpose for which it may seem
suitable and for an unlimited period of time without monetary
obligation.  There is no "registered version", no enabling keys, no
disks to wait for, no fancy bound documentation.  This is as complete
and fully functional as it gets.

CONTRIBUTIONS
-------------
As a system operator since 1986 myself, I'm very much aware of the costs
involved in running a BBS and don't care to add to any sysop's financial
burden.  Nevertheless, if you DO like SNIPPET and choose to use it to
enhance your BBS, a nominal donation of $5.00 would be appreciated.  In
return for your contribution, I'll make a good-faith effort to provide
you (via modem) with future revisions of the program.  With or without
donation, I would appreciate comments from SNIPPET users, particularly
with regard to unique and innovative applications, or suggestions for
improving the program.  An address for these purposes is provided at the
end of this file.











SNIPPET V4.01                   Page [1]




                      GETTING TO THE GOOD STUFF

WHAT IT DOES
------------
SNIPPET is a flexible daily "quip" or "quote" message retrieval
system that, while operable as a stand-alone program, is specifically
designed to be universally adaptable for use with any major MS DOS
BBS format.  For the latter, the only requirements are that the host
software must have a sysop-configurable daily maintenance "event"
routine as well as the means to read and display an external ASCII
text file.  ANSI.SYS (or equivalent driver) is also required for
color/graphics display.

The SNIPPET text messages may be displayed as an initial "banner"
prior to the log-on prompt, upon user demand via a door routine, or
as a closing bulletin displayed at log-off.  DCI or SLBBS sysops, for
example, can use SNIPPET with the auto-logon door option available to
them to create a new message for each logon.  Conceivably, the program
could also be adapted to generate messages to be displayed randomly
(when called by the host software) during an online session.  In a
non-BBS application, SNIPPET can be used to display a fresh
"thought-for-the-day" each time the user's PC is booted up.  Both color
and monochrome files are created.

INSTALLATION
------------
For those upgrading, SNIPPET V4.01 is compatible with existing V3.+ data
files.  However, program changes require replacement of the SNIPPET.CFG
file generated by earlier versions.

All required files, except for the output files (e.g., SNIPPET.ANS and
SNIPPET.BBS) must be located together in the same subdirectory.  Upon
installation of V4.01, verify that the subdirectory used for the SNIPPET
files is included in your AUTOEXEC.BAT PATH statement.  This should be a
matter of course for those using their main BBS subdirectory
(recommended) for SNIPPET.

Example:

        PATH=C:\DOS;C:\NORTON;C:\FASTBACK;C:\BBS
                                          ^^^^^^
Using the subdir 'C:\BBS' as an example, add this new statement to your
AUTOEXEC.BAT file:

        SET SNP=C:\BBS

NOTE:   These measures are optional, required only if it is necessary
        or desirable to be able to run SNIPPET and/or SNIPCFG from other
        than the resident drive and subdirectory (C:\BBS in this
        example).






SNIPPET V4.01                   Page [2]




Files required for installation are:

                SNIPCFG.EXE     -- Custom configuration module
                SNIPPET.CFG     -- Configuration and indexing data
                SNIPPET.EXE     -- Main text retrieval program
                SNIPPET.DAT     -- SNIPPET text message database
                                   (ASCII)

Although the SNIPCFG.EXE file is not really required for normal
operation after installation, it's a good idea to keep it handy for
future display or database modifications.

Other files included in the authorized distribution archive are:

                SNIPPET.ANS     -- Sample ANSI display file
                SNIPPET.BBS     -- Sample Monochrome display file
                SNIPPET.DOC     -- This file
                FILE_ID.DIZ     -- Transfer File Description
                WHATSNEW.DOC    -- Recent Modification Notes

In addition, while some BBS programs may have internal accomodations
to call SNIPPET directly as a regular event, others may require an
external EVENT.BAT file for this purpose.  SNIPPET returns directly
to DOS level after generating the new day's message, so a simple
batch file like the following should suffice:

                @echo off
                snippet
                bbs               rem: or equivalent, if req'd

For a non-BBS application, the following lines can be added to the
end of an AUTOEXEC.BAT file:

                cls
                snippet
                type snippet.ans

As noted earlier, this will cause a new message to be displayed each
time the system is rebooted.

In a BBS environment, some planning prior to installation is called
for, including where (when) the snippet file should be displayed,
what special filename may be needed by the host for access, how the
displayed message is to interact with surrounding internally
generated BBS text or graphics, and so forth.  Decisions regarding
display format can be finalized after a period of experimentation.  The
Preview option provided in SNIPCFG can be very helpful in this regard.

The next step is to run SNIPCFG.  If you have a monochrome graphics
display (Hercules compatible), you may wish to boot this program with a
[M] or [/M] command-line option to ensure proper cursor positioning.
For example:
                SNIPCFG M (or) SNIPCFG/M



SNIPPET V4.01                   Page [3]




This program is straightforward and fairly self-explanatory.  The
current parameter definitions for SNIPPET (contained in SNIPPET.CFG) are
displayed along with a command dialogue window via which any or all may
be selected for modification.

CONFIGURATION OPTIONS
---------------------
The database of "snippets" (quotes, proverbs and witticisms) is
unencrypted and may be freely edited "to taste" by the user, or replaced
in toto using any ASCII text editor.  The real secret to SNIPPET's
flexibility and adaptability to different applications and environments,
however, is its unique configuration program.

SNIPCFG is designed to be as helpful as possible, letting the
computer do what it does best--the drudge work.  It isn't necessary, for
instance, to backspace over text strings; entering any new character
will automatically delete the old text.  Commands not shown in the menu
of options include [ESC] and <CTRL-C>, which immediately exit to DOS,
and <CTRL-Y> which may be used to delete an entire line of text.
Principal parameters/commands include the following:

   [1]  Color Output Filename:
   [2]  Mono Output Filename:

        Defines output filenames to satisfy host software requirements.
        SNIPPET generates both color and monochrome versions of the
        retrieved message text for display.  They may be renamed to suit
        any special BBS bulletin display format.  EBBS-PC sysops might
        want to use "CB.ANS" and "CB.ASC", for instance, so that the
        appropriate version will be displayed as the Closing Bulletin at
        logoff.  SNIPCFG will automatically inhibit spaces and limits
        the length of the filename (before extension) to 8 characters.

   [3]  File Destination Path:

        Redirects the SNIPPET output files to any specified
        subdirectory.  The complete path in the form [d:\subdir\...]
        must be provided.  Spaces are disallowed and the program will
        always assume the first character entered to be the destination
        drive, formatting text accordingly.  If no path is specified,
        the files generated will be saved to the SNIPPET resident
        directory.

   [4]  SNIPPET Preface Text [U/NU]:

        A prefacing "title" text string up to 39 characters in length
        can be included with the displayed snippet.  BBS sysops can use
        this feature to tailor the message to their system's particular
        theme or style.  Automatic underlining (indicated by the [U]
        flag) of this text when displayed may be toggled on or off.
        Leading, trailing and double spaces are disallowed.  The snippet
        may be displayed without preface by simply deleting the text.




SNIPPET V4.01                   Page [4]




   [5]  Color/Graphics Options:

        Invokes a sub-menu from which the simple SNIPPET graphics
        element (a 78 column doubled line) may be toggled on and off,
        and the foreground colors for graphics, preface text and snippet
        message may be individually selected.

   [6]  Lead/Trailing Blank Lines:

        Up to 6 blank lines (line feeds) may be separately specified to
        lead and/or trail the message display.  These will precede and
        follow the graphics element if enabled.  The total space
        occupied by the display will vary with message length.  If
        adequate spacing is provided by the host software, "0/0" may be
        entered.

   [7]  Message Retrieval Mode:

        Toggles between Sequential and Randomized SNIPPET message
        retrieval modes.  In sequential mode, messages are selected in
        the strict numerical order of the database.  The alternative is
        to have them called up at random.  Note that although the
        program will not allow the same message to be displayed
        back-to-back, it is possible that a message will occasionally
        reappear within a few cycles in random display mode.  It's all
        in the luck of the draw!

   [8]  Total/Sort SNIPPET Msgs:

        Retotals the message database, with or without random shuffling.
        This option MUST invoked be after any editing of the database
        which changes the number of messages or which creates gaps in
        its numerical sequence.  If randomization is elected (a
        secondary command option), the database will be completely
        re-ordered and renumbered.

        WARNING!  Because of the simple ASCII/sequential nature of this
        file, the random sort option will take considerable time.  For
        example, a 10 MHz 286 takes 19 minutes to randomly shuffle 450
        messages, while a sequential sort requires only 10 seconds.

   [9]  Next SNIPPET To Retrieve:

        This option allows the user to arbitrarily select any message to
        be the next displayed.  This is primarily useful in the
        sequential mode; to re-initiate things after rebuilding the
        database, to set up a particular sequence of messages for a
        special occasion, or for test purposes.








SNIPPET V4.01                   Page [5]




   [P]  Preview SNIPPET Msgs:

        This option allows the user to view the SNIPPET message
        configuration as it will actually appear in operation before
        saving revised parameters, view specific messages by number, and
        review the entire message database.  Preview options include
        line numbers on/off, next message, previous message, and
        auto-sequencing.

        When the Preview feature is first activated, the "Next SNIPPET
        To Retrieve" (see above) will be displayed with leading and
        trailing spaces as previously configured.  Line numbers are
        provided to verify spacing.  (With line numbers active, some
        lines of text may be truncated.)  These may be toggled off for a
        more normal representation.  The SNIPPET database may be stepped
        through forwards or backwards with the N>ext and P>revious
        commands or automatically displayed in numerical order with the
        S>equence option.  While auto-sequencing, invoking the S>top
        command holds the current message and returns to the manual
        display mode.

        NOTE!  "The Next SNIPPET To Retrieve" will have advanced to the
        message number following the last displayed in Preview and you
        may wish to change this prior to exiting SNIPCFG.

   [X]  EXIT/Save Parameters:

        Ends the program and, if any parameter has been modified,
        provides the opportunity to save the new configuration.

SPECIAL BBS APPLICATIONS
------------------------
Many BBS packages have special bulletin formats to consider as well as
unique features which are not explicitly supported by SNIPPET.
Nevertheless, with a little imagination and help from a DOS batch
command or two, seamless integration is possible for virtually any BBS
software.  For example, DCI sysops can use the following technique to
use their BULLETIN.MNU to display SNIPPET messages.

Create files like these with an ASCII editor:

P1:
  **DCI SNIPPET.BUL #1 - ANSI COLOR

P2:
  **DCI SNIPPET.BUL #2 - Extended ASCII

P3:
  (etc.....)

CC:
  //W




SNIPPET V4.01                   Page [6]




SNIPEVEN.BAT:
  @echo off
  cd snip
  snippet
  cd \dci
  copy snippet.bbs snippet.asc             rem: Create "third" file
  copy p1+snippet.ans+cc+p2+snippet.bbs+cc+p3+snippet.asc+cc snippet.bul

The line "%%SNIPPET.BUL%%" should then be inserted into the DCI
BULLETIN.MNU file (following the **DCI BULLETIN #1 header) and
SNIPEVEN.BAT called as a daily event.  This will cause a daily-updated
SNIPPET message to be displayed after log-on which is followed by a
"Press Any Key" pause prompt.  Although SNIPPET generates 2 files
initially,  here the mono file is duplicated to provide a third display
for 80 column text-only users.

TriBBS sysops can also incorporate their system's internal display
control codes by using the COPY command in a batch file.  The TriBBS
automatic ANSI detection feature allows the the display of the
appropriate (color or mono) SNIPPET message immediately after
connection, as in the example that follows.

First, create files similar to the following:

KEY:
               rem: ASCII 16

SNIPT:
  @echo off
  \snip\snippet
  cd display
  copy snippet.ans+key logon1.ans
  copy snippet.bbs+key logon1.bbs
  cd \tribbs
  board

Add a new daily event with SNIPT as the Event File called.  Thereafter,
a fresh SNIPPET will be generated daily that will display at log-on,
followed by the "more" prompt.  Elsewhere in the log-on sequence, it
might be desirable to use a file consisting solely of CHR$(12) added
ahead of the SNIPPET message (e.g., where "clrs" = ASCII 12:
"copy clrs+snippet.ans+key logon3.ans") to clear the screen before its
display.

The optional SNIPPET Preface (title) Text also provides a unique
opportunity to utilize BBS control codes to personalize messages by, for
example, automatically inserting the caller's name.









SNIPPET V4.01                   Page [7]




One note of caution!  When using the COPY command to combine files, do
NOT use the same filename for both a file to be combined and the
destination file.  The following statement:

  copy p3+snippet.bul+cc snippet.bul

...should be avoided.  This is because DOS will delete "snippet.bul"
(the destination file) before attempting to combine (COPY) the files,
resulting in a "File Not Found" error.

MAINTENANCE
-----------
SNIPPET normally requires no particular attention, however users do
have the option of adding, deleting or modifying individual snippets.
There are a couple of important things to keep in mind when making
these alterations.

     1.   This release of the program comes with a database of 600
          messages.  It may be expanded to up to a maximum of 999.
          In normal sequential retrieval mode, the program will
          automatically start over at the top after the highest
          numbered text has been used.  In randomized mode, the
          "message total" defines the selection range.  If messages
          are added or deleted, changing the total number of messages
          or creating gaps in numerical order, the SNIPCFG module
          must be rerun to update this parameter in the CFG file.
          The "Total/Sort" option eliminates any gaps or errors in
          message numbering.

     2.   A delimiter in the form "@@###" is required for each
          individual snippet message file, where "###" is the message
          number read during retrieval.  Each new message added must
          include its own unique identifier in precisely this form.
          Also, when deleting message fields, remove the
          corresponding delimiters to prevent the display of "nul"
          files.

ACKNOWLEDGEMENTS
----------------
Although SNIPPET.DAT is an eclectic compilation of quips, quotations,
and proverbs with diverse and, for the most part, untraceable origins,
the material used for the most recent editing and augmentation may be
attributed primarily to two sources:

THE PORTABLE CURMUDGEON                THE GREAT THOUGHTS
Compiled/edited by John Winokur        Compiled by George Seldes
(C)opyright 1987 by John Winokur       (C)opyright 1985 by George Seldes
Published by New American Library      Published by Ballantine Books
NAL Penguin, Inc.                      Random House, Inc.
New York, NY                           New York, NY

ISBN 0-453-00565-9                     ISBN: 0-345-29887-X




SNIPPET V4.01                   Page [8]




I gratefully acknowledge the following individuals for taking the time
to beta-test SNIPPET on their systems and for offering their enormously
helpful comments and suggestions for program improvement, most of which
I've tried to incorporate in recent versions of the program:

                    Ed Parry, EBBS-PC BBS author
                Marianne (Cassi) Love, DCI BBS author
                               and
                Lou Ludwig, Sysop of END OF THE WORLD
                         (808-499-1501)



                               - o -



        Comments, suggestions, bug reports and, of course,
        donations should be addressed to:

                           John Folsom
                     6568 Bantam Lake Circle
                       San Diego, CA 92119


        Messages may be left on any of the following BBS systems:

Prides Crossing      Nordevald Software BBS        EBBS Headquarters
 San Diego, CA             Tampa, FL                 Sepulveda, CA
 619-464-6271            813-961-0788                818-891-9350
   9600 V.32             9600 HST 14.4               1200/2400 BPS
   CASDI/24                FLTAM/24                    CAGLE/24

                        The Lobster Buoy
                           Bangor, ME
                   207-941-0805  14.4 V.32bis
                   207-945-9346  14.4 HST/V.32bis


                      GENie Mailbox: J.Folsom
















SNIPPET V4.01                   Page [9]