home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / t / term93 / Term93 / !Term93 / !Manual / MManual < prev    next >
Encoding:
Text File  |  1994-05-07  |  3.2 KB  |  92 lines
  1. Manual
  2. ------
  3. © Data Store 1990
  4.  
  5. Manual is a compact textfile display utility with
  6. search and print facilities: in other words it is
  7. ideal for displaying help files for applications
  8. in a smaller amount of memory than Edit would use,
  9. and whilst allowing the user to find references in
  10. the text, does not risk corruption of the text
  11. because it is a 'read only' system.
  12.  
  13. This program is contained within most Data Store
  14. utilities and is accessed in two ways: either via
  15. the Filer help facility or within the program
  16. itself from an icon in its Info box.
  17.  
  18. Filer help is obtained by selecting the
  19. application in its directory viewer, then clicking
  20. the MENU button on the mouse. Slide across the
  21. second option ('App !xxxxx ⇨') and then select
  22. 'Help' from the submenu.        
  23.  
  24. To get the on-line manual from a running Data
  25. Store application, bring up its main menu and
  26. slide across the first option ('Info ⇨') - an
  27. 'Info box' will appear, giving the name and
  28. purpose of the application, a copyright message
  29. and the date and version number. At the bottom is
  30. an icon marked 'On-line manual': if you click on
  31. this icon, the on-line manual will appear.
  32.  
  33. Scrolling the manual
  34. --------------------
  35. You can scroll up and down the text using the
  36. mouse and scroll bars of the window, or by using
  37. the cursor keys and Page Up/Page Down keys
  38. on the keyboard.
  39.  
  40. The Find facility
  41. -----------------
  42. Clicking MENU over the text will bring up
  43. Manual's menu. This contains the option
  44. 'Find...'. You can search for any string of three
  45. or more characters by clicking on this to open a
  46. dialogue box in which you enter your search string
  47. and then press RETURN or click on OK. After a
  48. brief pause the dialogue box will be updated
  49. to show how many matches were found. The first
  50. match is highlighted and displayed in the middle
  51. of the window. You can scroll the window if you
  52. wish to see more of the context. Clicking on 'Next
  53. Match' will scroll the window automatically to
  54. display the next match. Similarly, should you be
  55. viewing the second or later match, you can scroll
  56. backwards by clicking on 'Previous Match'.
  57.  
  58. The Print Facility
  59. ------------------
  60. Clicking on 'Print' in the Manual menu will output
  61. the text to your printer, so long as the
  62. appropriate RISC OS Printer Driver is running. If
  63. this is not the case, an error message will
  64. appear.
  65.  
  66. Using Manual in your own Applications
  67. ------------------------------------- 
  68. To do this, just copy !Manual into the
  69. Application, and include within !Manual the
  70. textfile you want displayed as a file called
  71. 'Manual'. The only limitations on the content of
  72. the file are that (a) it must end in a carriage
  73. return and (b) whatever is on the first line is
  74. displayed in the title bar of the window after the
  75. string 'On-line Manual for...', so it is best to
  76. restrict the first line to the name of the
  77. application.
  78.  
  79. You should also create an obey file within your
  80. application called '!Help', which should contain
  81. just one line:
  82.  
  83. RUN <obey$dir>.!Manual
  84.  
  85. This is so that the Filer help facility operates
  86. correctly. You can of course be as creative as you
  87. like in deciding how to access the on-line manual
  88. within your own application: just because we at
  89. The Data Store do it by including an icon in the
  90. Info box doesn't mean you have to do it the same
  91. way.
  92.