home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / UTILS2 / RCNTX325.ZIP / MANUAL < prev    next >
Text File  |  1994-01-17  |  43KB  |  871 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                             RACONTEX SEARCH SYSTEM
  13.  
  14.                             Instruction Manual For
  15.                         Loading/Indexing and Searching
  16.  
  17.                   Copyright (c) Edward Guy CDP 1987,8,9,90,1
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26. A product of:
  27.  
  28. GUY SOFTWARE
  29. 1752 Duchess Avenue
  30. West Vancouver
  31. British Columbia
  32. Canada      V7V 1P9                                         December 17, 1993
  33.  
  34.                              Compuserve 71750,1036
  35.  
  36.  
  37.                                    CONTENTS
  38.  
  39.      DISCLAIMER   . . . . . . . . . . . . . . . . . . . . . . . . . . . .   1
  40.  
  41.      RACONTEX FEATURES  . . . . . . . . . . . . . . . . . . . . . . . . .   2
  42.  
  43.      LOADING/INDEXING INSTRUCTIONS  . . . . . . . . . . . . . . . . . . .   5
  44.      Quick Start  . . . . . . . . . . . . . . . . . . . . . . . . . . . .   5
  45.  
  46.      MICROSOFT WINDOWS AND RACONTEX.  . . . . . . . . . . . . . . . . . .   6
  47.  
  48.      FOR THE MORE TECHNICAL   . . . . . . . . . . . . . . . . . . . . . .   6
  49.      File Names   . . . . . . . . . . . . . . . . . . . . . . . . . . . .   7
  50.      Stopwords  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   7
  51.      Delimiters   . . . . . . . . . . . . . . . . . . . . . . . . . . . .   7
  52.      Formatting   . . . . . . . . . . . . . . . . . . . . . . . . . . . .   8
  53.      Merging Files  . . . . . . . . . . . . . . . . . . . . . . . . . . .   8
  54.      Copy Prevention  . . . . . . . . . . . . . . . . . . . . . . . . . .   9
  55.      For the REALLY technical   . . . . . . . . . . . . . . . . . . . . .   9
  56.      Updating licence information on an old database  . . . . . . . . . .  11
  57.      Program Limitations  . . . . . . . . . . . . . . . . . . . . . . . .  11
  58.  
  59.      SEARCH SYSTEM INSTRUCTIONS   . . . . . . . . . . . . . . . . . . . .  12
  60.      Simple Searches  . . . . . . . . . . . . . . . . . . . . . . . . . .  12
  61.      Display Options  . . . . . . . . . . . . . . . . . . . . . . . . . .  12
  62.      Word Proximity Searches  . . . . . . . . . . . . . . . . . . . . . .  15
  63.      Printer and File Output  . . . . . . . . . . . . . . . . . . . . . .  17
  64.  
  65.  
  66. Please note that  the SEARCH SYSTEM  INSTRUCTIONS can stand alone and  do not
  67. require an understanding of the LOADING/INDEXING INSTRUCTIONS.
  68.  
  69. There may be more up to date instructions in the file README. 
  70.  
  71. Racontex Manual                                                        Page 1
  72.     
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95. DISCLAIMER: The supplier has no liability to the licensee or any other person
  96. or  entity  for  any  damage   or  loss,  including  special,  incidental  or
  97. consequential damages caused  by this  product directly  or indirectly.   The
  98. software is supplied  "as is" without warranty  of any kind, either expressed
  99. or implied. Warranties of merchantability  or of fitness for  any purpose are
  100. specifically disclaimed.
  101.  
  102. Racontex Manual                                                        Page 2
  103.     
  104.  
  105.  
  106. RACONTEX FEATURES.
  107.  
  108. Many business uses.        In addition  to  the  obvious uses  for  statutes,
  109.                            legal transcripts,  etc Racontex  is valuable  for
  110.                            use with  collective agreements,  policy  manuals,
  111.                            office handbooks,  library catalogues  -- in  fact
  112.                            anywhere that  someone has to  "look something up"
  113.                            and there is a personal computer available.
  114.   
  115. Easy "Intuitive" Search.   Can be started with a  one line command (or from a
  116.                            batch  file  or  menu),   and  prompts  the   user
  117.                            throughout.     Context-sensitive   HELP   screens
  118.                            available at the press of a key. 
  119.   
  120. Contextual Search Tool.    Does not  lose the  context  of pages  found,  can
  121.                            "page up" and "page  down" from each occurrence of
  122.                            the search criteria,  (even if those  pages do not
  123.                            contain  the search  criteria)  and return  to  it
  124.                            instantly by pressing one key.   Moves to next  or
  125.                            previous incidence  of search  criteria by forward
  126.                            arrow or backward arrow keys.
  127.   
  128. Makes full use of display. Supports  50 lines of  on screen  text with  a VGA
  129.                            adapter, 36 lines of text on screen with an EGA or
  130.                            Hercules display as an  alternative to regular  25
  131.                            line text  mode. 36  line display will  fit a full
  132.                            page of court reporters' transcript on  the screen
  133.                            at once.
  134.  
  135. Proximity Search.          Supports  searches   of  word   alternatives   and
  136.                            combinations of alternatives within a given number
  137.                            of words of  each other,  or on  the same  page as
  138.                            each other.
  139.  
  140. File Output.               Supports  file export  of search  occurrence pages
  141.                            either as ASCII, ASCII  with search keys marked or
  142.                            Wordperfect   with    search   keys    in    bold.
  143.                            Alternatively can copy to printer.
  144.  
  145. Variable Stopword List.    Licensees of  the loading  (indexing) program  may
  146.                            specify their own list  of stopwords (words not to
  147.                            be  included  in   searches,  such  as  "and"  and
  148.                            "the") - this is a tremendous disk space saver.
  149.  
  150.  
  151. Racontex Manual                                                        Page 3
  152.     
  153.  
  154.  
  155. Variable Delimiter List.   Licensees of  the loading  (indexing) program  may
  156.                            specify their own  list of delimiters.   e.g. They
  157.                            may  determine  whether a  hyphenated word  is one
  158.                            word or two for search purposes.
  159.  
  160. Self Optimising for Speed. Detects  memory available and loads  either all or
  161.                            part  of  the  file  into  memory  for  sub-second
  162.                            response.    Pages large  files  into  memory  for
  163.                            display (takes a fraction of  a second from a hard
  164.                            drive).
  165.   
  166. Powerful File Compression. Compresses  text  file  to  such  a  degree  that,
  167.                            depending on the stop  word list, all files (text,
  168.                            index and  dictionary) fit  in only  slightly more
  169.                            space than the original ASCII text file.
  170.   
  171. Copyright Protection.      Licensees  of the loading program can market "Self
  172.                            Searching" disk copies of their documents and thus
  173.                            compete with  on-line text  data base  systems for
  174.                            statute  search  etc.  The  search  program  title
  175.                            screen  will  carry  the  copyright  title of  the
  176.                            licensee as well as  the program author.  Both are
  177.                            protected against "zapping"  with a disk modifying
  178.                            utility.
  179.   
  180. "Publisher Pack".          A "Publisher's Package" is available which permits
  181.                            a publisher  to include  the publisher's  client's
  182.                            names in the  protected area of  the title screen,
  183.                            as well  as  the publisher's  name.    Useful  for
  184.                            subscription publishers of statutes etc.  Includes
  185.                            install procedure  requiring on  screen assent  by
  186.                            client to subscription terms.
  187.   
  188. Optional copy prevention.  The  resulting  self searching  documents  may  be
  189.                            loaded  onto  computers  other  than  the original
  190.                            (subject to the appropriate licence) and then made
  191.                            "non-portable" to  prevent  unauthorised  copying.
  192.                            Useful for significant databases in companies with
  193.                            high staff turnover.
  194.  
  195. Easy to Add to Files.      Additional  sections can  be  added  easily  to  a
  196.                            document  in   the  system.     Ideal   for  daily
  197.                            transcript  of  an ongoing  hearing.    The  whole
  198.                            record of a  hearing can be  built up on  the hard
  199.                            drive of a  laptop, and passages  accessed in less
  200.                            than a second.
  201.  
  202.  
  203. Racontex Manual                                                        Page 4
  204.     
  205.  
  206.  
  207. Mouse interface.           If  Racontex detects a mouse,  it may  be used for
  208.                            navigation around the system.
  209.  
  210. Windows Interface          Windows interface in same package as DOS version.
  211.  
  212. On-Line Manual             A  copy of  this manual is  provided on-line  as a
  213.                            RACONTEX database.
  214.  
  215. Racontex Manual                                                        Page 5
  216.     
  217.  
  218.  
  219. LOADING/INDEXING INSTRUCTIONS
  220. The  Racontex  search  program  operates  on  a  text  database  produced  by
  221. processing the  document to  be searched  through a  "Loading" process  which
  222. performs  indexing and text  compression.   The loading/indexing  process has
  223. many options to allow for flexibility  in use, but you  do not need to  study
  224. them to get started.
  225.  
  226. Quick Start.
  227. There is an INSTALL procedure on  the disk, just put the disk in drive A  and
  228. type in  A:INSTALL and press  ENTER.  It  will set up a  subdirectory on your
  229. hard drive and copy the files into it.
  230.  
  231. The loading process  requires  that  the  program  files  be  in  the current
  232. directory, or  an  APPENDED  one  (which  could  include CD ROM, see the file
  233. READONLY.DOC). The database will be created in the current directory.  
  234.  
  235. (Please note that while the Racontex search program will work adequately on a
  236. "floppy only"  machine, the  loading process is  severely limited  if a  hard
  237. drive is  not available.  However  the loading process may  be performed on a
  238. hard drive computer and the loaded files used on a machine without one.)
  239.   
  240. If you wish to use the version  designed for Microsoft Windows, you may start
  241. the system with the  command  WIN  RCNTXWIN,  and follow the instructions  on
  242. the  screen.   That version  provides a Windows  "front end  processor" which
  243. deals with the dialogue  between you and the  system.  It then  brings up the
  244. search in a full screen window and behaves exactly like the DOS version until
  245. you exit or minimise the window.
  246.  
  247. To prepare a document  for use with the Racontex  search program, simply type
  248. in the  command "LOAD", and when the computer prompts you  for it type in the
  249. name of the text file you want to load.  The load process creates a series of
  250. files all beginning with OUTFILE, which you may rename if you wish. (Although
  251. you may perform  a database creation from  the Windows screen,  it will be  a
  252. little slower than from DOS, because of the overhead which windows imposes.)
  253.  
  254. To  search  those files type in  RACONTEX OUTFILE and follow the  prompts (or
  255. read the  separate instructions on  the use of  the search program).   If you
  256. want to use the search program on another computer (and assuming your licence
  257. permits it), place a formatted floppy disk in your A drive, type in
  258.  
  259.         COPY C:\RACONTEX\RACONTEX.* A:/V 
  260.  
  261. and press enter, then type in
  262.  
  263.         COPY C:\RACONTEX\OUTFILE.* A:/V 
  264.  
  265. and press enter.  You may then run the search program from the floppy disk on
  266. another machine.
  267.  
  268. Racontex Manual                                                        Page 6
  269.     
  270.  
  271.  
  272.  
  273. PLEASE NOTE:  Because  many applications require frequent additions to a text
  274. data base (e.g.  daily transcript  of an ongoing  legal proceeding)  the LOAD
  275. command checks  to see if  a suite  of files named OUTFILE  exists and  if it
  276. does, adds the new text to the end.  If you do not want that simply rename or
  277. delete the OUTFILE files.  The load command will remind you of this.
  278.  
  279. MICROSOFT WINDOWS AND RACONTEX.
  280. The windows  program RCNTXWIN  provides  all  of the  functions  of  RACONTEX
  281. through  a  single  window  in  Microsoft  Windows.    If  started  from  the
  282. subdirectory  containing  the  loading programs  which  are  used  to  create
  283. databases, it gives the options to create, rename and delete databases.  If a
  284. search-only  package  of  RACONTEX  is  being  used,  these  options  are not
  285. available and are not offered on the screen.  Loading under DOS is faster!
  286.  
  287. The options  are chosen  via the  "RADIO BUTTONS" at the  bottom left  of the
  288. screen.   Different drives and  directories may be chosen  using the standard
  289. Windows drive  and directory  boxes on  the screen.   Once  a file  has  been
  290. selected by "clicking" on its name in the file or database selection box, the
  291. command button  for starting  the operation  will appear.   For  a search  or
  292. creation operation  the window will  call a DOS window  up, and will  run the
  293. standard RACONTEX programs in it.  If you are not running in "enhanced mode",
  294. the screen will prompt  you to maximise the  icon for the operation.   If you
  295. are running in enhanced mode, the program will start running in a full screen
  296. window, which you may minimise if you wish.
  297.  
  298. When  you are selecting a database for searching,  renaming or deleting, only
  299. the database name appears in the box, although RACONTEX databases consist  of
  300. five files  each.  If you are selecting a file to create a database from, the
  301. full filenames appear.
  302.  
  303. In the "create"  mode a "view file"  command button also  appears.   Clicking
  304. this gives you  a preview of the beginning of  the file you have selected, so
  305. that you may be sure it is  the correct one.  During the viewing of this, the
  306. controls of the window "float" in front of the text.
  307.  
  308. In the "search" mode, a pull down menu at the top of the screen allows search
  309. output options to be  set.  You may select whether  the search display screen
  310. is 25, 36 or 50 lines.  The 50 line mode will usually get  a full page on the
  311. screen at once.  You may also select  whether any WordPerfect files  produced
  312. will be in the format of version 4.2 or version 5.
  313.  
  314. FOR THE MORE TECHNICAL:
  315.  
  316. The foregoing provides sufficient instructions for most applications, however
  317. a fair amount of customisation is possible.
  318.  
  319. Racontex Manual                                                        Page 7
  320.     
  321.  
  322.  
  323. File Names.
  324. A document in Racontex  form consists of a suite of  files, all with the same
  325. name but with different extensions (.NDX  .TXT  .DCT  .SPD  .PGF).   All must
  326. be present  for the  search engine  to work  and all  must be  transferred to
  327. transfer a document  to another computer.   These files are  produced by  the
  328. Loading/Indexing process.
  329.  
  330. Stopwords.
  331. In any text data base  application the most frequent 40 words in the language
  332. take up about  40% of the  disk space.   You do not  usually want to  able to
  333. search for words like AND,  THE and similar words (each occurrence of  a word
  334. which you do wish  to be able to search for takes 10 bytes of  space - if you
  335. do not wish to be able to search for a word it only takes 2 bytes.)
  336.  
  337. A file called STOPWORD  is included, and the  words in that file will not  be
  338. indexed for searching.   You may edit the file with any  ASCII word processor
  339. to change  the selection of stopwords,  or you may delete  it entirely if you
  340. wish every word to be indexed for searching.  Unless you include them in  the
  341. STOPWORD file,  initials are treated as words and it is advisable to STOPWORD
  342. them in  most cases (computer people will  probably not want to  stopword the
  343. initial "C" since  they will want to  index references to  the "C" language.)
  344. The system is "Case Blind",  i.e. although it will display both capitals  and
  345. lower case it treats them as identical  for indexing and searching and it  is
  346. therefore not necessary to STOPWORD "The" if you have done it to "the".
  347.  
  348. If Racontex files  produced by different  runs with different  stopword lists
  349. are merged using  the merge facility referred  to later, the  resulting files
  350. will be stopworded as if the stopword lists had also been merged.  Using this
  351. it  is possible to load  a document with a very  small (or even non-existent)
  352. stopword list and then  apply stopwords later if  storage considerations make
  353. this necessary.  If the Racontex files are still named "OUTFILE" with various
  354. extensions,  this may  be achieved  by changing  the stopword  list and  then
  355. issuing the command INDEX NUL,  which will add no new text but will apply the
  356. new stopwords.
  357.  
  358. Delimiters.
  359. The loading system needs to  know what constitutes a separate word.   A space
  360. always means the end of a word, but what about a hyphen?  A "delimiter" means
  361. a  character  which  indicates  the  end  of a  word,  and  because different
  362. applications may  need a different set of delimiters the system allows you to
  363. change them.
  364.  
  365. For  example, if a  period is embedded in  a word it  may just  mean that the
  366. typist forgot a space and in pure text documents you probably want the period
  367. to be  a delimiter.   However  in a  document listing  radio frequencies  you
  368. probably want "142.299" to be treated as one word and not two.
  369.  
  370.  
  371. Racontex Manual                                                        Page 8
  372.     
  373.  
  374.  
  375. You may provide your own list of delimiters by  including  a  file DELIMIT in
  376. the current directory when you run the  LOAD program.  It should contain just 
  377. one line like     -+\/,.!()[]{};: ending with a carriage return ([ENTER]).
  378.  
  379. The string  of characters which looks like  a comic book cuss  word indicates
  380. which characters will be used as delimiters.  If you do not include a DELIMIT
  381. file, the loading  process assumes  you forgot and uses !&()-_+=\/,.:;[]{}?<>
  382. as delimiters.
  383.  
  384. Formatting.
  385. The loading  process takes the FormFeed character (ASCII 12)  as the end of a
  386. "logical page", even though that may require more than one  screen to display
  387. a  page in the  Racontex search program.   That  logical page is used  in the
  388. search program when  a search is made for words  on the "Same Page".   If you
  389. are formatting a text file specifically for use with Racontex you should bear
  390. in mind your  screen characteristics to make  your searches as convenient  as
  391. possible.  If the searches will be performed on a "text only"  system or on a
  392. system with a Color Graphics Adapter  (CGA) there is room for 24  lines of 80
  393. characters each on the search screen at  once.  EGA will allow 35 lines of 80
  394. characters each, VGA 49 lines  of 80 characters each and Hercules will  allow
  395. 35 lines of 90 characters wide.  If the text file does not match these, there
  396. is no real problem as the search program will "wrap"  lines that are too wide
  397. and will "scroll" pages that are too long.
  398.  
  399. Since the objective  is to maximise  use of  the display screen,  "nul" lines
  400. often used for double spacing are eliminated.   If there is a requirement for
  401. a  blank line to  appear on the  display, include  at least one space  on the
  402. line.
  403.  
  404. If you  are preparing a copy of a file where paragraphs of it for some reason
  405. are logical units  (e.g. sections  of a  statute, procedure  manuals, library
  406. catalogues etc.) it often helps to set them up as "logical pages" so that the
  407. "same page" search will find combinations of words in the same paragraph.
  408.  
  409. Merging Files
  410. The  system provides the means to merge documents  produced by different runs
  411. of the Loader/Indexer.  You just enter the command
  412.  
  413.        MERGE  filea  fileb  filec 
  414.  
  415. where  filea and  fileb are  the names  of the suites  of files to  be merged
  416. (without extension  but optionally with pathnames) and filec is  the name the
  417. merged suite of  files is to  be given  (and cannot be  the same as  filea or
  418. fileb). 
  419.  
  420. Racontex Manual                                                        Page 9
  421.     
  422.  
  423.  
  424. Please note  that  the  merge  facility  will  not merge  files  produced  by
  425. different  licensed  copies   of  the  Loader/Indexer  (this   is  to   avoid
  426. compromising the copyright notice of  those who publish documents in Racontex
  427. form with their own copyright notice showing on the title screen). 
  428.  
  429. Copy Prevention
  430.  
  431. Once   RACONTEX database  files have been  installed on  a particular machine
  432. they may be "FIXED" on that machine.  This does not prevent their being moved
  433. to other  locations on  that machine  or backup  copies being  made, but  the
  434. copies will  only work with  a copy of  RACONTEX on that machine.   If run on
  435. another machine the only action will  be to display a message to that effect.
  436. (If run on another machine  with an earlier version of Racontex, the  message
  437. reports "Files damaged or altered", if run with a current  version version of
  438. Racontex the message says "Removed from machine authorised to run" it.) 
  439.  
  440. This is achieved  by using  the program RCNTXFIX.EXE.   The command  RCNTXFIX
  441. FILEA will render  non-portable the database  files with the  filename FILEA.
  442. If run on  files produced by an unregistered version, this may be reversed by
  443. running the UPDATE program.  Since the  UPDATE program will not work on files
  444. produced by  a registered version, such  files will remain  "fixed" no matter
  445. what.
  446.  
  447. This feature  prevents  copies  of a  database  being  made  by  unauthorised
  448. persons.   The  originals are  normally  kept  by an  authorised  person  and
  449. installed on the user machine by that person and then "RCNTXFIX"ed.
  450.  
  451. Additionally, the  ability to do a one key unload of  the whole database to a
  452. file  is disabled by the "fixing" process, to  protect the copyright of those
  453. using RACONTEX  to publish proprietary  material.  The optional  "Publishers'
  454. Package" produces an "install" procedure which automatically "fixes" files as
  455. they are installed on a client's machine.
  456.  
  457. For the REALLY technical:
  458.  
  459. The loading process operates as follows:
  460.  
  461. The LOAD command invokes a batch file LOAD.BAT which calls a program BREAKIT.
  462. If the file you instruct it to load is longer than 200kb this program creates
  463. working files by  breaking up the  input file into  a series of files  (named
  464. P!.1,  P!.2 etc) each no  greater than  about 200kb.   It then writes  a file
  465. INDEX1.BAT consisting of one line INDEX  P!.1 P!.2 ...etc.  After BREAKIT has
  466. executed LOAD.BAT chains  to INDEX1.BAT  which in  turn calls  INDEX.BAT (the
  467. main loading "engine").
  468.  
  469. INDEX.BAT takes as parameters the names of  the files to be indexed and added
  470. to the OUTFILE.* database files.  For custom applications you may replace the
  471.  
  472. Racontex Manual                                                       Page 10
  473.     
  474.  
  475.  
  476. LOAD.BAT  front end  process with  your own  program provided that  it leaves
  477. input files not significantly larger than 200kb, and is followed by a call to
  478. INDEX.BAT.   (If you know that your files  are within the size  limit you may
  479. initiate the process by calling INDEX.BAT directly.)
  480.  
  481. For example  you may have an application designed to print a document (e.g. a
  482. library catalogue, Rolodex cards etc) with a standard number of heading lines
  483. on  each  page or  with  some  consistent separator  for  "logical  pages" of
  484. information.  You  could write a  simple BASIC  program which will  read that
  485. file,  ignoring the heading lines  and inserting  FormFeed characters between
  486. the  logical  pages,  and  writing out  a  series  of files  for  input  into
  487. INDEX.BAT.
  488.  
  489. The file size  limitation is  there because Racontex  can handle  files whose
  490. index would be too  large to fit into  memory and it therefore loads them  by
  491. indexing sections and merging the indexed sections on the hard disk.
  492.  
  493. The programs used by INDEX.BAT are described below:
  494.  
  495. INDBAT.EXE file1 file2 
  496. Reads in file1 and produces output files named file2 with various extensions.
  497. Defaults: file1=INFILE file2=OUTFILE.
  498.  
  499. MERGBAT.EXE filea fileb filec
  500. Merges files produced  by INDBAT.EXE, filea is the  name of the first  set of
  501. input files (without extension) fileb is the same for the second set of input
  502. files  and filec is the  name to be assigned  to the output  files.  Defaults
  503. filea=INFILE1  fileb=INFILE2 filec=OUTFILE.
  504. Note that before  running MERGBAT.EXE it  is necessary to  rename "filea".TXT
  505. (i.e. the file with the extension .TXT produced by INDBAT.EXE) as "filec".TXT
  506. as is done in INDEX.BAT.  
  507.  
  508. As  inspection of INDEX.BAT  will show,  the process of indexing  and merging
  509. will continue until all of the files named on the INDEX.BAT command line have
  510. been processed.
  511.  
  512. Please note that it is necessary to copy the file  LICENCE.PGF to "filec".PGF
  513. after all of the indexing and merging, as shown in the batch file.
  514.  
  515. SPEEDIND filec
  516. Examines the output files denoted by filec (defaults to OUTFILE) and writes a
  517. file used  later by the Racontex search program in conjunction with the other
  518. files produced by INDBAT.EXE and MERGBAT.EXE.
  519.  
  520.  
  521.  
  522. Racontex Manual                                                       Page 11
  523.     
  524.  
  525.  
  526. The file produced by SPEEDIND (with the  extension  .SPD) is  the  key to the
  527. speed of the Racontex reader/search engine when running from slow media  e.g.
  528. over a LAN.  Unlike many  such programs, it does not read the whole file over
  529. the LAN, it brings "pages" of it only across the LAN. Unlike the full client/
  530. server alternative it does not require the server to have a "query executing"
  531. engine - it uses the regular LAN redirector. However, an exeptionally complex
  532. word proximity query may cause it to "thrash" as it brings across sections of
  533. the index for comparison.
  534.  
  535. If the loading  process detects errors  during the run, it writes  details of
  536. the  errors  to  a file  called  RCNTXERR.LST,  and  INDEX.BAT  warns  of the
  537. existence of such a file.
  538.  
  539. Updating licence information on an old database.
  540. If you have databases produced by an unregistered version you may update them
  541. by using the UPDATE program provided.  Syntax is UPDATE files, where  "files"
  542. is the name of the database files (without extension).  The new   LICENCE.PGF
  543. must be in the current directory  when  the  program  is run.  To protect the
  544. copyright of those who use Racontex to  publish material, the UPDATE  program
  545. will not work on databases produced by a registered version of the loader.
  546.   
  547. Program Limitations.
  548. At present the system is limited  to documents of 16000 pages long  or less -
  549. there is no limitation to page size.
  550.  
  551. The system is a  "database" type system in that each  word found in the input
  552. is stored only once (in lower case)  and all subsequent references to it  use
  553. pointers and  case flags.   The  "dictionary" must  reside in  memory and  is
  554. limited to 65000  bytes -  this is always  adequate since  it allows  for the
  555. storage of  over 10,000 different words for use in  a given document and most
  556. people have a normal vocabulary smaller than this (also a  document is likely
  557. to refer to a sub-set  of human experience and  therefore use a more  limited
  558. vocabulary).    If  the  loading system  runs  out  of dictionary  space,  it
  559. continues to  run but substitutes ?  for the word it  cannot store and writes
  560. the word with  an appropriate  message to  the RCNTXERR.LST  file).   In this
  561. extremely unlikely event you may elect to leave the document with the odd "?"
  562. in it or break up the document into two sections and handle each section as a
  563. separate document.  You might also consider amending the delimiter list.
  564.  
  565. The only other limitation  is the size of the hard  disk on the machine being
  566. used.   Because the loading  program substantially compresses the  text it is
  567. not uncommon (with  an appropriate stopword  list) for the output  files from
  568. the loading process to be smaller in total than the input text file.
  569.  
  570.  
  571. Racontex Manual                                                       Page 12
  572.     
  573.  
  574.  
  575.  
  576. SEARCH SYSTEM INSTRUCTIONS
  577.  
  578. This system  is designed for  the RApid  CONTEXtual search  of documents  for
  579. keywords  and combinations  of words.  It  works quickly  because it operates
  580. mainly in  memory - bringing in a specially prepared copy of the document and
  581. then working  on it  (if your  machine has  insufficient memory  to hold  the
  582. document - often  the case with large  documents like statutes, Racontex will
  583. "page" the files into memory at a slight penalty in speed - if you use a hard
  584. drive or LAN connection you  will not notice the  difference).
  585.  
  586. Simple Searches.
  587.  
  588. The program is  invoked by  typing at  the A> prompt  (C> or  D> with  a hard
  589. drive):
  590.  
  591.             RACONTEX [FILE]
  592.  
  593. where [FILE] is the  name of the prepared database file  set.  For example to
  594. search the copy of the Industrial Relations Act saved as IRACT you would type
  595. RACONTEX IRACT (if you use a menu system, selecting the appropriate menu item
  596. would do this for you).
  597.  
  598. If there are Racontex databases in the  current  directory,  typing  RACONTEX
  599. without a filename will present a menu of them for selection.
  600.  
  601. If you use  a hard drive you may  copy all of the  files on the  distribution
  602. disk to that drive, and then run the program from its prompt (usually C>).
  603.  
  604. Display Options.
  605.  
  606. Racontex  will  detect whether  you  have a  colour card  installed  for your
  607. monitor, and will use colours to enhance the menu if it finds one.  Sometimes
  608. a  computer has  a colour card installed,  but uses  a monochrome  monitor (a
  609. common situation with  laptops using  liquid crystal  screens, and  VGA (e.g.
  610. PS/2  50) machines with monochrome  monitors) which  causes some menus  to be
  611. difficult to read.  In that situation Racontex may be invoked by
  612.  
  613.             RACONTEX [FILE]/m
  614.  
  615. and it will use its monochrome setup whether or not a colour card is in use.
  616.  
  617. Racontex cannot always get  a whole page of a document  on the screen, and in
  618. this case it displays  the page a screen  at a time.  The  standard method of
  619. moving down such a page is to show each screen full separately, since this is
  620. the fastest method of display (particularly with liquid crystal screens).  An
  621.  
  622. Racontex Manual                                                       Page 13
  623.     
  624.  
  625.  
  626. optional method is to  "scroll" the screen like  credits on a film, and  this
  627. may be preferable if the  pages of a document  are only slightly longer  than
  628. the screen.  This option is selected by invoking Racontex by
  629.  
  630.             RACONTEX [FILE]/s
  631.  
  632. (If both of the above are wanted, use RACONTEX [FILE]/m/s)
  633.  
  634. If Racontex detects that your computer  has a graphics card which can support
  635. more than 25 lines of text on the screen (Hercules, EGA or VGA) it will offer
  636. you the  opportunity to switch to  graphics mode in order to get  more of the
  637. page on the screen (36 lines for EGA and Hercules, 50 lines for VGA).  If for
  638. some  reason you do not  want  to  be offered this  choice (e.g. the slightly
  639. slower screen writing is a concern, or you don't like the smaller letters, or
  640. your display is not fully IBM compatible) you may force the non-graphics mode
  641. to be used by invoking Racontex by
  642.  
  643.            RACONTEX [FILE]/ng
  644.  
  645. If Racontex detects a mouse, it  will allow you to use it  to navigate around
  646. the screens.  If you do not  wish this you may disable it by adding   /nm  as
  647. a start up option)
  648.  
  649.  
  650. If your  system  has a  problem  with programs  which write  directly to  the
  651. hardware, add the option /DV and the program will use DOS  Video calls, which
  652. are slower but may avoid some problems.
  653.  
  654.  
  655. The program will now load itself  and the files it needs to operate and after
  656. a little chugging around will display "press any key to continue".  After you
  657. have pressed a key it will display a screen like this:
  658.  
  659.    
  660. |Word to find?                                                              |
  661. |                                                                           |
  662. |      [ENTER] then [ESC] to quit. [F9] to display first page. [?] for help  |
  663.  
  664.    
  665. Note that whenever you see a question mark "?" in the menu  bar at the bottom
  666. of the screen you may display a help screen by pressing the [?] key.
  667.  
  668. At this point  you may press [F9] to jump  straight to the first  page of the
  669. document, or you may enter a word to search for.
  670.  
  671. If you  are searching the Industrial Relations Act for references to the word
  672. "oath", you would type in "oath" and press enter, like this:
  673.  
  674. Racontex Manual                                                       Page 14
  675.     
  676.  
  677.  
  678.  
  679.    
  680. |Word to find? oath                                                         |
  681. |                                                                           |
  682. |      [ENTER] then [ESC] to quit. [F9] to display first page.  [?] for help|
  683.    
  684. and the computer would respond:
  685.  
  686.    
  687. |Word to find? oath                                                         |
  688. |       oath 9 occurrences                                                  |
  689. |                                                                           |
  690. |[ESC]=Quit [F1]=OR [F2]=Same Page[F3]=Word Proximity[F8]=Tally[F9]=Dsply[?]|
  691.    
  692.  
  693. You could then press [F9] and the computer would display:
  694.  
  695.    
  696. | Evidence                                                                  |
  697. |  19.  (1)  The council may receive and accept such evidence and information
  698. | on oath, affidavit or otherwise as in its discretion it considers proper, |
  699. | whether or not the evidence is admissible in a court of law.              |
  700. |    (2)  The council may request and receive a report from a person it     |
  701. | appoints to investigate an application or to investigate and attempt to   |
  702. | settle a dispute under this Act, a collective agreement or the regulations.
  703. | The council may, in its discretion, in a proceeding or class of proceedings
  704. | consider the contents of a report without disclosing them to any party.   |
  705. |                                                                           |
  706. |[ESC] [P] [PGDN] [PGUP] [END] [HOME] [<-] [v] [->] [^] ([?] for help)      |
  707.    
  708. Notice how the word "oath" is highlighted on the screen.
  709. {In these instructions [v] represents the down  arrow and [^] represents  the
  710. up  arrow  because  some  printers  object  to  the  codes  for   the  actual
  711. characters.}
  712.  
  713. The "menu"  at the bottom of  the screen allows  you to navigate  through the
  714. document.  In the example given, the Industrial Relations Act has been set up
  715. with one "page" equal  to one section (note that some  "pages" fill more than
  716. one screen).   Therefore the  key [PGUP]  takes you  to the  previous section
  717. (i.e. Section 18),  [PGDN] takes you to  the following section, [HOME]  takes
  718. you  to the beginning of  the Act and [END] takes you to  the end of the Act.
  719. The  arrow keys take you  around the pages your search  found, [<-] will take
  720. you to the previous section containing your search key, [->] will take you to
  721. the next one, [^]  will take you to the  top of your current  page (it may be
  722. too long to fit on the screen) and [v] will take you to the current  one (you
  723. may have moved away from it with the [PGUP] and [PGDN] keys.  [ESC] will take
  724.  
  725. Racontex Manual                                                       Page 15
  726.     
  727.  
  728.  
  729. you back to  search for a  different set of key words.   In this case  we hit
  730. [->] and the computer displayed:
  731.  
  732.    
  733. | Summons and discovery of documents                                        |
  734. |  20.  On the recommendation of an officer appointed under section 8 or 96,|
  735. | or on its own motion, the council has power to summon and enforce the     |
  736. | attendance of witnesses and compel them to give oral or written evidence on
  737. | oath and to produce the documents and things the officer or the council   |
  738. | considers requisite to the full investigation and consideration of matters|
  739. | within his or its jurisdiction in the same manner as a court of record in |
  740. | civil cases.                                                              |
  741. |                                                                           |
  742. |[ESC] [P] [PGDN] [PGUP] [END] [HOME] [<-] [v] [->] [^] ([?] for help)      |
  743.  
  744.    
  745. Word Proximity Searches
  746.  
  747. Sometimes the  computer indicates that there are too many instances of a word
  748. for anyone to want to look at  all instances (try "picket$" in the Industrial
  749. Relations Act -  the $ [or %  or * for  those familiar with  other "wild card
  750. characters"] indicates that  you want  all words  beginning with  picket, and
  751. would  include pickets, picketing etc.)   In that case you  might want to try
  752. combining it with another word.  In our  example we could look for oath  only
  753. within a given  number of words of  some other word, in  this case "eviden$".
  754. To  do this  we select  "word proximity" from  the "word  to find"  screen by
  755. pressing [F3] on that screen, and the computer responds with:
  756.  
  757.    
  758. |                                                                           |
  759. |[F1]=Adj [F2]=Within 2 words [F3]=4 [F4]=8 [F5]=16 [F6]=32 [F7]=64 [F8]=128|
  760. |                                                                           |
  761.  
  762.    
  763.  
  764. To tell it that we  only want to look for our  next word within sixteen words
  765. of the last one, we press [F5] and then see:
  766.  
  767.  
  768.    
  769. |                                                                           |
  770. |Word to find?                               within 16 words of previous set|
  771. |                                                                           |
  772. |                                                                           |
  773. |      [ENTER] then [ESC] to quit.                   [?] for help           |
  774.  
  775.    
  776.  
  777. Racontex Manual                                                       Page 16
  778.     
  779.  
  780.  
  781. to which we respond as follows, and get the result shown:
  782.  
  783.     
  784. |Word to find? eviden$                       within 16 words of previous set|
  785. |   evidence 31 occurrences                                                 |
  786. | evidentiary 1 occurrence                                                  |
  787. |                                                                           |
  788. |[ESC]=Quit [F1]=OR [F2]=Same Page [F3]=Word Proximity[F8]=Tally[F9]=display|
  789.  
  790.    
  791. This time when we press [F9] we get the following result:
  792.  
  793.    
  794. | Evidence                                                                  |
  795. |   19. (1)  The council may receive and accept such evidence andinformation 
  796. | on oath, affidavit or otherwise as in its discretion it considers proper, |
  797. | whether or not the evidence is admissible in a court of law.              |
  798. |    (2)  The council may request and receive a report from a person it     |
  799. | appoints to investigate an application or to investigate and attempt to   |
  800. | settle a dispute under this Act, a collective agreement or the regulations.
  801. | The council may, in its discretion, in a proceeding or class of proceedings
  802. | consider the contents of a report without disclosing them to any party.   |
  803. |                                                                           |
  804. |                                                                           |
  805. |[ESC] [P] [PGDN] [PGUP] [END] [HOME] [<-] [v] [->] [^] ([?] for help)      |
  806.  
  807.    
  808. Notice that both "oath" and  "evidence" ( also "evidentiary") are highlighted
  809. and how only pages containing both words are displayed as you proceed through
  810. the document using the [->] key.
  811.  
  812. Sometimes it is  necessary to find a  combination of one of several  words in
  813. combination with one of another set of words.  e.g. to find all references to
  814. picketing an ally you would need to find the combinations given by:
  815.  
  816. picket$
  817. [F3] or [F2]  (word proximity or same page)
  818. Ally
  819. [F1]          ("or")
  820. Alli$         (to catch "allies" "allied" etc)
  821. [F9]          ("display")
  822.  
  823. The proximity  search may  continue  for as  many proximity  combinations  as
  824. needed,  but it must be remembered that what  the proximity "engine" is doing
  825. is dropping  out references to  the first search  key set found which  do not
  826. satisfy each  succeeding condition.    To assist  this process  the  computer
  827. displays a  history of  "The Search  So Far"  in a  box at the  right of  the
  828.  
  829. Racontex Manual                                                       Page 17
  830.     
  831.  
  832.  
  833. screen.  At the  end of each set  of "OR" conditions (indicated by  selecting
  834. some key other than F1) the computer performs this dropping out operation and
  835. displays the number  of pages  remaining which  satisfy the  search criteria.
  836. When  F9  is selected  those remaining  occurrences  are displayed.    The F8
  837. "Tally" option is provided to allow a display of the number of hits remaining
  838. before the  "display" option is selected so that if too many remain a further
  839. criterion may be specified.
  840.  
  841. Printer and File Output.
  842.  
  843. When you have a document displayed on the screen, another choice shown on the
  844. menu is [P].  Pressing the P key will tell the system that you wish to have a
  845. copy  of the  current page  (or - for  files not  protected with  the RCNTFIX
  846. feature - all pages or those pages with "found" occurrences) printed for some
  847. purpose.  The  first time you press the P key, you will be  given a choice of
  848. output forms.  You may either direct the output to your printer  or to a file
  849. for later printing, or for incorporation in some other document.  It makes it
  850. easier to find if you include  the pathname of your word processing directory
  851. in  the file  name (otherwise  the file  will be  placed in the  DOS "current
  852. directory").
  853.  
  854. You may also select a file output format for later use.   If you select plain
  855. ASCII, the file  produced will contain straight  text.  If  you select  ASCII
  856. with {}  highlighting, the keywords will  appear in the file enclosed  in { }
  857. brackets.  You may  then use your word processor to  change these to whatever
  858. code it uses to turn on and off whatever form of highlighting you require.  
  859.  
  860. If you  select WordPerfect with bold, the file will be written in WordPerfect
  861. format, with the keywords set to bold print.  The  file  will be  produced in
  862. WordPerfect version 5.0.    WordPerfect 5.1 will also  read this file format.
  863. If you require a file in WordPerfect 4.2 format, start up RACONTEX with /WP42
  864. as  an option   on  the command  line (in  Windows, select from  the pulldown
  865. menu).     
  866.  
  867. If a file with the name you give exists, the new information will be appended
  868. to it, and  if you specified  WordPerfect format,  RACONTEX will add  its new
  869. information in the same version.  
  870.  
  871.