home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / t / tidydesk / !TidyDesk / !Help next >
Encoding:
Text File  |  1996-10-28  |  44.9 KB  |  941 lines

  1.   ________________________________________________________________________
  2.  /                                                                        \
  3. |                      TidyDesk v1.63: Desktop Manager                     |
  4. |                             October 1996                                 |
  5. |                            by Mike Curnow                                |
  6.  \________________________________________________________________________/ 
  7.  
  8. Quick Start
  9. ===========
  10. After double clicking on !Tidydesk two extra menu functions are available.
  11. Pressing ALT-Menu brings up a menu to control the current window, whilst
  12. CTRL-Menu provides control over all open windows. The CTRL-Menu is also
  13. available from the iconbar. The menu options provide the same action as the
  14. window control icons, even when the icons are obscured. Your desktop a mess?
  15. Select Tidy from the iconbar/CTRL-Menu to neatly arrange the windows.
  16.  
  17. On screen help is available from the iconbar/CTRL-Menu. Full interactive
  18. help is provided through the !Help application, including help on menu
  19. entries under RiscOS 3. Try this before delving further into this manual.
  20. However careful reading of this help file will reveal many useful features.
  21. Better still, print it out.
  22.  
  23. Full Details
  24. ============
  25. TidyDesk is designed to provide extra control over the desktop without
  26. affecting normal operation. Features are:
  27.  
  28. a) A menu to control the window under the pointer.
  29. b) A menu to control all open windows, allowing windows to be tidied etc.
  30. c) Keyboard control over window sizes, which window is topmost and window
  31. scrolling.
  32. d) Drag and resizing of windows from anywhere within the window, including
  33. dragging upwards and leftwards.
  34. e) Cut and paste of icon text, and a flashing caret with variable flash time.
  35. f) Customisable screen blanker.
  36. g) Task killing (for bugged applications).
  37. h) Long double click to open application directories and load files,
  38. including direct editing of BASIC programs.
  39. i) Mouse parking.
  40. j) Fully customisable keyboard short cut facility, giving quick entry of
  41. text, launching applications or issuing OS commands, via a simple ALT key
  42. combination.
  43. k) Run programs in a task window.
  44.  
  45. RiscOS Support:
  46. TidyDesk has been designed for optimum use under RiscOS 3.x. Some windows may
  47. not look so good on prior versions due to the usage of outline fonts and 3d
  48. icons. In RiscOS 3.1 and before most text in TidyDesk is displayed in the
  49. Homerton.Medium font rather than the coarse system font but users of low
  50. resolution monitors may want to turn this feature off - see the configuration
  51. section.
  52.  
  53. On RiscOS 3.5+ TidyDesk uses outline fonts if you configure your desktop to
  54. do so, otherwise it uses the system font. TidyDesk has been reported as
  55. working correctly under RiscOS 3.5+ including the StrongArm, but it has only
  56. been tested by the author on RiscOS 3.1.
  57.  
  58. ---------------------------------------------------------------------------
  59.  
  60. ALT-Menu
  61. --------
  62. Press ALT and Menu together whilst the pointer is over a window. A menu is
  63. opened showing the name of the window owner in the title. The menu controls
  64. the window under the pointer, the options being :
  65.  
  66. Wdw to Front: brings the window to the front. Same as clicking on the title bar.
  67. Wdw to Back  : puts the window to the back.
  68. Maximise Wdw : makes the window as large as possible.
  69. Minimise Wdw : makes the window as small as possible.
  70. Max. Width   : maximises the width of the window.
  71. Max. Height  : maximises the heigth of the window.
  72. Close Wdw    : closes the window.
  73. Iconise Wdw  : iconise the window.
  74. Pin Window   : closes the window and places it on the pinboard. The window
  75.              : title must specify a file or directory name.
  76. Quit Task    : shuts down the task owning the window.
  77.  
  78. Note: Maximise and Minimise only work on windows that are resizeable.
  79. Remember to release the Alt key BEFORE making a menu selection.
  80.  
  81. CTRL-Menu or Iconbar Menu
  82. -------------------------
  83. Press CTRL and menu together to open a menu providing control over all open
  84. windows. This menu is also available from iconbar when the 'I' start-up
  85. option is used by clicking menu over the icon. The menu selections are:
  86.  
  87. Windows: leads to a submenu showing all the open windows by task name and
  88. shortened version of the window title, in the order back-most to top-most
  89. window. The window owning the caret (if any) is ticked. For each window there
  90. is a further submenu which is exactly the same as the ALT-Menu described
  91. previously. Clicking on the window name brings the window to the top, so
  92. running down the window list, clicking as you go, cycles through all the
  93. windows.
  94.  
  95. Tidy All: tidies all the windows, in backmost to topmost order, so that you
  96. can see them all and also see the icon bar. Tidy->Stack (the default) stacks
  97. the windows on top of each other just showing their title bars, whilst
  98. Tidy->View arranges the windows across the desktop. Note that some windows
  99. can't be made the size required to fit neatly across the screen, so some
  100. overlap is inevitable. However you should get a reasonably clear picture of
  101. what is running and be able to select the window you want.
  102.         
  103. Tidy Filer: Like Tidy All but just for Filer windows. The submenu also allows
  104. you to close all Filer windows. Note: if you use Adjust with Close, then the
  105. parent directories will be opened, which is probably not what you wanted. 
  106.  
  107. Lose Caret: takes the caret away from the current input window. This menu
  108. entry will be shaded if no task owns the caret. Losing the caret is
  109. particulary useful to gain access to hot-key tasks (eg. Ctrl-key
  110. combinations) and the function keys which would otherwise be trapped by the
  111. current task. It is also useful to temporarily exit input mode sometimes to
  112. prevent unwanted keystrokes being inputted, especially when the input window
  113. is hidden. To restore the caret just click on the window where you wish to
  114. resume inputting.
  115.  
  116. Blank: when ticked shows that screen blanking is active. Clicking on Blank
  117. turns this feature on and off. The time before screen blanking defaults to 5
  118. minutes - see the configuration section to change this. The sub-menu options
  119. are:
  120.   Lissajous - draw a Lissajous figure on screen blank when ticked.
  121.             When off a user definable message is displayed.
  122.   Current x - the current x position for the Lissajous figure.
  123.   Current y - the current y position for the Lissajous figure.
  124. See the Blanking section for more details.
  125.  
  126. Edit Keys: See the section on ALT-keys for details.
  127. Help: Shows brief details on keyboard and mouse extensions. These key 
  128.       assignments assume the supplied keyboard mapping is being used.
  129. Quit: This terminates TidyDesk, should you want to.
  130.  
  131. ----------------------------------------------------------------------
  132.  
  133. Window Control Extensions
  134. -------------------------
  135. TidyDesk allows windows to be moved and resized without having to drag on
  136. the title bar or resize icon. This is achieved by holding down ALT plus
  137. SELECT or ADJUST and optionally the SHIFT key, when the pointer is over ANY
  138. part of a window. The pointer will change shape to show that the window can
  139. be moved or resized, at which point you may release the keys.
  140.  
  141. These extensions make it much easier to move and resize windows. Dragging is
  142. instant if you have set the instant WIMP drag via !Configure, otherwise a
  143. dashed outline will be drawn until you release the mouse. Note that if you
  144. drag a fixed tool box TidyDesk automatically moves its associated parent
  145. window as well.
  146.  
  147. ALT + SELECT or ADJUST : Allows dragging of the window. Select causes the
  148. window to be opened on top, Adjust maintains its stack order. Tip: use
  149. ALT+Select to bring a window to the front.
  150.  
  151. ALT+SHIFT+ADJUST : Resizes the window as if dragging on the resize icon.
  152.  
  153. ALT+SHIFT+SELECT : Resizes the window from the top left corner, allowing you
  154. to drag a window leftwards and upwards.
  155.  
  156. Note: When resizing windows which can be dragged off screen, you can keep
  157. dragging off screen too, unlike a standard resize. You can only resize
  158. windows which have a resize icon, but you can grab windows by their tool
  159. boxes (eg. !Draw's tool box).
  160.  
  161. Keyboard Functions And Shortcuts
  162. ================================
  163. The main functions of TidyDesk are available directly from the keyboard,
  164. which is useful whilst using editors for example. Some additional functions
  165. are also provided. The following Alt-Key combinations for window control are
  166. provided as standard, but may be customised (See the ALT-Key section). Note
  167. that 'current window' refers to the window in which the caret is in, or the
  168. one under the pointer if there is no caret (Use ALT-L to release the caret).
  169.  
  170. Alt-Home         : Performs a Tidy->Stack on the windows. Use the V start up
  171.                    option to set Tidy->View.
  172. Alt-Page Up      : Puts the current window to the back. The current window is
  173.                    the window owning the caret if any, else the one under the
  174.                    pointer.
  175. Alt-Page Down    : Puts the current window to the top. Tip: use Alt-Select
  176.                    to bring the window under the pointer to the front.
  177. Alt-Cursor Left  : Minimises the current window to the pointer location.
  178. Alt-Cursor Down  : Maximises the current window.
  179. Alt-Cursor Up    : Maximises the current window's height.
  180. Alt-Cursor Right : Maximises the current window's width.
  181. Alt-Delete       : Closes the current window.
  182. Alt-Tab          : Put topmost window to the back. Multiple tab presses thus
  183.                    cycle through all open windows.
  184. Alt-\            : Parks the pointer at the right, half way up the screen 
  185.                    (ie. over the scroll bar if window full size).
  186. Alt-I            : Iconise current window
  187. Alt-L            : Loses the caret.
  188. Alt-M            : Activates control of the mouse from the keyboard.
  189. Alt-P            : Close the window and pin file/directory onto pinboard.
  190. Alt-V            : Toggles the Pinboard backdrop to the front then back again.
  191. (See Pinboard)     When toggled to the front, double clicking on the backdrop or
  192.                    an icon placed on it causes the backdrop to be automatically
  193.                    placed at the back again. Also, pressing Shift-F12 to toggle
  194.                    the icon bar will also cause the backdrop to be sent to the
  195.                    back.
  196. ALT-F1 through F5: Changes the mouse speed setting 1-7, useful when using !Draw
  197.                    or !Paint.
  198. ALT-F6 to F12    : Set a screen mode. These are set to the one's I use.
  199.                    Customise to your requirements.
  200.  
  201. The following keys may be used instead of the scroll bars when no task is in
  202. input mode (use Lose Caret or ALT-L to get out of input mode). They scroll
  203. the window under the pointer. These keys can be useful in !Paint and !Draw
  204. for example.
  205.  
  206. Cursor Left  : same as clicking on scroll left icon
  207. Cursor Right : same as clicking on scroll right icon
  208. Cursor Down  : same as clicking on scroll down icon
  209. Cursor Up    : same as clicking on scroll up icon
  210. Shift Cursor Left  : pages left
  211. Shift Cursor Right : pages right
  212. Shift Cursor Down  : pages down
  213. Shift Cursor Up    : pages up
  214. Page Down          : pages down
  215. Page Up            : pages up
  216.  
  217. Keyboard Control of the Mouse
  218. -----------------------------
  219. This feature is activated by pressing Alt-M (this can be redefined). The colour
  220. of the pointer is inverted to show that keyboard control is in effect. Pressing
  221. the cursor keys moves the mouse pointer in that direction. Use cursor+shift for
  222. very fine control or cursor+ctrl for fast movement. The mouse buttons are
  223. simulated by the Delete (Select), Copy/End (Menu) and PageDown (Adjust) keys.
  224. Pressing a key twice quickly is the same as a double click. Dragging is not
  225. supported.
  226.  
  227. Cut And Paste
  228. -------------
  229. This feature allows text to be copied from textual icons into writeable
  230. icons via a clipboard. Use these keys:
  231.  
  232. Ctrl-C: Cut text to clipboard.
  233. Ctrl-X: Cut text, deleting source.
  234. Ctrl-V or Insert: Paste text into a writeable icon.
  235. Alt-Insert: Paste text into icons, editors etc.
  236. Ctrl-Z: Paste text, overwriting original text.
  237.  
  238. The text is cut from the caret position if the caret is within a textual
  239. icon. If not, then the text at the pointer location is cut if the pointer is
  240. over a text icon. Successful cutting is indicated by switching the pointer
  241. shape to a hand. Use Lose Caret if you want to be sure of copying text under
  242. the pointer. Suitable textual icons are menu entries and often text in
  243. dialogue boxes.
  244.  
  245. Some applications trap the above keypresses in which case the above
  246. functions will not work. Note also that Cut and Paste does not work inside
  247. editors such as !Edit since they have their own cut and paste mechanisms.
  248. However Alt-Insert should always function. Up to 255 characters may be
  249. pasted in one go. A more powerful pasteing function is provided via the
  250. Alt-Key facility.
  251.  
  252. Task Killing
  253. ------------
  254. The Wimp disables the escape key to prevent the inadvertant termination of
  255. applications. However bugs do occur in applications and it can be nice to
  256. escape out of them without resetting the machine. TidyDesk provides two
  257. levels of escape which should only be used if you suspect an application is
  258. looping.
  259.  
  260. Alt-Esc: Same as pressing Escape outside of desktop. Usually enough to kill
  261. applications written in BASIC or C.
  262.  
  263. Alt-Brk: More severe version of above, capable of terminating assembler
  264. programs as well.
  265.  
  266. In both cases you should save any outstanding work once control is regained.
  267. Note that files may be left open (try *CLOSE) and the state of the machine
  268. cannot be guaranteed to be safe.
  269.  
  270. --------------------------------------------------------------------------
  271.  
  272. Long Double Click
  273. -----------------
  274. Holding down the Select or Adjust button over a filer icon after a previous
  275. click causes the following to happen:-
  276.  
  277. Applications: The application directory is opened rather than running the
  278. application. This is similar to holding down the Shift key at the same time,
  279. which can still be used.
  280.  
  281. Files: Attempts to load the file. If there is an Alias$@LoadType_xxx system
  282. variable set for the file, then the file is *Load'ed. If not then the file is
  283. passed to !Edit (or !Zap) which will be loaded if not already so. If you
  284. don't want files loaded into !Edit, set up an Alias$@LoadType_xxx for the
  285. file - issue "*SHOW ALIAS$@Load*" for the current settings. For instance, to
  286. load a sprite to the screen try "Set Alias$@LoadType_ff9 Screenload %0" (the
  287. system default is SLoad).
  288.  
  289. In both cases, using Adjust rather than Select will cause the source Filer
  290. directory to be closed as normal.
  291.  
  292. Extensions For Loading Basic Programs
  293. -------------------------------------
  294. For BASIC programs the variable BEd$Dir is set to the directory of the
  295. program loaded. To ensure your programs are saved to the correct directory
  296. add this as the first line of your program: "10REM > <BEd$Dir>.name" (press
  297. ALT+E for this to be done automatically).  Note also that the function keys
  298. are set, the defaults being: F1 EDIT, F2 RUN, F3 SAVE , F11 QUIT, F12 BASIC.
  299. These may be altered by editing the value of Alias$TidyBcmd in the !Run
  300. file.
  301.  
  302. Some people like the CSD to be set to the directory containing the file just
  303. loaded into BASIC. To do this add "DIR |<BEd$Dir>|M" to the Alias$TidyBcmd
  304. string. Infact you can add any suitable OS command to Alias$TidyBcmd,
  305. separating each by ||M. The commands will be executed each time a BASIC
  306. program is loaded.
  307.  
  308. By setting the B start-up option, the BASIC editor EDIT will be entered after
  309. loading. For this to work ensure that the BASIC editor is loaded.
  310.  
  311. Under RiscOS 3 Basic programs may be loaded into !Edit or !Zap by issuing
  312. "*Unset Alias$@LoadType_FFB" in your !Boot file. In this case do not use the
  313. B start up option.
  314.  
  315. Running Applications In Task Windows
  316. ------------------------------------
  317. In RiscOS 3.1+ the TaskWindow command allows non-desktop applications to be
  318. run within a window. To do this normally you have to open up a task window
  319. from the task manager icon, and then type in the full path name.
  320.  
  321. TidyDesk provides a much quicker way to do this - just drag the program onto
  322. the TidyDesk icon and the program will automatically be run in a task
  323. window. Note: you can change the amount of memory allocated to the task and
  324. the taskname by changing the variable TD$TaskWind - see the customisation
  325. section. Acceptable file types are Utility, BASIC, Application and Obey.
  326.  
  327. --------------------------------------------------------------------------
  328.  
  329. Flashing Caret
  330. ==============
  331. By setting the C start up option the caret will flash on and off when
  332. displayed, making it easier to locate. The flash period defaults to 0.4
  333. seconds but this can be changed.
  334.  
  335. --------------------------------------------------------------------------
  336.  
  337. Screen Blanking
  338. ===============
  339. This feature prevents screen burn in and is effective only when running
  340. under the desktop. The screen is blanked after 5 minutes (default) have
  341. elapsed with no keyboard or mouse activity. When blanked either a moving
  342. message (default) or a Lissajous graphic is drawn. Unlike most other screen
  343. blankers desktop operation continues, allowing background tasks to continue
  344. operating. To restore the screen move the mouse (if the 'M' start-up option
  345. is set), click a mouse button (eg. menu) or press a key (eg. Shift, Alt or
  346. Ctrl). The defaults can be overriden by the configuration options (see
  347. later) and from the CTRL-Menu.
  348.  
  349. Screen Messages
  350. ---------------
  351. On a blank, a message is displayed in one of three modes:
  352.  
  353. a) In a system font, moving down a line every 4 seconds. This option is
  354.    selected by setting the value of TD$BlankFont to "".
  355.  
  356. b) In an outline font of your choice, moving down a line every 4 seconds.
  357.    This option is activated by selecting an outline font and setting the Z
  358.    start up option to Z0 to de-activate scrolling.
  359.  
  360. c) As a scrolling message in an outline font. When the message leaves the
  361.    screen it reappears one line lower. This option is activated by selecting
  362.    an outline font and setting Zn where n is the scroll step amount in os
  363.    units. This option requires RiscOS 3.1+.
  364.  
  365. In all cases the message cycles back to the top when the bottom is reached.
  366.  
  367. The message text, font and font size are customisable by setting four system
  368. variables. Normally these will be set in the TidyDesk !Run file (see
  369. Configuration section) but they can be modified at any time. The variable
  370. values are read just prior to blanking the screen, allowing you to change the
  371. message text and font whilst the system is running. This could be done via an
  372. Alarm task for example.
  373.  
  374. SetMacro TD$Blankmsg  text
  375. This variable sets the message text, the maximum length of which is 255
  376. characters to enable long scrolling messages. For non-scrolled messages you
  377. should keep the message text to less than a screen line. Use SetMacro rather
  378. than Set to allow the value to vary. For example, "SetMacro TD$BlankMsg
  379. <Sys$Time>" would set the message to the current time.
  380.  
  381. Set      TD$BlankFont  fontname           eg. Homerton.Bold
  382. SetEval  TD$BlankFontx x-points           eg. 16
  383. SetEval  TD$BlankFonty y-points           eg. 16
  384. These variables name the outline font and size in points to be used. If no
  385. font name is given, then the system font is used. Note when choosing font
  386. sizes to ensure your message still fits on one screen line. Nb. You must use
  387. 'SetEval' to set the font size, not 'Set'.
  388.  
  389. If the outline font is not available (eg. you mis-typed the name or changed
  390. font directories), then the message is displayed in the system font rather
  391. than give an error display which would prevent the screen blanker from
  392. working.
  393.  
  394. Scrolling Message Text
  395. ----------------------
  396. To activate this feature you must select an outline font and set the value of
  397. Z to 1 or more. Z is the amount of os_units to move left each re-plot, so
  398. letting you choose the scroll speed to some degree. Typical values will be 2
  399. on a RiscPC or an A5000, and 4 or 8 on other machines. Z is specified in the
  400. TD$Option string - see the Configuration section for more details.
  401.  
  402. TidyDesk uses standard RiscOS calls to display the message so please be
  403. prepared for some flicker. TidyDesk is not a game and cannot use game
  404. techniques such as switching screen banks since these are not possible in
  405. high resolution modes. Also note that the message is only moved when the
  406. desktop is not doing other tasks - if another application wakes up then it
  407. could be some while before the message is moved. This is done so as to not
  408. stop desktop operation, unlike other screen blankers.
  409.  
  410. There are various things you can do to improve the speed of the display.
  411. First, smaller fonts (eg. 14 points) will display quicker than big chunky
  412. ones, though the latter look nicest. Secondly, carefully set the Font Manager
  413. customisation settings. Basically, if the FontManager cannot cache the font
  414. you selected then scroll display will be VERY slow. Cached, 4-bits per pixel
  415. displays usually work the fastest. You can achieve this by setting the
  416. following *Configure options. Use *Status to see your current settings.
  417.  
  418. FontSize and FontMax: these set the minimum and maximum size of the Font
  419. Cache. Use the *FontList command to see the amount of cache already in use.
  420. If the cache is full, then it is unlikely that the scroll message will get
  421. cached, so increase FontSize and/or FontMax.
  422.  
  423. FontMax3: sets the maximum point size to cache. This value must be EQUAL or
  424. GREATER than TD$BlankFontX/Y to ensure the scroll message is cached.
  425.  
  426. FontMax4 and FontMax5: these enable sub-pixel anti-aliasing. This gives a
  427. very accurate display but uses 4 times more memory than 4-bits per pixel
  428. bit-maps (16 times more than 1-bit per pixel ones) and needs a lot of
  429. processing. Either set these values to 0 or ensure they are LESS than the
  430. values of TD$BlankFontX/Y. To use these values effectively you will need a
  431. very large font cache.
  432.  
  433. FontMax2: sets the maximum point to scale to anti-aliased bit-maps.
  434. Anti-aliased fonts look much nicer than 1-bit per pixel ones, especially at
  435. small point sizes, since they use up to 16 grey-scales to plot intermediate
  436. pixels to give much smoother lines. Anti-aliased bit-maps however needs 4
  437. times as much memory, thus filling the cache up more. If memory is limited
  438. then set FontMax2 to LESS than TD$BlankFontX/Y - the scroll font will then be
  439. cached as a 1-bit per pixel bit-map which will look a bit jagged, but will
  440. display fast.
  441.  
  442. The *Configure FontMax settings are permanent. If you have RiscOS 3.1+ check
  443. your Desktop boot file - there is likely to be a line "ChangeDynamicArea
  444. -FontSize nk" which overrides the Configure FontSize option. Another Acorn
  445. trap I am afraid for the unknowing.
  446.  
  447. To summarise, FontSize and FontMax set the cache size which must be big
  448. enough. FontMax3 must be larger than your font else it will not be cached. To
  449. save memory ensure FontMax4 and FontMax5 are less than your font. If memory
  450. is really limited then set FontMax2 less than your font size, else make it
  451. bigger. Note that these rules apply to all applications that use outline
  452. fonts, so you can use the above rules to speed up the desktop. Pity Acorn do
  453. not explain it in this way.
  454.  
  455. If you use the Fontlist command after your scroll message has been displayed
  456. you can tell if your font is being cached. If you look down the list you
  457. should see the font name you selected in your selected point size, showing
  458. the amount of memory it is consumming. Note that TidyDesk releases the font
  459. when it is not being displayed to allow the cache memory to be used elsewhere
  460. if required, so the use count will probably be zero.
  461.  
  462. Lissajous Screen Plot
  463. ---------------------
  464. To select a Lissajous plot use the L start up option (see Configuration). The
  465. Lissajous plots come from the !Lissajous application - refer to it's Help
  466. file for details on how Lissajous figures are created. When a Lissajous
  467. figure is plotted, use the following keys to control the display:
  468.    cursor left decreases the x plot
  469.    cursor right increases the x plot
  470.    cursor down decreases the y plot
  471.    cursor up increases the y plot
  472.    Return restores the x/y values to their settings
  473. The current x/y values are shown in the CTRL-Menu.
  474.  
  475. Different Lissajous patterns may be used by double clicking on a Lissajous
  476. figure created by !Lissajous, or by using the command *TidyDesk_Load
  477. <filename>. This command could be added as the penultimate line of the
  478. !TidyDesk !Run file to permanently set the Lissajous plot.
  479.  
  480. Screen blanking consumes very little cpu, even when Lissajous plotting,
  481. enabling long running applications such as ray tracers to continue to run
  482. unaffected. Also it does not change screen mode or alter the main palette in
  483. any way (only the border palette), thus leaving the desktop and other
  484. programs unaffected by the screen blank.
  485.  
  486. If you use a different screen blanker, then use the T0 start-up option (see
  487. later) to TidyDesk's blanker off.
  488.  
  489. --------------------------------------------------------------------------
  490. Alt-Key Facility
  491. ================
  492. This is a very powerful time-saving feature that allows you to perform the
  493. following actions by pressing ALT and another key:
  494.   a) Insert text as if typed at the keyboard including things like today's
  495.      time and date.
  496.   b) Launch an application, eg !Draw or !Impression.
  497.   c) Issue an OS command, such as *BASIC.
  498.   d) Invoke a TidyDesk provided feature.
  499.   e) Load text into an application.
  500.  
  501. The ALT key is used since this will in most cases avoid conflicts with other
  502. programs. If a conflict does arise, TidyDesk can be customised to only trap
  503. the left or right Alt key - see the customisation section. Many preset
  504. facilities are provided with TidyDesk, but these keys or any other may be set
  505. at any time.
  506.  
  507. Editing Key Definitions
  508. -----------------------
  509. Selecting Edit Keys from the main menu or clicking Select on the iconbar
  510. icon will open a window with 4 areas:
  511.   a) ALT or ALT+Shift key definition
  512.   b) Key being edited
  513.   c) Facility to save the definitions
  514.   d) A keyboard layout showing which keys are in use.
  515.      (note: this keyboard layout is for A3/4/5xxx series machines - the keys
  516.       may be in different places on other keyboards).
  517.  
  518. Alt Key + : Click on Shift to access the ALT+Shift+key definitions.
  519.  
  520. Key x: This panel shows the key being edited. A key may perform one of 4
  521. functions:
  522.   a) Insert text as if typed at keyboard
  523.   b) Issue an OS command
  524.   c) Load text into an application
  525.   d) Perform a TidyDesk provided function.
  526.  
  527. These are covered in more detail below. For Insert, Command and Load, click
  528. on the white icon to key in the text for the key. For TD Cmd click on the
  529. menu icon and then select the function you want - the white icon shows
  530. which command has been selected.
  531.  
  532. Click on Update to set the key definition, or Delete to remove the
  533. definition. The corresponding key will be colour coded in the main panel to
  534. show it has been selected.
  535.  
  536. Keys: Click on Save to permanently save the definitions into a file within
  537. the !TidyDesk directory. Click on End to close the display.
  538.  
  539. Keyboard: This panel shows all the keys on the keyboard, colour coded to
  540. show their function. Click on a key to see its function:
  541.    White          : unused key or RiscOS special characters (see later)
  542.    Light Blue     : Insert text
  543.    Dark Blue      : Load text
  544.    Light Green    : TidyDesk command
  545.    Dark Green     : OS command
  546.    Light Grey     : Reserved because they are used by Risc OS.
  547.  
  548. Single Key Editing
  549. ------------------
  550. To quickly edit a single key, press ALT-K - a panel will appear asking you
  551. to press the key to be edited, with Shift if required. The panel that
  552. appears is just the main key editing panel. You can press Alt-K even when
  553. the Edit Key(s) window is open to switch to another key. When you click on
  554. Update or Delete the key will be set and the panel closed, unless you use
  555. Adjust. However note that the definition will not be permanently set - use
  556. Save from the main Edit Keys window for this.
  557.  
  558. Text Inserting
  559. --------------
  560. Up to 255 characters can be inserted when you press ALT+key. This is
  561. effective inside any editor (eg. Impression) or even outside the desktop
  562. (eg. BASIC Editor). This allows repetitive text strings to be quickly
  563. entered without mistake. Note: There is a bug within !Edit on RiscOS 3.1
  564. causing every 21st character to be lost - use the Load facility to overcome
  565. this.
  566.  
  567. Instead of typing in the text to be inserted, you can save text from another
  568. application, providing an extended cut and paste facility:
  569.   a) Select the text within the application
  570.   b) Press Alt-K and the key to receive the text
  571.   c) Open the application menu and open the Select->Save panel
  572.   d) Drag the file icon onto the edit key window and the text will be
  573.      transferred into the key definition.
  574.   e) Press Update
  575. Note also that text may be dragged the opposite way, from the Edit Key
  576. window into an application. This allows easier editing of long text
  577. sequences.
  578.  
  579. GSTrans:
  580. The inserted text supports the GS-Trans format, allowing control codes and
  581. system variables to be used. For instance |J (or |M) is the same as pressing
  582. Return whilst <Sys$Time> would enter the current time (ALT+Shift+T is preset
  583. to this value). Use |<..> to insert <> symbols without translation (see
  584. ALT+E). Linefeeds and carriage-returns are automatically converted to/from
  585. GS-Trans format when dragging text to and from the Edit key window.
  586.  
  587. To save you having to work out the GSTrans value for control codes, all you
  588. need to do is press the control codes you require (eg. CTRL-J or F3), and the
  589. correct GSTrans sequence will be generated. What this allows you to do is
  590. enter multiple control codes to a task. For example within !Edit, pressing F4
  591. opens the Search window, and then pressing F2 recalls the previous text. You
  592. could assign ALT-F4 to F4+F2 so that this always occurs.
  593.  
  594. Notes:
  595. Sometimes it is necessary to generate a delay to give the target task enough
  596. time to open the new window. To do this insert |@ (CTRL-@, the null
  597. character) after the control code causing a switch of windows.
  598.  
  599. To insert a null code, enter it twice, ie |@|@.
  600.  
  601. To insert CTRL-U (delete contents of an icon) use |U.
  602.  
  603. TidyDesk traps all control codes whilst editing a key, including the F12 key,
  604. so use ALT-L to lose the caret if you really need to perform a F12 function.
  605.  
  606. GSTrans Format:
  607. This is documented in the RiscOS User guide.
  608.  
  609. Alt-T is preset to the variable <TD$Date> which inserts the current date in
  610. a user definable format. See the Configuration Options section to set the
  611. date format.
  612.  
  613. Loading Text
  614. ------------
  615. This is similar to Insert Text, but instead of inserting into the keyboard
  616. the data is sent as a text file to the current application which is the one
  617. owning the caret, or the one under the pointer if no caret. The difference
  618. depends very much on the application. For Impression for instance, using
  619. Load allows the inclusion of styles, eg.
  620.  
  621.      {"Bold" on}Some Bold Text{"Bold" off}
  622.  
  623. would cause Impression to enter the text in the Bold style. If you used
  624. Insert the bracketed commands would not be interpreted.
  625.  
  626. As mentioned previously use Load to add more than 20 characters to !Edit.
  627.  
  628. The text data for Load may be edited in the same way as for Insert. Also you
  629. can use GS-Trans codes and system variables.
  630.  
  631. Issuing Commands
  632. ----------------
  633. This facility is only available from the desktop. The command is issued as a
  634. new desktop task, so any output will appear in a window. Under RiscOS 3
  635. prefix the command with "TaskWindow" for the output to appear in a
  636. multi-tasking window (see Alt+Shift+B as an example). Whilst any command can
  637. be issued, the following are suitable examples:
  638.   a) BASIC (ALT-B preset)
  639.   b) the full name of an application directory to launch a task
  640.   c) "Filer_OpenDir dirname" to open a directory display
  641.   d) An Obey or TaskObey file
  642.   e) WimpMode xx to change screen mode (RiscOS 3)
  643.   f) Using SET, SETEVAL and SETMACRO
  644.  
  645. Up to 255 characters can be typed in. A quick way to enter a file name is to
  646. drag the file or application from a Filer window onto the Edit Key window.
  647. Multiple commands can be issued by separating each by |J, but the easiest
  648. way to do this is to code the command sequence within !Edit and then save
  649. the output onto the Edit Key window. To re-edit a multi-command, drag the
  650. command from the Edit Key window into !Edit.
  651.  
  652. Two commands are provided which are useful in this context.
  653.  
  654. MouseStep n: sets the mouse speed from 1-127 (see Alt-F1 through F5).
  655.  
  656. TD_Insert text: inserts the text into the keyboard buffer. This is useful
  657. when performing multi-line expressions. Alt-N is defined as:
  658.  
  659.      SetEval N N+1 |J TD_Insert <N>
  660.  
  661. Pressing ALT+N increments the value of N and then inserts the number into
  662. the keyboard. Try it and see - useful for section numbering. Press
  663. ALT+Shift+N to reset back to 1.
  664.  
  665. To insert the date in different formats use:
  666.    SET TD$DateForm "format string" |J TD_Insert <TD$Date>
  667.  
  668. TidyDesk Provided Commands
  669. --------------------------
  670. TidyDesk provides many functions which can be assigned to a key. They are
  671. documented in the "Keyboard Shortcuts" section previously. The standard key
  672. assignments are:
  673.  
  674. Command       Key Assignment        Function
  675. ———————————————————————————————————————————————————————————————————
  676. Wdw to Front  ALT-Page Up           Window to top
  677. Wdw to Back   ALT-Page Down         Window to bottom
  678. Maximise Wdw  ALT-Cursor Down       Maximise window
  679. Minimise Wdw  ALT-Cursor Left       Minimise window
  680. Max. Width    ALT-Cursor Right      Maximise window's width
  681. Max. Height   ALT-Cursor Up         Maximise window's height
  682. Close Wdw     ALT-Delete            Close window
  683. Tidy Wdws     ALT-Home              Tidy windows
  684. Cycle Wdws    ALT-Tab               Cycle through windows
  685. Park Mouse    ALT-\                 Mouse to far right
  686. Edit Key      ALT-K                 Open ALT key edit window
  687. See Pinboard  ALT-V                 Toggle pinboard to front/back
  688. Lose Caret    ALT-L                 Lose caret
  689. Escape        ALT-Escape            Present escape to current task
  690. Kill Task     ALT-Break             Cancel current task
  691. Iconise Wdw   ALT-I                 Iconise the current window
  692. Pin Window    ALT-P                 Close window and place on pinboard
  693. Mouse by keys ALT-M                 Control mouse from keyboard
  694.  
  695. All of these functions may be reassigned to different keys. Note that window
  696. refers to the current window - the one owning the caret or the one under the
  697. pointer if no caret.
  698.  
  699. RiscOS ALT Keys
  700. ---------------
  701. RiscOS provides some ALT-key functions of its own. Some of these provide
  702. access to special characters such as © - these may be reassigned within
  703. TidyDesk as long as the key is not greyed out. TidyDesk shows you the
  704. character RiscOS 3.1 inserts into the keyboard when using the Latin1
  705. character set. To restore a key to its original function click the Delete
  706. icon.
  707.  
  708. Greyed out keys cannot be reassigned. The numeric keys are used within RiscOS
  709. to allow any key code to be inserted into the keyboard by pressing ALT and
  710. the ASCII keycode using the numeric keypad. The keys marked 'Accent Letter'
  711. are used to form accented letters by pressing ALT+key then the letter to
  712. accent by itself. For example ALT+[ followed by E produces é.
  713.  
  714. --------------------------------------------------------------------------
  715.  
  716. Configuration Options
  717. =====================
  718. Configuration options are set by editing the !TidyDesk !Run file. Hopefully
  719. the next version of TidyDesk will feature a desktop customising application
  720. since the list of options has grown some what. For now, please read the
  721. following section carefully to get the most out of TidyDesk.
  722.  
  723. TD$Options:
  724. The following options can be set by editing the line "SET TD$Options ..."
  725. in the file !Run within the !TidyDesk directory. For the options to take
  726. effect, restart TidyDesk. Each option is a single letter which may be
  727. specified in any order, with or without intervening spaces. To remove all
  728. the options specify:     SET TD$Options ""
  729.  
  730. Ak : By default TidyDesk traps both the left and Alt keys. To avoid conflicts
  731.      with other applications, TidyDesk can trap either the left key - AL - or
  732.      the right key - AR.
  733. B  : When loading BASIC files by a long double click, enter BASIC EDIT mode.
  734. Cn : Turns on the flashing caret. 'n' (optional) specifies the flash period
  735.      in centiseconds. The default is 40 (0.4 seconds).
  736. D  : Protect dialogue box window sizes on a tidy operation.
  737. I  : Place TidyDesk on icon bar, otherwise use CTRL-Menu to access.
  738. L  : Activates the Lissajous screen blank plot.
  739. M  : Mouse move terminates a screen blank.
  740. O  : Use outline fonts in low resolution screen modes.
  741. P  : Protect all window sizes on a tidy operation.
  742. S  : When Tidying windows, reset the scroll bars to their home position.
  743. Tn : Sets the screen blank time to 'n' minutes - 0 disables screen blanking.
  744. V  : Sets the ALT-Home key action to Tidy->View. The default is
  745.      Tidy->Stack.
  746. Xn & Yn : sets the default X & Y Lissajous plot values.
  747. Zn : n is the number of OS units to shift the screen blank message left each
  748.      redisplay. If Z0 is specified the screen message is not subject to
  749.      scrolling. Scrolled messages are only supported in outline fonts and
  750.      with RiscOS 3+.
  751.  
  752. Note: Setting the D and S options will produce the cleanest result without
  753. disturbing window sizes unduly when performing a window tidy operation.
  754.  
  755. *TidyDesk_Load <filename> : use this command to load a Lissajous figure of
  756. your choice.
  757.  
  758. Alias$TidyBcmd is used to set the function keys on entry to BASIC - see
  759. section on Long Double Click.
  760.  
  761. SetMacro TD$Blankmsg   text
  762. Set      TD$BlankFont  fontname           eg. Homerton.Bold
  763. SetEval  TD$BlankFontx x-points           eg. 16
  764. SetEval  TD$BlankFonty y-points           eg. 16
  765. TD$BlankMsg is used to set the message used on a screen blank if screen
  766. blanking has been enabled and Lissajous plotting has been disabled. Specify
  767. up to 255 characters which can include RiscOS variables eg.
  768.    SetMacro TD$BlankMsg The screen was blanked at <Sys$Time>
  769. See the screen blanking section for more details.
  770.  
  771. TD$DateForm "format string" is used to set the date format of the <TD$Date>
  772. variable. See your RiscOS User Guide on for the specification of date format
  773. strings - too many to mention here!
  774.  
  775. TD$TaskWind is used to set the options for running programs in a task window.
  776. Issue *Help Taskwindow to see the available options - TidyDesk passes the
  777. TD$TaskWind options on to the Taskwindow manager.
  778.  
  779. To conserve memory it is possible to remove the "RMLOAD <TD$Dir>.TD_Help"
  780. command which will stop the help information being loaded until required.
  781.  
  782. For best operation TidyDesk should be loaded at power on by specifying
  783. $.path.!TidyDesk in your !Boot file. See the final topic for help on setting
  784. up !Boot files.
  785.  
  786. --------------------------------------------------------------------------
  787.  
  788. Notes On Window Controls
  789. ========================
  790. This section describes limitations and caveats which you should be aware of.
  791.  
  792. Window Resizing: a window's size can be changed via Minimise, Maximise or
  793. Tidy, regardless of whether it has the related window control icons. Some
  794. windows without control icons (such as tool boxes) do not have correct
  795. minimum and maximum sizes defined, so when you minimise, maximise or tidy
  796. it, the window is not correctly sized. This is usually cured by closing the
  797. window and then re-opening it from the owning task, or try Maximising it.
  798. Use the D start-up option to stop these window sizes being changed on tidy,
  799. and P to protect all window sizes.
  800.  
  801. Task Quit: use this selection with caution - it ends the task with no
  802. prompts to save data. Never quit the Filer or Task Manager.
  803.  
  804. Using Adjust: use Adjust to keep the menu open. Note that closing a Filer
  805. window with adjust will open the parent directory. When using CTRL-Menu,
  806. Adjust does not cause the menu to be re-made since re-sorting the window
  807. list could be confusing. Note that after closing a window with Close, the
  808. other menu options may or may not work for that window, depending on the
  809. application - the window will be re-opened if it still exists.
  810.  
  811. --------------------------------------------------------------------------
  812.  
  813. Automating The Desktop At Startup
  814. =================================
  815. The following notes should be of help in automating the state of the machine
  816. at power on. I give these since Acorn's instructions are minimal!
  817.  
  818. RiscOS 3
  819. If you use the "Desktop Boot" facility of the Task Manager to set up your
  820. desktop boot file then TidyDesk will automatically add a line to load itself.
  821. Alternatively if you have customised your boot file then add this line to
  822. your !Boot file and/or desktop boot file:-
  823.    Run <pathname>.!TidyDesk
  824.  
  825. RiscOS 2
  826. 1) Issue *CONFIGURE BOOT - this forces the system to look for a !Boot file
  827. at start up. Also issue *Configure Language 3 to set RiscOS as the default
  828. language.
  829.  
  830. 2) Create an EXEC file called $.!Boot on your hard disk using !Edit. If you
  831. only have a floppy disk, create the file on your system disk (the one
  832. containing !System and all your main applications). For the moment just add
  833. the next 2 lines:
  834.  *$.dir.!TidyDesk                load before starting desktop
  835.  *DESKTOP -FILE $.dir.Deskboot
  836. where dir is a suitable directory such as BOOT.
  837.  
  838. 3) Issue *DIR $ then *OPT 4,3 to set the boot option for the !Boot file on
  839. this disk.
  840.  
  841. 4) Create the $.dir.Deskboot file as an EXEC file using !Edit. Typically the
  842. lines will be:
  843.  
  844.    Set Edit$Options ...              Set !Edit options
  845.    Set Copy$Options ...              Set *COPY options
  846.    pathname.!Fonts.!Boot             Prepares the Fonts for use
  847.    pathname.!Draw.!Boot              Initialise !Draw
  848.    pathname.!application             to start an application such as !Alarm
  849.    FILER_OPENDIR adfs::diskname.$    opens the root directory of this disk
  850.  
  851. Now, when your machine is powered on or you press CTRL-Reset, the system
  852. will automatically be fully configured to your options. If you use floppies,
  853. you will need to ensure that your System disk is in the drive before booting
  854. the system.
  855.  
  856. Note that the lines ending .!Boot don't start an application, but ensure
  857. that the application will be ready to be run when required. For example,
  858. when you double click on a Draw file, the system will now know what to do
  859. with it and where to find !Draw. These lines are only needed for
  860. applications that have their own data files.
  861.  
  862. If the applications are on different disks, you can still set them up.
  863. Generally you will need to add lines to "Deskboot" in the form:
  864.  
  865.    Set Alias$@RunType_xxx adfs::diskname.$.!application.!Run %*0
  866.  
  867. You will find the necessary lines in the !Boot file of the application.
  868.  
  869. Note that the Deskboot file can be any name and can be tucked away in any
  870. directory on the system disk. The !Boot file however must be in the root
  871. directory.
  872.  
  873. To bypass the !Boot at reset or power on, simply hold down the SHIFT key.
  874.  
  875. Note: if you have multiple filing systems use *CONFIGURE Filesystem name to
  876. set the filing system to contain the !Boot file. If you have multiple disk
  877. drives, use *CONFIGURE DRIVE to set the default disk drive to contain the
  878. !Boot file.
  879.  
  880. Multiple Configurations with a hard disk: if several people use the machine
  881. and you want different configurations for each, set the last line of the
  882. !Boot file to *Deskboot -File ADFS::diskname.$.Deskboot, where diskname is
  883. the name of each person's personal configuration disk containing their
  884. unique Deskboot file.
  885.  
  886. --------------------------------------------------------------------------
  887.  
  888. History
  889. -------
  890.  
  891. 1.00 12/01/92 Initial version with window controls and screen blanking.
  892. 1.01 18/04/92 User definable function keys on entry to BASIC.
  893. 1.10 11/05/92 Drag and resize windows via CTRL/ALT. Alt-TAB task cycling.
  894.               Pointer park. Alt-cursor controls affect caret owner.
  895.               Flashing caret. Allow loading before *DESKTOP.
  896.               Task killing. Cut and Paste text icon contents.
  897.               Icon bar menu.
  898. 1.11 26/05/92 Alias$TidyBkeys now Alias$TidyBcmd and allows setting of CSD.
  899. 1.13 24/09/92 Outline font support.
  900. 1.20 18/11/92 Alt-Key editing feature plus other minor enhancements.
  901. 1.25 04/12/92 RiscOS 3.1 enhancements, tidy up of Alt-key feature, bug
  902.               fixes. Changes to Long double click for BASIC loading.
  903. 1.30 08/12/92 Alt-key enhancements, full interactive help, bug fixes.
  904. 1.31 29/01/94 Acorn Newlook style icons.
  905. 1.40 06/05/94 Pinboard toggling. Max width, height & close window commands.
  906.               Lose caret command. Some bug fixes (ALT-Tab no longer inserts
  907.               a tab into !Zap, & handle insertion of character codes >x80).
  908. 1.41 10/05/94 Automatic translation of control codes into GSTrans format.
  909. 1.42 17/05/94 Allow some RiscOS ALT keys to be redefined. Support for 32k
  910.               and 16M colour modes for Lissajous plotter.
  911. 1.43 02/10/94 Centralise Lissajous plot in all screen modes. Custom select
  912.               which Alt keys to trap. Windows brought to front correctly.
  913. 1.50 01/11/94 Support DesktopSave to automate booting. User defined screen 
  914.               blank msg and in any outline font. Screen blank scroll message.
  915. 1.60 12/09/95 Add Iconise and Pin functions. Add window title to window list.
  916. 1.61 16/11/95 Add keyboard control of the mouse.
  917. 1.62 27/02/96 Overcome RiscOS 3.5 problem with outline fonts in icons.
  918. 1.63 28/10/96 StrongArm support.
  919.  
  920. --------------------------------------------------------------------------
  921.  
  922. Copyright
  923. ---------
  924. This software is copyrighted by Mike Curnow and IS NOT PUBLIC DOMAIN. If you
  925. regulary use this software then it can be registered for £6 direct from the
  926. author, the benefit being that you get the latest version and entitlement to
  927. future updates. This software must not be resold without prior consent from
  928. the author. 
  929.  
  930. Mike Curnow,
  931. Stoneleigh
  932. Swan Lane
  933. Great Bourton
  934. Banbury
  935. OX17 1QR
  936. email: mike.curnow@dial.pipex.com
  937.  
  938. SAE with all correspondance please. Send a formatted disk if you want to
  939. upgrade to the latest version of this program (registered users only) or you
  940. are reporting a bug and would like a fix.
  941.