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