home *** CD-ROM | disk | FTP | other *** search
/ The Best of the Best / _.img / w001 / iedit30.doc < prev    next >
Text File  |  1991-04-02  |  24KB  |  438 lines
  1.                                    IEdit
  2.                                 Version 3.0
  3.  
  4.      Welcome to IEdit!  This new version is a major revision of IEdit,
  5. and I hope you enjoy it.  New features include:
  6. (Since IEdit 2.2)
  7.  
  8. * Line, box and filled box drawing modes
  9. * Alt-H creates a hexadecimal icon text file for programmers
  10. * New license numbering allows the full version of IEdit as Shareware
  11. * Improved Help function is completely mouse driven
  12. * IExtract now allows graphic selection of the icon to extract
  13. * Significantly faster icon drawing during the LOAD function
  14. * 80286 specific code for faster execution throughout
  15.  
  16. (Since IEdit 2.0)
  17.  
  18. * New icon-based function selection
  19. * Invert Mask editing
  20. * Icon scrolling in any direction
  21. * A View function to preview your icon in a Windows-style dialog box
  22. * Graphic Load function lets you pick your icon visually
  23. * A "Best Guess" invert mask function
  24. * An "Undo" function
  25. * A built in file length check guards against viruses
  26. * A "Change a Color" function to alter a color over an entire icon
  27. * "Rotate" turns your icon 90° clockwise
  28. * A Grid for precise icons
  29. * A shell to DOS for quick jumps to the DOS command line
  30. * "Mirror" function makes symmetric icons easier
  31. * "Quick Help" for functions with a single mouse click
  32. * A scroll "Chain" to link or unlink icon and invert mask scrolling
  33.  
  34. ┌───────────────────────────────────────────────────────────────────────────┐
  35. │Quick Tip #1:                                                              │
  36. │You will find IEdit's Help functions contain much of the information below.│
  37. │                                                                           │
  38. │IEdit's "Quick Help" pops-up when you click the right button on a          │
  39. │function icon.                                                             │
  40. └───────────────────────────────────────────────────────────────────────────┘
  41.  
  42.                                 Introduction
  43.  
  44.      IEdit is a full featured tool for creating and editing icons for the
  45. Microsoft Windows environment.  IEdit itself however, is a DOS application.
  46. As many users know, IEdit was released in two versions, a Shareware version
  47. (IEDIT.EXE), and an Enhanced version (IEDITE.EXE).  Now IEdit is released as
  48. a single version using License Numbers for registered users.
  49.     IEdit was originally created for my own use, but caught on with the
  50. rapid growth of Windows 3.0, and now enjoys users from California to Austria!
  51. If you're curious about the technical aspects of IEdit and icons, read the
  52. Technical Information section at the end of this file.
  53.  
  54.  
  55.                              System Requirements
  56.  
  57. * Dos 3.0 or greater
  58. * A VGA system
  59. * Approximately 150k disk space (depending on number of icons)
  60. * At least 300k of free ram
  61. * 300-500k free disk space for swapping if SHELL feature is used
  62. * A Microsoft compatible mouse
  63. * At least a '286 based computer (AT or better).
  64. * Windows 3.0 (of course) to use your icons.
  65.  
  66. Users who have a different system setup may be able to obtain a special
  67. version of IEdit from me (e.g. An 8088 (XT class) version).
  68.  
  69.  
  70.                                Creating Icons
  71.  
  72.      First, start IEdit by typing "IEDIT" at the DOS prompt, be sure that
  73. you've loaded your mouse's driver program beforehand (Usually MOUSE.COM).
  74.  
  75.  ┌──────────────────────────────────────────────────────────────────────┐
  76.  │Quick Tip #2:                                                         │
  77.  │You can also load an icon into IEdit from the command line by typing: │
  78.  │  IEDIT <Icon-filename>                                               │
  79.  └──────────────────────────────────────────────────────────────────────┘
  80.  
  81.      The left side of your screen will have the main icon editing box.  The
  82. icons you create are actually a square of dots 32 by 32.  Each dot can be
  83. one of 16 colors (including black).  Icons also have another 32 by 32 square
  84. of dots (at the right center of IEdit) called an "invert mask".  You won't
  85. need an invert mask for most icons so we'll cover them later.
  86.      Between the main icon area and the invert mask is a color bar
  87. containing the 16 colors you can choose from.  Select a color by moving the
  88. mouse pointer over a color and clicking the left mouse button.  Above the
  89. icon area the upper "Current" color box will reflect your choice.  You can
  90. select a second color with the right button, it will appear in the lower
  91. "Current" box.  The idea here is pick a main (upper) color for drawing with
  92. the left button, and a secondary (lower) color for drawing with the left
  93. button.  I like to choose my icon's background color for the lower color,
  94. that way I can draw with the left button and erase with the right.
  95.      You can now move the mouse pointer over to the main icon area and use
  96. the either mouse button to draw a single dot.  You can also hold the button
  97. and move the mouse to draw continuously.  In the upper left corner you'll
  98. notice a tiny version of the main icon area, this is the actual size of the
  99. icon you're drawing.  You'll want to check this box to insure that your
  100. icon isn't too detailed to be seen when it's finished.  If you're trying to
  101. be precise you'll find the coordinate display (also above the main icon
  102. area) helpful, as well as the GRID function which puts a grid over the icon
  103. area (using your current upper color).
  104.      When you start drawing, the main icon area is black, so you can erase
  105. any mistakes by choosing the color "Black" from the color bar.  Later
  106. you'll see that you can start with any color you choose as the background,
  107. and then you'll need to use that color to "erase" a mistake.
  108.      Once you've created a suitable icon, choose VIEW from the function
  109. icons at the bottom.  You'll see a small Windows-like box in the center of
  110. the screen.  This is the way your icon (including the invert mask, if any)
  111. will look inside Windows, click any mouse button to erase the View box.
  112.  
  113.  
  114.                         Saving and Loading icons
  115.  
  116.      You'll need to save your icon to a file in order to use it in Windows.
  117. If you're editing a previous icon, just choose SAVE and IEdit will
  118. replace the old icon file with the new one you're editing.  If you choose
  119. SAVE TO, or if you haven't previously saved the current one, you'll be
  120. prompted for a file name.  Type a name for your icon and press enter. IEdit
  121. will give your file name the extention "icn".  Don't choose a different
  122. extention since IEdit's LOAD function won't be able to find it if you do.
  123.      When you want to edit an icon, choose LOAD from the function bar.
  124. You'll be presented with a screen with all the icons in the current
  125. directory.  Just click on the icon you want to edit.  You can choose
  126. CANCEL to go back without loading an icon.  You can also choose NEW DIR
  127. and you'll be prompted for a new directory path.  BE SURE and give the full
  128. path (i.e. Drive etc.) such as "C:\Windows" or "C:\Icons".  If you know the
  129. name of the icon you want to edit, choose LOAD FROM, it will prompt you for a
  130. specific file name to edit.
  131.  
  132.  
  133.                          More editing functions
  134.  
  135.      IEdit has four drawing modes, DRAW, LINE, BOX and FILLED BOX.  A
  136. summary of each mode is below:
  137.  
  138.  ┌───────┬───────────────┬──────────────┬──────────────┬───────────────────┐
  139.  │MODE ->│ DRAW          │ LINE         │ BOX          │ FILLED BOX        │
  140.  ├───────┼───────────────┼──────────────┼──────────────┼───────────────────┤
  141.  │       │               │      │       │   ┌─┼─┐      │     ┌─┼─┐         │
  142.  │Pointer│ (Arrow)       │  ────┼────   │ ──┼─┼─┼──    │   ──┼─█─┼──       │
  143.  │       │               │      │       │   └─┼─┘      │     └─┼─┘         │
  144.  ├───────┼───────────────┼──────────────┼──────────────┼───────────────────┤
  145.  │Draws  │ Freestyle     │ Line between │ Box between  │ Filled box between│
  146.  │       │               │ two points   │ two corners  │ two corners       │
  147.  ├───────┼───────────────┼──────────────┼──────────────┼───────────────────┤
  148.  │Button │ Left or Right │ Left         │ Left         │ Left              │
  149.  │to use │               │              │              │                   │
  150.  └───────┴───────────────┴──────────────┴──────────────┴───────────────────┘
  151.  
  152.      The DRAW mode allows you to draw single dots wherever you move the
  153. mouse.  You may use the left button to draw with the upper current
  154. color, or the right button to use the lower current color.  You can also
  155. hold either button to draw continuously.
  156.  
  157.      The LINE mode lets you draw lines by selecting two points, the first
  158. point will be marked when you click the left button.  When you click the
  159. left button a second time, a line will be drawn between the two points.
  160.  
  161.      The BOX mode lets you draw boxes similar to the line mode except
  162. that instead of selecting points with each mouse click, you are
  163. selecting the corners of a box.
  164.  
  165.      The FILLED BOX mode works exactly like the box mode except that the
  166. box drawn is filled in with the current (upper) color.
  167.  
  168.  ┌──────────────────────────────────────────────────────────────────────┐
  169.  │Quick Tip #3:                                                         │
  170.  │You may change your color choice in the middle of drawing a line, box │
  171.  │or filled box by simply selecting the new color before clicking on the│
  172.  │second point or corner.                                               │
  173.  └──────────────────────────────────────────────────────────────────────┘
  174.  
  175.      The "buttons" along the edges of the main icon area will scroll the
  176. icon toward that edge, click on them to scroll your icon.  Likewise, the
  177. buttons below the invert mask are used to scroll it.  The CHAIN function
  178. allows you to link the two so that when you scroll either the icon or the
  179. invert mask, both will scroll.  Click on the CHAIN icon and you'll see
  180. tiny links appear on it, click again to unlink.
  181.      The INVERT function lets you invert the colors in your icon.  The
  182. invert function is easier to use than to explain, so just try it.  You can
  183. un-invert the colors by simply selecting INVERT a second time.
  184.      The CLEAR function will clear both the icon and the invert mask,
  185. and start over.  IEdit won't let you lose your work by clearing or loading
  186. without prompting you.  You'll see the message "Abandon this icon ([Y]/N)",
  187. you can press the right button for "Yes" or the left for "No", or press Y
  188. or N.  The CLEAR TO function is similar to the clear function except that it
  189. clears the icon to the "Current" selected color (instead of black).  The
  190. MOUSE icon lets you increase or decrease the sensitivity of your mouse.
  191. Click and hold on the right button to increase the sensitivity, or on the
  192. left button to decrease it.  You'll hear a rising or falling tone also.
  193. You may need to experiment to find the proper setting.
  194.      The CHG A CLR ("Change a color") function is simple.   First, click on
  195. the color in the color bar that you wish to change.  Second click on the
  196. CHG A CLR icon, then click on your new color choice.  The first color will be
  197. replaced by the second throughout the icon.
  198.      The ROTATE function simply rotates your icon 90° clockwise.
  199.      The MIRROR function erases the right side of your icon and replaces it
  200. with a mirror image of the left side.  By using ROTATE and MIRROR you can make
  201. icons that are symmetric horizontally, vertically or both.
  202.  
  203.  ┌───────────────────────────────────────────────────────────────────┐
  204.  │Quick Tip #4:                                                      │
  205.  │If your planning to draw an icon with a symmetric border around it,│
  206.  │the rotate and mirror functions can save time.                     │
  207.  └───────────────────────────────────────────────────────────────────┘
  208.  
  209.      The UNDO function returns your icon to its state before the last
  210. function was executed (except LOAD).  You cannot undo manual drawing you have
  211. done.  You can use UNDO again to go back to the state before the first UNDO.
  212.  
  213.  ┌─────────────────────────────────────────────────────────────────────┐
  214.  │Quick Tip #5:                                                        │
  215.  │Whenever you see the "Abandon this icon (Y/N)?" prompt, you can click│
  216.  │the RIGHT mouse button for "Yes" or the LEFT for "No".               │
  217.  └─────────────────────────────────────────────────────────────────────┘
  218.                             About Invert Masks
  219.  
  220.      Invert masks are a smaller version of an icon.  They do not use
  221. colors, each dot in an invert mask is either on (white) or off (black).
  222. When Windows is DISPLAYING (not moving) an icon, it uses the dots as a mask
  223. to determine where on the main icon to invert the colors.  My experience
  224. has been with VGA systems, other (particularly monochrome) systems may
  225. behave differently.  Most often you'll want to make the black portions of
  226. your icon inverted, this will make them the same as the background color
  227. in Windows.
  228.      For example:  Suppose you create two icons, both with red blocks at
  229. the center.  You make them nearly identical two different ways.  You can
  230. put a white background on one (example 1 below), and leave the other black,
  231. but give it an invert mask around the block (example 2).  This will invert the
  232. black to white in Windows.  So, you wind up with two icons that look
  233. identical; until you move them. Then you'll see that the one without the
  234. invert mask has a white area that runs over whatever you're moving over, in
  235. contrast the invert mask icon won't.  In addition, the inverted icon will
  236. change its background to the same as Windows', while the uninverted one will
  237. stay white.  In some cases, the invert mask icon will invert the colors behind
  238. it.  I realize this is difficult, I suggest you make a few icons for yourself
  239. and try them out.
  240.      The red tracer will appear to guide you if you manually edit an invert
  241. mask (it moves with you over the main icon).  Be sure and try the GUESS INV
  242. function first.  Also be sure to use the VIEW function, it uses the invert
  243. mask information in its display (The icon in the upper left corner does not).
  244.  
  245.             Example 1          ║           Example 2
  246.                                ║
  247.     ┌─────────┐  ┌─────────┐   ║   ┌─────────┐  ┌─────────┐
  248.     │██White██│  │         │   ║   │         │  │██White██│
  249.     │█▒▒▒▒▒▒▒█│  │         │   ║   │ ▒▒▒▒▒▒▒ │  │█       █│
  250.     │█▒▒RED▒▒█│  │         │   ║   │ ▒▒RED▒▒ │  │█       █│
  251.     │█▒▒▒▒▒▒▒█│  │         │   ║   │ ▒▒▒▒▒▒▒ │  │█       █│
  252.     │█████████│  │         │   ║   │         │  │█████████│
  253.     └─────────┘  └─────────┘   ║   └─────────┘  └─────────┘
  254.        icon      invert mask   ║      icon      invert mask
  255.      ┌──┴─────────────┘        ║        └────────────┴──┐
  256.      │                         ║                        │
  257.      │                         ║                        │
  258.      │    ┌─────────┐          ║         ┌─────────┐    │
  259.      │    │██White██│          ║         │██White██│    │
  260.      │    │█▒▒▒▒▒▒▒█│          ║         │█▒▒▒▒▒▒▒█│    │
  261.      └─>  │█▒▒RED▒▒█│          ║         │█▒▒RED▒▒█│  <─┘
  262.           │█▒▒▒▒▒▒▒█│          ║         │█▒▒▒▒▒▒▒█│
  263.           │█████████│          ║         │█████████│
  264.           └─────────┘          ║         └─────────┘
  265.            resulting           ║          resulting
  266.              icon              ║            icon
  267.    (in Windows or with VIEW)   ║  (in Windows or with VIEW)
  268.                                ║
  269.     ∙ Background always white  ║   ∙ Background same as screen's
  270.  
  271.  ┌────────────────────────────────────────────────────────────────────────┐
  272.  │Programmer's Tip:                                                       │
  273.  │Pressing Alt-H will create a hex text file of the current icon (with the│
  274.  │extention ".HEX").  This may be useful for including an icon within     │
  275.  │source code.                                                            │
  276.  └────────────────────────────────────────────────────────────────────────┘
  277.  
  278.                           About License Numbers
  279.  
  280.      IEdit has changed it's style, instead of distributing a Shareware
  281. version freely and an Enhanced version to registered users, a single
  282. version is distributed and registered users obtain a License number that
  283. removes the "annoyware" displays (and relieves their conscience).
  284.  
  285. Registered users should be aware that the License number is unique to
  286. them and "pirated" versions found will identify the offender.  In
  287. addition, the License number is permanently "installed" in IEdit, and
  288. cannot be changed.
  289.  
  290.  
  291.                               How to order
  292.  
  293.      First print out the file "ORDER.FRM" and fill it out.  Mail it to
  294. me with a check for $8 (or $10 if you want IEdit shipped).  BE SURE TO
  295. INCLUDE YOUR PHONE NUMBER!  I'll need it (as well as a best-time-to-call)
  296. in order to give you your License number.
  297.  
  298.      If you no longer have the order form, simply send me your name,
  299. address, telephone number and (heh heh) a check, so I can call you and give
  300. you your License number.
  301.  
  302.  
  303.                            Pricing Information
  304.  
  305.           Product     Price
  306.           ───────     ─────
  307.           IEdit        $8       (Add $2 S&H if you don't wish to have
  308.           Updates      $4       me call for your License number.)
  309.  
  310.      Dollar amounts are U.S. funds.  Checks or money orders only; not
  311. responsible for cash lost in shipping.  Add $2 to total for shipping to UK
  312. and Europe.
  313.      Minor revision updates (e.g. from 2.0 to 2.2) are free by modem to
  314. registered users.  Registered users are notified when the next major version
  315. is available.  Most orders shipped within 48 hours.  Checks are not cashed
  316. until product is shipped or License number given.  IEdit is guaranteed to
  317. perform reasonably, if you have a problem that cannot be solved, return
  318. any shipped materials within 10 days for a full refund of purchase amount.
  319.  
  320.  
  321.  
  322.                               Using IExtract
  323.  
  324.      You can use IExtract to "rip" the icon out of an application.  The
  325. result is an icon file that you can edit and use like any other.  IExtract
  326. works with most, but not every Windows application.  The syntax is as
  327. follows from the DOS command line:
  328.  
  329.      IEXTRACT <Windows-application-filename> <Target-icon-filename>
  330.  
  331. You must specify both the source (application) and the target (.icn filename).
  332. IExtract will create the icon file at the path specified or in the current
  333. directory.  Typing "IEXTRACT" by itself will also give the command syntax.
  334.  
  335. Remember that the resulting icon is still under the copyright of the software
  336. company, and you may violate some software agreements by using IExtract.
  337. Check with your software manufacturer for details.
  338.  
  339.  
  340. I'm afraid I had to discontinue IInject.  The danger of accidentally damaging
  341. a Windows program was too great - I wouldn't want to be responsible for it.
  342.  
  343.  
  344.                   Notes on recovering from errors and bugs
  345.  
  346. * If you crash or run a TSR during a SHELL, the IEdit swap file will remain
  347. on your disk, it's a hidden file called "$IEDSWAP.AAA".  IEdit places it in
  348. the directory specified by your TEMP environment variable (in your autoexec),
  349. or in the current directory if a TEMP is unavailable.  Be sure and delete this
  350. file if this happens as it will take up quite a bit of disk space and will
  351. cause errors the next time you use SHELL.  Use Norton Commander, PC Tools or
  352. a similar product to delete it.  * Be carefull! *  You will lose your work if
  353. you crash the system during a SHELL.
  354.  
  355. * If you're running IEdit from a DOS Window in Windows 3.0 *DO NOT* use the
  356. SHELL feature.  DOS applications from Windows are shakey enough.  You WILL
  357. loose any unsaved work, but Windows won't crash.
  358.  
  359. * It's possible that you have just enough free memory to load IEdit itself,
  360. but not enough for one of IEdit's functions.  IEdit traps for this, but I've
  361. been unable to test it.  In any case your current icon should be saved as
  362. "IEDITERR.ICN".
  363.  
  364. * Please let me know if you find any other annoyances/bugs.
  365.   ^^^^^^^^^^^^^^^^^^
  366.  
  367.                   Technical and Miscellaneous Information
  368.  
  369. * IEdit itself was created with Microsoft's QuickPascal and now stands at
  370. roughly 2600 lines of code.  Despite the fact that IEdit had to overcome
  371. at least three bugs in QP, I still can't recommend it more highly.  The
  372. editor is very similar to Notepad (and indeed all MS products) and the
  373. Help is amazing (the manual rarely leaves the shelf).
  374.  
  375. * The 766 byte icon file format is tricky at best, it is in three parts.
  376. A 126 byte header tells Windows what it is and color info, bitmap size, etc.
  377. Next is the "main" icon, 512 bytes (2 pixels per byte x 1024 pixels).
  378. Then a 128 byte block (32 x 32 x 1 bit/pixel) defines the invert mask.
  379. An early bug that made it's way into several icon editing programs, and
  380. one icon distributed with IEdit v 0.9 (beta) actually caused Windows
  381. to give an "Unrecoverable Application Error" immediately after it was
  382. used, but only in '386 Enhanced mode.  This has been eliminated by the
  383. offending programs, and IEdit's icons are fine.
  384.  
  385. * Why VGA only?  Well not entirely due to a lack of EGA graphic
  386. capabilities, but more due to a lack of similar TEXT modes between the
  387. two.  Keeping 640x480 and 640x350 straight is tricky enough without
  388. dealing with text as well.  Ignoring that, EGA simply looks bad with
  389. 25% less resolution.  Also, most Windows users have a VGA anyway.  The
  390. same applies to mice and '286 specific code.
  391.  
  392. * Astute readers may have figured out that IEDIT3.OVL is really just the
  393. upper menu bar.  It is never executed, but I named it with the .ovl extention
  394. to insure it would be included if someone was copying files around their
  395. hard disk.  IEdit will crash without it.  Also, IEDITMEN.OVL is actually a
  396. screen image of the icon function bar.
  397.  
  398. * Why is it so cheap?  I'm a college student (Computer Information
  399. Sciences major, wanna hire me next year?  Please?) and I've done more than
  400. my share of "leeching" the Shareware market, so I priced IEdit so that I
  401. could have afforded to register it.  Also, I love writing software.  But
  402. the best result so far has been getting letters (and checks) from all over
  403. the WORLD(!).  I'd also like to thank people who called and wrote with
  404. comments and suggestions, they are reflected in this version.
  405.  
  406. * What else have I written?  Not much, IEdit is my first semi-serious
  407. venture into Shareware, but I did write an autoexec.bat multi-utility
  408. called Autoit.  It let's you speed up the keyboard rate, turn off the Num
  409. Lock, adjust the ram refresh rate, and check for a keystroke since boot-up
  410. (to branch out of the autoexec), all in one 5k program.
  411.  
  412. * My address: James Bell  4511 Sherwood Trace  Gainesville, Fl  32605.
  413. or call me at (904) 372-3695.
  414.  
  415. * Windows and QuickPascal are TM's of Microsoft Corp.
  416.  
  417. * Many thanks to Tom Wagner and (of course) Dr. Dobbs for the swap-to-
  418. disk ideas and examples.
  419.  
  420.                               What's next?
  421.  
  422. Any other features added to future versions of IEdit will depend
  423. completely on user suggestions.  As-is IEdit has more features than any
  424. other icon program I've seen, and about all that's left is to make it a
  425. Windows application.  But (sigh) I simply don't have the $315 for the
  426. Windows SDK.  So, if you wanted to instantly become my best friend in
  427. the entire world....
  428.  
  429. I am working on a graphic-based manual viewer.  The idea is to let a
  430. program's doc file include instructions for drawing EGA graphics.  The
  431. result will be a doc file with pictures for better explanation, all within
  432. a nice graphic, mouse-aware environment.
  433.  
  434. Thanks again, good luck, and happy Windows-ing!
  435. James Bell                                                     1/4/91
  436.  
  437.  
  438.