home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / KTAG101.ZIP / KTAG.DOC < prev    next >
Text File  |  1994-12-24  |  16KB  |  380 lines
  1. ─────────────────────────────────────────────────────────────────
  2.                                                  Kaleidoscope Tag
  3.                                                              1.01
  4.                                                    Copyright 1994
  5.                                               SaturnSoft Software
  6.                                               All Rights Reserved
  7.  
  8.                                                        Guy Martin
  9.                                                       1:202/905.0
  10. ─────────────────────────────────────────────────────────────────
  11.  
  12.       Contents
  13.  
  14.    i  License Agreement
  15.   ii  Support
  16.  iii  Registration
  17.   iv  Support
  18.  
  19.  1.0  What is Kaleidoscope Tag?
  20.  1.1  Features
  21.  1.2  Requirements
  22.  
  23.  2.0  Contents
  24.  2.1  Installation
  25.  
  26.  3.0  Filtering Taglines
  27.  3.1  FFilter.txt (Full Filter)
  28.  3.2  PFilter.txt (Partial Filter)
  29.  
  30.  4.0  Hints
  31.  4.1  Known Bugs
  32.  
  33. Appendix A  Full Screen Message Editor Specifications
  34. Appendix B  Copyrights / Technical Information
  35.  
  36.   i    License Agreement
  37. ─────────────────────────────────────────────────────────────────
  38.         SaturnSoft doors are commercial programs marketed under
  39.         the "User Supported" or "Shareware" concept.  You are
  40.         allowed to install this program on your system and
  41.         evaluate it before deciding whether to purchase a license
  42.         to continue using it.  This program is not public domain
  43.         or freeware.  If you use this program for more than 30
  44.         days after successful installation, you are legally
  45.         required to register it or remove all operating copies
  46.         from your system.
  47.  
  48.         The User Supported or Shareware concept works only if you
  49.         and your fellow sysops support it.  If you find this
  50.         program useful, you can register it.  This will help
  51.         offset the development costs, and encourage us to write
  52.         other programs that might be useful to you.  After all,
  53.         no one likes to work for nothing!  A registration form is
  54.         included in the distribution archive.
  55.  
  56.                 Kaleidoscope Tag is Copyright 1994
  57.                       by SaturnSoft Software
  58.                        ALL RIGHTS RESERVED.
  59.  
  60.         You may copy this program and documentation for backup
  61.         purposes.  You also may copy and share UNMODIFIED copies
  62.         of the original program archive.  The copyright notice
  63.         must remain attached to all copies.  You may not sell,
  64.         distribute, share, or allow use of your registration key
  65.         or code.
  66.  
  67.         You may not sell SaturnSoft Software products for a fee,
  68.         or distribute them along with other products without
  69.         written permission of SaturnSoft Software, nor may you
  70.         modify or remove the copyright notice from the program
  71.         or the documentation.  BBS operators who charge for
  72.         access to their systems are exempt from this provision as
  73.         long as no additional payment is required for access to
  74.         SaturnSoft Software products beyond basic file access.
  75.         These files may NOT be placed on a CDROM medium or in a
  76.         "Shareware Library" without written permission of
  77.         SaturnSoft Software.
  78.  
  79.         All SaturnSoft Software products are extensively tested
  80.         before being publicly released, but as with any
  81.         software, bugs may still occur.  SaturnSoft Software
  82.         products are provided as is, and neither SaturnSoft
  83.         Software (and agents of) nor any BBS operator
  84.         distributing this software is responsible for any damage
  85.         incurred during the operation of the program.  You are
  86.         advised to test all SaturnSoft Software products
  87.         thoroughly on a backup copy of your BBS before putting
  88.         them online.
  89.  
  90.         Comments, suggestions and bug reports are welcome. If you
  91.         have any, you may contact one of the SaturnSoft Software
  92.         Support Systems listed in SUPPORT.DOC and leave a message
  93.         to the Sysop.  If you are reporting a bug, please give as
  94.         much detail as possible describing the problem you are
  95.         having, your system configuration, and if you would be
  96.         willing to test possible corrections to the problem.
  97.  
  98.  
  99.  ii    Support
  100. ─────────────────────────────────────────────────────────────────
  101.          Any questions concerning registration, installation, or
  102.          possible bug reports should be sent to:
  103.  
  104.                 Guy Martin      1:202/905.0
  105.  
  106.         Please see the README file for important information!
  107.  
  108. iii    Registration
  109. ─────────────────────────────────────────────────────────────────
  110.         ALL REGISTRATIONS MUST BE IN US DOLLARS, or they will not
  111.         be processed.  Not responsible for postal service loss or
  112.         misdirection.
  113.  
  114.         A registration is a license for use, and does not
  115.         include ownership or any rights beyond the use of the
  116.         software.  SaturnSoft Software is not liable for any use
  117.         or misuse of the product.  SaturnSoft Software does plan
  118.         on product upgrades, but SaturnSoft Software is not
  119.         required to do so.  All upgrades of this product will be
  120.         free for licensed individuals, but method of acquiring
  121.         the upgrade is left to the individuals.
  122.  
  123.         First time registration for KTag is $8.00 USD.
  124.  
  125.         Key changes (Re-registration) for bbs name changes
  126.         will be charged $4.00.  Registration fee is non
  127.         refundable.  Registrations are not transferable.
  128.  
  129.         Make all funds out to:  SaturnSoft Software
  130.  
  131.         Send check, money order, cash (Bad Choice) or postal
  132.         coupon and REGISTER.INF to:
  133.  
  134.                 SaturnSoft Software
  135.                 23300 West Arata Rd. #59
  136.                 Troutdale, Or. 97060-2733
  137.                 USA
  138.  
  139.         Please allow adequate time for registration processing.
  140.         All questions should be Netmailed to Guy Martin at
  141.         1:202/905.
  142.  
  143.  iv    Support
  144. ─────────────────────────────────────────────────────────────────
  145.         Support can be had via NetMail or appropriate FidoNet
  146.         echomail conferences.  I frequently monitor DOORGAMES,
  147.         ON_LINE_GAMES, RA_UTIL and TAG_TALK.
  148.                                             
  149. 1.0    What is Kaleidoscope Tag?
  150. ─────────────────────────────────────────────────────────────────
  151.         Kaleidoscope Tag (Or KTag for short) offers the ability
  152.         that only users of offline readers had the privledge of
  153.         doing previously, adding taglines to their personal
  154.         messages.
  155.  
  156. 1.1    Features
  157. ─────────────────────────────────────────────────────────────────
  158.         KTag allows the the sysop full control over what taglines
  159.         are used via an ASCII text file.
  160.  
  161.         Easy to install!
  162.  
  163.         Selects ten random taglines for the user to choose from.
  164.  
  165.     {+} Allows the user to search the tagfile for specific
  166.         taglines quickly and easily.
  167.  
  168.         Allows the user to enter a tagline of their own or not
  169.         add one at all.
  170.  
  171.         Allows the sysop to filter taglines for undesired
  172.         language.
  173.  
  174.         User inactivity time out.
  175.  
  176.         KTag will not stop working or become more restrictive in
  177.         any way if not registered.  But you are still required to
  178.         register if you wish to use KTag for more than 30 days.
  179.  
  180.         {+} Registered feature
  181.                                             
  182. 1.2    Requirements
  183. ─────────────────────────────────────────────────────────────────
  184.         KTag requires bulletin board software that uses a full
  185.         screen external editor option.  Or any bbs software that
  186.         supports the MSGTMP file.  See appendix A for more
  187.         information.
  188.  
  189.         External editors such as GEdit, IceEdit and various
  190.         others should have no conflicts with KTag.
  191.  
  192.         KTag also requires a DORINFO1.DEF file, normally created
  193.         by the bbs when using a external editor.
  194.  
  195.         A FOSSIL.  Most bbs software currently marketed, require
  196.         or will use a FOSSIL.
  197.  
  198.         ANSI.SYS or similar loaded.  See your DOS manual.
  199.  
  200. 2.0     Contents
  201. ─────────────────────────────────────────────────────────────────
  202.         KTAG100.ZIP contains:
  203.  
  204.             FileName
  205.           ------------
  206.           README         A simple readme file about support
  207.           HISTORY        Version to date
  208.           KTAG.EXE       The program
  209.           REGISTER.INF   Registration form
  210.           KTAG.DOC       This documentation
  211.           TAGLINES.TXT   A sample tagline file
  212.  
  213. 2.1    Installation
  214. ─────────────────────────────────────────────────────────────────
  215.         Create a directory for KTag.   Ex: C:\BBS\KTAG
  216.  
  217.         UnZip the contents of the release archive in to that
  218.         directory.  You will need to create a batch file in your
  219.         BBS directory.  This file will contain TWO lines.
  220.  
  221.         C:\BBS\FSMEdit.BAT
  222.         ------------------
  223.         Line1     C:\BBS\editor.exe %1 %2 %3 %4 %5 %6 %7 %8 %9
  224.         Line2     C:\BBS\KTAG\KTAG.EXE
  225.  
  226.         The first line is the drive:\path\filename.exe of your
  227.         full screen message editor used by your users.  The %1
  228.         through %9 are IMPORTANT (See Appendix A for more
  229.         information).  Do not change the drive letter or change
  230.         directories in this batch file.
  231.  
  232.         The second line calls KTag.  No command line switches are
  233.         necessary.
  234.  
  235.         KTag will auto detect remote or local users.  KTag will
  236.         search for the tagline file as "TAGLINES.TXT" in the
  237.         directory that the KTAG.EXE is in.
  238.  
  239.         Follow the directions for your bbs software on installing
  240.         a full screen message editor, except use
  241.  
  242.                 C:\BBS\FSMEdit.BAT
  243.  
  244.         for the filename of the editor.
  245.  
  246.         If the user requests to write their own tagline, KTag
  247.         will add the tagline to the message, but will not save
  248.         the tagline to the TAGLINES.TXT file.
  249.  
  250. 3.0    Filtering taglines
  251. ─────────────────────────────────────────────────────────────────
  252.         KTag allows you as sysop to filter out words or phrases
  253.         that you wish not to be used.
  254.  
  255.         Two files are used for this.  PFILTER.TXT and
  256.         FFILTER.TXT.  Filtering will only occur if one or both
  257.         files are found in the same directory as KTAG.EXE.
  258.  
  259.         Filtering only occurs if one or both files are found in
  260.         the same directory as KTAG.EXE.  FFilter is checked
  261.         first, then PFilter.  Filtering is case insensitive.
  262.  
  263.         All words that are censored, will be censored with *'s.
  264.         If the tagline is altered by a filter, it will be
  265.         replaced with *'s and then displayed to the user.  The
  266.         user is then prompted with the choice of using the
  267.         censored tagline or not.
  268.  
  269.         Maximum length of a words or phrases is 15 characters for
  270.         both FFilter and PFilter.
  271.         
  272. 3.1    FFilter.Txt (Full Filter)
  273. ─────────────────────────────────────────────────────────────────
  274.         If found this file will filter out undesired words or
  275.         phrases from the tagline.  Each line of this file should
  276.         contain a word of a phrase that is not wanted.
  277.  
  278.         Let's say you have 'red' in the FFilter.txt.
  279.  
  280.         Tagline:        ... Red roses are pretty!
  281.         Would become:   ... *** roses are pretty!
  282.  
  283.         Tagline:        ... I've got you cornered
  284.  
  285.         Would not be changed, as 'corneRED' does not match 'RED'
  286.         as a full word.
  287.  
  288. 3.2    PFilter.Txt (Partial Filter)
  289. ─────────────────────────────────────────────────────────────────
  290.         Like FFilter.Txt, PFilter.txt is used to filter the
  291.         tagline also.  But PFilter.Txt filters out ALL occurrences
  292.         of a word or phrase, even if found in side another word!
  293.         FFilter.Txt uses the same format as PFilter.txt.  One
  294.         word or phrase per line.
  295.  
  296.         Let's say you have 'red' in the PFilter.txt.
  297.  
  298.         Tagline:        ... Red roses are pretty!
  299.         Would become:   ... *** roses are pretty!
  300.  
  301.         Tagline:        ... I've got you cornered
  302.         Would become:   ... I've got you corne***
  303.  
  304.         As 'RED' is found in 'corneRED'.
  305.  
  306.         It is suggested that all words/phrases in the PFilter
  307.         have a minimum of 5 characters, else you might end up
  308.         filtering good words.
  309.  
  310. 4.0    Hints
  311. ─────────────────────────────────────────────────────────────────
  312.         Run a disk cache utility.  Such as SmartDrive or
  313.         HyperDisk.  This is make the process of searching
  314.         for taglines faster.
  315.  
  316.         Be sure you have more than 1000 taglines.  Anything
  317.         smaller, will requires multiple openings and closings to
  318.         the tagline file, which is slow (Thanks to DOS).
  319.  
  320. 4.0    Hints
  321. ─────────────────────────────────────────────────────────────────
  322.         None.  We like it this way.
  323.  
  324.                             Appendix A
  325. ─────────────────────────────────────────────────────────────────
  326.        The External Editor Interface Specifications
  327.  
  328.         Most FSME (Full Screen Message Editors) use the
  329.         QuickBBS-style MSGTMP interface to communicate with the
  330.         BBS.  FSMEs use a temporary text file called MSGTMP (no
  331.         extension) which must be located in the current
  332.         directory.  If the caller is replying to a message, the
  333.         BBS quotes the original message text for pasting into
  334.         the reply and writes it to the MSGTMP file. The lines
  335.         should be written to the temporary text file separated
  336.         by a carriage return/line feed sequence.  All quote
  337.         information and prefixes should be added before writing
  338.         to the file.
  339.  
  340.         Once the user has finished editing the message text, the
  341.         FSME writes the text to the same MSGTMP file.  The BBS
  342.         must call the FSME with several command line parameters.
  343.         This is why the %1 through %9 are important in the batch
  344.         file shown in the installation section.  KTag does not
  345.         require these parameters, but ALL of the FSMEs on the
  346.         market DO need these.  The required parameters are shown
  347.         below and must be on the command line exactly as shown.
  348.  
  349.                 EDITOR.EXE <port> <baud> <timeleft> <inactivity>
  350.  
  351.  
  352.                             Appendix B
  353. ─────────────────────────────────────────────────────────────────
  354.         Kaleidoscope Tag was written using Borland Turbo Pascal
  355.         and with use of JPDoor 4.1.
  356.  
  357.         The following software titles and brand names are
  358.         copyright by their respective persons or organizations.
  359.         
  360.  
  361.             GEdit                     Gerard van Land
  362.             HyperDisk                 Roger Cross, HyperWare
  363.             IceEdit                   Jeremy Landvoigt
  364.             JPDoor                    McSoft, Inc.
  365.             PKUnZip                   PKWare, Inc.
  366.             QuickBBS                  Pegasus Software
  367.             RAEdit                    Wantree Dev.
  368.             SmartDrive                Microsoft Corporation
  369.             Turbo Pascal              Borland International, Inc.
  370.  
  371.  
  372.              Minimum TagLines: 100
  373.              Maximum TagLines: 65,536
  374.                Maximum Length: 70 Characters
  375.         Minimum Length Filter: 1  Character (minimum 5 suggested)
  376.         Maximum Length Filter: 15 Characters
  377.               Maximum Filters: Unlimited
  378.  
  379.                               -EOF-
  380.