home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / may94 / util / wb / picicon.lha / PicIcon / Doc / PicIcon.doc next >
Text File  |  1994-04-05  |  18KB  |  552 lines
  1.                PicIcon 1.03 - Icon Image Generator
  2.  
  3. Table of Contents
  4.  
  5.    1.0 Introduction
  6.    2.0 Copyright
  7.    3.0 Using PicIcon
  8.        3.1 CLI Startup
  9.        3.2 Workbench Startup
  10.            3.2.1 Tooltypes
  11.    4.0 Hints and Tips
  12.    5.0 Note for Workbench 3.0
  13.    6.0 Limitations
  14.    7.0 Bug reports
  15.    8.0 Change History
  16.    9.0 Acknowledgments
  17.       
  18.  
  19. 1. Introduction
  20.  
  21. PicIcon takes an IFF image file, both ILBM and ANIM formats are supported,
  22. and creates an icon image showing the contents of the file. This allows
  23. images to be more easily recognised from the Amiga Workbench.
  24.  
  25. PicIcon be used from both the CLI and Workbench, although it is more suited
  26. to the Workbench environment with some functions only being available via
  27. Workbench.
  28.  
  29. PicIcon is distributed as shareware. This version is fully functional
  30. however a requester saying that is not registered will appear after
  31. a number of files have been processed. See the copyright section for
  32. details on how to register.
  33.  
  34. PicIcon requires AmigaDOS 2.04 (V37) or later to run.
  35.  
  36.  
  37. 2. Copyright
  38.  
  39.                   PicIcon release 1.03
  40.  
  41. PicIcon 1.03 and PicIcon project icon (hereinafter "Files") and
  42. their related documentation and examples
  43. (c) Copyright 1994 Michael J. Sheppard. All Rights Reserved.
  44.  
  45. This version of PicIcon is shareware. Permission is given to distribute
  46. these Files freely via any means which preserves its copyrights. The
  47. Files may not be sold for profit. Any distribution must include both
  48. the PicIcon License file and the PicIcon documentation drawer complete
  49. with contents.
  50.  
  51. The registered version of PicIcon contains the full source code and
  52. removes the shareware message from it's operation. To register send
  53. 10 UK pounds, or $15 US, to ;
  54.  
  55.    PicIcon Registration.
  56.    M.J.Sheppard
  57.    163, Sapgate Lane,
  58.    Thornton
  59.    Bradford
  60.    BD13 3DY
  61.  
  62. If you include an Internet email address with your registration then I
  63. will keep you informed of updates to PicIcon and their availability. 
  64.  
  65. These Files and their related documentation and examples are provided
  66. "AS-IS" and subject to change without notice; no warranties are made.
  67. All use is at your own risk. No liability or responsibility is
  68. assumed.
  69.  
  70.  
  71. 3. Using PicIcon
  72.  
  73. PicIcon can be started from either the Workbench or CLI.
  74.  
  75. PicIcon has two modes of operation. It can either try and match the colours
  76. in the file with those currently in use by Workbench, or just assign colours
  77. on a modular basis i.e. Areas in colour 1 in the file appear as colour 1 in
  78. the icon. For any file whose image has greater than 256 colours PicIcon will
  79. always try to match the colours. For images with fewer than 256 colours the
  80. method used can be set by the user via the match colours checkbox on the
  81. settings window.
  82.  
  83. When matching colours PicIcon looks for the nearest colour based on colour
  84. intensity. This can result is some unexpected colour choices. For example
  85. for a greyscale image PicIcon may introduce some colour in the icon this is
  86. because there aren't enough greys in the Workbench palette to match all of
  87. the colours to a grey. More information about PicIcons colour matching can
  88. be found in the Hints and Tips section of this document.
  89.  
  90.  
  91. 3.1 CLI Startup
  92.  
  93. PicIcon processes all of the files listed on the command line and exits.
  94. If an error is detected when processing a file then PicIcon will continue
  95. to the next file if possible.
  96.  
  97. The command template for PicIcon is as follows;
  98.    
  99. PicIcon FILES/M,SETTINGS/K,WIDTH/K/N,HEIGHT/K/N,DEPTH/K/N,QUIET/S,ALL/S
  100.  
  101.    FILES/M
  102.  
  103.    A list of files to create icon images for. if this is an AmigaDOS pattern
  104.    PicIcon will process all files that match the pattern.
  105.              
  106.    E.g.
  107.      PicIcon  #?.ham
  108.             
  109.      Will create icon images for all files in the current drawer having
  110.      names ending in '.ham'.
  111.  
  112.    SETTINGS/K
  113.  
  114.    This is the name of a file containing PicIcon settings to use
  115.    when processing the files. New settings files can be created
  116.    using the Settings window.
  117.  
  118.    If this parameter is not present then PicIcon will load the
  119.    default settings file, S:PicIcon.config.
  120.  
  121.    WIDTH/K/N
  122.  
  123.    This is the width, in pixels, of the icons created by PicIcon.
  124.    This value overrides the value stored in the settings file. 
  125.    Default = 48
  126.  
  127.    HEIGHT/K/N
  128.  
  129.    This is the height, in pixels, of the icons created by PicIcon.
  130.    This value overrides the value stored in the settings file.
  131.    Default = 20
  132.  
  133.    DEPTH/K/N
  134.  
  135.    This is the depth, in planes, of the icons created by PicIcon.
  136.    This value overrides the value stored in the settings file.
  137.    This effects the number of colours used in the icons and can
  138.    be 2, 3 or 4 for 4, 8 or 16 colours respectively.
  139.    Default = 3 ( 8 colours ).
  140.  
  141.    Note: Under Workbench 3.0 the choice of icon depth is limited
  142.      to 2 or 3 giving 4 or 8 colours only. This is due to the
  143.      change in colour handling introduced for Workbench 3.0.
  144.  
  145.    QUIET
  146.  
  147.    By default PicIcon displays the names of the files as it processes
  148.    them.  Setting this flag stops PicIcon from displaying this
  149.    information.
  150.  
  151.    ALL
  152.  
  153.    This flag causes PicIcon to process all of the files in the
  154.    directories specified in the FILES argument, including any
  155.    subdirectories that they might have.   
  156.  
  157.  
  158. 3.2 Workbench Startup
  159.       
  160. To start PicIcon from Workbench double-click on the PicIcon icon with the
  161. left mouse button. After a few seconds an application icon will appear on
  162. the Workbench. 
  163.  
  164. PicIcon recognises an number of tooltypes to modify it's operation;
  165. SETTINGS, WIDTH, HEIGHT, DEPTH, QUIET, FONT and FONTSIZE. These are
  166. described in detail below.
  167.  
  168. To create an image drag the icon of a file onto the application icon and
  169. release the mouse button. PicIcon will then process the file and create
  170. an icon image.
  171.  
  172. If you double-click on the application icon a window is displayed allowing
  173. you to change the current settings used to create icons.
  174.  
  175. To stop PicIcon either double-click on the PicIcon disk icon, or select the
  176. quit item on the settings window menu bar.
  177.  
  178. 3.2.1 Tooltype descriptions
  179.  
  180.    SETTINGS=<filename>
  181.  
  182.    This is the name of a file containing PicIcon settings to use
  183.    when processing the files. New settings files can be created
  184.    using the Settings window.
  185.  
  186.    If this parameter is not present then PicIcon will load the
  187.    default settings file, S:PicIcon.config.
  188.  
  189.    WIDTH=<pixels>
  190.  
  191.    This is the width, in pixels, of the icons created by PicIcon.
  192.    This value overrides the value stored in the settings file. 
  193.    Default = 48
  194.  
  195.    HEIGHT=<pixels>
  196.  
  197.    This is the height, in pixels, of the icons created by PicIcon.
  198.    This value overrides the value stored in the settings file.
  199.    Default = 20
  200.  
  201.    DEPTH=<planes>
  202.  
  203.    This is the depth, in planes, of the icons created by PicIcon.
  204.    This value overrides the value stored in the settings file.
  205.    This effects the number of colours used in the icons and can
  206.    be 2, 3 or 4 for 4, 8 or 16 colours respectively.
  207.    Default = 3 ( 8 colours ).
  208.  
  209.    QUIET
  210.  
  211.    By default PicIcon displays a window showing the progress is it
  212.    making processing each file. This option stops this window appearing.
  213.    This can be overridden using the Quiet option on the Settings menu.
  214.  
  215.    FONT <name>
  216.  
  217.    PicIcon uses the system default font for all windows. This option
  218.    allows you to specify a particular font to use for the windows.
  219.  
  220.    The FONTSIZE tooltype should be used to set the size of the font.
  221.  
  222.    FONTSIZE <pixels>
  223.  
  224.    This tooltype allows you to set the size of the font given in the
  225.    FONT tooltype.
  226.  
  227.    Settings Window
  228.  
  229.    The settings window allows you to modify the current settings used to create
  230.    icon images. It is activated by double-clicking on the PicIcon application
  231.    icon. The effects of the changes are controlled by the three buttons at the
  232.    bottom of the window, Save, Use, and Cancel. No changes made to the window
  233.    will have any effect on the creation of images until one of these three
  234.    buttons is pressed.
  235.  
  236.    The settings that can be changed from this window are ;
  237.  
  238.    Width:
  239.  
  240.    Gadget Type  : Slider   
  241.    Value range  : 20 - 80 pixels
  242.    Shortcut key : w
  243.  
  244.    This gadget allows you to change the width of the icons produced. When making
  245.    changes to the dimensions of the icon you should consider the di