home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / xref_v1.1.lha / XRef / Doc / english / makeaguideindex.doc < prev    next >
Encoding:
Text File  |  1995-01-09  |  1.7 KB  |  61 lines
  1. XRef-Tools/MakeAGuideIndex                           XRef-Tools/MakeAGuideIndex
  2.  
  3. $VER: makeaguideindex.doc 1.3 (13.09.94)
  4.  
  5. NAME
  6.     MakeAGuideIndex - generates an index file for some given AmigaGuide files
  7.  
  8. TEMPLATE
  9.     FILES/M/A,INDEXFILE/K,INCLINKS/S,FILEPART/S,NOLETTERS/S
  10.  
  11. FORMAT
  12.     MakeAGuideIndex [FILES] file [file2 [..]] [INDEXFILE idxfile] [INCLINKS]
  13.                     [FILEPART] [NOLETTERS]
  14.  
  15. FUNCTION
  16.     this command generates a index file or node for the given AmigaGuide
  17.     files. If no INDEXFILE is specified the index is appended to the first
  18.     AmigaGuide file.
  19.  
  20. INPUTS
  21.     FILES (STRINGS) - AmigaGuide files to create index for. If no INDEXFILE
  22.         is specified the generated index is append to the first file specified
  23.         here
  24.  
  25.     INDEXFILE (STRING) - indexfile to create.
  26.  
  27.     INCLINKS (BOOLEAN) - if this switch is set, all links in the specified
  28.         AmigaGuide files are included in the index.
  29.  
  30.     FILEPART (BOOLEAN) - if this switch is set, the index name is a part of
  31.         the title of a node, which is calculated via FilePart() call. For
  32.         example the title of a node is given as "XRef/My Title", a index
  33.         is generated with the name "My Title".
  34.  
  35.     NOLETTERS (BOOLEAN) - if this switch is set, don't generate a initial
  36.         letter line.
  37.  
  38. EXAMPLE
  39.     MakeAGuideIndex myapp.guide INCLINKS FILEPART
  40.  
  41.     or
  42.  
  43.     MakeAGuideIndex myapp.guide INDEXFILE myapp.index INCLINKS FILEPART
  44.  
  45. SEE ALSO
  46.     XRefConvert
  47.  
  48. COPYRIGHT
  49.     (C) 1994 by Stefan Ruppert
  50.  
  51. HISTORY
  52.     MakeAGuideIndex 1.3 (13.9.94) :
  53.         - workbench support added
  54.  
  55.     MakeAGuideIndex 1.2 (3.9.94) :
  56.         - ctrl-c support added
  57.  
  58.     MakeAGuideIndex 1.1 (17.7.94) :
  59.         - created
  60.  
  61.