home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsf / hyperhelp / !HyperHelp / !Help < prev    next >
Encoding:
Text File  |  1996-08-14  |  11.4 KB  |  250 lines

  1.  
  2.                     -------------------------------------------       
  3.                     |                                         |
  4.                     |               !HyperHelp                |
  5.                     |                                         |
  6.                     |         Programming and grafix by       |
  7.                     |                                         |
  8.                     |             Chris Wymark                |
  9.                     |                                         |
  10.                     |      © Visions of the Impossible, 96    |
  11.                     |                                         |
  12.                     -------------------------------------------
  13.  
  14.  
  15.  
  16. What is !HyperHelp?
  17. °°°°°°°°°°°°°°°°°°°
  18.  
  19. !HyperHelp is a Hyper text viewing system.  This means that it displays documents which contain sprites and links to other places in the text.  The links can be clicked on and you will be moved to the relevant place in the text.  (A useful analogy might be labeled book marks!)
  20.  
  21.  
  22. How do I use !HyperHelp?
  23. °°°°°°°°°°°°°°°°°°°°°°°
  24.  
  25. !HyperHelp was designed to be very easy to use.  Once you have loaded the program open the window by clicking on the icon bar icon (it might have opened automatically, depending on how the options are set).  
  26.  
  27. Any hyper text links will be shown in green and if you move the mouse pointer over them, it will change to a pointy finger thing!  IF you click on the link you will be moved through the text to the relevant location.  Thats it!
  28.  
  29.   
  30. What's do the buttons on the toolbar do?
  31. °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
  32.  
  33. Right then starting from left to right,
  34.  
  35. 1.  This swaps between using outline fonts and the system font.  This can make a considerable difference in window redraw speed, and also outline fonts look a bit duff on lower-res monitors.
  36.  
  37. 2 & 3.  These two buttons allow movement between current and previous links that you have clicked on.
  38.  
  39. 4. This is the search window a more detailed explanetion is below.
  40.  
  41. 5. This returns you to the beginning on the text.
  42.  
  43. 6. This swaps between paged mode and text mode. In effect this means you can either scroll right through the entire document, or view it in pages.
  44.  
  45.  
  46. Searching for something:
  47. °°°°°°°°°°°°°°°°°°°°°°°°
  48.  
  49. In the search window there is a writable icon, which allows you to type in something to search for.  Once you are happy with the contents of this icon, either press <Enter> or click on O.K. this will then initiate the search.
  50.  
  51. Explanation of icons:
  52.  
  53. Case sensitive:- This makes the search become case sensitive, eg Chris is different to chris
  54.  
  55. To buffer:- This will send all of the results of the search to the list at the the bottom of the search window.  You can then double click on each object in the list.
  56.  
  57. Fuzzy search:- This will search all of the links for partial matches from the search icon.
  58.  
  59. Min length:- This alters the minimum length of the partial match, this is to stop one letter matches been thrown up.
  60.  
  61.  
  62. Options window:
  63. °°°°°°°°°°°°°°°
  64.  
  65. The options window allows the user to configure !HyperHelp to suit there own preferences.  The options supported are as follows;
  66.  
  67. Open text window on startup - Fairly self explanetory
  68.  
  69. Use outline fonts on startup - Again fairly self explanetory
  70.  
  71. Maximum number of links - The lower this is the less memory the program requires, but the less Hyper text links can be supported.  Probably best left as it is!
  72.  
  73. Load Hyper Text Sprites - If this is not selected none of the assoicated sprites will be loaded with the Hyper text document.
  74.  
  75. Fill window background - Guess what?
  76.  
  77. Display text as pages - Work it out your self :-)
  78.  
  79.  
  80. !HyperHelp commands:
  81. °°°°°°°°°°°°°°°°°°°°
  82.  
  83. The syntax of the commands is as follows:
  84.  
  85. {command parameter1 parameter2 parameter3 etc}
  86.  
  87. The curly brackets are essential, and there should be NO space between the command and the opening bracket.
  88.  
  89. Commands:
  90.  
  91. ================================================================================
  92.  
  93. Font - fontname,fontsize 
  94.  
  95. This allows you to change the font and size in the hyper text document.
  96.  
  97. Example, {font Trinity.Medium 17}
  98.  
  99. ================================================================================ 
  100. Sprite - spritename
  101.  
  102. This plots the named sprite at the current text pointer.
  103.  
  104. Example, {sprite !hyperhelp}
  105.  
  106. ================================================================================ 
  107. Colour - 0-15
  108.  
  109. This allows you to change the colour of the text, the colour range is that which the WIMP uses.
  110.  
  111. Example, {colour 11} - changes to red text
  112.  
  113. ================================================================================ 
  114. LinkTo - nodename,nodetitle
  115.  
  116. This command is the most important command, as without it you cannot create any HyperText links.  The nodename is then name of the corresponding node, and the nodetitle is the hyper text link title.  Please note though that you can not have spaces in the nodetitle, if you do need a space please use a _ instead.
  117.  
  118. Example, {linkto firstpage Main_Menu}
  119.  
  120. ================================================================================ 
  121. Node - nodename
  122.  
  123. This command informs !HyperHelp of the location of a link.
  124.  
  125. Example, {node firstpage}
  126.  
  127. ================================================================================ 
  128. FullDoc 
  129.  
  130. This command tells !HyperHelp to override the settings of the program concerning whether or not the document is to be displayed as pages or in full document mode.
  131.  
  132. Example, {fulldoc}
  133.  
  134. ================================================================================ 
  135. Pages 
  136.  
  137. This command tells !HyperHelp to override the settings of the program concerning whether or not the document is to be displayed as pages or in full document mode.
  138.  
  139. Example, {Pages}
  140.  
  141. ================================================================================ 
  142.  
  143.  
  144. Have a look in the example files if any of the above is unclear.
  145.  
  146.  
  147. Conditions of use:                 
  148. °°°°°°°°°°°°°°°°°°
  149. This application is ** FREEWARE ** and may be distributed freely.  NO part of the program code and assoicated files may be used in your own programs.  You must not tamper or alter any of the program code.
  150.  
  151. If you do use this program some credit would be nice...
  152.  
  153. I (Chris Wymark) retain the copyright at all times.
  154.  
  155. No files may be added to the directory EXCEPT any !HyperHelp files and there associated sprite files.
  156.  
  157. The copyright remains mine at all times.
  158.  
  159.  
  160. Disclaimer
  161. °°°°°°°°°°
  162.  
  163. I cannot be held responsible for any loss of data due to the use or misuse of this program.  !HyperHelp is used entirely at your own risk.
  164.  
  165. Limitations:
  166. °°°°°°°°°°°°
  167.  
  168. !Hyperhelp does not like small documents or documents with fewer then 3 nodes.  And that is about it!
  169.  
  170.  
  171. Other programs written by the same author:
  172. °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
  173.  
  174. !Tricky    -    A highly original maze game, involves a shifting maze and VERY good computer A.I. players (in fact so good, that Owain had problems beating it (Owain is very inteligant)), four player, RISC PC compatiable, Enhanced VGA mode, lots of sampled sounds, 100K of music...Shareware
  175.  
  176. !AVSChars  -    A replacement for Acorns awful !Chars applications, properly handles ALL fonts (including OpusII), and other features such as zooming into fonts etc...Freeware
  177.  
  178. !HyperHelp -    This is a Hyper text viewer and creation system, it supports many commands in it's script language.  It supports the use of outline fonts and sprites in documents.Freeware
  179.  
  180. VOTI Bin  -    This Automatic trash can allows you to delete files and directories but keeps a copy in an archive. Automatically clears archives after a user definable delay. It has the following features:               
  181.                  • Disallow files to be deleted.
  182.                  • Full archive search facility.                
  183.                  • Password protection to disallow option changes.
  184.                  • Module cannot be killed (unless you want it to). Stops
  185.                    RMClears from removing the module.
  186.                  • Helpful wimp front end.
  187.                  • Functions outside of the desktop.
  188.                  • Integrates seamlesly with the Filer.
  189.                  • Squash's trashed files.
  190.                  • And numerous other options...
  191.                  
  192. !HedgeHog  -    Game published by ArcWorld,
  193.  
  194. !Frosty    -    Another game published by ArcWorld,
  195.  
  196. !AVSDelta  -    Animation compression system, supports background masking, logicical plotting modes, 'on the fly' decompression of animations, supporting for manipulation of animations whilst being plotted, very high compression ratio and many other features. Shareware
  197.  
  198. !AVSSquash -    Another compression program, uses the packing algorithm. Freeware
  199.  
  200. !Grab      -    Allows the user to save screens by pressing a key combination, useful for grabbing game screens. Freeware
  201.  
  202. CSDPrompt  -    Displays the currently selected directory on the * prompt (like DOS does). Freeware
  203.  
  204. XModule    -    Allows execution of * commands without errors being reported (useful for command scripts). Freeware
  205.  
  206. DTWelcome  -    Allows the user to replace the desktop welcome banner with a sprite of their choice. Freeware
  207.  
  208. There's more but this !Help files is getting to large, so write for the catalouge if you want to see the entire range of VOTI software.  Please note that all Shareware software costs £5.00.  Freeware software is free (funnily enough :-) ) although you must a £1.00 per disc, for the postage and packing... 
  209.  
  210.  
  211. Hi's to...
  212. °°°°°°°°°°
  213.  
  214. Owain Cole, currently the other half of VOTI and good friend (drinking companion) of mine...
  215.  
  216. Catherine, Rachel, Lora, Sarah G., Diana, Greg, Jon, Ray, Rhys, Parry, Tom, Rob, Waton, Bert, Boff, Johny and everybody else who I can't be arsed to write down...
  217.  
  218.  
  219. Visions of the Impossible:
  220. °°°°°°°°°°°°°°°°°°°°°°°°°°                     
  221.  
  222. VOTI is always looking for people with no programming, music or graphical skills so we can take the mick out of them. However, if you can stick a few LDMIA's together, drum up a decent beat on DSYM, or wield your mouse as though the very ghost of (some Italian painter) had possesed your body, then drop us a line at the below address. (Or if you can program, write music, or draw.)
  223.  
  224. Owain Cole,                        Chris Wymark,
  225. VOTI,                              VOTI,
  226. Shieling,                          Hinakura,
  227. Fleet Lane,                        Greyfield Road,
  228. Twyning,                           High Littleton,
  229. Gloucestershire.                   Bristol.
  230. GL20 6DG                           BS18 5XX
  231. tel-01684 294325                   tel-01761 470601
  232.  
  233. We also have our own World Wide Web site:
  234.  
  235. http:\\www.aston.ac.uk\~preecedj\voti.html
  236.  
  237. Most of our software is available from this web site! (Or will be anyway...)
  238.  
  239. If you've got an amazing idea for a game or util that U'd like to see made, then drop us a line too giving vivid details, and we'll steal your idea! (Ok, we won't but if it's any good, we'll consider writting it.)
  240.  
  241. Oh yeah, if you do write, then don't expect a reply too quick 'cos both me an Owain are slackers and so we need to take time to relax before lifting up the keyboard again to type out a couple of lines. If you want any software, or anything to be returned then send a disc for us to reply on too. Please format it to the required format first ie ADFS800K or 1.6Mg, and use a suitable label for the name cos otherwise it'll get lost.
  242.  
  243. I have a 13Mb, RiscPC 610, so if you want anything tested on a nice high powered machine then send it along with a fiver, or something, and I'll test it for you
  244.  
  245.  
  246. Look out for my next game, and others bits of software....
  247.  
  248.  
  249.  
  250. Chris Wymark