home *** CD-ROM | disk | FTP | other *** search
/ No Fragments Archive 10: Diskmags / nf_archive_10.iso / MAGS / AT_WORLD / ATRIW1.MSA / ST-GUIDE.S12_ST-GUIDE_READ.ME < prev    next >
Text File  |  1995-03-09  |  5KB  |  98 lines
  1. ---------------------------------------------------------------------------
  2. README for ST-Guide                                       English Release 4
  3. ===========================================================================
  4. Important!
  5. Read ST-GUIDE.CHG for details of the latest changes.
  6.  
  7. ST-Guide consists of two archives:
  8.  
  9. STGUIDxE.LZH:    Contains ST-Guide, HCP, HypFind, STool and RefLink
  10. STGUTIxE.LZH:    Contains 1st-Conv, PC-Conv, MAN2STG with C source code 
  11.                  along with HELP_RC, HELPDISK, HypTree and others!
  12.  
  13. We'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 you 
  15. make so I can make sure everbody has access to the latest and optimum 
  16. 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 master 
  29. 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 won't be 
  43. able to find its files:
  44.  
  45. PATHS:   The path where HYP files are located, more than one path can be 
  46.          entered, use the ';' character to seperate paths.
  47. HYPFOLD: The default path used by the file selector and HCP.
  48. HYPTOP:  The default hypertext loaded when ST-GUIDE is called without 
  49.          parameters.
  50. REF:     The path to the ALL.REF file, which may already be listed in the 
  51.          PATHS variable. It's not needed during installation and can be 
  52.          added later.
  53. HCP:     The path to the compiler, HCP.TTP.
  54.  
  55. ST-GUIDE should not be renamed as some applications which offer on-line 
  56. help may not be able to find it.
  57.  
  58. Managing your hypertexts
  59. ------------------------
  60. Each hypertext consists of a HYP and a REF file. The HYP file contains the 
  61. compiled hypertext and the REF file contains the references defined in the 
  62. hypertext.
  63. Using REFLINK.TTP it's possible to combine the references contained in 
  64. each REF file into a single ALL.REF file.
  65. There are several ways of adding the contents of an individual REF file to 
  66. ALL.REF:
  67. a) Install REFLINK.TTP as an application for '*.REF' files using the 
  68.    desktop. After installation a double click on any REF file on the 
  69.    desktop will call REFLINK.TTP and add the contents of the REF file to 
  70.    an ALL.REF file located using the REF path in ST-GUIDE.INF.
  71. b) Drag a REF file/s onto REFLINK.TTP.
  72. c) Run REFLINK.TTP and manually enter the path to the desired REF file.
  73.  
  74. d) One convienient method, where possible, is to store all hypertexts in a 
  75.    single folder and call REFLINK.TTP using '*.REF*'. This generates an 
  76.    ALL.REF file containing all the references in all the hypertexts 
  77.    contained in the folder.
  78.  
  79. The last option is recommended because it enables ST-Guide (via the 'Find' 
  80. option) or hypertexts to search for references in other hypertexts.
  81.  
  82. Catalogue your collection
  83. -------------------------
  84. Using STOOL.TOS it's possible to automatically catalogue all your 
  85. hypertexts thematically. This does however depend on the author of the 
  86. hypertext including the necessary infomation in the hypertext header.
  87.  
  88. On starting STOOL.TOS each of the paths entered in the ST-GUIDE.INF PATH 
  89. entry is searched for HYP format hypertexts and creates a hypertext 
  90. called CATALOG.HYP. this can be loaded via the 'Open' option from the 
  91. 'Extras' menu in ST-GUIDE.ACC or installed as the default hypertext in 
  92. ST-GUIDE.INF.
  93.                              
  94. Finally
  95. -------
  96. Reboot your computer and we wish you every success using ST-Guide.
  97. ---------------------------------------------------------------------------
  98. 7th March 1995