home *** CD-ROM | disk | FTP | other *** search
/ World of Shareware - Software Farm 2 / wosw_2.zip / wosw_2 / DATABASE / RACONT.ZIP / MANUAL < prev    next >
Text File  |  1991-04-21  |  39KB  |  798 lines

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