home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 69 / af069sub.adf / AppiSizer / appisizer.doc < prev    next >
Text File  |  1978-02-04  |  17KB  |  459 lines
  1.  
  2. ----------------------------------------------------------------------------------
  3. main
  4. ----------------------------------------------------------------------------------
  5.  
  6.                       AppISizer Guide Summary (16-Oct-93)
  7.  
  8.  
  9.                            '  Copyright           '
  10.                            '  Distribution        '
  11.                            '  Requirement         '
  12.                            '  Nouveau  - New      '
  13.                            '  Introduction        '
  14.                            '  Description         '
  15.                            '  Configuration       '
  16.                            '  Starting AppISizer  '
  17.                            '  Removing AppISizer  '
  18.                            '  Author's address    '
  19.                            '  Usage restrictions  '
  20.                            '  Warranty            '
  21.                            '  Credits & Thanks    '
  22.                            '  Index               '
  23.  
  24. ----------------------------------------------------------------------------------
  25. copyright
  26. ----------------------------------------------------------------------------------
  27.  
  28.                  AppISizer   -  version 0.68   11-Oct-93
  29.  
  30.          © 1992-1993 'Gérard Cornu'  -   Compiled with 'SAS/C ®' 6.3
  31.  
  32.    AppISizer, as well as all the accompanying files, is ©1992-93 Gérard
  33.    Cornu.
  34.  
  35. ----------------------------------------------------------------------------------
  36. warranty
  37. ----------------------------------------------------------------------------------
  38.  
  39.    NO WARRANTY
  40.    ~~~~~~~~~~~
  41.  
  42.    There is no warranty for this software package. Although the 'author'
  43.    has tried to prevent errors, he can't guarantee that the software package
  44.    described in this document is 100% reliable. You are therefore using this
  45.    material at your own risk. The author cannot be made responsible for any
  46.    damage which is caused by using this software package.
  47.  
  48. ----------------------------------------------------------------------------------
  49. distribution
  50. ----------------------------------------------------------------------------------
  51.  
  52.    DISTRIBUTION
  53.    ~~~~~~~~~~~~
  54.  
  55.    This software package is freely distributable. It may be put on any
  56.    media which is used for the distribution of free software, like Public
  57.    Domain disk collections, CDROMs, FTP servers or bulletin board systems.
  58.  
  59.    In order to ensure the integrity of this software package, distributors
  60.    should use the complete original distribution. The author cannot be made
  61.    responsible if this software has become unusable due to modifications
  62.    of the distribution contents or of the distribution files themselves.
  63.    There is no limit on the costs of the distribution, e.g. for the media,
  64.    like floppy disks, streamer tapes or compact disks, or the process of
  65.    duplicating. Such limits have been proven to be harmful to the idea of
  66.    freely distributable software, e.g. instead of reducing the price of the
  67.    floppy disk below the limit, the software was simply removed from the
  68.    master disk.
  69.  
  70.    Although the 'author' does not impose any limit on the distribution of
  71.    this software, he would like to express his personal opinions on this
  72.    matter:
  73.  
  74.       * This software package should be made available to everyone free of
  75.         charge whenever it is possible.
  76.  
  77.       * If you have acquired this software package under normal conditions
  78.         from a Public Domain dealer on a floppy disk at a price higher than
  79.         25FF or US $5, then you have definitely paid too much. Please don't
  80.         support this improper profit making any longer and switch to a
  81.         cheaper source as soon as possible.
  82.  
  83.                                     ---------
  84.  
  85.   'Peter Miles' is certainly allowed to include it in the 'I.C.P.U.G.' Amiga
  86.    library.
  87.  
  88.   'Fred Fish' is obviously allowed to include it in its unique 'AmigaLibDisk'
  89.    library.
  90.  
  91.   'Thierry Colin' is authorised to include it in the 'D.P.A.T.' collection.
  92.  
  93.  
  94.  
  95. ----------------------------------------------------------------------------------
  96. fred
  97. ----------------------------------------------------------------------------------
  98.  
  99.   FRED FISH and the AmigaLibDisk Library:
  100.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  101.  
  102.  
  103.   |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|
  104.   |  As regard to  Fred and the  AmigaLibDisk  library,  don't  forget to  |
  105.   |  contact  your club or  'Fish disks'  distributor to have them take a  |
  106.   |  regular  subscription  to  the  AmigaLibDisk  library, if they don't  |
  107.   |  already have one. This is very important for the future of the Amiga- |
  108.   |  LibDisk library, therefore for the future of the Amiga.               |
  109.   |                                                                        |
  110.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  111.  
  112. ----------------------------------------------------------------------------------
  113. restrictions
  114. ----------------------------------------------------------------------------------
  115.  
  116.    USAGE RESTRICTIONS
  117.    ~~~~~~~~~~~~~~~~~~
  118.  
  119.    No program, document, data file or source code from this software
  120.    neither in whole nor in part, may be used on any machine which is used
  121.  
  122.       * for the research, development, construction, testing or production
  123.         of weapons or other military applications. This also includes any
  124.         machine which is used in the education for any of the above
  125.         mentioned purposes.
  126.  
  127.       * by people who accept, support or use violence against other people,
  128.         e.g. citizens from foreign countries.
  129.  
  130. ----------------------------------------------------------------------------------
  131. requirement
  132. ----------------------------------------------------------------------------------
  133.  
  134.    REQUIREMENT
  135.    ~~~~~~~~~~~
  136.  
  137.    AppISizer needs at least KickStart 37.175 to run, and has been developed
  138.    and tested with KS 37.175 and WB 38.35. Also tested with KS 39.92 (!)
  139.    and WB 40.25. I can't foresee any reason why it shouldn't work with
  140.    higher versions as well.
  141.  
  142. ----------------------------------------------------------------------------------
  143. nouveau
  144. ----------------------------------------------------------------------------------
  145.  
  146.    N E W - N O U V E A U
  147.    ~~~~~~~~~~~~~~~~~~~~~
  148.  
  149.    AppISizer is now localized but supplied only with a french catalog,
  150.    for the time being.
  151.  
  152.    For other languages I rely on nice people who would return to me the
  153.    translated 'empty.ct' file, (see below).
  154.  
  155.    If you have WB2.1 or over, and you wish that AppISizer 'talks' to
  156.    you in French (not a very good french I'm afraid ;-), just copy
  157.    'appisizer.catalog' to your 'LOCALE:catalogs/français/' directory.
  158.  
  159.    If on the other hand, you would like to do a translation in another
  160.    language, use the enclosed 'empty.ct' file, then send 'me' a copy once
  161.    completed. This will allow me to send you the resulting *.catalog file
  162.    and include it in the next release. Thank you in advance.
  163.  
  164.    What's new to AppISizer apart from that and the correction of a little
  165.    bug with the 'ICON_PATH' tooltype and cli option (thanks go to MungWall,
  166.    for showing it to me!)...
  167.  
  168.       - The output display has been made cleaner.
  169.  
  170.       - The closing of the 'window' is now more 'intuitive', you can either:
  171.  
  172.                - press any key (almost any ;-) inside the window
  173.  
  174.                - click the left or middle mouse button inside the window
  175.  
  176.                - click the window's close gadget.
  177.  
  178.  
  179.    The 'size engine' of AppISizer hasn't been modified at all, Why? ...
  180.    I haven't received a single 'error report' about it ;-)
  181.  
  182. ----------------------------------------------------------------------------------
  183. introduction
  184. ----------------------------------------------------------------------------------
  185.  
  186.    INTRODUCTION
  187.    ~~~~~~~~~~~~
  188.  
  189.    AppISizer is the 'Workbenchised' version of my littl'ol' Sizer utility.
  190.    Not only is it Workbenchised, but as soon as it is launched it transforms
  191.    itself into an 'AppIcon' , what a miracle! No... easy, 'thanks' to C= Amiga
  192.    software people, not forgetting the hardware guys!
  193.  
  194.    I almost forgot to tell you something very important, AppISizer SHOULD
  195.    be pronounced 'happy sizer' ;-)
  196.  
  197.  
  198. ----------------------------------------------------------------------------------
  199. appicon
  200. ----------------------------------------------------------------------------------
  201.  
  202.    APPICON
  203.    ~~~~~~~
  204.  
  205.    If you need more info  about 'AppIcons' have a look in the RKRM
  206.    Libraries 3rd edition page 359+ (ISBN 0-201-56774-1), or just try
  207.    AppISizer and you'll quickly know what an AppIcon is ;-).
  208.  
  209. ----------------------------------------------------------------------------------
  210. description
  211. ----------------------------------------------------------------------------------
  212.  
  213.    DESCRIPTION
  214.    ~~~~~~~~~~~
  215.  
  216.    AppISizer puts an 'AppIcon' on your Workbench (see 'configuration').
  217.    Once you drop an icon on top of it, the represented object will be 'sized'
  218.    and a 'window' will open to give you the results.
  219.  
  220.    You can drop several icons at once, using multi or extended selection .
  221.  
  222.    See the doc for Sizer, the shell version, for a detailed explanation of
  223.    the results.
  224.  
  225. ----------------------------------------------------------------------------------
  226. starting
  227. ----------------------------------------------------------------------------------
  228.  
  229.    STARTING APPISIZER
  230.    ~~~~~~~~~~~~~~~~~~
  231.  
  232.    It can be started either by entering its name in a Shell (preceded by
  233.    'run >NIL:', double-clicking on its icon, or by dropping AppISiszer
  234.    in your WBStartup drawer.
  235.  
  236. ----------------------------------------------------------------------------------
  237. removing
  238. ----------------------------------------------------------------------------------
  239.  
  240.    REMOVING APPISIZER
  241.    ~~~~~~~~~~~~~~~~~~
  242.  
  243.    Very easy, just double-click on AppISizer's 'AppIcon' then click on
  244.    'Remove AppISizer'.
  245.  
  246. ----------------------------------------------------------------------------------
  247. configuration
  248. ----------------------------------------------------------------------------------
  249.  
  250.    CONFIGURING APPISIZER
  251.    ~~~~~~~~~~~~~~~~~~~~~
  252.  
  253.    AppISizer (from version 0.61 onward) supports 5 ToolTypes and 5 command
  254.    line options.
  255.  
  256.    The ToolTypes are:
  257.  
  258.       ICON_PATH     <<<<<< before version 0.61 was: APPICON_PATH
  259.       ICON_XPOS     <<<<<<   "       "     "    "   APPICON_XPOS
  260.       ICON_YPOS     <<<<<<   "       "     "    "   APPICON_YPOS
  261.       WINDOW_XPOS   <<<<<< from version 0.61
  262.       WINDOW_YPOS   <<<<<<   "     "     "
  263.  
  264.  
  265.    The command line template is:
  266.  
  267.    ICON_PATH/K,ICON_XPOS/K/N,ICON_YPOS/K/N,WINDOW_XPOS/K/N,WINDOW_YPOS/K/N:
  268.  
  269.    ICON_PATH is for specifying an alternate 'AppIcon' , the full path should
  270.    be given. The '.info' extension is optional. If this tooltype is not
  271.    set or if this path doesn't indicate an icon, AppISizer will use its
  272.    internal icon image.
  273.  
  274.    ICON_XPOS and ICON_YPOS are for the X (left position), and Y (top
  275.    position) of the internal or external 'AppIcon' . Please note that if you
  276.    specify a position which is already occupied by another icon, or if you
  277.    specify either position as 0, or if you supply only one position,
  278.    Workbench will place the AppIcon wherever it sees fit.
  279.  
  280.    WINDOW_XPOS and WINDOW_XPOS are for positioning the top left hand corner
  281.    of the output window.
  282.  
  283.    The following is only for people who don't know how to use tooltypes:
  284.  
  285.       The ones supplied are in the form:
  286.  
  287.       (TOOLTYPE_FOO=<quick explanation text>)    <--- note the parentheses
  288.                                                       and the angle brackets
  289.  
  290.       If for example you want to use the tooltype ICON_PATH, you have first
  291.       to remove the two parentheses, then replace the text and angle brackets
  292.       by your choice i.e.:
  293.  
  294.       ICON_PATH=My_icon_assign:contains/the_nicest_icon
  295.       ICON_XPOS=500
  296.       ICON_YPOS=128
  297.       WINDOW_XPOS=50
  298.       WINDOW_YPOS=25
  299.  
  300.  
  301.    Command line example:
  302.  
  303.    run >NIL: AppISizer icon_path=dir:containing/my_icon icon_xpos=500
  304.    icon_ypos=20 window_xpos=120 window_ypos=25
  305.  
  306.    Those tooltypes and options were added following suggestions I received
  307.    from Lucas Janin, thanks 'Lucas'.
  308.  
  309. ----------------------------------------------------------------------------------
  310. warning
  311. ----------------------------------------------------------------------------------
  312.  
  313.    WARNING
  314.    ~~~~~~~
  315.  
  316.    A quick word about AppISizer and links. Personally I don't use links,
  317.    not yet, I didn't get time to look at them! So AppISizer has not been
  318.    tested with soft or hard links. But don't hesitate to give 'me' any
  319.    information about them and AppISizer's behaviour.
  320.  
  321.  
  322. ----------------------------------------------------------------------------------
  323. author
  324. ----------------------------------------------------------------------------------
  325.  
  326.     Send any suggestion, bug report, compliment ;-), dark chocolate,
  327.     freely distributable software, 16 Gb hard disks, A3 48 bits colour
  328.     scanners, brand new AMIGA 6000 with Alpha CPU, etc...
  329.  
  330.  
  331.     OR JUST A POST CARD (made of dark chocolate!) to:
  332.  
  333.                          Gérard CORNU
  334.                          11 avenue Edouard Aynard
  335.                          69130 ECULLY
  336.  
  337.                          FRANCE.  '(WPC)'
  338.  
  339.  
  340.  
  341.                     Have plenty of nice days! ... me too!
  342.  
  343. ----------------------------------------------------------------------------------
  344. wpc
  345. ----------------------------------------------------------------------------------
  346.  
  347.                           World People Community ;-)
  348.  
  349. ----------------------------------------------------------------------------------
  350. dpat
  351. ----------------------------------------------------------------------------------
  352.  
  353.    D.P.A.T
  354.    ~~~~~~~
  355.  
  356.    French PD library, Domaine Public Amiga Toulouse.
  357.    Started and managed by Thierry Colin at AmigaNews.
  358.  
  359. ----------------------------------------------------------------------------------
  360. icpug
  361. ----------------------------------------------------------------------------------
  362.    I.C.P.U.G
  363.    ~~~~~~~~~
  364.  
  365.    ICPUG is the one and only Independent Commodore Products Users Group.
  366.    ICPUG is a non-profit making voluntary group run by its members for
  367.          its members.
  368.  
  369.    To become a member of this brilliant club contact:
  370.  
  371.    Jack COHEN, ICPUG Membership secretary, P.O. Box 1309,
  372.    LONDON, N3 2UT, ENGLAND.
  373.  
  374. ----------------------------------------------------------------------------------
  375. thanks
  376. ----------------------------------------------------------------------------------
  377.  
  378.    (in alphabetical order...)
  379.  
  380.  
  381.    Amiga                For being the best platform to 'work' on.
  382.  
  383.    Commodore-Amiga      For making and improving it.
  384.    Software and
  385.    Hardware Teams
  386.  
  387.   'Fred Fish'           For the much helpful 'AmigaLibDisk library'.
  388.  
  389.   'I.C.P.U.G.'          For all the nice guys and gals making it!
  390.  
  391.    Jen Allen            For the chocolate bar, and everything else!
  392.  
  393.    Joy & John Harding   For their kindness, and for showing me their nice 
  394.                         Devon country.
  395.  
  396.    Lucas Janin          For being the first AppISizer user to tell me so!
  397.  
  398.    Paul OVERAA          For an helpful article deciding me to start to
  399.                         write Sizer, then AppISizer.
  400.  
  401.    Peter Miles          For supplying me with AmigaLibDisks, and all the help.
  402.  
  403.   'SAS/C ®' Team        For my preferred compiler environment.
  404.  
  405.    Stefan Becker        For the indispensable ToolManager, and for letting
  406.                         me use his disclaimer.
  407.  
  408.    Thierry Colin        For having upgraded (just kidding!)
  409.  
  410.  
  411.    And all the other people for supporting me and/or the Amiga ;-)
  412.  
  413. ----------------------------------------------------------------------------------
  414. index
  415. ----------------------------------------------------------------------------------
  416.  
  417.    APPISIZER GUIDE INDEX
  418.    ~~~~~~~~~~~~~~~~~~~~~
  419.    '     AmigaLibDisk     '
  420.    '     AppIcon          '
  421.    '     Author           '
  422.    '     Bug report       '
  423.    '     Catalog          '
  424.    '     Chocolate        '
  425.    '     CLI options      '
  426.    '     Compliments      '
  427.    '     Configuration    '
  428.    '     Copyright        '
  429.    '     Credits          '
  430.    '     Description      '
  431.    '     Distribution     '
  432.    '     D.P.A.T.         '
  433.    '     Français         '
  434.    '     Fred FISH        '
  435.    '     French           '
  436.    '     I.C.P.U.G.       '
  437.    '     Introduction     '
  438.    '     Languages        '
  439.    '     Links            '
  440.    '     Localisation     '
  441.    '     New              '
  442.    '     Nouveau          '
  443.    '     Output window    '
  444.    '     Post card        '
  445.    '     Removing         '
  446.    '     Requirement      '
  447.    '     Restrictions     '
  448.    '     Shell            '
  449.    '     Starting         '
  450.    '     Suggestions      '
  451.    '     Tested           '
  452.    '     Thanks           '
  453.    '     Tool types       '
  454.    '     Usage            '
  455.    '     Warranty         '
  456.    '     WBStartup        '
  457.    '     Window           '
  458.    '     Workbench        '
  459.