home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / TEXT / UTILITY / RSS22.ZIP / RSS.DOC < prev    next >
Encoding:
Text File  |  1992-02-27  |  15.3 KB  |  305 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. *******************************************************************************
  12. *                                RSS.DOC-V2.2                                 *
  13. * LAST UPDATE - Feb. 27, 1992. (c) 1991, 92 Ron Loewy.                        *
  14. *******************************************************************************
  15.  
  16.  
  17.  
  18.  
  19.         ░░░░░░░░░░░░░          ░░░░░░░░░░░         ░░░░░░░░░░░
  20.         ░▒▒▒▒▒▒▒▒▒▒▒▒░        ░░▒▒▒▒▒▒▒▒▒▒▒       ░░▒▒▒▒▒▒▒▒▒▒▒
  21.         ░▒▓▓▓▓▓▓▓▓▓▓▓░▒      ░░▒▒▓▓▓▓▓▓▓▓▓▓▓     ░░▒▒▓▓▓▓▓▓▓▓▓▓▓
  22.         ░▒▓██████████░▒▓    ░░▒▒▓▓███████████   ░░▒▒▓▓███████████
  23.         ░▒▓█  on's   ░▒▓█    ░░▓▓██ mart         ░░▓▓██ earc
  24.         ░░░░░░░░░░░░░ ▒▓█     ░░░░░░░░░░          ░░░░░░░░░░h
  25.         ░▒▒▒▒▒▒▒░░▒▒▒▒ ▓█      ▒▒▒▒▒▒▒▒░░          ▒▒▒▒▒▒▒▒░░
  26.         ░▒▓▓▓▓▓▓▓░░▓▓▓▓ █       ▓▓▓▓▓▓▓▓░░          ▓▓▓▓▓▓▓▓░░
  27.         ░▒▓███████░░████         ██████░░▒▒          ██████░░▒▒
  28.         ░▒▓█       ░░                 ░░▒▒▓▓              ░░▒▒▓▓
  29.         ░▒▓█        ░░      ░░░░░░░░░░░▒▒▓▓██   ░░░░░░░░░░░▒▒▓▓██
  30.          ▒▓█         ▒▒      ▒▒▒▒▒▒▒▒▒▒▒▓▓██     ▒▒▒▒▒▒▒▒▒▒▒▓▓██
  31.           ▓█          ▓▓      ▓▓▓▓▓▓▓▓▓▓▓██       ▓▓▓▓▓▓▓▓▓▓▓██
  32.            █           ██      ███████████         ███████████
  33.  
  34. *******************************************************************************
  35. *                                  File List                                  *
  36. *******************************************************************************
  37.  
  38.  This package contains the following files :
  39.  
  40.  RSS.EXE        - RSS program executable.
  41.  RSS.DOC        - This file.
  42.  RSS.REG        - Registration file.
  43.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  44.  
  45. *******************************************************************************
  46. *                                Why Register                                 *
  47. *******************************************************************************
  48.  
  49.   RSS is a shareware product, if you find this product valuable, 
  50.  please register it. This section describes the reasones you should register.
  51.  
  52.   By registering you will receive a printed manual, with many examples, 
  53.  and a diskette with the latest RSS version, and - you will help us to create
  54.  the next version of RSS - that will include even more features then the
  55.  features that are currently available!, we might even add YOUR enhancment
  56.  requests!
  57.  
  58. *******************************************************************************
  59. *                                  Whats New                                  *
  60. *******************************************************************************
  61.  
  62.   V2.2 - Added the ? help command. From this version RSS is distributed by
  63.          ISOFT D&M, P.O.B 5517, Coralville IA 52241, U.S.A
  64.  
  65.   V2.1 - Video configuration is restored better when RSS terminates.
  66.  
  67.   V2.0 - Added the FIND command that displays the text source of the
  68.          found key, the SEARCH command "finds" the same keys, but
  69.          only displays the key and file name, the find command displays
  70.          the actual text.
  71.  
  72.          PLEASE NOTICE - Dictionaries built in previous releases of RSS
  73.          are NOT COMPATIBLE with RSS V2.0 and above! . Be sure to RE-BUILD
  74.          all of your dictionaries before you start using them with RSS V2.0.
  75.  
  76.          I'm sorry for the inconvenience this restriction might cause, but 
  77.          the new FIND feature is so important that the dictionary structure
  78.          change is worthy.
  79.  
  80.   V1.2 - Command re-direction from the DOS prompt is now available.
  81.        - Build file definition prefix on command line changed to
  82.          '$' from '^', The '^' character is used by 4DOS as a command
  83.          delimiter.
  84.  
  85.   V1.1 - RSS has a new information screen when building the indexes, the old
  86.          version supplied all the keys with no sum information. Now RSS shows 
  87.          the sum information of the keys found in each file. 
  88.  
  89. *******************************************************************************
  90. *                                Introduction                                 *
  91. *******************************************************************************
  92.  
  93.  RSS is an extention of my own TXS text search program, RSS uses the same
  94. technology and search logic to perform FAST LOGIC searches on static text
  95. databases. The difference is that RSS has a more complicated database
  96. build facilities with enhanced creation parameters, and the ability to
  97. hold huge databases. RSS is a command line program where TXS is a full
  98. CUA environment. As RSS is a superset of TXS, I might integrate the two
  99. products by enhancing future versions of TXS and RSS to work in dual mode -
  100. "simple" mode - current TXS database definition, and "enhanced" mode -
  101. current RSS database definition.
  102.  
  103.  The need for RSS was created when I found out I spend a lot of time searching
  104. a problem index of a company I give technical support and consulting to, the
  105. index arrives once a month, and is about 1 MB large. In the index we have
  106. about 500 - 2000 different problem descriptions with search keywords. The
  107. problems are seperated by a dashed line, and are uniqely identified by a
  108. problem key number that appears on the first line after the dashed seperator
  109. line, with the prefix PROB#=. I found myself hoping for the ability to perform
  110. smart searchs with logic operators, the way I do on our telefax database with
  111. my own TXS and XCD programs.
  112.  
  113.  RSS was built to be generic enough to answer the problem I encountered, and
  114. provide a similiar solution to as many cases as possible. RSS allows the user
  115. to define a multi-key, multi-file database, with variable length "entries"
  116. (or records), build an economic existential dictionary on it, and use it as
  117. an index for fast logic searches. RSS allows the definition of common words
  118. that are belived to exist in all of the entries, and are thought to be left
  119. out of the dictionary, by defining "exclude" dictionary. RSS supports two
  120. dictionary "models", the small model that supports dictionaries of up to
  121. 30,000 words, and the big model that supports up to 120,000 words.
  122.  
  123.  Version 2.0 of RSS added the ability to FIND the search criteria in the
  124. source text database. RSS does not read the entire text database to display
  125. the relevant text, but saves a pointer and length indicators in the dictionary
  126. created during the build. RSS searces are as fast as ever, and only the text
  127. that meets the search criteria is extracted from the text database and 
  128. displayed.
  129.  
  130.  If you know Ralf Brown's Interrupt List you can look for a package called
  131. RSSINT27 that defines a build definition file for that list. 
  132.  
  133. *******************************************************************************
  134. *                                 Terminology                                 *
  135. *******************************************************************************
  136.  
  137.  In order to understand RSS operation and customization we will define the
  138. following terms :
  139.  
  140. SEPERATOR - a string prefix that is used to define the end of an entry, and the
  141.             begining of a new one.
  142.  
  143. KEYLINE   - an integer that is used to define the number of lines below the
  144.             SEPERATOR line in the entry, the entry's key resides on.
  145.  
  146. KEYPOS    - the position from the start of the line the key starts.
  147.  
  148. KEYLEN    - the number of characters used to define the key.
  149.  
  150. DELIMITER - a character used to seperate between two words in a text database.
  151.  
  152. EXCLUDE   - a word that appears on all of the entries in the database, and
  153.             we want to exclude from actual database.
  154.  
  155. *******************************************************************************
  156. *                            Dictionary-Definition                            *
  157. *******************************************************************************
  158.  
  159.  In order to define the dictionary to RSS, the user must create a dictionary-
  160. build-file-definition. This file has the following structure :
  161.  
  162.   seperator string      start looking at the line start                        
  163.   keyLine integer       no. of lines below the seperator line where key is ..  
  164.   keyPos integer        key starts at pos on keyLine                           
  165.   keyLen integer        keyLength                                              
  166.   delimiter char        character used as delimiter in the area ...            
  167.   exclude word          words to exclude                                       
  168.   dictionary parm       small or big dictionary              
  169.                   
  170.  Example :                                                                   
  171.  
  172.   seperator ======= seperator is a 7 = string at the begining of the line,   
  173.                     rest of line is ignored.                                 
  174.   keyline 1         key is in first line below the seperator                 
  175.   keypos 12         key starts in column 12                                  
  176.   keylen 5          and is 5 characters long                                 
  177.   delimiter ' '     space is a delimiter                                     
  178.   delimiter ','     , is a delimiter                                         
  179.   delimiter '='     = is a delimiter                                         
  180.   exclude he        he will not be entered to dictionary                     
  181.   exclude prod      prod -"- ...                                             
  182.   dictionary big    dictionary will use the 4 dict vars, instead of default 1
  183.  
  184. *******************************************************************************
  185. *                                  Operation                                  *
  186. *******************************************************************************
  187.  
  188.  At the dos command line type RSS to get the following help screen :
  189.  
  190.   RSS V2.2, ISoft D&M, P.O.B 5517, CORALVILLE IA 52241, U.S.A
  191.                                
  192.   Usage ..
  193.         RSS cmd cmd-parm
  194.   Where cmd Are ..
  195.         b  - build database from files given in cmd-parm
  196.         s  - search database for expression given in cmd-parm
  197.         f  - find in database entries for cmd-parm expression
  198.         ?  - display help screen
  199.   Build format ..
  200.         RSS b [@dictionary-file] [$definition-file] files [files]
  201.   Search command ..
  202.         RSS s [@dictionary-file] logic-search-expr
  203.   Find command ..
  204.         RSS f [@dictionary-file] logic-search-expr
  205.   Notice ..
  206.         dictionary-file - with no suffix, will use .DCT and .CFG
  207.         definition-file - used to build dictionary.
  208.  
  209.   IMPORTANT : DO NOT SPECIFY .BDF SUFFIX TO DEFINITION FILE!
  210.   
  211. *** Remarks :
  212.  
  213.  When you enter file names to build in the build command, dos wild-cards are
  214.  allowed.
  215.  
  216.  If you omit the dictionary-file, RSS will try to get the dictionary name
  217.  from the environment variable RSSDICT, if this name does not exist, RSS will 
  218.  use the name 'RSSDICT' to build the dictionary configuration and index files.
  219.  
  220.  If you omit the definition-file, RSS will try to get the definition name
  221.  from the environment variable RSSBLDF, if this name does not exist, RSS will 
  222.  use the name 'RSSBLDF' to read the build configuration parameters.
  223.  
  224.  PLEASE NOTICE - dictionary and definition file parameters given MUST NOT
  225.  include any file name extention. 
  226.  (e.g.  RIGHT      -> rss b @dict1 $def *.*
  227.         WRONG      -> rss b @dict1 $def.bdf *.*                     )
  228.  
  229.  The logic search expressions understood by RSS have the following format  :
  230.  
  231.   [NOT] search-word-1 [AND | OR | XOR [NOT] search-word-2 [AND | ...]]
  232.  
  233.   Some examples will clarify the definition :
  234.  
  235.  RON and not landmark                   - will print all of the files that 
  236.                                           contain the word RON, but do not
  237.                                           contain the word LANDMARK.
  238.  JOG or DIE                             - will print all the files that 
  239.                                           contain the word JOG, or the
  240.                                           word DIE, or both of them.
  241.  JOG xor DIE                            - All of the files that contain
  242.                                           either one of the words DIE or JOG,
  243.                                           but not both of them.
  244.  
  245.   Some points to consider :
  246.  
  247.   RSS does not make a difference between upper and lower case letters. - 
  248.  lanDmark, LANDMARK, landMArK and landmark are all the same.
  249.  
  250.   RSS definition for a word - any set of characters seperated by delimiters.
  251.  
  252.   Operator precedence   : NOT, AND, XOR, OR.
  253.  
  254. *******************************************************************************
  255. *                                  Warranty                                   *
  256. *******************************************************************************
  257.  
  258.   There is no warranty what so ever, The program is supplied as is,
  259.  The distributer (ISoft D&M), or the author (Loewy Ron), are not,
  260.  and will not be responsible for any damages, lost profits, 
  261.  or inconveniences caused by the use, or inability to use this program. 
  262.  The use of the program is at your own risk. 
  263.  By using (or attempting to use) the program you agree to this.
  264.  
  265. *******************************************************************************
  266. *                                Distribution                                 *
  267. *******************************************************************************
  268.  
  269.   RSS is distributed by ISoft D&M, P.O.B. 5517 CORALVILLE IA 52241, U.S.A.
  270.   
  271.   RSS is (c) copyrighted by Loewy Ron, 1991, 92.
  272.  
  273.   RSS is a shareware program, please register your copy. 
  274.   To register your copy of RPTP please refer to the supplied
  275.   RSS.REG file. 
  276.   
  277.   Other programs distributed by ISoft D&M are described in the supplied  
  278.   PROGRAMS.TXT file.
  279.   
  280. *******************************************************************************
  281. *                                   Contact                                   *
  282. *******************************************************************************
  283.  
  284.   Please contact :
  285.  
  286.   ISoft D&M,  
  287.   P.O.B 5517
  288.   Coralville IA 52241,
  289.   U.S.A
  290.  
  291. *******************************************************************************
  292. *                                   Credits                                   *
  293. *******************************************************************************
  294.  
  295.   RSS was written using Turbo-Pascal 6.0 (Copyright - Borland Intl').
  296.  
  297.   4DOS is a copyright of J.P. software.
  298.  
  299.   E.T. Floyd wrote the DDJ published DICT unit, I used the ideas in this unit
  300.   to create RSS, and was helped by the published source code, but My dictionary
  301.   uses different hash algorithm. ( I saw that in DDJ Jan. 1991 MR. Floyd 
  302.   answered a letter regarding the hash algorithm. ), I removed some of the
  303.   code I did not need from the DICT unit, and added the ability to remove
  304.   keys from the dictionary.
  305.