home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / xref_v1.1.lha / XRef / Doc / english / aguidexrefv37.doc < prev    next >
Encoding:
Text File  |  1995-01-09  |  3.7 KB  |  109 lines
  1. XRef-Tools/AGuideXRefV37                               XRef-Tools/AGuideXRefV37
  2.  
  3. $VER: aguidexrefv37.doc 1.10 (22.09.94)
  4.  
  5. NAME
  6.     AGuideXRefV37 - searches the xref-lists for a given string/pattern and
  7.                     shows a amigaguide text for the found entries
  8.  
  9. TEMPLATE
  10.     STRING,CATEGORY,FILE/K,CACHEDIR/K,LINELENGTH/N/K,COLUMNS/N/K,LIMIT/N/K,
  11.     NOPATTERN/S,NOCASE/S,PUBSCREEN/K,PORTNAME/K
  12.  
  13. FORMAT
  14.     AGuideXRef [[STRING] string|pattern] [[CATEGORY] category] [FILE xreffile]
  15.                [CACHEDIR dir] [LIMIT maxentries] [LINELENGTH numchars] 
  16.                [COLUMNS numcolumns] [NOPATTERN] [NOCASE] [PUBSCREEN pubname]
  17.                [PORTNAME arexxportname]
  18.  
  19. FUNCTION
  20.     this command gives an CLI interface to the xref.library, which uses the
  21.     AmigaGuide system to display some found xref entries and have a link to
  22.     its real documentation.
  23.     If you specify the CACHEDIR, this directory will be used to save the
  24.     AmigaGuide files, if there are more the one entries for the given string
  25.     or pattern. Any next call with this CACHEDIR and the given string/pattern,
  26.     it will no longer call the xref.library function, but uses this file.
  27.     If you do not specify a CATEGORY all xreffiles in the xref.library are
  28.     parsed.From xref.library 1.8 the categorystring can be a pattern !
  29.  
  30. INPUTS
  31.     STRING (STRING) - string|pattern to search for
  32.  
  33.     CATEGORY (STRING) - category to parse (no specified category matches
  34.         all categories). Can be a pattern !
  35.  
  36.     FILE (STRING) - file to parse, this argument overrides the CATEGORY
  37.         argument
  38.  
  39.     CACHEDIR (STRING) - if you want to save all generated AmigaGuide files
  40.         to have a fast access to it, just specify here the directory, in which
  41.         these files will saved
  42.  
  43.     LIMIT (NUMBER) - specifies the maximal number of entries to match
  44.         (default : xref.library default (XREFBA_DefaultLimit))
  45.  
  46.     LINELENGTH (NUMBER) - specifies the number of chars for a line
  47.         (default : xref.library default (XREFBA_LineLength))
  48.  
  49.     COLUMNS (NUMBER) - specifies the number of columns, which will be used
  50.         if more than one entry matches
  51.         (default : xref.library default (XREFBA_Columns))
  52.  
  53.     NOPATTERN (BOOLEAN) - interprets the given string as a normal string
  54.         instead of a pattern
  55.  
  56.     NOCASE (BOOLEAN) - makes the search case-insensitive
  57.  
  58.     PUBSCREEN (STRING) - specifies the screen, on which the AmigaGuide window
  59.         should be opened
  60.  
  61. EXAMPLES
  62.     The following example searches all xreffiles of the AutoDoc category for
  63.     xrefentries with the word "Window" inside and tries to open a window on
  64.     the
  65.     GoldEd Screen, if it has found some entry matches this pattern :
  66.  
  67.         AGuideXRefV37 #?Window#? #?AutoDoc#? PUBSCREEN=GOLDED.1
  68.  
  69. SEE ALSO
  70.     LoadXRef,MakeXRef,ParseXRef,dos.library/ParsePattern()
  71.  
  72. COPYRIGHT
  73.     by Stefan Ruppert (C) 1994
  74.  
  75. HISTORY
  76.     AGuideXRefV37 1.10 (22.9.94) :
  77.         - ENTRYA_NodeName wasn't used for the guide node. This is fixed !
  78.  
  79.     AGuideXRefV37 1.9 (8.9.94) :
  80.         - workbench support added
  81.  
  82.     AGuideXRefV37 1.8 (3.9.94) :
  83.         - some tagnames changed
  84.  
  85.     AGuideXRefV37 1.7 (10.8.94) :
  86.         - now V37,V39 versions are two programs
  87.  
  88.     AGuideXRef 1.6 (29.7.94) :
  89.         - major changes for V39 version
  90.         - entries now sorted to files
  91.  
  92.     AGuideXRef 1.5 (10.6.94) :
  93.         - File highlighted added
  94.  
  95.     AGuideXRef 1.4 (5.6.94) :
  96.         - now unique tempfiles
  97.         - V39 datatype skeleton
  98.         - V39 datatype entry with the FORCEV39 switch
  99.  
  100.     AGuideXRef 1.3 (28.5.94) :
  101.         - CACHEDIR and PORTNAME options added
  102.  
  103.     AGuideXRef 1.2 (20.5.94) :
  104.         - LINELENGTH and COLUMNS options added
  105.  
  106.     AGuideXRef 1.1 (10.5.94) :
  107.         - first beta release
  108.  
  109.