home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / z / zapconfig / !ZapConfig / !Help < prev    next >
Text File  |  1996-12-18  |  40KB  |  793 lines
  1. > !ZapConfig
  2. > Allow configuration of Zap (by Dominic Symes)
  3. > © Copyright James Aylett 1996
  4. > Version 1.21
  5.  
  6. Copyright
  7. ---------
  8.  
  9. ZapConfig is copyright (c) James Aylett. It may not be distributed without
  10. the express and written permission of the author, except that it may be
  11. distributed along with Zap under the distribution conditions as laid down by
  12. Dominic in the standard (public release) Zap distribution. Zap is copyright
  13. (c) Dominic Symes. Any such distribution must contain the entire contents of
  14. the !ZapConfig directory, unaltered in any way.
  15. ZapSetup is copyright (c) Matthew Wilcox.
  16.  
  17. ZapConfig version 1.21 requires Zap version 1.30 or later, and RiscOS 3.10 or
  18. later, to run. It has been tested up to Zap 1.35, and should work with
  19. subsequent versions, barring major changes to the format of the configuration
  20. files.
  21.  
  22. ZapConfig was written using DeskLib, the FreeWare C library for RiscOS.
  23.  
  24. ###  READ THE DISCLAIMER (NEAR THE BOTTOM) BEFORE IT'S TOO LATE  ###
  25. ### I cannot be held responsible for any loss of your nice setup ###
  26. ###     It's also a good idea to read the known bugs section     ###
  27.  
  28. Introduction
  29. ------------
  30.  
  31. Zap is very flexible. In many ways too flexible. Too big, too far, too deep,
  32. and much too flexible. More than seventeen¹ innocent users have been put off
  33. by the automatic comment from experienced Zappers, 'Oh, just reconfigure it
  34. if you don't like that'. The next question in the conversation is always
  35. 'How?'. Up till now everyone has had to either hack their way through Zap's
  36. Keys file, and use the Options menu, or swap to an alternative base set by
  37. using ZapSetup. This is still far too complex, and so ZapConfig was finally
  38. started properly.
  39.  
  40. ¹ This may be wrong.
  41.  
  42. Use
  43. ---
  44.  
  45. Note that I've assumed throughout here that you are familiar with RiscOS and
  46. the way RiscOS programs work. I mean, you're trying to configure _Zap_,
  47. aren't you? :-)
  48.  
  49. One thing before you start: Zap can cope with no !Config file in its main
  50. directory, but ZapConfig can't currently, so before you run ZapConfig (which
  51. will give an error but _not_ leave gracefully - and it will be left
  52. containing whatever data was in memory, so saving could result in very nasty
  53. things happening), save Zap's !Config file by clicking Menu on Zap's iconbar
  54. icon, moving right from Options and selecting Save options (at the top). This
  55. will keep ZapConfig happy. Note that you must not distribute Zap in this
  56. state; when you distribute Zap you must do it with no !Config file in Zap's
  57. main directory, and with the Standard options set selected.
  58.  
  59. Loading ZapConfig in the usual way, you click on the iconbar icon to get the
  60. main configuration window. This actually contains very little by way of
  61. configuration, but presents a pair of sections. The top bit contains ten
  62. icons, and allows you access to the actual configuration. Go ahead, click on
  63. them.
  64.  
  65. The bottom part of the window allows you to specify which configuration set
  66. and which template set Zap uses. The configuration set shown is also the one
  67. you're currently editing using ZapConfig. This uses the configuration sets as
  68. supplied with Zap 1.30 or later, in the style of ZapSetup. Click on the menu
  69. icon (at the far right) to get a list; Standard refers to the standard set
  70. inside the main directory; these are the ones that _must_not_be_altered_ in
  71. copies of Zap you pass on to other people. Down from that will be a list
  72. containing, most likely: Default, MJEbourne, MRWilcox and Salt. The last
  73. three are written by 3rd party authors (Martin Ebourne has written various
  74. add-on modes to Zap, Matthew Wilcox wrote ZapSetup, and Darren Salt wrote a
  75. module adding various commands to Zap). The Default one is not to be confused
  76. with Standard; Default is the best one to edit for your own use.
  77.  
  78. It is also possible to create new sets, using the item at the bottom of the
  79. menu and typing in the name you want.
  80.  
  81. Note: if a particular file (Keys, !Config, whatever) doesn't already exist
  82. inside the option set you select then the file loaded for editing will be
  83. from the Standard set supplied inside Zap. However when you save your
  84. changes, these will be saved as part of the option set.
  85.  
  86. You can change between template sets in the same way, except that you can't
  87. create new ones. ZapConfig will list all template sets available (in
  88. <Zap$Dir>.Templates), up to a maximum of 12. Currently nine template sets are
  89. distributed with Zap (but you probably want to get rid of mine because it's
  90. horrible :-).
  91.  
  92. To save the configuration and template sets shown - so that Zap will use them
  93. next time it starts up - click on the Save button at the bottom right of the
  94. window. Note that exiting ZapConfig without saving does not prompt for
  95. confirmation.
  96.  
  97. Configuration Part 1 - Key bindings
  98. -----------------------------------
  99.  
  100. It is advisable to read Sections A.1, A.2 of the Zap help file at this point,
  101. since they explain key bindings. However you may ignore the bits which talk
  102. specifically about the Keys file - just read the bits which explain how the
  103. command format for each key binding works, and what key bindings are in the
  104. first place.
  105.  
  106. Clicking on the 'Edit key bindings' button will open a dazzling window
  107. representing your keyboard. If you have a RiscPC then this window will be
  108. slightly different to if not, since the RPC uses a standard PC-style keyboard
  109. layout, whereas older machines use a modified keyboard.
  110.  
  111. The window is split in two; the top displays the current key binding you are
  112. editing, and the bottom displays the keyboard. Clicking on a 'key' on the
  113. keyboard will select that key as the one to edit. This is then displayed in
  114. the far left icon at the top. To the right of this are two option buttons,
  115. showing whether you are editing the shifted and/or control-modified version
  116. of the key (in that order - !FinalLook for RiscOS 3.1 will result in the
  117. shifted icon being somewhat obscure because the available fonts for RiscOS
  118. 3.1 don't contain a suitable shift character). At the far right is the actual
  119. action performed by this keypress; the command bound to the keypress.
  120. Clicking on the shifted and control-modified icons will toggle them on and
  121. off, and any alteration in the keypress being editing will be reflected in
  122. the action icon, which is editable to allow you to change it. Choosing
  123. another keypress _temporarily_ saves the key binding you have altered; the
  124. changes aren't saved until you close the window.
  125.  
  126. ZapConfig now deals with the full *&xxx command used in Zap's standard
  127. keybinding for the keypad numbers (it drops the key bindings through to
  128. keymap 0, with the base of the range starting at &xxx. Omitting the &xxx -
  129. having just the command '*' - drops through to keymap 0 with no renumbering,
  130. as used in the Emacs keymaps, 1).
  131.  
  132.  
  133. Note that the keys ',' '.' and '/', plus some others, don't actually do
  134. anything in Zap when used with control or shift and control. ZapConfig deals
  135. with this in a slightly upsetting way due to the way it's coded; the control
  136. switch has no effect on these keys, so for instance it treats shift+ctrl+'.'
  137. the same as shift+'.' = '>'.
  138.  
  139. Configuration Part 2 - Window Display
  140. -------------------------------------
  141.  
  142. Clicking on the 'Window display' button will open a window allowing you to
  143. set all sorts of groovy things associated with fine-tuning Zap's display. It
  144. is divided into three parts.
  145.  
  146. In the top left you can configure Zap's treatement of anti-aliased fonts
  147. (character reduction refers to how many pixels it strips off each character
  148. when displaying), and the default font and size to use.
  149.  
  150. In the bottom left you can configure Zap's default bitmap fonts, both the
  151. low-res and hi-res versions.
  152.  
  153. On the right you can set all sorts of things associated with Zap's window
  154. spacing. End of file zap is the number of lines Zap adds to the end of a
  155. window so that you're not typing right at the window extent. Cursor indent is
  156. how close you can get to the edge of a window before Zap will start scrolling
  157. it. Left margin doesn't work, but right margin does and is in OS coordinates.
  158. Auto-width gives the upper and lower bounds for the auto-width width (using
  159. the auto-width option :-). Margin is in characters.
  160.  
  161. Right down the bottom you can set Zap's default redraw s