home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 1 / ARM_CLUB_CD.iso / contents / apps / program / a / amfhelp / !AMFHelp / !Help < prev    next >
Encoding:
Text File  |  1992-06-23  |  6.0 KB  |  121 lines
  1. !AMFHelp  1.00 (23-Jun-92)
  2. ==========================
  3. Interactive Text Viewer
  4. =======================
  5. AMFHelp is a program that will allow the display and use of specially
  6. designed "interactive" text files. Such files are displayed in normal read
  7. only windows, but contain special highlighted words, that when clicked on,
  8. will open another window, containing more information, and possibly more
  9. highlighted words. It thus allows more understandable instructions to be
  10. written.
  11.  
  12. Use
  13. ===
  14. Before loading AMFHelp,it is necessary to have a specially created text file.
  15. Normally,these would be supplied,with AMFHelp,with the software that needed
  16. instructions,but should you be starting from scratch,such a file must be
  17. created.
  18.  
  19. An AMFHelp file is a specially formatted text file,having a filetype of AF7,
  20. consisting of a number of text articles,each of which has a special header,
  21. followed by a chunk of text.For example,a text article header could be as
  22. follows:
  23.  
  24. {identifier} Title
  25. Text
  26.  
  27. Within curly,"{" and "}",brackets,the word identifier should be replaced
  28. with a case sensitive article identifier,which is used to identify the text
  29. article,so that the correct article is opened when a highlighted word is
  30. selected.Title should be replaced with the title of the text article,which
  31. is placed with the title bar of the text articles window.Finally,Text should
  32. be replaced with a chunk of text,sometimes a few lines,sometimes many,
  33. depending on your requirements.
  34.  
  35. Dragging such a file into AMFHelp will merely open the first text article in
  36. a window,without any interaction,for no points of interaction have yet been
  37. defined.To do this,certain words in the AMFHelp file need to be highlighted.
  38. This is achieved by placing square,"[" and "]",brackets around the word or
  39. words to be highlighted within a text article,so that it appears red when
  40. AMFHelp is loaded.Should the word or words within the square brackets
  41. exactly match a text article identifier,when these words are selected,that
  42. text article will be opened.Be sure that the word or words are exactly (same
  43. case) as a text article identifier,and that within your text chunk,you do
  44. not use "{","}","[" or "]" except to show highlighted words and new text
  45. articles.Once all the required words have been highlighted,you can drag the
  46. file into AMFHelp,and interaction may take place.
  47.  
  48. Selecting a highlighted red word will,if a text article is defined for it,
  49. open that text article in a separate window.If select is used to select the
  50. word,the original window will remain open,behind the new window,otherwise,if
  51. adjust is used,the original window will be closed.Pressing menu on any text
  52. article will allow you to view information about the AMFHelp system,and to
  53. close all the windows open using AMFHelp.Clicking on the main AMFHelp icon
  54. will reopen the first text article in the currently loaded AMFHelp file.
  55.  
  56. Pressing menu on the AMFHelp icon on the icon bar will allow the Preferences
  57. option to be selected.From the Preferences window,it is possible to define a
  58. file that AMFHelp will automatically load when AMFHelp is loaded,making
  59. AMFHelp particularly useful for displaying interactive instructions.By
  60. renaming AMFHelp as Help,and redefining the !Sprites file using Paint,it is
  61. possible to store AMFHelp within another application,so that by selecting
  62. the Help option from that applications filer menu,AMFHelp will be
  63. automatically loaded,together with the predefined file,so long as the
  64. preferences have been saved with the relevant icon.It is usually wise to use
  65. a relative filename,for example <AMFHelp$Dir>.HelpFile to refer to files
  66. stored within AMFHelp,as this facilitiates easy copying from filing system
  67. to filing system.
  68.  
  69. Distribution
  70. ============
  71. Should you wish to use AMFHelp within your own software,as described above,
  72. to display instructions interactively,and you wish to distribute that
  73. software as Public Domain,write to the author of AMFHelp,describing why you
  74. wish to use AMFHelp,supplying a copy of the software you wish to use AMFHelp
  75. in,and a contribution of £25 towards the upkeep of the monastery.Should your
  76. request be accepted,you will receive your own distribution copy of AMFHelp,
  77. which you can legally distribute as part of your own software,subject to the
  78. terms of license.Action will be taken against those who illegally distribute
  79. AMFHelp,so should you wish to use it,register now.
  80.  
  81. Versions
  82. ========
  83. 1.00 Original version.
  84.  
  85. Source
  86. ======
  87. This version of AMFHelp was originally supplied as part of a software
  88. package,namely the AMF the Doomwatcher Collection Part II.It should not be
  89. distributed separately from this package,although it may be separated for
  90. the personal use of the owner,so long as it is not passed on to others in
  91. this form,unless this copy of AMFHelp is distributed as an officially
  92. licensed Help program for an application (above).
  93.  
  94. Copyright
  95. =========
  96. This version of AMFHelp is not Public Domain.It may be distributed as
  97. Public Domain only by those who are licensed so to do,with the terms of this
  98. license and the official distributor for this version to be found as part of
  99. the general information supplied with this software collection.No part of
  100. this software may be used in any other program,whether commercial or public
  101. domain,without my prior written consent,though any files created by this
  102. software are not bound by this condition.This software may not be
  103. distributed for a profit,save that required to cover packaging and media
  104. costs,nor may it be distributed by an unlicensed person or company.Copyright
  105. (©) is retained by the author,who may be contacted at the address beneath.No
  106. liability can be accepted by the author for any loss or damage arising from
  107. use or misuse of this software.
  108.  
  109. Addresses
  110. =========
  111. Should you wish to contact the author of this software,make any constructive
  112. comments or suggestions,report any errors or bugs,or make any donations (all
  113. cheques being made payable to A.M.Flintham),write to the address beneath:
  114.  
  115. AMF the Doomwatcher,
  116.   The Monastery of Doomwatcher Monks,
  117.     50 Burlington Way,
  118.       Mickleover,
  119.         Derby.
  120.           DE3 5BD
  121.