home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine 1996 / ARCHIVE_96.iso / discs / mag_discs / volume_9 / issue_09 / wuerthner / !XChars / !Help next >
Text File  |  1996-01-22  |  14KB  |  277 lines
  1. XChars 1.04 (22-Jan-96)
  2.  
  3. Purpose:     Advanced chars utility
  4. Author:      Martin Wⁿrthner
  5. Runs under:  RISC OS 3.1 or higher
  6. Status:      FREEWARE (see below)
  7.  
  8. XChars is a replacement for the Chars utility that comes with RISC OS
  9. with a lot of additional features, such as:
  10. - multiple windows
  11. - outline fonts at arbitrary sizes
  12. - font aspect, line/character spacing control
  13. - different arrangements of characters (+optional display of ctrl chars)
  14. - configurable default settings
  15. - character zoom window at configurable size by clicking Adjust on a letter
  16.   (during the duration of the button press only or as a persistent window)
  17. - configurable character insertion hot key: Shift, Ctrl or Alt (both keys
  18.   or only left/only right key)
  19. - option to install an application icon on the icon bar
  20. - all options can be set independently in each window
  21. - "hotlist": the state of all options (font,font size,line spacing etc.) of
  22.   a window can be saved (associating a name with it) and restored later
  23.   from the hotlist menu
  24. - automatic display of character code under the pointer
  25.  
  26.  
  27. ****************************************************************************
  28. *  Features added recently: (If you are new to XChars, skip this section)  *
  29. ****************************************************************************
  30.  
  31. New feature of version 1.04
  32. ---------------------------
  33. The Display options window offers a new option: "Display character code".
  34. This option can be switched on/off for each window individually. If it
  35. is on, the character code of the character under the pointer is displayed
  36. near the pointer in a small yellow box which also moves as you move the
  37. pointer. (see "The Display options window")
  38.  
  39. New feature of version 1.03
  40. ---------------------------
  41. Now works much better with dialogue boxes! (For details, see "History")
  42.  
  43. New features of version 1.02
  44. ----------------------------
  45. Clicking ADJUST on the XChars icon on the icon bar brings the most recently
  46. used character window to the top. Holding SHIFT down simultaneously brings
  47. all windows to the top (see "The XChars icon").
  48. For some fonts, it is helpful to see the click-sensitive zone of each
  49. character. The arrangement submenu offers the new option "Show grid" with a
  50. submenu to choose the grid colour from (see "Character grid").
  51.  
  52.  
  53. *******************
  54. *  XChars manual  *
  55. *******************
  56.  
  57. Starting XChars
  58. ---------------
  59. Double-click on the !XChars application to load it. Depending on the
  60. Startup options which have been set up, the application installs an
  61. icon on the icon bar and/or opens a character display window.
  62.  
  63. The XChars window
  64. -----------------
  65. Each window shows the full character set in one font. If you click SELECT
  66. on a character, it is inserted at the caret position in the application
  67. which currently owns the input focus (the window with the cream title bar).
  68.   If you click ADJUST, the character is displayed in a bigger 'zoom' window
  69. (note that this only works with outline fonts, not with the System font!).
  70. Depending on the 'Persistent zoom window' option in the Choices window (see
  71. below under "Choices window"), the zoom window disappears automatically as
  72. soon as you release the ADJUST button or it remains on screen (in the latter
  73. case it is called persistent). The persistent zoom window has a close icon,
  74. so you can close it just as any other window. To reopen it, simply click
  75. ADJUST again in any XChars window.
  76.   The font size to be used in the zoom window can be changed in the Display
  77. options window (see below).
  78.   When trying to enter text in a writable menu field or a transient
  79. dialogue box, the SELECT click method cannot be used, because this would
  80. cause the destination window to disappear. To overcome this problem, you
  81. can also insert a character by placing the pointer over it and pressing
  82. the character insertion hotkey (e.g. Ctrl). The hotkey to be used can be
  83. configured in the Choices window (see below, "The Choices window").
  84.  
  85. Changing the font, font size etc.
  86. ---------------------------------
  87. The toolbar (at the top of each character window) shows the current font
  88. and the font size. The font can be changed by clicking on the pop-up menu
  89. button next to the font name and choosing a font from the menu.
  90.   If the current font is an outline font (i.e. not the System font), then 
  91. The size can be changed by using the up/down arrows or entering a number
  92. in the input field. The change only takes effect if you click on the OK
  93. button. A quicker way of changing the font size is to choose a size from
  94. the font size menu which appears if you click on the pop-up menu button
  95. next to the font size input field. This changes the font size immediately.
  96.   The arrangement of the characters can be changed from the window's menu:
  97. You can choose between 32 by 8,16 by 16 and 8 by 32. Also, if you select
  98. the option 'Show ctrl', then the window shows the control characters at
  99. the top row as inverted letters. So, e.g. to enter Ctrl-C, click SELECT
  100. on the inverted letter 'C'. Ticking 'Show grid' shows the character grid
  101. (see below, "Character grid").
  102.   More advanced options are found in the Display options window: Choose
  103. 'Display options' from the window's menu to open it:
  104.  
  105. The Display options window:
  106. ---------------------------
  107. In this window you can change the font aspect, the line and character
  108. spacing and zoom font size. The font aspect determines the width of the
  109. characters in relation to their height. Normally, characters are displayed
  110. at 100% which is the default. If the aspect ratio is smaller than 100%, the
  111. characters appear narrow, if it is greater than 100%, they are expanded.
  112.   The next two options, line spacing and char spacing can in most cases
  113. be left at their default values, i.e. at 100%. XChars automatically leaves
  114. enough room vertically to accomodate even the highest character of the font.
  115. Horizontally, it uses by default 80% of the widest character (i.e. this
  116. corresponds to char spacing 100%) which is enough in almost all cases as it
  117. is very inlikely that two very wide characters are next to each other.
  118.   However, if you want more (or less) space between the rows/columns, then
  119. you can increase (or decrease) the line/char spacing.
  120.   The last value is the font size to be used in the character zoom window
  121. (this is the window you call up by clicking ADJUST on a character). This is
  122. set for each window individually, so if you have a persistent zoom box (or
  123. if you press and hold Adjust) the size of the zoom window may change as you
  124. move from one window to another.
  125.   If you switch "Display character code" on, the character code of the
  126. character under the pointer is displayed near the pointer in a small yellow
  127. box which also moves as you move the pointer. This option can be switched
  128. on/off for each window individually. Probably not a feature you would want
  129. to switch on for every window, but it was added by popular demand, so at
  130. least some people will hopefully find this useful. What about adding a
  131. definition of a System font window with "Display character code" switched on
  132. to your hotlist? This way you have quick access to character codes in case
  133. you need them. If you should really want this feature for every window,
  134. simply modify your default setup.
  135.  
  136. Default settings
  137. ----------------
  138. The whole set of options can be saved as the default by choosing 'Save as
  139. default' from the window's menu. This means that any new window now has
  140. the properties of the current window, e.g. the font, font size etc.
  141.   This is saved to disc, so the next time you start the application it will
  142. still remember which default settings to use.
  143.  
  144. The hotlist
  145. -----------
  146. One of the most powerful features of XChar is the hotlist: You can add the
  147. complete state of a window including all options to the hotlist and give
  148. it a name. By choosing the entry from a menu later, you can recall the
  149. settings you associated with that name.
  150.   Supposed you use Dingbats quite often and you want it to be displayed at
  151. 24pt with a line spacing of 120%. Instead of setting all these options
  152. every time you want to view Dingbats, you can set them once and then add
  153. the current window state to the hotlist:  Click menu over the window and
  154. follow the submenu arrow of the entry "Add to hotlist". Then, type the name
  155. which you want to associate with these settings, e.g. "Dingbats" and click
  156. on OK.
  157.   To recall the settings later, click on the "A" icon to the left of the
  158. tool bar. This displays the hotlist. The first entry of the hotlist is
  159. always "Default". Choosing this restores the default settings. Below this
  160. entry, you can see all the additional entries. Choosing one of these
  161. restores the settings associated with the corresponding entry.
  162.   If you want to modify one of the entries, choose it, change the options,
  163. and then use "Add to hotlist" again without changing the name in the
  164. writable field. This overwrites the old definition with your modified one.
  165. A hotlist entry can be removed by choosing its name from the "Remove"
  166. sub-menu.
  167.   Like the default settings, the hotlist is immediately saved to disc
  168. every time you modify it.
  169.  
  170. The Choices window
  171. ------------------
  172. The Choices window is opened by choosing 'Choices...' from the icon bar menu.
  173. Obviously, this is only possible if there is an XChars icon on the icon bar.
  174. If there is not, the 'Choices...' entry is present in the main menu obtained
  175. by clicking Menu over any XChars window.
  176.   The Choices window allows you to configure some options which are global
  177. and do not belong to a particular window. These are the startup options,
  178. the character insertion hotkey and the zoom window behaviour:
  179.   When the application starts up it can either install an icon on the
  180. icon bar or open a window (or do both). Of course, doing neither of
  181. both is not sensible as in this case you could not access the application
  182. at all! This option only takes effect if you quit and re-load the
  183. application.
  184.   The character insertion hotkey can be either of Ctrl, Shift or Alt. As
  185. each of these keys appear twice on the keyboard, you can choose which one
  186. is to be used. If you want both keys to be active, select both option icons,
  187. 'Left key' and 'Right key'. By deselecting both option icons, the whole
  188. feature (character insertion by hotkey) can be disabled.
  189.   The last option in the Choices window determines whether the zoom window
  190. stays on the screen when you release the Adjust button of the mouse (this
  191. happens if the option 'Persistent zoom window' is switched on) or whether
  192. it is closed automatically (if the option is switched off).
  193.  
  194. Character grid
  195. --------------
  196. Some fonts have characters which behave odd in terms of positioning because
  197. they appear to the left or right of their bounding box. For example, this
  198. happens with the vowels of classical Hebrew fonts, e.g. HolyBible.HebClassic
  199. (by ExpLAN Computers) or Royal.BblcHbrw (by EFF) because the vowels have to
  200. appear underneath the preceding consonant.
  201.   The click-sensitive zone of each character is linked to a global bounding
  202. box, so clicking on one of these characters sometimes seems to insert the
  203. wrong one.
  204.   One thing which helps is to increase the character spacing (e.g. to 140%),
  205. but even then, you have to click exactly on the vowels or to the left of them.
  206. If you switch on the character grid (main menu 'Arrangement.Show Grid'), you
  207. see the click-sensitive zone of each character.
  208.   The submenu allows you to choose the grid colour.
  209.  
  210. The XChars icon on the icon bar
  211. -------------------------------
  212. Clicking SELECT on the XChars icon opens a new window with the current
  213. default settings.
  214. Clicking ADJUST on the XChars icon brings the most recently used window to
  215. the top. Pressing SHIFT at the same time brings all the windows to the top.
  216.  
  217. Quitting the application
  218. ------------------------
  219. You can quite XChars by choosing 'Quit' from the icon bar menu. If there is
  220. no XChars icon on the icon bar, the application quits as soon as you close
  221. all open windows.
  222.  
  223. Distributing this application to other people
  224. ---------------------------------------------
  225. You are allowed to give this application to anyone you want (terms and
  226. conditions, see below under "Copyright message").
  227.   After copying it, you should delete the files "Default" and "Hotlist"
  228. files inside the copied !XChars directory. Otherwise, the default settings
  229. or the entries in the hotlist may contain names of fonts which are not
  230. present on the destination system leading to error messages.
  231.   Be careful not to delete anything else!
  232.  
  233. Credits
  234. -------
  235. Thanks to Neil Walker for his !ZoomChars application. I borrowed his idea
  236. of providing a zoom window, transient or persistent.
  237.  
  238. History
  239. -------
  240. 1.00 (24-Nov-95):
  241.   - first version sent to Hensa and Stuttgart
  242. 1.01 (28-Nov-95):
  243.   - sensitive boxes around characters are now centred
  244. 1.02 (14-Dec-95):
  245.   - minimum window width can be smaller with System font as font size icons
  246.     in toolbar cannot be accessed anyway -> smaller window in System font mode
  247.   - added ADJUST and SHIFT-ADJUST click actions on icon bar icon
  248.   - added character grid option
  249. 1.03 (20-Jan-96):
  250.   - Why did not anybody tell me that this thing did not really work with dialogue
  251.     boxes (e.g. Zap and Impression)? Embarassing... Now uses Wimp_ProcessKey
  252.     instead of sending a KeyPressed message to the destination task. So simple...
  253. 1.04 (22-Jan-96):
  254.   - Because of popular demand: "Display character code" option added to display
  255.     the code of the character under the pointer
  256.  
  257. Copyright message
  258. -----------------
  259. This application, XChars, is ⌐ Martin Wⁿrthner, 1995 and is FREEWARE.
  260. This means that you may copy it freely provided that
  261. (a) all files of this application are distributed together without
  262.     modification (see above: "Distribution this application...")
  263. (b) this application is not sold for profit without my explicit written
  264.     permission (this includes distribution on CD)
  265.  
  266. You can contact me at:
  267.  
  268. Martin Wⁿrthner
  269. Jahnstra▀e 18
  270. 71116 GΣrtringen
  271. Germany
  272.  
  273. Phone: +49-7034-928986
  274. Fax:   +49-7034-928988
  275.  
  276. e-mail: wuerthne@trick.informatik.uni-stuttgart.de
  277.