home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsf / hiper / ReadMe < prev   
Encoding:
Text File  |  1996-08-03  |  4.9 KB  |  135 lines
  1. !Hiper v1.15 readme file - 30/06/95
  2. ------------------------
  3.  
  4. Right - !Hiper does everything you could possibly want from a hypertext help
  5. system. It's small, fairly easy to 'program' and fast.
  6. You'll need the 'DrawFile' module from Acorn to go on - it was supplied
  7. with v0.02 of !Hiper and is available from numerous sources... including
  8. the Acorn User CD (which, in the event of dire need, can be just about
  9. read by a PC)
  10.  
  11. Main features:
  12.  
  13.  - Can display in any font (so long as it's outline...)
  14.  - Sprites, drawfiles, 'hotspot' files can be displayed 'inline' (as they
  15.    say on the World Wide Web) or on the page (as mere mortals call 'em ;-)
  16.  - _Understandable_ source file format (none of this structuring as wot
  17.    appears in HTML and confuses everybody, and none of this hidden text and
  18.    footnotes wot appears in some other little-known help file source format)
  19.  - help files can be read from file in either 'cache' mode or 'minimum
  20.    memory' mode
  21.  - fairly obviously hyper-text links (in a pretty green colour (usually) )
  22.    to other parts of the file or to *-commands
  23.  - a pretty hand that shows you when you can click on something
  24.  - Compact help file format
  25.  - can print files
  26.  - 'history' lists and a back button
  27.  - numerous text formatting options
  28.  - context-sensitive stuff...
  29.  - messages allowing 'Hiper-text doors' - adding extra flexibility to where
  30.    pages come from.
  31.  - context sensitive help (run !DoorTest for information)
  32.  - kitchen sink :-)
  33.  
  34. The future
  35. ----------
  36.  
  37. If you like this program (or intend to use it with your own program), tell
  38. me - enough support will persuade me to register the filetype with Acorn.
  39. (Lots of support will give some momentum to my request - filetypes are
  40. getting as rare as gold dust in intergalactic space...)
  41.  
  42. The filetype that this uses (&0AA) is one of the 'user' filetypes allocated
  43. by Acorn, and as such may conflict with other programs.
  44.  
  45. The source code
  46. ---------------
  47.  
  48. Stuff that you may find interesting in the source code (in case you want
  49. to alter it :-/):
  50.  
  51. DEFPROCassm - various bits of machine code assembled here!
  52. DEFPROCinit - umm...
  53. DEFPROCreadhelpfile(fn$) - loads the given help file (duly checking for
  54. format, etc)
  55. DEFPROCloadsubj(subj%) - (probably the most useful...) - loads the given
  56. subject number
  57. DEFPROCsetuplines(addr%,subj%) - formats the text found at addr% (with
  58. subject number subj%).
  59. DEFPROCgraphic - deals with inline graphics
  60.  
  61. There are other procedures, but now you know what these do, you can work
  62. 'em out for yerself ;-)
  63.  
  64. Notes
  65. -----
  66.  
  67. The maximum number of 'lines' currently available is 1000. This can be
  68. changed by editing the !RunImage file. A new 'line' is added whenever there
  69. is a change of status (x positioning, colouring, link, etc).
  70. If this limit is exceeded, you will get an error 'Help page too big'.
  71.  
  72. Zap
  73. ---
  74.  
  75. Does anyone know what has happened to the author of my favorite text editor,
  76. Dominic Symes... I'd like to get into contact with him about the hyper-text
  77. version of the !Help file supplied with said editor (he was very unsure about
  78. where he could be contacted after July so I'd like to know if his E-mail
  79. address, etc are still the same (I Msy br a ritten toper)
  80.  
  81. Contacting me
  82. -------------
  83.  
  84. E-mail: Arcade as 'ahunter' (it's a bulletin board...)
  85.         The internet... Ahunter@spuddy.mew.co.uk
  86.  
  87. Snail-mail:
  88.  
  89. Andrew Hunter
  90. 18 Warren Close
  91. Elmswell
  92. Bury St. Edmunds
  93. Suffolk
  94. IP30 9DS
  95.  
  96. Disclaimer
  97. ----------
  98.  
  99. I cannot accept responsibility for any damage or loss caused by your use
  100. (or inability to use) this program. (By the way any means ANY - if this
  101. program killed your pet cat, your business or yourself... I cannot take
  102. responsibilty - it's free software)
  103.  
  104. Distibution
  105. -----------
  106.  
  107. This program is FREEWARE - it is still copyright me (that is, Andrew Hunter).
  108.  
  109. You may freely distribute this program so long as all files are left intact
  110. and a reasonable charge is made for materials used in its distribution. If
  111. used as part of a larger software product, then you may not either say or
  112. imply that this program was written by you.
  113.  
  114. If you wish to distribute this as part of your own project, you must fully
  115. credit me (Andrew Hunter) as the author of this and say where you obtained
  116. this program. 
  117.  
  118. 'All files left intact' means either the original archive, or just the !Hiper
  119. application. (I.e. you can seperate the !Hiper application and distribute it
  120. with your own programs - but not alter any of the files in there - including
  121. the !Run file).
  122.  
  123. I cannot take responsibility for any damage (direct or indirect) caused by
  124. the use or misuse of this program.
  125.  
  126. Credits
  127. -------
  128.  
  129. Thanks have to go to Chris Claydon of ARMed Forces for the revamped user
  130. interface (it's based around his design), and for using it as part of his
  131. ARMed Forces BBS (that's on 01962 880003 - RSDFS). It seems to be pretty much
  132. unique in the comms world (how many other BBS's do you know with a 'proper'
  133. hiper-text interface). If you don't already have the requisite software, then
  134. use a standard ANSI/ZModem comms package to download the various bits.
  135.