home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / desktop / outlnwimp_1 / !DeskCtrl / !Help next >
Text File  |  1995-11-20  |  24KB  |  576 lines
  1. Instructions for !DeskCtrl by Andrew Sellors
  2.  
  3. *****************************************************************************
  4. * NOTE:                                                                     *
  5. * !DeskCtrl is Shareware.                                                   *
  6. * It is part of the Outline Wimp desktop enhancement package and must not   *
  7. * distributed without the accompanying files.                               *
  8. *                                                                           *
  9. * You may use this software for a trial period of 30 days. If, after this   *
  10. * you decide you would like to continue using it then you are required to   *
  11. * Register. See the ReadMe1st file for details of registering               *
  12. *                                                                           *
  13. * This version maybe freely copied and distributed, provided that it is     *
  14. * complete with all original files, and that you do not sell it.            *
  15. * PD libraries may charge a nominal fee for the cost of duplication,        *
  16. * postage etc.                                                              *
  17. *                                                                           *
  18. * In no circumstances shall the author be liable for any damage, loss of    *
  19. * profits, time or data or any indirect or consequential loss rising out of *
  20. * the use of this software or inability to use this software.               *
  21. *****************************************************************************
  22.  
  23. Contents:
  24. ---------
  25.  
  26. Features
  27. Compatibility
  28. Operation
  29. Iconbar menu
  30. "Edit Palette" window
  31. "Mode Selector" window
  32. Hot-Keys
  33. "Desktop Font Setup" window
  34. "Texture Setup" window
  35. "Desktop Control Setup" window
  36. "CMOS RAM Setup" window
  37. Clicking on iconbar icon
  38. Auto loading of extension modes
  39. Configuring the Colour and Resolution menus
  40. Adding mode definitions
  41. Removing "Quit" from the menu
  42. Contacting the author
  43. Credits
  44.  
  45. ********************************************************************************
  46.  
  47. Features
  48. --------
  49.  
  50. Replaces Palette Utility on iconbar.
  51.  
  52. Provides palette chooser and facility for loading and saving palette files.
  53.  
  54. Saves current mode and palette in "DeskBoot" file like the Palette Utility.
  55.  
  56. Provides RiscPC style mode picker with configurable menus for different monitor
  57. types, whilst still allowing modes to be selected by number.
  58.  
  59. Provides "Hot-Keys" for quick selection of modes.
  60.  
  61. Provides easy selection of the configuration parameters of the outline font
  62. windowmanager.
  63.  
  64. Provides easy loading of sprites for the textured window background
  65. windowmanager and display of texture allocations. (Only with registered version
  66. of outline font windowmanager, see ReadMe1st file)
  67.  
  68. Loads up extension mode Relocatable Modules placed in "Mode" directory on
  69. startup.
  70.  
  71. Uses 3D bit in CMOS RAM to select 2D or 3D windows _and_ iconsprites on startup.
  72. NOTE: Read about "CMOS RAM Setup" window below for how to turn on 3D windows.
  73.  
  74. Provides facility to alter options in CMOS RAM that do not have *configure
  75. commands.
  76.  
  77. ********************************************************************************
  78.  
  79. Compatibility:
  80. --------------
  81.  
  82. This program is for RISC OS 3.10 or later. The program will function without
  83. the outline font windowmanager loaded, just with the features of configuring
  84. the windowmanager removed.
  85.  
  86. ********************************************************************************
  87.  
  88. Operation:
  89. ----------
  90.  
  91. When the !DeskCtrl icon is double-clicked, DeskCtrl installs itself on the icon
  92. bar in the place of the Palette Utility, the palette utility is still however
  93. running as it is needed to respond to the *Desktop_SetPalette command.
  94. When Quit, the Palette Utility is restarted and replaces DeskCtrl on the icon
  95. bar.
  96.  
  97. ********************************************************************************
  98.  
  99. Iconbar menu
  100. ------------
  101.  
  102.    +-----------+
  103.    | DeskCtrl  |
  104.    +-----------+
  105.    | Info    ⇨ | ⇨ opens "About this program" window
  106.    | Palette   | Opens "Edit Palette" window
  107.    | Mode    ⇨ | Opens "Mode Selector" window, ⇨ submenu allows mode to be set
  108.    | Font      | Opens "Desktop Font Setup" window.                  by number
  109.    | Texture   | Opens "Texture Setup" window.
  110.    | CMOS      | Opens "CMOS RAM Setup" window.
  111.    | Options   | Opens "Desktop Control Setup" window.
  112.    | Quit      | Quits program (can be removed, see below).
  113.    +-----------+
  114.  
  115. ********************************************************************************
  116.  
  117. "Edit Palette" window
  118. ---------------------
  119.  
  120. This allows the 16 colour desktop palette, the mouse pointer colours and the
  121. screen border colour to be altered.
  122.  
  123. "RGB" group
  124. -----------
  125.  
  126. The proportions of the red, green and blue constituents of each colour can be
  127. changed by either dragging the coloured bars or by typing the number into the
  128. writeable icon to the left of the corresponding bar and pressing RETURN.
  129. The "Round RGB Continuously" option makes the program mimic the Palette
  130. Utility by only allowing the proportions of each colour to change in multiples
  131. of 16.
  132. Clicking on the "Round RGB" button causes the values of the colour bars to be
  133. rounded to a multiple of 16.
  134. For the technically minded, the rounding process keeps the bottom 8 bits of the
  135. value set at zero.
  136.  
  137. "Colours" group
  138. ---------------
  139.  
  140. The array of buttons to the left of this group select the colour that the colour
  141. bars alter when they are dragged or the number typed in. The top two numbered
  142. rows correspond to the 16 wimp colours and the bottom row the border and mouse
  143. pointer colours.
  144. The current colour and its number (or name for the border and mouse colours) are
  145. shown to the right.
  146.  
  147. Clicking on the "Save" icon causes a savebox to pop up which allows the current
  148. palette to be saved as a palette file.
  149. Clicking on the "Close" icon closes the window, all the changes made when it was
  150. open are kept.
  151. Clicking on the "Default" icon sets the wimp palette to its default colours.
  152.  
  153. ********************************************************************************
  154.  
  155. "Mode Selector" window
  156. ----------------------
  157.  
  158. This allow the screen mode to be changed.
  159.  
  160. When opened the current screen mode's details (if known) are entered into the
  161. "Colours" and "Resolution" boxes. If !DeskCtrl has not been configured to know
  162. about the current mode that is selected then an error message is displayed when
  163. this window is opened. See the section "Adding mode definitions" below for
  164. instructions on how to add new modes to !DeskCtrl
  165.  
  166. Clicking on the menu icon to the right of the number of colours brings up a
  167. menu allowing a new number of colours to be selected. If a mode with the
  168. selected resolution is not defined in that number of colours then a new
  169. resolution is chosen.
  170.  
  171. Clicking on the menu icon to the right of the resolution brings up a menu
  172. allowing a new resolution to be selected. If, like with the colours, the
  173. selected number of colours cannot be provided at that resolution then a new
  174. number of colours is chosen.
  175.  
  176. Clicking on the "Change" icon with Select changes the screen mode to the
  177. selected one and closes the window, if the icon is clicked on with Adjust then
  178. the window is left open when the new mode is selected.
  179.  
  180. Clicking on the "Cancel" icon closes the window without changing the screen
  181. mode.
  182.  
  183. The resolution menu is chosen for the particular monitor configured and both
  184. menus are fully user definable, thus users with graphics enhancer cards can
  185. add more resolutions and colours to the menus, see below for details.
  186.  
  187.  
  188. ********************************************************************************
  189.  
  190. Hot-Keys
  191. ---------
  192.  
  193. The program provides hot-keys to allow quick mode selection.
  194. These work be advancing the selection of the resolution or colour menus.
  195.  
  196. <Alt>+(Cursor Up>    changes the mode to the next resolution down in the menu.
  197.                       With the provided menus this increases the resolution.
  198. <Alt>+<Cursor Down>  changes the mode to the next resolution up in the menu.
  199.                       With the provided menus this decreases the resolution.
  200. <Alt>+<Cursor Left>  changes the mode to the next number of colours up in the
  201.                       menu. With the provided menus this decreases the number of
  202.                       colours.
  203. <Alt>+<Cursor Right> changes the mode to the next number of colours down in the
  204.                       menu. With the provided menus this increases the number of
  205.                       colours.
  206.  
  207. As with the selections on the colour and resolution menus on the "Mode Selector"
  208. window, if the number of colours or resolution is undefined then new ones will
  209. be chosen.
  210.  
  211. ********************************************************************************
  212.  
  213. "Desktop Font Setup" window
  214. ---------------------------
  215.  
  216. This window allows the outline font windowmanager to be configured without
  217. having to use the command line. The window is only displayed if the outline
  218. font windowmanager is installed, otherwise the menu option on the main menu
  219. is greyed out. 
  220.  
  221. "Font" group
  222. ------------
  223.  
  224. The box at the top of the window shows the fontname of the outline font used
  225. by the windowmanager, it can be changed by clicking on the menu icon to the
  226. right which brings up the standard font menu. The menu is updated every time
  227. it is shown so that it will take account of new fonts as and when they are added
  228. to the system.
  229.  
  230. The writeable icon below labelled "Size" allow the font size in points to be
  231. changed by either typing it in or using the up and down arrow icons to increment
  232. or decrement the number.
  233.  
  234. The writeable icon below labelled "Aspect X:Y" allow the aspect ratio to be set
  235. in a similar way to the font size. An aspect ratio of less than 100% squashes
  236. the letter's length and greater than 100% stretches them. The aspect ratio only
  237. changes the length and not the height of the letters.
  238.  
  239. "Text" group
  240. ------------
  241.  
  242. The "Justify key short-cuts" option selects whether the key short-cut text is
  243. right justified in menus. This makes them look better when a proportionally
  244. spaced font is used.
  245.  
  246. The "Use font 'WimpMisc' option selects the use of the font 'WimpMisc' which
  247. contains some of the characters that normal outline fonts lack, such as the
  248. set of arrow characters. When this option is selected, "Replace up arrow with"
  249. is turned off as both cannot be turned on at the same time.
  250.  
  251. The "Replace up arrow with" option selects whether the up arrow character, which
  252. is used in key short-cut descriptions in menus, is replaced by the character
  253. defined below. This is useful as most outline fonts do not contain a up arrow
  254. character and therefore, without any replacement, the key short-cuts would be
  255. very confusing. The character used can be set by either typing it's ASCII code
  256. in the writable icon and pressing RETURN or by using the up and down arrow icons
  257. to scroll through the possibilities. The character selected is shown in the box
  258. to the left of it's ASCII code. When this option is selected, "Use font
  259. 'WimpMisc' is turned off as both cannot be turned on at the same time.
  260.  
  261. Clicking on "Change" with Select configures the windowmanager as selected and
  262. then closes the window, clicking with Adjust configures the windowmanager but
  263. leaves the window open.
  264.  
  265. Clicking on "Cancel" closes the window without making any changes.
  266.  
  267. Read the !Help file for the !WimpPatch application for more details on the
  268. outline font windowmanager.
  269.  
  270. ********************************************************************************
  271.  
  272. "Texture Setup" window
  273. ----------------------
  274.  
  275. This window allows the textured window backgrounds of the registered outline
  276. font windowmanager to be configured without using the command line. If the
  277. unregistered windowmanager patch is being used or just the normal windowmanager
  278. then the menu option to open the window is greyed out.
  279.  
  280. Unlike some of the other dialogue boxes in !DeskCtrl, operations with this
  281. window are performed immediately instead of only when the "OK" button is
  282. pressed.
  283.  
  284. A sprite file containing texture tiles can be loaded by dragging its icon
  285. to the "Texture Setup" window. The filename of the currently loaded sprite file
  286. is shown in the "Texture File:" box. If no file is loaded then "<None>" is
  287. shown instead.
  288.  
  289. The centre portion of the window shows tables of what tiles have been loaded.
  290. Up the side of the tables are the Wimp background colours and along the top
  291. are the number of bits per pixel of the modes:
  292. "1" = 1bpp = 2 colours
  293. "2" = 2bpp = 4 colours
  294. "4" = 4bpp = 16 colours
  295. "8" = 8bpp = 256 colours
  296. "D" = Default tile - the tile that is used if no specific tile is provided for
  297.                      the current colour depth of the screen mode.
  298. Different tiles can be defined for different window background colours. They
  299. can also be defined for specific colour depths to speed up plotting. A typical
  300. configuration would be to provide a 16 colour default tile and a specific 256
  301. colour tile for 8bpp modes. This would mean that in 256 colour modes where the
  302. most work is done to perform the tiling, a 1:1 match between the tile and the
  303. screen is provided resulting in the optimum tiling speed with the 16 colour
  304. default tile being used for all other colour depths.
  305.  
  306. See the !Help file of the registered !WimpPatch for more details.
  307.  
  308. The "Use Textures" option selects whether the tiling of window backgrounds is
  309. turned on or off. This option can be on if no tiles have been loaded, the
  310. backgrounds will still be the normal colours though.
  311.  
  312. Clicking on the "Kill Textures" button, turns off textured window backgrounds
  313. and removes the textures file from memory, freeing the memory used.
  314.  
  315. The "Close" button closes the window, no other buttons are present at the bottom
  316. of the window as the actions are performed immediately.
  317.  
  318. ********************************************************************************
  319.  
  320. "Desktop Control Setup" window
  321. -----------------------------
  322.  
  323. This window allows the configuration options that are loaded as the program
  324. starts to be changed and saved.
  325.  
  326. "Icon-Bar Click Open:" group
  327. ----------------------------
  328.  
  329. This group of icons allow the selection of the window that is opened when the
  330. iconbar icon is clicked on with Select and Adjust.
  331. This allows frequently used windows like the "Mode Selector" to be opened
  332. by clicking on the iconbar icon rather then having to use the menu.
  333.  
  334.  
  335. Clicking on "Set" with Select applies the changes made and closes the window,
  336. clicking with Adjust applies the changes but leaves the window open. In either
  337. case the options are not saved and so will be lost when the program is quit.
  338.  
  339. Clicking on "Cancel" closes the window without altering the options.
  340.  
  341. Clicking on "Save" performs the same action as "Set" except that the options are
  342. saved so that they will be used the next time the program is run.
  343.  
  344. Clicking on "Default" changes the options to the default setting without
  345. actually applying them.
  346.  
  347. When the options are saved, the state of the "Round RGB Continuously" option
  348. in the "Edit Palette" window is saved also.
  349.  
  350. ********************************************************************************
  351.  
  352. "CMOS RAM Setup" window
  353. -----------------------
  354.  
  355. This window allows you to change those options in the CMOS RAM that do not have
  356. *configure commands.
  357.  
  358. "Desktop" group
  359. ---------------
  360.  
  361. "Use solid-drags" selects whether solid-drags are turned on for when file icons
  362. are dragged. This will only affect solid-drag aware programs such as this one
  363. which will show the icon of the file as it is moved to it's destination rather
  364. than the normal dotted-line box. Sadly the filer is not solid-drag aware, but
  365. the excellent "FilerPatch" by Jens H. Ovesen (available in most good PD
  366. libraries) provides this and many other useful features.
  367.  
  368. "Use dither more often". With this off the wimp only dithers the grey scale
  369. colours in 2 colour modes. With this on, in all modes, any wimp colour that does
  370. not match any the hardware can display will be dithered.
  371.  
  372. "Use 3D look" selects whether programs should use 2D or 3D windows. This is only
  373. for programs that are aware of this, such as this program and !Printers v1.22+.
  374.  
  375. "Hardware" group
  376. ----------------
  377.  
  378. "Do long power-on tests" selects whether the long or short hardware test is
  379. performed when the computer is first turned on. On ARM 2 machines this takes a
  380. while so you might want to turn it off.
  381.  
  382.  
  383. Clicking on "Change" with Select updates the CMOS RAM with the selections made
  384. and then closes the window, clicking with Adjust updates the CMOS RAM but leaves
  385. the window open.
  386.  
  387. Clicking on "Cancel" closes the window without making any changes.
  388.  
  389. ********************************************************************************
  390.  
  391. Clicking on iconbar icon
  392. ------------------------
  393.  
  394. Clicking with either Select or Adjust on the iconbar icon opens up the windows
  395. configured by the "Desktop Control Setup" window.
  396.  
  397. This allows frequently used windows such as the "Mode Selector" to be brought
  398. up quickly without having to use the menu.
  399.  
  400. ********************************************************************************
  401.  
  402. Auto loading of extension modes
  403. -------------------------------
  404.  
  405. Any Relocatable Modules placed in the "Mode" directory will be loaded by the
  406. program when it starts up. This is included to load modules that provide extra
  407. resolutions and or colours, of which 4 new modes are provided with this program.
  408. They are:
  409.  
  410. Mode  32: 800x600  256 colours.
  411. Mode 116: 1024x348   2 colours.
  412. Mode 117: 1024x348   4 colours.
  413. Mode 118: 1024x348  16 colours.
  414.  
  415. Note: All these modes are for multisync monitors only and are already included
  416. in the multisync resolution menu.
  417.  
  418. IMPORTANT NOTE: Depending on what model of computer you have, your VIDC may not
  419. be able to display mode 32.
  420.  
  421. Older machines with 8Mhz memory (A300, A440, A400/1, A3000) can not display this
  422. mode, even if they have a 36Mhz oscillator fitted, as there is not enough memory
  423. bandwidth. (It will work without a 36Mhz oscillator, but like the other 800x600
  424. modes at this lower refresh rate, the flicker makes it unusable)
  425.  
  426. Machines with the ARM 250 (A30x0, A4000) can display this mode as the memory
  427. and the VIDC is fast enough.
  428.  
  429. The A5000 may be able to display this mode, it depends on the individual VIDC
  430. chip. Chip production is variable and as this mode is near the rated limits of
  431. the VIDC10, some chips may and some may not be able to display it.
  432.  
  433. I don't know whether you will damage your VIDC if it is run out of spec., but
  434. I would advise that you don't use it if you see "snow" on the screen or the
  435. chip gets to hot.
  436.  
  437. ********************************************************************************
  438.  
  439. Configuring the Colour and Resolution menus
  440. -------------------------------------------
  441.  
  442. The colour and resolution menus are defined in the "Messages" file held in
  443. the application directory.
  444.  
  445. Load this file into a text editor such as "!Edit" by double clicking on the
  446. !DeskCtrl icon in the filer window with the shift key pressed to open up the
  447. contents of the application directory and then dragging the "Messages" file
  448. icon to the "!Edit" icon.
  449.  
  450. The colour menu is defined by the line:
  451.  
  452. menu.col:2,4,16,256
  453.  
  454. more colours can be added simply by adding the text to the end
  455. NOTE: When the number of colours is changed, the mode definitions need to be
  456. changed also, see below for details.
  457. Eg.
  458. menu.col: 2,4,16,256,32 thousand,16 million
  459.  
  460. The resolution menu is defined by a line, such as:
  461.  
  462. menu.res3: 320 x 256,640 x 250,640 x 256_,640 x 480
  463.  
  464. There are six resolution menus defined, the number at the end of "menu.res"
  465. indicating for which monitor type they are used. The above example is monitor
  466. type 3, VGA. Note, the menu entry "640 x 256" has an underscore "_" after the
  467. text. This causes a dotted line to be placed below this item in the menu and
  468. can be used to separate groups of mode to make the menu easier to read.
  469.  
  470. Any defined resolutions can be added to the menus, the program does not check
  471. of that particular monitor type can display it, if it can't then the wimp
  472. selects a different mode that is supported.
  473.  
  474. ********************************************************************************
  475.  
  476. Adding mode definitions
  477. -----------------------
  478.  
  479. The definitions of the modes that the colour and resolution menus correspond to
  480. are also present at the end of the "Messages" file. The reason that the
  481. definitions are in the file and not read from the operating system when the
  482. program is running is that it allows multiple modes to be defined with the same
  483. resolution and number of colours. For example, on my system I have my own set
  484. of 800x600 modes defined as modes 108 to 110 and use these instead of modes
  485. 29 to 31 which are provided by RISC OS, thus on my system the definition for
  486. the 800x600 resolution holds the numbers 108 to 110 rather than 29 to 31.
  487.  
  488. A resolution definition comprises of a tag on the left and then a comma
  489. separated list of modes as long as the number of colours defined in the colour
  490. menu, the first number corresponding to the first number of colours entry in
  491. the colour menu and so on. If a resolution does not have a mode number for a
  492. particular number of colours then its mode number is entered as -1.
  493.  
  494. Eg.
  495. m.800x600:  29, 30, 31, -1
  496.  
  497. Would describe the resolution 800x600 (note the m. before the resolution).
  498. This corresponds to a colour menu with 4 entries and this resolution is
  499. undefined in the 4th entry in the colour menu (256 colours).
  500.  
  501. When adding more modes for graphics enhancers etc. , the text between the "m."
  502. and the ":" must match the text in the resolution menu but with the spaces
  503. removed. Thus an entry "m.1024x768:" would correspond to the item "1024 x 768"
  504. in the resolution menu.
  505.  
  506. If the number of colour entries is changed in the colour menu then all the mode
  507. definitions have to be updated to include -1's for the resolutions that do not
  508. support the numbers of colours added.
  509.  
  510. ********************************************************************************
  511.  
  512. Removing "Quit" from the menu
  513. -----------------------------
  514.  
  515. The "Quit" option at the bottom of the iconbar menu can be removed to prevent
  516. the program being accidentally quit:
  517.  
  518. Load the "Messages" file in the !DeskCtrl directory into a text editor such
  519. as !Edit and look for the the line:
  520.  
  521. menu.main:Info,Palette,Mode,Font,Texture,CMOS,Options,Quit
  522.  
  523. and remove the "Quit" entry from the end, thus:
  524.  
  525. menu.main:Info,Palette,Mode,Font,Texture,CMOS,Options
  526.  
  527. and save the file.
  528. The next time !DeskCtrl is loaded, the option will be gone from the menu,
  529. but the program can still be quit using the taskmanager.
  530.  
  531. ********************************************************************************
  532.  
  533. Contacting the author
  534. --------------------
  535.  
  536. I, Andrew Sellors, can be contacted either at
  537.    57 Boundaries Road
  538.    Feltham
  539.    Middlesex
  540.    TW13 5DR
  541.    England
  542.  
  543. Or via Internet email at
  544.    asellors@orac2.demon.co.uk
  545.  
  546. Any feedback from users (bugs reports, requests for new features etc.) is
  547. gladly received. 
  548.  
  549. ********************************************************************************
  550.  
  551. Credits
  552. -------
  553.  
  554. Thanks must go to Paul Coucher who beta tested the previous versions and pointed
  555. out all the bugs in both this program and the outline font patch for the window
  556. manager.
  557.  
  558.  
  559. This program was written with the help of the basic library
  560. linker, !Blib by Ian Palmer and the folowing libraries
  561.  
  562.   Event    - © Ian Palmer, 1st March 1993
  563.   Icon     - © Ian Palmer & Tom Hughes, 1st March 1993
  564.   Memory   - © Ian Palmer, 1st March 1993
  565.   Menu     - © Ian Palmer, 1st March 1993
  566.   Message  - © Tom Hughes 28th January 1993
  567.   OS       - © Ian Palmer, 1st March 1993
  568.   Sprite   - © Tom Hughes 1st March 1993
  569.   Template - © Ian Palmer & Tom Hughes, 2nd March 1993
  570.   Transfer - © Tom Hughes 26th February 1993 
  571.   Window   - © Ian Palmer & Tom Hughes, 1st March 1993
  572.  
  573.  
  574.  
  575.  
  576.