home *** CD-ROM | disk | FTP | other *** search
/ Dream 45 / Amiga_Dream_45.iso / Atari / Docs / ST-Guide / stguide2.lzh / ST-GUIDE / README.TXT < prev    next >
Text File  |  1994-09-27  |  4KB  |  97 lines
  1. ---------------------------------------------------------------------------
  2. README for ST-Guide
  3. ===========================================================================
  4. Important! Read ST-GUIDE.CHG in the DOCS folder for up to the date news.
  5.  
  6. ST-Guide consists of two archives:
  7.  
  8. ST_GUIDE.LZH:   Containing ST-Guide, HCP, STool, RefLink
  9. STG_UTIL.LZH:   Containing 1st-Conv, PC-Conv, MAN2STG
  10.                 with source codes in C in each case,
  11.                 as well as HELP_RC and HELPDISK.
  12.  
  13. I've included the source code so other programmers can debug or extend 
  14. the converters. Please let me know and send me a copy of any changes 
  15. you make so I can make sure everbody has access to the latest and 
  16. optimum versions at all times.
  17.  
  18. ---------------------------------------------------------------------------
  19. Installation guide
  20. ===========================================================================
  21.  
  22. To minimise the risk of other software affecting the installation of 
  23. ST-Guide perform the installation after a reboot on a 'clean' minimum 
  24. system!
  25.  
  26. Extracting the archives
  27. -----------------------
  28. Extract the contents of the archives OR copy the contents of the 
  29. master disk onto the root directory of your boot partition/disk.
  30.  
  31. Either method should preserve the directory structure and ensures ST-GUIDE 
  32. can locate its files. Double check to ensure ST-GUIDE.ACC and ST-GUIDE.INF 
  33. reside in the root directory of the boot partition or disk.
  34.  
  35. Configuring ST-Guide
  36. --------------------
  37. Using a text editor (eg Everest) load ST-GUIDE.INF and carefully read 
  38. through the options. Each option is described in detail followed by the 
  39. option line itself. Lines preceded with a '#' character are NOT currently 
  40. active.
  41.  
  42. It's important the path entries are correct otherwise ST-Guide will not be 
  43. able to find its files:
  44. PATHS:   The path where HYP files are located, more than one path can be 
  45.          entered, use the ';' character to seperate paths.
  46. HYPFOLD: The default path used by the file selector and HCP.
  47. HYPTOP:  The default hypertext loaded when ST-GUIDE is called without 
  48.          parameters.
  49. REF:     The path to the ALL.REF file, which may already be listed in the 
  50.          PATHS variable. It's not needed during installation and can be 
  51.          added later.
  52. HCP:     The path to the compiler, HCP.TTP.
  53.  
  54. ST-GUIDE should not be renamed as some applications which offer on-line 
  55. help may not be able to find it.
  56.  
  57. Managing your hypertexts
  58. ------------------------
  59. Each hypertext consists of a HYP and a REF file. The HYP file contains the 
  60. compiled hypertext and the REF file contains the references defined in the 
  61. hypertext.
  62. Using REFLINK.TTP it's possible to combine the references contained in 
  63. each REF file into a single ALL.REF file.
  64. There are several ways of adding the contents of an individual REF file to 
  65. ALL.REF:
  66. a) Install REFLINK.TTP as an application for '*.REF' files using the 
  67.    desktop. After installation a double click on any REF file on the 
  68.    desktop will call REFLINK.TTP and add the contents of the REF file to 
  69.    an ALL.REF file located using the REF path in ST-GUIDE.INF.
  70. b) Drag a REF file/s onto REFLINK.TTP.
  71. c) Run REFLINK.TTP and manually enter the path to the desired REF file.
  72.  
  73. d) One convienient method, where possible, is to store all hypertexts in a 
  74.    single folder and call REFLINK.TTP using '*.REF*'. This generates an 
  75.    ALL.REF file containing all the references in all the hypertexts 
  76.    contained in the folder.
  77.  
  78. The last option is recommended because it enables ST-Guide (via the 'Find' 
  79. option) or hypertexts to search for references in other hypertexts.
  80.  
  81. Catalogue your collection
  82. -------------------------
  83. Using STOOL.TTP it's possible to automatically catalogue all your 
  84. hypertexts thematically. This does however depend on the author of the 
  85. hypertext including the necessary infomation in the hypertext header.
  86.  
  87. On starting STOOL.TTP each of the paths entered in the ST-GUIDE.INF PATH 
  88. entry is searched for HYP format hypertexts and creates a hypertext 
  89. called CATALOG.HYP. this can be loaded via the 'Open' option from the 
  90. 'Extras' menu in ST-GUIDE.ACC or installed as the default hypertext in 
  91. ST-GUIDE.INF.
  92.                              
  93. Finally
  94. -------
  95. Reboot your computer and we wish you every success using ST-Guide.
  96. ---------------------------------------------------------------------------
  97. 27th September 1994