home *** CD-ROM | disk | FTP | other *** search
/ TopWare Tools / TOOLS.iso / tools / top1032 / iconedit.doc < prev    next >
Encoding:
Text File  |  1993-04-21  |  13.5 KB  |  304 lines
  1.  
  2.  
  3.                                     ┌────┐
  4.                                  ┌──┴─┐┌─┴──┐
  5.                               ┌──┴─┐┌─┴┴─┐┌─┴──┐
  6.                            ┌──┴─┐┌─┴┴─┐┌─┴┴─┐┌─┴──┐
  7.                         ┌──┴─┐┌─┴┴─┐┌─┴┴─┐┌─┴┴─┐┌─┴──┐
  8.                         │    ├┤    ├┤    ├┤    ├┤    │
  9.                         └────┘└────┘└────┘└────┘└────┘
  10.                                     IconEDIT
  11.                                    ver. 1.0
  12.                           Copyright 1993, EFD Systems
  13.                                All Rights Reserved
  14.                         ┌────┐┌────┐┌────┐┌────┐┌────┐
  15.                         │    ├┤    ├┤    ├┤    ├┤    │
  16.                         └──┬─┘└─┬┬─┘└─┬┬─┘└─┬┬─┘└─┬──┘
  17.                            └──┬─┘└─┬┬─┘└─┬┬─┘└─┬──┘
  18.                               └──┬─┘└─┬┬─┘└─┬──┘
  19.                                  └──┬─┘└─┬──┘
  20.                                     └────┘
  21.  
  22.  
  23.  
  24.  
  25. ─────────────────────────────────────────────────────────────────────────────
  26.                          T A B L E  of  C O N T E N T S
  27.  
  28.  
  29.  Description  ----------------------------------------------------------- 3
  30.  
  31.  Installation and Startup  ---------------------------------------------- 4
  32.  
  33.  Building Menus  -------------------------------------------------------- 5
  34.  
  35.  Editing and Copying Icons  --------------------------------------------- 6
  36.  
  37.  Command Buttons  ------------------------------------------------------- 8
  38.  
  39.  How-To  ---------------------------------------------------------------- 9
  40.  
  41.  Mail Order  ------------------------------------------------------------ 11
  42.  
  43.  Maintenance Log  ------------------------------------------------------- 12
  44.  
  45.  
  46.  
  47.  
  48.  
  49. ───────────────────────────────────────────────────────────────────────────────
  50.                                   Description
  51.  
  52. IconEDIT is the graphical setup and maintenace utility for IconDOS.  IconEDIT is
  53. used to build and edit icon menu files containing up to 32767 icons.  With
  54. IconEDIT you can draw your own icons from scratch or you can copy and modify
  55. existing icons.  At the same time, you can edit an icon's title and attach a DOS
  56. command string to the icon.
  57.  
  58. IconEDIT is almost totally mouse driven; therefore, a MicroSoft compatible mouse
  59. is required.  If a mouse driver is not present at startup, IconEDIT will abort
  60. with a short message.  IconEDIT also requires a VGA monitor (EGA will not work).
  61. This condition is also checked at startup.
  62.  
  63. IconDOS icons are always 32 by 32 pixels.  Wallpaper is also a 32 by 32 pixel
  64. graphic that is placed into a special file, PAPER.ICN, for display as a
  65. repeating backdrop pattern.  Therefore, IconEDIT does not make a distinction
  66. between icons and wallpaper and will edit either.  During editing, IconEDIT
  67. displays a normal and an expanded view of the icon.  Drawing with the mouse
  68. always takes place in the expanded view.
  69.  
  70.  
  71.  
  72.  
  73. ───────────────────────────────────────────────────────────────────────────────
  74.                             Installation and Startup
  75.  
  76. Installation is very easy.  Simply make a new directory and copy all of the
  77. IconDOS files to it.  If you insist, a batch file called INSTALL.BAT has been
  78. provided which will do this for you.  Change to the drive and directory where
  79. the IconDOS files are located and type:
  80.  
  81.                     INSTALL path   Example: INSTALL C:\MENU
  82.  
  83. To start IconEDIT, type:
  84.  
  85.                           ICONEDIT iconfile [buffile]
  86.  
  87. "iconfile" is the name of the file that you wish to edit.  The file will be
  88. created if it does not exist.  "buffile" is the name of an optional
  89. cut/copy/paste buffer file.  If "buffile" is not specified, IconEDIT will create
  90. and use a file called ICON.TMP.  The "buffile" is the key to copying and moving
  91. icons between files.
  92.  
  93. NOTE: The buffer file grows in size with each CUT or COPY command.  ICON.TMP is
  94. never deleted or overwritten, only added to.  You may wish to delete this file
  95. from time to time to prevent it from becoming excessive in size.
  96.  
  97. ───────────────────────────────────────────────────────────────────────────────
  98.                                  Building Menus
  99.  
  100. An icon menu file can be built by hand drawing icons using IconEDIT; however, it
  101. is easier and faster to copy icons from the provided library of over 100 icons
  102. whenever possible.  Specific instructions for copying icons using IconEDIT are
  103. provided in the following section.  After icons have been drawn or copied, use
  104. IconEDIT to add icon titles and command strings.  Due to the command string size
  105. limit of 14 characters, imposed by the IBM keyboard buffer, the command string
  106. is normally used to call a batch file and pass parameters.  The batch file
  107. actually contains the list of DOS commands needed to carry out specific icon
  108. actions.  A single batch file file can contain multiple sets of commands, one
  109. set for each icon in a menu.  An icon specific parameter can be passed and used
  110. by the batch file to select the proper command set.  RUN.BAT is a fully
  111. commented batch file which illustrates this technique.  This file can be
  112. modified for your own needs as desired.  The batch file is also used to make the
  113. menu system re-entrant by returning control to IconDOS after a command list has
  114. been executed.  Comments in RUN.BAT also illustrate this.
  115.  
  116. The batch file containing the DOS command sets should be located somewhere
  117. inside your DOS path.  This will allow IconDOS to work from any directory.
  118. IconDOS is not required to be inside the DOS path but the full directory path
  119. must be used for both IconDOS and menu files like this:
  120.                           C:\MENU\ICONDOS C:\MENU\DEMO
  121. ───────────────────────────────────────────────────────────────────────────────
  122.                            Editing and Copying Icons
  123.  
  124. As noted earlier, IconDOS is mostly mouse driven.  Notes on-screen explain how
  125. CTRL and ALT keys will modify certain mouse actions; otherwise, the keyboard is
  126. only used to enter and edit icon titles and command strings.
  127.  
  128. All drawing takes place in the expanded view of the icon.  Individual pixels are
  129. painted by clicking inside a pixel box.  Lines can be drawn by holding down a
  130. mouse button and moving the cursor.  A wide brush (3 X 3 pixels) is available
  131. for filling in larger regions by holding down the ALT key while drawing.
  132.  
  133. The left and right mouse buttons can be assigned drawing colors by clicking on
  134. the color bar.  To erase instead of draw, simply assign the background color to
  135. one of the buttons and draw over the area to be erased.
  136.  
  137. Note that you must explicitedly store your artwork to disk by clicking either
  138. the SAVE or APPEND command buttons; otherwise, your work will be lost when you
  139. leave IconEDIT or move to the next icon.
  140.  
  141. To edit an icon's title or command string, click inside the labeled edit box.
  142. The mouse is disabled until editing is terminated by ENTER or ESC.  The box
  143. editor provides Insert and Overstrike modes toggled with INSERT.  Alt-C will
  144. clear the box, Alt-R will restore.  Home and End move to the box start/end.
  145. ───────────────────────────────────────────────────────────────────────────────
  146.                        Editing and Copying Icons (cont'd)
  147.  
  148. When building a menu, it is generally preferable to copy an icon from the
  149. provided library, ICON.LBR, instead of drawing your own icon from scratch.
  150.  
  151. To copy icons between files, start IconEDIT in the following manner:
  152.  
  153.                         ICONEDIT fromfile tofile
  154.  
  155. For example, to copy an icon from ICON.LBR to MYMENU.MNU, start IconEDIT with:
  156.  
  157.                           ICONEDIT ICON.LBR MYMENU.MNU
  158.  
  159. Step through ICON.LBR until you find the desired icon.  Note that Ctrl and Alt
  160. keys can be used with the NEXT and PREVIOUS command buttons to jump more rapidly
  161. through the file.  Once the icon is found, click COPY.  A copy of the icon will
  162. be placed in MYMENU.MNU.  DO NOT use CUT unless you wish to actually remove
  163. the icon from ICON.LBR as it is being placed into MYMENU.MNU.
  164.  
  165. IconDOS can be used to view the icon library and select icons to be copied.
  166. Simply type ICONDOS ICON.LBR.  Icons are displayed in succession by row, 56 per
  167. page.  Noting the numbers of your selected icons makes it easier to find and
  168. copy them later with IconEDIT.
  169. ───────────────────────────────────────────────────────────────────────────────
  170.                                 Command Buttons
  171.  
  172. PREVIOUS - Move to the previous icon in the file.  Hold the Alt key to move in
  173.    steps of 5 icons.  Hold the Ctrl key to move to the start of the file.  The
  174.    current icon number and the total icon count are shown at the upper right.
  175. NEXT - Move to the next icon in the file.  Alt key moves by 5.  Ctrl key moves
  176.    to the end of the file.  When moving, the user is prompted to save the
  177.    current icon if it has been modified.
  178. CLEAR - Clears the icon to the color of the mouse click button.  For example, to
  179.    clear the icon to solid red, assign red to one of the mouse buttons by
  180.    clicking on the color bar and then click CLEAR with the red button.
  181. CUT - Removes the current icon from the file and places it in the buffer file.
  182.    The last icon in the file is moved to fill the current position, the total
  183.    icon count is reduced by 1 and the file is truncated.
  184. COPY - Copies the current icon to the buffer.  The current file is unchanged.
  185. PASTE - Copy the next icon from the buffer file and overwrite the current icon
  186.    display.  Only the screen display is overwritten, SAVE or APPEND must be used
  187.    to overwrite the icon on disk.  PASTE starts at the end of the buffer file
  188.    and progresses backward with each use in a Last-In-First-Out (LIFO) manner.
  189. APPEND - Adds the currently displayed icon to the end of the file. Increases the
  190.    total icon count by 1.
  191. SAVE - Overwrites the current disk icon number with the displayed icon.
  192. Exit - The window button in the extreme upper left of the screen exits IconEDIT.
  193. ───────────────────────────────────────────────────────────────────────────────
  194.                                      How-To
  195.  
  196. - Add a new icon to a file?
  197.  
  198. Click the APPEND command button.  A copy of the current icon will be appended to
  199. the end of the file where it can be safely modified or re-drawn as needed.
  200. Alternately, you can modify any icon in place and then click APPEND.
  201.  
  202. - View all of the icons in a file?
  203.  
  204. Start IconDOS and specify the file.  For example, ICONDOS ICON.LBR, will display
  205. all of the icons from the provided icon library in succession by row with 56
  206. icons per page.
  207.  
  208. - Setup a submenu?
  209.  
  210. Assign a submenu file name to an icon in place of a DOS command string.  IconDOS
  211. will load the submenu file when the icon is clicked.  You may want to provide an
  212. icon in the submenu which re-loads the previous menu.  See DEMO.MNU and
  213. SUBDEMO.MNU for an example.  All menus and submenus should always be maintained
  214. in the same directory; otherwise, IconDOS may have trouble locating the needed
  215. files.
  216.  
  217. ───────────────────────────────────────────────────────────────────────────────
  218.                                 How-To (cont'd)
  219.  
  220. - Move icons within a file?
  221.  
  222. Delete the default buffer file, ICON.TMP.  Edit the file using the default
  223. buffer, i.e. don't specify a buffer file.  COPY all of the icons to be moved.
  224. Use PASTE and SAVE to place the icons in new positions.
  225.  
  226. - Move icons between files?
  227.  
  228. The most direct way is to edit the file to be copied FROM while using the file
  229. to be copied TO as the cut/copy/paste buffer.  Alternately, icons copied from
  230. any file into the default buffer can be pasted into any subsequent file also
  231. being edited with the default buffer since the default buffer is never deleted
  232. or overwritten, only added to.
  233.  
  234. - Always use the same wallpaper?
  235.  
  236. Make a library backup copy of PAPER.ICN by typing:  COPY PAPER.ICN PAPER.LBR
  237. Edit PAPER.ICN using IconEDIT and delete everything except the one wallpaper
  238. that you wish to use.  PAPER.ICN, as supplied, contains 20 different
  239. wallpapers.  IconDOS selects wallpaper at random from whatever is available in
  240. this file at startup.  If only 1 is available, it will always be used.
  241. ───────────────────────────────────────────────────────────────────────────────
  242.                                    Mail Order
  243.  
  244. To use this software beyond the trial period requires the purchase of a license.
  245. A license can only be purchased by direct mail order from the author (just like
  246. in the old days with the Sears catalog).  See ORDER.FRM or send a check or money
  247. order for $25 US to:
  248.                                   EFD Systems
  249.                             304 Smokerise Circle SE
  250.                               Marietta, GA 30067                  CIS:72627,3026
  251.  
  252. As a minimum, licensed users will receive the following:
  253.  
  254. - The lastest licensed version of IconDOS.
  255.  
  256. - A library of at least 200 additional high quality icons and new wallpaper.
  257.  
  258. - A utility to display 16 color PCX files and capture icons from the screen.
  259.   Provides an indirect but workable path to convert Window's icons to IconDOS.
  260.   The icon library was converted from public domain Windows icons in this way.
  261.  
  262. - Information on upgrades and new utilities not offered as shareware.
  263.   Registered users can upgrade to any later version for a $5 S & H fee.
  264.  
  265. ───────────────────────────────────────────────────────────────────────────────
  266.                                 Maintenance Log
  267.  
  268. 1.0 - 1/8/93 (the King's birthday) Original release.
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282. *** End of Book ***
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299. *******************************************************************************
  300.  
  301.             CDV - Software ∙ Postfach 2749 ∙ 7500 Karlsruhe 1
  302.  
  303.               Tel 0721-97224-0 ∙ Fax 0721-21314 ∙ Btx *CDV#
  304.