README for ST-Guide Lite v1.4 October 1995 =========================================================================== Programmed by Holger Weets (c) 1994. For more details refer to the ST-Guide HYPertext. Distribution ------------ ST-Guide Lite is a cut down version of the full ST-Guide hypertext system and is ONLY for distribution with other applications which use ST-Guide format documentation. The files included in this archive or on the disk comprise the official English version of ST-Guide Lite and may NOT under any circumstances be distributed via BBSs, Mailboxes and PD libraries or included on Magazine Cover disks, Magazine subscriber disks or CD-ROM collections without the prior written permission of both Holger Weets and Joe Connor. Things you should know! ----------------------- ST-GUIDE.ACC can be renamed ST-GUIDE.PRG and run as a program from the desktop if prefered. A complete ASCII version of the hypertext can be recreated from the HYP file using the ST-Guide utility HCP.TTP as follows: -Place a copy of HCP.TTP and the HYP to be ASCIIfied in the same directory -Run HCP.TTP, enter the following command line: -v -o~ Where is replaced by the name of the hypertext, for example: ST-GUIDE.HYP and select 'OK' -After processing and exiting HCP you should now find a file with the same name as the hypertext in the same directory with the extender STG. In our example ST-GUIDE.STG. This is an ASCII file which an be loaded into any text editor or word processor and printed out. -Optionally the original hypertext source can also be recreated using the -r parameter in HCP instead of -v. Taking our example again enter: -r -o~ RTF and HTML files can also be created using a utility called UDO which converts between RFT, ST-Guide and HTML (www) files. HCP.TTP is included in the complete ST-Guide distribution UDO is available separately Both are available from all good PD/Shareware libraires. UK Support and registration --------------------------- ST-Guide is Fairware and supported in the UK by Joe Connor. Benefits for registered users: - Access to the free update service - Labelled Master disk - ST-Guide illustrated on-line catalogue of supported software - ST-Guide on-line help - Selection of other software (dependent on disk space) The Shareware/registration fees are set to cover the currency handling, stationary, media and postage costs incurred in mailing out master disks. How to register inside the UK ----------------------------- 2) Make a cheque payable for at least œ6 to Joe Connor. 3) Be sure to include your name and address in a legible format! 4) Send cheque to: 65 Mill Road, Colchester, CO4 5LJ, England Joe Connor can be contacted by Email at: jconnor@cix.compulink.co.uk --------------------------------------------------------------------------- Brief Installation guide (refer to the ST-Guide HYPertext for more info) =========================================================================== 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 (Skip if your version is already extracted) ------------------------------------------------------------------- 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 Lite (Only neccessary if not pre-configured) ----------------------------------------------------------------- Using a text editor (eg Everest) you can edit the example ST-GUIDE.INF below and save it as ST-GUIDE.INF. 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. ST-GUIDE should not be renamed as some applications which offer on-line help may not be able to find it. Example ST-GUIDE.INF file: ------------------------------ cut here --------------------------------- # ======================================================================== # Please edit this ST-Guide INF file to your requirements # ======================================================================== # # Read this! # This file can be edited in any ASCII text editor (eg Everest) # If you experience any problems with ST-Guide try removing # ST-GUIDE.INF altogether. ST-Guide then uses its internal defaults. # If the problem goes away you'll know something is wrong with your # ST-GUIDE.INF file. # This file is configured by default to run from Drive C: but anyone # running a floppy based system can simply change each occurence of # C: to A: # By default ST-Guide looks in the root directory of your boot drive # for a 'GUIDES' folder which can be used to store all your 'HYP and # 'REF' files. # Lines preceded with a '#' symbol (like this one) are comments and # ignored by ST-Guide. # # # ST-Guide options: # ----------------- # Default search path, where ST-Guide looks for 'HYP' hypertexts: PATHS=C:\GUIDES;A:\GUIDES # # Default directory ST-Guide opens when calling the File Selector. # The Hypertext ComPiler (HCP) also compiles to this path: HYPFOLD=C:\GUIDES\ # # A list of file extenders and paths to external viewers may follow: C= IMG=C:\1STVIEW.ACC # # An external viewer, which must be memory resident can be used to # display unknown file types: EXTVIEW=NOTICE # # The hypertext file to be loaded via the ST-Guide 'Catalog' option or # when ST-Guide is started without parameters: HYPTOP=C:\GUIDES\CATALOG.HYP # # The file used to find references: REF=C:\GUIDES\ALL.REF # # ST-Guide can use GDOS screen fonts if loaded, the code determines the # font used. Refer to main documentation for syntax details: #FONT=98,9 FONT=1,10 # # The following three variables are only relevant in colour resolutions # and are ignored in monochrome resolutions. # TXTCOLOR Displays text in the specified colour. # REFCOLOR Displays references in the specified colour using the # normal typestyle (NOT bold and underlined). # BCKCOLOR Background colour for ST-Guide windows. # # Default colours (Note! Your system may change these values!): # 0=White 1=Black 2=Red 3=Green # 4=Blue 5=Cyan 6=Yellow 7=Magenta # 8=Grey 9=Dark grey 10=Dark red 11=Dark green # 12=Dark blue 13=Dark cyan 14=Dark yellow 15=Dark magenta TXTCOLOR=2 REFCOLOR=3 #BCKCOLOR=8 # # If this option is active (the value is irrelevant) a right mouse key # click is interpreted as 'Retrace'. #RIGHTBACK= # # If this variable is active, clicking on 'normal' text does not cause # ST-Guide to search for references. #REFONLY= # # HCP is used to compile STG files into HYP files. STool uses this entry # to find HCP and compile: HCP=C:\ST-GUIDE\HCP.TTP # # The number of spaces a tab will be expanded to is set here: #TABSIZE=4 # # This variable is provided to install ARROWPATCH. This patch corrects a # bug in the AES which prevents the scroll bars in windowed accessories # from working correctly with certain TOS versions. # If you exerience this behaviour activate this patch ON (by removing # the preceding #). # This patch is not needed if you are running WINX, MagiC, MTOS or # already have the ARROWPATCH installed globally. #ARROWPATCH=1 # # The first two values set the top left corner of the window. The # next two values set the bottom right corner for the ST-Guide window: #WINSIZE=100,100,400,200 # # This file will be loaded automatically if ST-Guide is started without # parameters: DEFHYP=ST-GUIDE.HYP # # These options are used automatically when HCP is called: #HCP_OPT= # # Hypfind is called by ST-Guide to search for search masks in all pages # in the current hypertext. HYPFIND=C:\ST-GUIDE\HYPFIND.TTP # # Whenever 'Print' is selected output is sent to the Clipboard and # Re-directed to this listed application for output: #PRINTER=C:\ILIST.ACC # # Path for Remarker: # Without '!' preceding the path Remarker is automatically started on # opening ST-Guide. # With '!' preceding the path Remarker is started using [Alternate]+R REMARKER=!C:\ST-GUIDE\REMARKER.PRG # # These options pass parameters from ST-Guide to HypTree: #HYPTREE_OPT= # # TO call STool from an ST-Guide hypertext: $STOOL=C:\ST-GUIDE\STOOL.TOS # # # RefCheck options: # ----------------- # Path to RefLink for REFCHECK: REFLINK=C:\ST-GUIDE\REFLINK.TTP # # Default REFCHECK options used if no command line is passed: REFCHECK-OPT=ads # # # KATMAKER options: # ----------------- # Output filenames in the hypertext without extenders KM_SHORT # # Display filenames in the hypertext in lower case characters KM_SMALL # # # HypTree options: # ---------------- # Here the default size of the HypTree window can be displayed. # If these variables are not defined, the size and position of the last # window will be used, if available. HT_WINSIZE=40,40,100,200 # # Using this switch you can decide whether all pages included in the # HypTree structure are visible (0 = No, 1 = Yes) HT_OPENALL=1 # # This variable sets the position of the triangle in the window # 0 = next to the text, 1 = On the left hand margin of the window. HT_MACLIKE=0 # # The following command line is sent to HypTree from ST-Guide (via # VA_START) after the user double clicks on the menu bar title in any # hypertext page. The following strings are replaced with the actual # values when called: # %p Pathname of the hypertext file # %n Name of the hypertext file (without path) # %s The internal name of the hypertext page HT_CALLSTG=-s1 %p %s # # The following command line is sent to ST-Guide from HypTree as soon # as the current hypertext is closed: HT_STOPSTG=-s0 # # That's it! ------------------------------ cut here --------------------------------- EOF