home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / pocketbk / developmen / helpkit1 / HELPKIT1.TXT < prev    next >
Text File  |  1994-12-17  |  3KB  |  96 lines
  1. Helpkit1.ZIP information
  2. ========================
  3.  
  4. Written by Jezar at Psion
  5.  
  6. You have a royalty free right to use
  7. and distribute this software in any
  8. way you see fit, provided that you
  9. agree that neither Psion nor Jezar will
  10. be held liable for the consequences of
  11. you doing so.
  12.  
  13. This kit is comprised of the following
  14. files:
  15.  
  16. Helpcomp.opl - The help compiler.
  17. Helpshow.opl - Example of using help.
  18. Helpxmpl.hlp - Sample help source.
  19. Helptext.txt - This file.
  20. Help.als     - Just a word alias.
  21.  
  22. The help compiler will run on a Series
  23. 3 and a Series 3a. However, at present
  24. you can only use the inbuilt help
  25. system on a 3a. I may write some code
  26. to use the inbuilt help on the Series
  27. 3 Classic if time permits. Until then,
  28. please DO NOT attempt to modify 
  29. Helpshow.opl to run on the Classic, as
  30. the program will abort immediately
  31. with exit code 48
  32.  
  33. History
  34. =======
  35. A brief investigation of the internals
  36. of the Series 3a code revealed that a
  37. mechanism for using the inbuilt help
  38. system was already in place. All that
  39. was required was for someone to
  40. document it. So here we go...
  41.  
  42. You only need to do two things:
  43. 1) Set the help filename
  44. 2) Start the help, with the help topic
  45.    resource number, and the number of
  46.    the initial help screen to show.
  47.    
  48. Obviously, from the above description
  49. you can see that you can perform 
  50. context-sensitive help, by choosing
  51. which help page to show initially.
  52.  
  53. Interestingly, there is NO NEED to use
  54. LOCK ON and LOCK OFF while calling the
  55. inbuilt help system, as it does it for
  56. you automatically.
  57.  
  58. The help compiler
  59. =================
  60. This takes a plain text file, and 
  61. compiles it into a genuine Psion ".rsc"
  62. file. The resource file writer engine
  63. is designed to be re-usable and can
  64. write any type of resource to a file.
  65.  
  66. The source file format used, is the
  67. Tom Dolbilin standard. This was chosen
  68. partly because it is a nice, easy to
  69. understand format, and also because
  70. there may be many people already using
  71. this standard. The format should be
  72. clear from the sample one supplied, but
  73. basically:
  74.     1) The first line is the help title
  75.     2) The second line (optional) is the
  76.        path and/or filename of the
  77.        compiled help.
  78.     3) Then topics and text are listed,
  79.        bracketed by #begin/#end keywords.
  80.     4) A hash (#) followed by THREE
  81.        digits becomes a single character.
  82.  
  83. Note that if you prefer PC development,
  84. you can use the Psion resource
  85. compiler on a normal .rss file, and
  86. use the constants generated to launch
  87. the help system.
  88.  
  89. I hope you find this code useful.
  90.  
  91. Best wishes,
  92. jezar@cix.compulink.co.uk
  93.  
  94. End of file - Helpkit1.txt
  95.  
  96.