--------------------------------------------------------------------------- README for ST-Guide =========================================================================== Important! Read ST-GUIDE.CHG in the DOCS folder for up to the date news. ST-Guide consists of two archives: ST_GUIDE.LZH: Containing ST-Guide, HCP, STool, RefLink STG_UTIL.LZH: Containing 1st-Conv, PC-Conv, MAN2STG with source codes in C in each case, as well as HELP_RC and HELPDISK. I've included the source code so other programmers can debug or extend the converters. Please let me know and send me a copy of any changes you make so I can make sure everbody has access to the latest and optimum versions at all times. --------------------------------------------------------------------------- Installation guide =========================================================================== To minimise the risk of other software affecting the installation of ST-Guide perform the installation after a reboot on a 'clean' minimum system! Extracting the archives ----------------------- Extract the contents of the archives OR copy the contents of the master disk onto the root directory of your boot partition/disk. Either method should preserve the directory structure and ensures ST-GUIDE can locate its files. Double check to ensure ST-GUIDE.ACC and ST-GUIDE.INF reside in the root directory of the boot partition or disk. Configuring ST-Guide -------------------- Using a text editor (eg Everest) load ST-GUIDE.INF and carefully read through the options. Each option is described in detail followed by the option line itself. Lines preceded with a '#' character are NOT currently active. It's important the path entries are correct otherwise ST-Guide will not be able to find its files: PATHS: The path where HYP files are located, more than one path can be entered, use the ';' character to seperate paths. HYPFOLD: The default path used by the file selector and HCP. HYPTOP: The default hypertext loaded when ST-GUIDE is called without parameters. REF: The path to the ALL.REF file, which may already be listed in the PATHS variable. It's not needed during installation and can be added later. HCP: The path to the compiler, HCP.TTP. ST-GUIDE should not be renamed as some applications which offer on-line help may not be able to find it. Managing your hypertexts ------------------------ Each hypertext consists of a HYP and a REF file. The HYP file contains the compiled hypertext and the REF file contains the references defined in the hypertext. Using REFLINK.TTP it's possible to combine the references contained in each REF file into a single ALL.REF file. There are several ways of adding the contents of an individual REF file to ALL.REF: a) Install REFLINK.TTP as an application for '*.REF' files using the desktop. After installation a double click on any REF file on the desktop will call REFLINK.TTP and add the contents of the REF file to an ALL.REF file located using the REF path in ST-GUIDE.INF. b) Drag a REF file/s onto REFLINK.TTP. c) Run REFLINK.TTP and manually enter the path to the desired REF file. d) One convienient method, where possible, is to store all hypertexts in a single folder and call REFLINK.TTP using '*.REF*'. This generates an ALL.REF file containing all the references in all the hypertexts contained in the folder. The last option is recommended because it enables ST-Guide (via the 'Find' option) or hypertexts to search for references in other hypertexts. Catalogue your collection ------------------------- Using STOOL.TTP it's possible to automatically catalogue all your hypertexts thematically. This does however depend on the author of the hypertext including the necessary infomation in the hypertext header. On starting STOOL.TTP each of the paths entered in the ST-GUIDE.INF PATH entry is searched for HYP format hypertexts and creates a hypertext called CATALOG.HYP. this can be loaded via the 'Open' option from the 'Extras' menu in ST-GUIDE.ACC or installed as the default hypertext in ST-GUIDE.INF. Finally ------- Reboot your computer and we wish you every success using ST-Guide. --------------------------------------------------------------------------- 27th September 1994