home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 5 / RISCWORLD_VOL5.iso / SOFTWARE / Issue6 / FontFX / !Patterns / Files / !Manual / MManual < prev    next >
Encoding:
Text File  |  1990-12-29  |  3.0 KB  |  89 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. To display help via the Filer, you do the
  19. following: click MENU whilst pointing at an
  20. application, then slide across the 'App' option in
  21. the menu, and then click SELECT on then 'Help'
  22. option in that menu.
  23.  
  24. To display help from a running Data Store
  25. application, bring up its main menu, and slide
  26. across the first option which is Info. The Info
  27. box will appear which has the icon 'On-line
  28. Manual' at the bottom. Click on this icon to bring
  29. up the manual.
  30.  
  31. Scrolling the manual
  32. --------------------
  33. You can scroll up and down the text using the
  34. scroll bars of the window or by using the cursor
  35. keys/Page Up and Page Down keys on the keyboard.
  36.  
  37. The Find facility
  38. -----------------
  39. Clicking MENU over the text will bring up
  40. Manual's menu. This contains the option
  41. 'Find...'. You can search for any string of three
  42. or more characters by clicking on this to open a
  43. dialogue box in which you enter your search string
  44. and then press RETURN or click on OK. After a
  45. brief pause the dialogue box will be updated
  46. to show how many matches were found. The first
  47. match is highlighted and displayed in the middle
  48. of the window. You can scroll the window if you
  49. wish to see more of the context. Clicking on 'Next
  50. Match' will scroll the window automatically to
  51. display the next match. Similarly, should you be
  52. viewing the second or later match, you can scroll
  53. backwards by clicking on 'Previous Match'.
  54.  
  55. The Print Facility
  56. ------------------
  57. Clicking on 'Print' in the Manual menu will output
  58. the text to your printer, so long as the
  59. appropriate RISC OS Printer Driver is running. If
  60. this is not the case, an error message will
  61. appear.
  62.  
  63. Using Manual in your own Applications
  64. ------------------------------------- 
  65. To do this, just copy !Manual into the
  66. Application, and include within !Manual the
  67. textfile you want displayed as a file called
  68. 'Manual'. The only limitations on the content of
  69. the file are that (a) it must end in a carriage
  70. return and (b) whatever is on the first line is
  71. displayed in the title bar of the window after the
  72. string 'On-line Manual for...', so it is best to
  73. restrict the first line to the name of the
  74. application.
  75.  
  76. You should also create an obey file within your
  77. application called '!Help', which should contain
  78. just one line:
  79.  
  80. RUN <obey$dir>.!Manual
  81.  
  82. This is so that the Filer help facility operates
  83. correctly. You can of course be as creative as you
  84. like in deciding how to access the on-line manual
  85. within your own application: just because we at
  86. The Data Store do it by including an icon in the
  87. Info box doesn't mean you have to do it the same
  88. way.
  89.