home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 131.lha / AddIcon.doc < prev    next >
Encoding:
Text File  |  1986-11-21  |  15.3 KB  |  462 lines
  1.                           AddIcon Users Manual
  2.  
  3.                               Version 2.0
  4.  
  5.                                 5/19/88
  6.  
  7.  
  8.     AddIcon Version 2.0 © 1988 Stormgate Software
  9.  
  10.     Donald T. Meyer
  11.     7 Homestead
  12.     St. Peters, MO 63376
  13.  
  14.  
  15.  
  16.   THE COMMERCIAL PLEA:  -----\
  17.                         ---| |
  18.                            | |
  19.                           \   /
  20.                            \ /
  21.                             V
  22.  
  23.    This software is being distributed as shareware.  If you like it and
  24. use it, please do your part for the shareware concept (not to mention
  25. my computer-based indebtedness :-{) and register as a user by sending
  26. $10 in small, unmarked bills to the above address.  This will not only
  27. entitle you to support (which should not really be needed a whole lot)
  28. but will also get you the next version of this program if I write a
  29. next version.  Who knows, maybe some other stuff I have written or will
  30. write may also find it's way onto the disk?!  By the way, that $10 is
  31. not set in stone.  More would be fine (surprised?), but so would less,
  32. although you may very well NOT get an update disk should there be one. 
  33. Support also might not provide 100% correct answers... ;-{)
  34.  
  35.  
  36.  
  37.   CHEAPSKATES AND IMPOVERISHED AMIGA FANATICS RESUME READING.
  38.  
  39.                           | |
  40.                           | |
  41.                          \   /
  42.                           \ /
  43.                            V
  44.  
  45.  
  46.  
  47.  AddIcon is a utility program which will automaticly create icons for
  48. files which do not have them, or even files that do if you so desire. 
  49. This is it's simplest use.  It's more complex capabilities also allow
  50. it to selectivly replace "pieces" of existing icons.  Icons are not
  51. actually "created", rather there is a directory which contains icon
  52. templates which are cloned as required.  These templates are nothing
  53. more than normal icons, which the user may modify and add to as
  54. desired.
  55.  
  56.  
  57.  When AddIcon is started (from CLI or WorkBench), the main window is
  58. always opened.  This contains two string gadgets which allow entry of
  59. the directory and, optionaly, the specific file to create icons for. If
  60. just a directory is specified, icons will be created for all files
  61. which it contains.  If a filename is also specified, an icon will be
  62. created for that file only.
  63.  
  64.  The file "AddIcon.config" contains the data which allows customization
  65. of AddIcon, as well as storing menu status's, window positions and
  66. sizes, etc.
  67.  
  68. Please note that in the following text, the words "drawer" and
  69. "directory" are used interchangably.
  70.  
  71.  
  72.  
  73.  
  74.   ==================  MAIN WINDOW GADGETS  =====================
  75.  
  76.  
  77. Clicking the close gadget will cause the program to exit.
  78.  
  79. The  "Drawer:"  string gadget allows you to enter the name of a
  80. directory in which files to add icons to can be found.  If no filename
  81. is present in the  "Filename:"  gadget, icons are added for all files
  82. contained in the given drawer.  If a filename has been typed into the 
  83. "Filename:"  gadget, only this file will have an icon created for it.
  84. Wildcards may also be used in the filename gadget.  These are very
  85. simple, of the form  "*.c" or "fred.*".  The asterisk is a wildcard
  86. matching anything, and can appear only once, at the beging or the end
  87. of the name.  The period is not neccessary.  Here are some further
  88. examples:
  89.    *.doc
  90.    *totals
  91.    *q
  92.    a*
  93.    January*
  94.    q*a         INVALID    wildcard in middle
  95.    fredand*me  INVALID    wildcard in middle
  96.    *amiga*     INVALID    two wildcards
  97.    **timmy     INVALID    two wildcards
  98.  
  99.  
  100.  
  101.  The START! gadget begins the icon creation process, as does pressing
  102. return while the   Drawer:   gadget is selected.
  103.  
  104.  
  105.  The STOP! gadget will cause an in-progress creation to halt.  This is
  106. really only usefull if icons are being added to all files in a
  107. directory.
  108.  
  109.  
  110.  There are two versions of AddIcon.  In the smaller one, the file
  111. requester gadget does not function.
  112.  In the larger version, this will cause a file requester to pop up,
  113. allowing easy selection and browsing of directories and files.
  114. **As of 2.0 the larger version is not complete**
  115.  
  116.  
  117. It is also possible to select files and drawers from the workbench via
  118. "extended selection".  If you select a drawer for example, then hold
  119. down the <shift> key and double-click AddIcon, the filename string
  120. gadget will contain a message indicating that when AddIcon was started,
  121. there were some object selected on the Workbench.  Clicking the start
  122. gadget would then cause AddIcon to process the item or items as if they
  123. were typed into the string gadgets.
  124.  
  125.  
  126.   =========================  MENUS  ================================
  127.  
  128.  
  129.         PROJECT MENU
  130.  
  131.     Source Directory
  132.  
  133. Allows changing directory where templates come from.  All icons are
  134. cloned from a template icon of your choosing.  This menu selection will
  135. present you with a requester showing the current directory that AddIcon
  136. expects to find the templates in.  It can then be changed to any
  137. directory that you choose.
  138.  
  139.  
  140.     Load Config
  141.  Load a new configuration file.  A requester will be presented in which
  142. you can enter the filename of the desired configuration file to load.
  143. The ability to load and save the current program configuration is a
  144. very handy way to customize AddIcon based upon your habits.  When
  145. AddIcon is started, it begins a search for a file named
  146. "AddIcon.config".  Several directories are searched until this file is
  147. found.  First is the directory AddIcon is in (if launched from
  148. WorkBench) or the "current directory" if launched from CLI.  Second is
  149. the root directory ( ":" ).  The last place AddIcon looks is in the
  150. "S:" directory.  When found, the configuration file is loaded which
  151. establishes most of AddIcon's operating parameters.  For more
  152. information about this file see the section titled "Configuration File
  153. Details".
  154.  
  155.  
  156.     Save Config
  157.  
  158. Save the current configuration to a file.  This will bring up a
  159. requester which will allow you to specify the filename to save the
  160. current configuration as.  For more information see above "Load Config"
  161. and the section titled "Configiration File Details".
  162.  
  163.  
  164.     Open List Window
  165.  
  166. Opens the listing window.  If the listing window is closed, this will
  167. cause it to be opened.  The listing window is used by AddIcon to show
  168. which files it is working on and which icon it has decided to add, also
  169. for other various messages.  If started from CLI, these messages will
  170. instead be sent to the CLI window.  This information is for information
  171. only.  Any error messages, etc. will appear in a requester.
  172.  
  173.  
  174.     Help
  175.  
  176. **not implemented in 2.0**
  177.  
  178.  
  179.     About
  180.  
  181. Tells a little about whodunit.
  182.  
  183.  
  184.     Quit
  185.  
  186. Exits the program.
  187.  
  188.  
  189.  
  190.  
  191.         TYPES MENU
  192.  
  193.     Projects
  194.  
  195. If checked, icons for 'regular' files will be created.
  196.  
  197.  
  198.     Tools
  199.  
  200. If checked, icons for executable programs will be created.
  201.  
  202.  
  203.     Drawers
  204.  
  205. If checked, directories will have icons created for them.
  206.  
  207.  
  208.     Trashcan
  209.  
  210. If checked, trashcan icons can be created.  This one is not too usefull
  211. since the only way to tell a trashcan directory from a normal one is by
  212. the name.  AddIcon does not look at the name.  Perhaps it should?
  213.  
  214.  
  215. These control the types of icons created.  This acts mainly as a filter
  216. which can prevent some types of icons from being created.  It in no way
  217. will cause the type of the template used to be changed.
  218. This type applies to the type of the template icon, not the
  219. destination icon (even if there is one).  
  220. For example, if "Tools" was the only one checked, only icons whose
  221. template type was TOOL would be created.  If AddIcon determined that
  222. the icon to add was PROJECT, TRASHCAN, or DRAWER then no icon would be
  223. created for that file since their corresponding type was not checked.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.         PIECES MENU
  230.  
  231.     Image
  232.  
  233. The graphic picture which is seen on the workbench.
  234.  
  235.  
  236.     Default Tool
  237.  
  238. The tool which is started by workbench to use this project file.
  239.  
  240.  
  241.     Type
  242.  
  243. whether the icon represents a Tool, Project, Trashcan, etc.
  244.  
  245.  
  246.     Position
  247.  
  248. Where in the window the icon will be positioned.
  249.  
  250.  
  251.     Stack Size
  252.  
  253. Used by workbench to allocate some memory used by a Tool.
  254.  
  255.  
  256.     Tool Types
  257.  
  258. Parameter information which is sometimes used by Workbench tools to
  259. tell something about a file.  See the v1.2 Notepad documentation for
  260. some examples of this kind of data's usage.
  261.  
  262.  
  263.     Drawer Data
  264.  
  265. For a drawer icon, this is what determines where and how big the window
  266. is when you open the drawer.
  267.  
  268.  
  269.  These control whether all or part of an existing icon is replaced.  If
  270. all are checked, then the new icon is an exact clone (exception:
  271. position will ALWAYS be set to 'free floating') of the template icon.
  272.  If some of these are unchecked, only the pieces checked will be
  273. replaced in the pre-existing icon. This is useful to change images
  274. while leaving position, etc. alone, also to add or change a default
  275. tool for some icons.  This is an advanced feature which can be very
  276. usefull if you understand what types of information is contained in an
  277. icon.
  278. Example:  All your artwork icons look like picture frames.  You have
  279. just drawn or found an icon that you think is great, and would like all
  280. your artwork to have this picture.  Quite a job since you have 300
  281. picture files on your hard drive!  With AddIcon, simply put the new
  282. icon in your AddIcon template directory, giving it the correct name so
  283. AddIcon will use it as the ILBM template.  On this menu, un-check
  284. everything but "Image".  Now run AddIcon upon the directory which
  285. contains your picture files.  Only the image will be replaced.  The
  286. location in the drawer, default tools, ect. will not be touched!
  287.  
  288.  
  289.  
  290.  
  291.         OPTIONS MENU
  292.  
  293.     Ask Before Creating New Icons
  294.  
  295. If this is checked, a requester will be presented asking the user if an
  296. icon should be indeed created on a file-by-file basis.  This is really
  297. usefull only when adding icons to all the files in a directory.
  298.  
  299.  
  300.     Replace Existing Icons
  301.  
  302. If this is checked, existing icons will be replaced with whatever
  303. template icon AddIcon decides is appropriate.
  304.  
  305.  
  306.     Ask Before Replacing Existing Icons
  307.  
  308. If "Replace Existing icons" is checked, this item will then determine
  309. if the user should be asked prior to replacement.
  310.  
  311.  
  312.     Do Sub directories
  313.  
  314. This will cause all directories "under" the specified directory to have
  315. icons created for their files.  For example, if this is checkmarked and
  316. you select DF0: as the directory to add icons to, all files on DF0:
  317. will be processed, even if they are in subdirectories like DF0:c/more or
  318. DF0:mystuff/private/secret.
  319.  
  320.  
  321.  
  322.  
  323.         STARTUP MENU
  324.  
  325.     Auto File Requester
  326.  
  327. In the large version of the program, this will cause the file requester
  328. to always be presented to the user as the means of specifeing a
  329. directory or file.
  330.  
  331.  
  332.     Do Selected
  333.  
  334. If this is checked, any files or directories "extended selected" on the
  335. workbench when this program is started will have icons created for
  336. their files.
  337.  
  338.  
  339.     Do Default Directory
  340.  
  341. When checked, this will cause the program to immediatly add icons to
  342. whatever is specified as the default Drawer: and Filename: strings.
  343.  
  344.  
  345.     Auto-Exit
  346.  
  347. If checked, along with either "Do Selected" or "Do Default Directory"
  348. that action will be performed and the program will then exit by itself.
  349.  This allows one double-click to call up the program, add icons to the
  350. default directory, and then quit the program.
  351.  
  352.  
  353. All of the above affect what AddIcon does when it is first started.
  354.  
  355.  
  356.  
  357.  
  358.         SPECIAL MENU
  359.  
  360.     Delete All Icons
  361.  
  362. Deletes icons instead of adding them.  Looks to the "Types" menu items
  363. to provide some control of it's action.
  364. **Not implemented or fully defined in 2.0**
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.                ------  CONFIGURATION FILE DETAILS  ------
  372.  
  373. If you save a configuration file (note that one has to exist to start
  374. with or AddIcon will not work) you can retain the state of the program
  375. for the subsequent times that you run AddIcon.
  376.  
  377. Several configuration files may be saved with different names.  These
  378. can then be loaded to quickly change AddIcon's "personality".
  379.  
  380. The configuration files contain a version number corresponding to the
  381. program version.  If these do not match, AddIcon will proceed anyway
  382. after giving you a warning message.  Future versions of AddIcon will
  383. attempt to retain the ability to read "old" configuration files.  This
  384. should mean that the only action you should have to take in the future
  385. would be to re-save all configuration files.  We shall see...
  386.  
  387. The configuration file contains information not only about the
  388. configuration which the user prefers, but also the information
  389. controlling icon template names etc.  The following is an outline of
  390. the configuration files contents:
  391.  
  392.       <various internal and menu parameters>
  393.       User should not change any of this.
  394.       ----------------------------------------
  395.       <The names and messages for content based icon adding>
  396.       User may change these, but not the number of line here or
  397.       the position.
  398.       ----------------------------------------
  399.       <Extensions, names, and messages for extension based adding>
  400.       User may change, add to or delete these as desired.
  401.       ----------------------------------------
  402.  
  403. This file is an normal ASCII text file which may be edited with almost
  404. any Amiga text editor (TxEd, Ed, Emacs, etc.).  it is composed of three
  405. sections.  Some may be changed quite a bit by the user, some should be
  406. touched little if any.  The three sections are seperated by and
  407. terminated with a line containing a bunch of ------'s.
  408.  
  409. First section.
  410. This contains a version number, title and various default directory
  411. names, window positions and menu states.  This section really should
  412. never be altered by the user, as most things here can be set through
  413. the normal program methods.
  414.  
  415. Second section.
  416. This contains the names and messages for icons to be added based upon
  417. the content of a file.  These cannot be added to by the user, but the
  418. names and messages can be changed.  The format is icon name followed by
  419. a comma followed by the message given in the listing window when this
  420. icon is used.  The order is what determines things here.  This order
  421. and the criteria used are as follows:
  422.  
  423.    1. Unknown.  If AddIcon does not recognize this file at all.
  424.    2. Executable.  For executable programs (Tools).
  425.    3. Directory.   For directories (Drawers).
  426.    4. Text File.   If AddIcon thinks the file is a text file.
  427.    5. Forth Source.   If the file seems to be text and starts with "\".
  428.    6. ILBM.   If the file is an IFF form ILBM but an unknown type.
  429.    7. Lo-Res.
  430.    8. Lo-Res Interlace.
  431.    9. Medium-Res.
  432.   10. Hi-Res.
  433.   11. HAM Lo-Res.
  434.   12. HAM Lo-Res Interlace.
  435.   13. A RIFF animation file.
  436.  
  437. These cannot be added to by the user since they are used based upon an
  438. algorithmic assessment of file contents.  I can and will add to them as
  439. I come across usefull formats.  Registered users are encouraged to send
  440. me formats you would like to have included in the possible next
  441. release.  Please attempt to either tell me enough about the file format
  442. so that I can write a routine to identify it, and/or send me some
  443. samples.
  444.  
  445.  
  446. The third section.
  447. This is where some real user customization can take place.  The entrys
  448. here consist of the target file extension, template icon name, and list
  449. window message.  Again all are seperated by commas.  These can be added
  450. to, deleted and of course changed.  A sample entry like:
  451.  
  452.    DOC,document,Document File
  453.  
  454. is interpreted thusly.  The "DOC" is the extension looked for on the
  455. end of the target file ( such as "AddIcon.doc"  or  "Recipe.Doc"  or
  456. "Friends.doc" ).  The second string "document" should correspond to the
  457. name of an icon in the template directory that you want to use for
  458. files which end in ".doc" ( of course the template icon name will be
  459. "document.info" but AddIcon knows that ).  The third string "Document
  460. File" is what will be printed in the listing window when this icon is
  461. added to a file by AddIcon.
  462.