home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / help / hiper_1 / ReadMe < prev    next >
Encoding:
Text File  |  1997-07-02  |  6.5 KB  |  173 lines
  1.  -------------                                                       ----------
  2.   Readme file                  Hiper Help 2.02                        FREEWARE
  3.  -------------                 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯                       ----------
  4.                               by Andrew Hunter
  5. ================================================================================
  6.  
  7. What is it then?
  8. ----------------
  9.  
  10. Hiper help is a hyper-text display system, designed for the creation of help
  11. files (but, no doubt, useful for other things, such as electronic books). It
  12. has a very flexible page layout system, a reasonable size, a small memory
  13. requirement and is (now) fast. The file type, message block, sprites, etc
  14. are all registered with Acorn.
  15.  
  16. The 'Help compiler' help file shows a few (but not all) of its capabilities -
  17. you should find that you can make a help file whose layout can be anything
  18. you want - you have full control of fonts, colour, positioning and underlining.
  19. In this version, there is no limit to the size of the page and (hopefully) no
  20. limit to the size of file the help compiler can deal with.
  21.  
  22. It has an Acorn allocated file type - &13a, and the message block and other
  23. resources are allocated too. (So, if there's a clash, it shouldn't be my
  24. fault)
  25.  
  26. How do I go about using it?
  27. ---------------------------
  28.  
  29. The actual source files themselves are text and usually look something like the
  30. following:
  31.  
  32. {FONTS Trinity.Medium 13 Trinity.Bold.Italic 13 Homerton.Bold 24}
  33. {ARTICLE Help on help}{TITLE Help on Help}
  34. {DRAWFILE 5}
  35.  
  36. {FONT 3}Help on Help{FONT 1}
  37. ...
  38.  
  39. To compile them, run !HC, drag the file in, and it works away, producing a
  40. save box at the end. Save the file out and double click on it to view it.
  41. (note that !HC needs a scrap directory to work properly)
  42.  
  43. I recommend that you get MultiUtils to use with Hiper - you can declutter your 
  44. desktop with Virtual, get icons from the Wimp sprite pool with CSD & utils, and
  45. the auto-arrange feature of !BD I find very useful for keeping files on the
  46. backdrop tidy.
  47.  
  48. [All the most recent versions of my programs are uploaded to Arcade]
  49.  
  50. Wahh! It doesn't work right. I'm going to sulk!
  51. -----------------------------------------------
  52.  
  53. Hmm. Why not write to me? I may be able to help...
  54. (In other words, if you find a bug, a feature or can't seem to get the thing
  55. working right, _write to me_ - muttering about it under your breath won't
  56. make it go away. I'll fix all bugs that are reported, and will probably
  57. implement any suggestions for improvements.)
  58.  
  59. My address
  60. ----------
  61.  
  62. No doubt there are tons of bugs in this version of Hiper help... if you find
  63. something that you think could be improved, write to me (note that psychic
  64. messages are unlikely to be recieved. Neither can I hear you muttering about
  65. bugs from a long distance. Using pen and paper [or email] is more likely to
  66. get a result :-)
  67.  
  68. E-mail: 'Ahunter' on Arcade (#1099)
  69.         'Ahunter@spuddy.mew.co.uk' for you people that use the Internet.
  70.  
  71. And for those that still use pen and paper (nerds: a pen is an ancient form
  72. of wordprocessor that is only compatible with the file format 'paper 1.0'.
  73. It has little bounds-checking, and so trying to use it on a modern computer
  74. is likely to result in ink on your screen).
  75.  
  76. Ahem. That bracket was so long you probably lost the thread, so here is my
  77. snail-mail address:
  78.  
  79.    Andrew Hunter,
  80.    18 Warren Close,
  81.    Elmswell,
  82.    Bury St. Edmunds,
  83.    Suffolk,
  84.    IP30 9DS
  85.    
  86. Hiper help vs Stronghelp
  87. ------------------------
  88.  
  89. OK, so I'm biased, having spent a couple of weeks rewriting the thing, and
  90. a year or two developing it before that.
  91.  
  92. Stronghelp is a much more widely used help system on Acorn computers than Hiper
  93. Help. It is about 20k larger than the new version, and about twice as large
  94. as previous versions (v0.xx and v1.xx).
  95.  
  96. Here is the situation as I see it:
  97.  
  98.   Stronghelp
  99.   ----------
  100.  
  101.     Advantages
  102.     ==========
  103.  
  104.     Very fast
  105.     'Filing system' approach allows easy editing of manuals
  106.     *Stronghelp command is very useful for looking up words moderately
  107.     quickly
  108.     Considerable flexibility in what is shown on page (lots of macro features)
  109.     Low memory consumption
  110.     Lots of help files in Stronghelp format
  111.  
  112.     Disadvantages
  113.     =============
  114.  
  115.     Poor message system makes context-sensitive help more difficult
  116.     *Stronghelp only really works well with StrongEd
  117.     No searching dialog box
  118.     User can be confused by menu for each page
  119.     No compression
  120.     Clutters up display with hundreds of windows after a while
  121.     Large pages don't look good
  122.     No history (other than right-click on close icon)
  123.   
  124.   Hiper Help
  125.   ----------
  126.   
  127.     Advantages
  128.     ==========
  129.     
  130.     Very user friendly interface
  131.     User can't accidently alter file
  132.     Compression
  133.     File can be loaded entirely into memory for extra speed
  134.     Help files can have multi-resolution sprites
  135.     Comprehensive message system
  136.     Fairly low memory consumption
  137.     History menu, back button.
  138.     Background sprites
  139.     
  140.     Disadvantages
  141.     =============
  142.     
  143.     Help source code can get somewhat confusing [not so much in this version...]
  144.     Compressed file format can be slow
  145.  
  146. If you think I should add anything, write to me... (It should be noted that
  147. I use my own compiler manual while writing Hiper files, and StrongHelp for
  148. the DeskLib manuals: I find StrongHelp's approach clutters my desktop very
  149. annoyingly [even in a 1024x768 mode] because I keep forgetting to use the
  150. right mouse button - the Hiper Help history menu is far more convienient)
  151.  
  152. I actually converted the StrongHelp Desklib manual to Hiper format... the
  153. converter isn't quite perfect yet, but the compiler and display system performed
  154. flawlessly (and v1.17 crashed in an interesting way when I loaded the 1Mb file
  155. into that by mistake :-)
  156.  
  157. Disclaimer
  158. ----------
  159.  
  160. Hiper Help is provided 'as is' - there is no warranty of any kind, express
  161. or implied. You use it at your own risk: should it cause, indirectly or
  162. directly, loss of any kind (data, money, livelihood, etc) it is your own
  163. fault for using the thing in the first place.
  164.  
  165. You may distribute Hiper Help, so long as you use the original archive, intact
  166. and unaltered, make sure that the author (Andrew Hunter) is fully credited and
  167. charge either nothing or a reasonable fee (say, no more than £3 to cover
  168. costs). Hiper Help is FreeWare, NOT public domain: it is © Andrew Hunter and
  169. you may not distribute parts of the package or altered versions of the package
  170. without written permission. An exception to this is the !Hiper program, which
  171. may be distributed separately, but MUST NOT be altered without permission.
  172.  
  173.