home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / desktop / palette / !Palette+ / !Help < prev    next >
Text File  |  1993-02-27  |  13KB  |  219 lines
  1.  
  2.             Help file for Palette Plus.
  3.             ===========================
  4.  
  5.        This programme is ©1991 to P.R.Banks (me) but it may be copied and
  6.    duplicated for use as long as all files stored in its sub-directory are
  7.    copied as well. I withhold all rights to the code contained in it and if
  8.    you wish to use code from this application you must obtain permission in
  9.    writing from myself. Not that it is particularly worth it as the code is
  10.    fairly simple.
  11.        To use it double click on it and it will load itself and ,dependant
  12.    on the setting of its configuration file, open a window showing informat-
  13.    ion on the current screen mode. Clicking select on the icon will open this
  14.    window (if it is closed) or reopen it at the top of the screen if it is
  15.    not open. The auto-open option can be turned off. Clicking menu will
  16.    present you with this menu :-
  17.  
  18.    ----------------
  19.    | Palette Plus | ----------
  20.    ---------------- | Status |
  21.    | Info      -» | ----------
  22.    | Status    -» | | View   |
  23.    | Revise List  | | Save   |
  24.    | Find Mode    | ----------
  25.    | Mode List    |
  26.    | Quit         |
  27.    ----------------
  28.  
  29.    'Info'       :- leads to a standard window informing you who wrote this 
  30.    and what it does....boring I know but it does keep to the standard.
  31.  
  32.    'Revise List':- does precisely that and updates the programmes list of 
  33.    what modes are available for use. You should use this option whenever you
  34.    load or kill a module that has screen mode definitions in it. It must be
  35.    noted that non wimp modes are ignored (ie mainly modes 3,6 & 7). This is
  36.    because I felt it was pointless including modes that cannot be reached
  37.    from the Wimp.
  38.  
  39.    'Find Mode'  :- Opens a window that allows you to search for a desired
  40.    screen mode. To use the window fill all the white Desired Statistics icons
  41.    with the wanted X resolution,Y resolution & Colours of the screen you want
  42.    . Either hitting return when the caret is in the Colours white icon or
  43.    clicking on the 'Search' icon will cause the programme ,using the config-
  44.    ured search scheme,to look for the best fit mode currently available. This
  45.    option is most useful when you are porting images from other machines and
  46.    you want to find the best Archimedes screen to display them in. The search
  47.    algorithm makes no assumptions about the machines hardware and will take 
  48.    advantage of Multisync,VGA or High Res Monochrome monitors as well as the
  49.    standard Arc monitor. Also any graphics cards installed,if they inform the
  50.    O.S. in the correct way,will be taken advantage of. Of course if you are 
  51.    using a High Res Monochrome monitor expect predictable answers!
  52.  
  53.    'Mode List'  :- This opens a window that lists all known screen modes with
  54.    their colours and resolutions. If the 'SafetyLock' is off clicking on the
  55.    window will select the screen mode currently highlighted allowing you to
  56.    pick and choose for yourself!
  57.  
  58.    'Quit'       :- Well if you can't guess what this does you are using the
  59.    wrong machine! Please note the configuration settings you are using must
  60.    be explicitly saved and the programme will let you quit without saving 
  61.    them! (This is mainly because the configuration settings are so trivial
  62.    ...)
  63.  
  64.    'Status'     :- This leads to a sub menu which allows you to alter or save
  65.    your configuration of this programme and it has two options :-
  66.                  'View' opens the configure window that allows you to set the
  67.                         Search Type used. X and Y searches do so by selecting
  68.                         all modes with the right colours and then selecting 
  69.                         out of this sub list by X or Y resolutions first 
  70.                         fitting the second resolution last. This can lead to
  71.                         different results depending on the information 
  72.                         entered in the white Desired statistics icons. X:Y 
  73.                         Ratio searches for a screen mode with the closest 
  74.                         fitting Ratio of Pixels to that entered. When X:Y 
  75.                         Ratio search meets two screen modes with equally good
  76.                         ratios it selects the one with the highest number of
  77.                         pixels so that the screen mode with the greatest 
  78.                         chance of displaying all of the picture at once is 
  79.                         chosen.In general the order of preference of search
  80.                         is :-
  81.                                        X:Y Ratio (because this preserves the
  82.                                                   correct image aspect)
  83.                                        X first   (because Y compression is
  84.                                                   less noticable than X)
  85.                                        Y first   (for the reasons above)
  86.                         Other flags to be set or unset are 'safetylock',
  87.                         'close on select' & 'open at start up'.
  88.                             'SafetyLock' :- When set it locks the Mode List
  89.                              window so that clicking on it has no effect. 
  90.                              This is to allow you to prevent accidental 
  91.                              clicking on the window creating havoc with the
  92.                              machine suddenly changing screen mode! This can
  93.                              and has caused problems for me before....
  94.                             'Close on Select' :- This ,when set, causes the
  95.                              mode list window to close when clicked on with 
  96.                              the select mouse button (The left most button).
  97.                              This is to give the window a 'Menu' feel that 
  98.                              you can select a mode and the window will go 
  99.                              away. It also means that the chances of an 
  100.                              accidental clicking on this window are reduced 
  101.                              as it does not stay around on screen till you 
  102.                              call it. Please note when the safety lock option                                is set this option is ignored....
  103.                             'Open at Start Up' :- This controls whether the
  104.                              application opens it's main window when it is
  105.                              started. Setting it to off does give the
  106.                              application a more 'RISC-OS' feel to it as all
  107.                              you see is the icon on the icon bar till you
  108.                              summon the main window...
  109.                  'Save' saves the Search type used the 'Safetylock','Close on
  110.                         Select' & 'Open at Start Up' setting to the config 
  111.                         file in the application directory. When the 
  112.                         application is next started these settings will,of 
  113.                         course,be preserved. This is merely to prevent a 
  114.                         ritual of setting these options everytime you start 
  115.                         the application up.
  116.  
  117.    At any time you may use the Help application on the Risc OS Application
  118.    Disk 1 to aid you. The help works in any of the windows and is context
  119.    sensitive. And that is the lot really. This application was designed 
  120.    because there are alot of public domain modules about that provide new 
  121.    screen modes and don't document their exsistence at all (StrongED by 
  122.    Guttorm 'Armstrong' Vik is a prime example in providing mode 127...) also
  123.    the desktop palette utility is a little sparse in detail when it comes to
  124.    screen modes where it expects you to go hunting through manuals to find 
  125.    detailed information. It is so much nicer to have this information 
  126.    presented online as it were....
  127.        If this programme makes it out of the Wellington region of New
  128.    Zealand I would appreciate either a letter or (preferrably) an email
  129.    message to me at 'banks_p@kosmos.wcc.govt.nz'. The email address is valid
  130.    indefinitely for the moment. The address for the letter is:-
  131.  
  132.         Mr P.R.Banks,
  133.        10 Southgate Rd,
  134.          Island Bay,
  135.          Wellington 2,
  136.          New Zealand.
  137.  
  138.        Of course any bug reports or suggestions for improvement will be
  139.    welcomed to either of these addresses too. Well have fun with this
  140.    programme and I hope you get as much enjoyment out of using it as I have
  141.    gained out of writing it.
  142.  
  143.    Version History
  144.    ===============
  145.  
  146.    Version  | Comments
  147.    ------------------------------------------------------------------
  148.    0.00     | Simple non 'Wimped' version. (25-Jul-1990)
  149.    0.01     | First Wimp version and first Publicly released version. 
  150.             |   (28-Jul-1990)
  151.    0.02     | Tidied up some internal window handling (29-Jul-1990)
  152.    1.01     | Added the 'mode search' function and attendant routines.
  153.             |   Not bad I reckon for not having my Manual on the Wimp
  154.             |   here! Needs more work though.... (28-Aug-1990)
  155.    1.02     | Added the Hourglass function to 'Acornise' the program
  156.             |   properly. Still haven't got my manual back and I need
  157.             |   to add caret handleing to the dialogue box!!!
  158.             |   (19-Oct-1990)
  159.    1.03     | Added Caret handleing and some key processing to the
  160.             |   find mode window.Still no sign of the manual....
  161.             |   :-( (3-Jan-1991)
  162.    1.04     | Updated the Hourglass percentage generator to give a
  163.             |   more realistic percentage. Added the beginings of
  164.             |   the Mode List window.Added the icon handling code
  165.             |   in preparation for this window. (3-Jan-1991)
  166.    2.00     | Added the Mode List window in full. This version now
  167.             |   presents you with a full list of all current modes
  168.             |   and allows you to select a mode at the press of a
  169.             |   rodent! (5-Jan-1991)
  170.    2.01     | Added the code to fix a redraw window problem...I tell
  171.             |   ya *never* try to get the wimp to draw icons upside-
  172.             |   down by putting the max y in the min y and vice verca..
  173.             |   .. The wimp does some very unusual things. (5-Jan-1991)
  174.    2.02     | Added two new search types instead of the fixed X first
  175.             |   search. Added the icons to handle the new code. Began
  176.             |   making the configuration window. (5-Jan-1991)
  177.    2.03     | Added the 'Safetylock' feature to prevent accidents switching
  178.             |   the screen mode about. (5-Jan-1991)
  179.    2.04     | Added the configuration save feature and tidied up the iconbar
  180.             |   code. Now it *always* displays the icon! (5-Jan-1991)
  181.    2.05     | Added a new icon to the main window to display the total no.
  182.             |   of modes known to the program. (5-Jan-1991)
  183.    2.06     | Added the code to handle the suggestions sent to me by email
  184.             |   to configure whether you want the main window to open at
  185.             |   start up and whether the mode list window acts like a menu
  186.             |   or a window. (20-Feb-1991)
  187.    2.07     | Added the code for interactive help from the Help application
  188.             |   on the Risc OS Applications Disk 1. Even made the help
  189.             |   context sensitive! (10-Mar-1991)
  190.    2.08     | Tidied up the window code a bit more (some nice interface
  191.             |   touches) and cleaned up the interactive help some more.
  192.             |   It now gives a default level of help on windows without
  193.             |   having to query an icon. (04-May-1991)
  194.    2.09     | Added a new memory monitoring variable to prevent errors in the
  195.             |   Wimp_Slot sizing and tided up a memory allocation error.
  196.             |   (15-May-1991)
  197.    2.10     | Corrected a memory dimensioning error which caused the program
  198.             |   to run out of memory and die on a 1 meg machine (*blush*). 
  199.             |   Now once all functions have been used once no more memory is
  200.             |   needed. (17-May-1991)
  201.    2.11     | General tidying up internally. Added a few more help messages.
  202.             |   Thats about it really. (18-May-1991)                    
  203.    2.12     | Corrected it for use with ScResizer so that it auotmatically 
  204.             |   updates it's mode list window for the current screen mode.
  205.             |   Altered the mode list window so that non-wimp modes no longer
  206.             |   show up. Corrected a few potentialy embarrising errors 
  207.             |   regarding memory usage. <sigh...> now up to 56K on a 1 Meg 
  208.             |   machine. So much for keeping it small! (15-Jun-1991)
  209.    2.13     | `Templated' the information window to save on internal space.
  210.             |   Added the attendant code to handle this. Also compacted the
  211.             |   mode list window to help on space as well. (15-Jun-1991)
  212.    2.14     | Cured a small bug in a procedure thats stops non fatal but
  213.             |   annoying errors. <Sigh> always remember your special cases!
  214.             |   As my Comp Lecturer tells my class every so often. 
  215.             |   (13-Jul-1991)
  216.    2.15     | Fixed a minor open_window bug that caused problems under RO3.
  217.  
  218.    If this file flashed by too fast to read load in !Edit and try again. And
  219.    if you can't manage that I *really* can't help you.... :-)