home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 301.lha / AIndex.doc < prev    next >
Encoding:
Text File  |  1980-11-30  |  2.9 KB  |  76 lines
  1.  
  2.  
  3. ***************************** AIndex ********************************
  4.        A generic, automatic indexing program for the Amiga
  5.  
  6.               Copyright (c) LaserUp! Software, 1989
  7.                        All rights reserved
  8.  
  9. Shareware donation $15
  10. If you like and/or use this program, please send your donation to:
  11.  
  12.     LaserUp! Software
  13.     889 DeHaro St.
  14.     San Francisco, CA 94107
  15.     (415) 826-6193
  16.  
  17.      Almost every software review I have read recently mentions the
  18. inclusion or lack of inclusion of an index as the making or breaking
  19. feature of the manual.  Manually (sic) creating an index to a long
  20. document is an onerous task at best, and after searching in vain for
  21. a public domain, generic, and easy to use program to create an index 
  22. for our upcoming LaserUp! Draw, I wrote AIndex.
  23.  
  24.      AIndex will automatically create an index of selected words in a
  25. document.  It keeps track of the location of the selected words by
  26. chapters and/or pages of the document by inserting dot commands into
  27. the document.
  28.  
  29.      Creating an index is a simple three step process:
  30.  
  31.      1.  After writing and editing your document, mark the chapters
  32. and pages using the following dot commands:
  33.   
  34.      .chap=n  or .ch=n    
  35.      .page=n  or .pg=n      (n is any number)
  36.      .page+   or .pg+
  37.      ^L (control-L)  
  38.  
  39.      2.  Create a wordlist of the words or phrases in the document
  40. that needs to be indexed.  Write one word or phrase per line using
  41. any text editor and save the file.  Phrases can be up to 100
  42. characters in length.  The index can be up to 500 entries long for
  43. this version of AIndex.
  44.  
  45.      3.  run AIndex by typing from the CLI or Shell:
  46.  
  47.          AIndex document_name wordlistname outputname
  48.      
  49.      If you do not type three filenames following the program name, a
  50. USAGE screen will appear telling you what to do.
  51.  
  52.      If no chapters are specified in the document then the program
  53. will automatically start with page 1 and increment the page number
  54. each time it reads ".pg+", ".page+", or ^L.  If you want to specify
  55. a particular page number in the document, use the ".page=n" or
  56. ".pg=n" command.  If chapters are specified using the ".chap=n" or
  57. ".ch=n" dot command, page numbers are reset to 1 at the beginning
  58. of each chapter.
  59.  
  60.      The output file will contain the wordlist with comma separated
  61. page numbers for each entry.  If chapters are specified, the page
  62. numbers are in the "chap.page" format, ie. 1.2, 6.22, etc.  A
  63. possible future option might be to use an underscore or a dash
  64. instead of the period.
  65.  
  66. **********************************************************************
  67.  
  68.      We are working on automating the creation of the wordlist by
  69. marking the selected words for indexing directly in the document
  70. using an escape sequence.  Anyone sending in their $15 donation
  71. will receive this upgrade as soon as it is available.
  72.  
  73.      Any comments, complaints, or suggestions are also welcome.
  74.  
  75. Scott Anthony
  76.