home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR36 / IVENTORY.ZIP / INVENT.DOC < prev    next >
Text File  |  1991-12-02  |  15KB  |  321 lines
  1.                               INVENTORY PROGRAM
  2.  
  3.                               INTRODUCTION
  4.  
  5.      This program was originally written for keeping and inventory of  Cross stitch floss,
  6. however, I believe/hope that is it flexible enough to help keep track of other materials. The
  7. program is distributed as a FULLY FUNCTIONAL program, every option works. It is also
  8. distributed under the shareware concept, therefore a registration form is included. If you plan to
  9. use the program, you are requested to mail the registration form, and a donation, to:
  10.  
  11.                                        Chris O'Donnell
  12.                                        576 Benson Road
  13.                                         Middlebury Ct. 06762
  14.  
  15.   An $8.00 donation is suggested, but send what you feel the program is  worth. Comments,
  16. complaints and suggestions are also accepted. They can be sent to the above address, or via E-
  17. mail to CIS: 70431,1427.  Input from registered users will be responded to, input from  non-
  18. registered users will be contemplated.
  19.  
  20.      Please remember that the inventory is only as accurate as you are.If you use up a color, and
  21. don't update the file here then it will NOT be accurate. This is not a program error, it's a user
  22. error.
  23.  
  24.      The following files are included:
  25.  
  26.                     INVENT.EXE - The executable INVENT program
  27.                     DMC.INV    - DMC Floss numbers and descriptions
  28.                     BATES.INV  - BATES Floss numbers and descriptions
  29.                     ANCHOR.INV - Anchor Floss numbers and descriptions
  30.                     INVENT.DOC - This document
  31.                     REG.DOC    - Registration form
  32.  
  33.      INVENT is a text-based program, not graphics. It ASSUMES that you have an 80 column
  34. monitor. If anyone has a 40 column monitor, I will added the code to accommodate this. I use
  35. only 3 colors: White, Light gray and Dark Gray. Additional versions will use more colors. If you
  36. get strange results, let me know, along with information about your machine and I'll see what I
  37. can do.
  38.  
  39.      In order to run the INVENT program, you need to have the .EXE and any inventory files in
  40. the same directory. If you delete the .INV files that come with the program, you have to build
  41. the inventory from scratch. The .INV files included contain DMC, BATES and ANCHOR floss
  42. numbers, and some descriptions. I obtained the numbers and description from a few X-stitch
  43. books. After talking with my local craft store, I discovered that the companies, themselves, do
  44. NOT assign a name to the floss, just a number. The names are supplied by the publishers/authors
  45. of the X-stitch books. I do NOT claim that any of these files has the COMPLETE floss
  46. numbers, I loaded almost 100 DMC numbers, and the BATES and ANCHOR numbers that were
  47. associated with these.
  48.  
  49.                                    LIMITATIONS
  50.  
  51.      1. A maximum of 60 inventory files
  52.      2. Each file can contain a maximum of 500 records
  53.      3. Each item can be identified by a maximum of 6 characters
  54.      4. Each item can have a 50 character description
  55.      5. When the records are sorted, a STANDARD ASCII sort is performed.
  56.      this means that the following numbers:
  57.      1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
  58.      will be sorted:
  59.      1 10 11 12 13 14 15 16 17 18 19 2 20 21 22 23 24 25 3 4 5 6 7 8 9
  60.  
  61.      This is because the 1 is actually "1<NULL>" and 10 is "10<NULL> and  "10<NULL>" is
  62. before "2<NULL>". To keep the numbers in "human" sequence enter: 000001 000002 .....
  63. 000025 or <><><><><>1 <><><><><>2 ..... <><><><>25 where <> is a space. I have loaded the
  64. .INV files using the 000001 method. Use what ever works for you, JUST BE CONSISTENT. If I
  65. get a landslide of requests for a  different sort, I will write one.
  66.  
  67. NOTE: IF YOU USE <><><><><><>1 THE CURSOR WILL BE POSITIONED UNDER
  68. THE FIRST SPACE. THIS IS ] THE CURSOR IS POSITIONED UNDER THE FIRST
  69. "CHARACTER".
  70.  
  71.  
  72.                               EXECUTION OF INVENT
  73.  
  74. NOTE: I am assuming that you are familiar with basic DOS procedures, i.e.
  75. copying/moving/deleting files.
  76.  
  77.      When you have moved the .EXE and any of the .INV files to a directory, you are ready to run
  78. the program. Enter INVENT to start the program. If you have not deleted the .INV files, the first
  79. screen looks like this:
  80.  
  81.  
  82.                          01: ANCHOR   02: BATES  03: DMC
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.                     Enter file number to select inventory file
  90.                     Enter 04 to create a new file: 00
  91.                     Hit ESC to exit program
  92.  
  93.  
  94.  
  95.      At this point, you can enter the number associated with an existing file, or create a new file.
  96. As you create new files, they will appear on the screen. The number you enter will be entered
  97. from the right. Thus the 00 changes to 01 or 02 or 03 or 04. If you have 15 files, the 00 changes to
  98. 01 and the 12, as you enter "12". You cannot enter a number larger than the number of files + 1. If
  99. you make a mistake, use the backspace key to correct the number. Then hit ENTER to load the
  100. file. (See CREATING NEW FILE for
  101. information on creating new files)
  102.  
  103.                            WORKING WITH EXISTING FILES
  104.  
  105.      After selecting a file, the file is loaded. A "Loading inventory file" message is displayed. A "."
  106. will be repeated across the screen as the file is loaded. After the file has been read, the following
  107. screen is displayed:
  108.  
  109.      Add New Items: F1 Delete Items: F2  Change Quantity: F3 Change Description: F4
  110.      Change Sort Field: F5 Set Search Criteria: F6 Color Code: F7 Print Function: F8
  111.      Save and Continue: F9 Save and Exit: F10 Quit and Exit: F11
  112.  
  113.      abcdef(000) ghijkl(000) mnopqr(000) stuvwx(000) yz1234(000)
  114.                                    .
  115.                                    .
  116.                                    .
  117.                                    .
  118.                                    .
  119.  
  120.        DESCRIPTION: description of entry
  121.  
  122.      The screen can hold 19 rows of 6 columns of information. Use the arrow keys (UP, DOWN,
  123. LEFT & RIGHT) to move the cursor. HOME will move the cursor to the first column in the
  124. current row, END to the last column. PAGE UP & PAGE DOWN will scroll display. A
  125. <BEEP> will sound if you attempt to move the cursor past the beginning or end of a row, or
  126. past the top or bottom of the data. If you <ARROW DOWN>, the screen will scroll 1 line up (if
  127. possible). If you <ARROW UP> the screen will scroll 1 line down, until the top of the data is
  128. reached. As the cursor moves from 1 item to another, the "DESCRIPTION:" will change.
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.                               Add New Items: F1
  140.  
  141. To add new items, hit F1. the following screen is displayed:
  142.  
  143.      Enter each field, ending each entry with ENTER
  144.      When finished, hit ENTER with no information
  145.  
  146.  
  147.                     Identifier: ______
  148.                     (5 Characters)
  149.  
  150.                     Quantity: ___
  151.                     (3 numbers)
  152.  
  153.                     Description: __________________________________________________
  154.                     (Optional 50 characters)
  155.  
  156.      Enter the item identifier, and hit enter. The Quantity field will change to 000, the default
  157. quantity. Change the quantity by entering a number, and hitting enter. Enter a description, and
  158. hit enter. After each entry, the cursor returns to the Identifier field. Hit enter with no information
  159. to return to the first screen. The information you entered will be sorted into the existing data.
  160. The data screen will be displayed, starting at the top of the file.
  161.  
  162.  
  163.                               Delete Items: F2
  164.  
  165.      To delete items, move the cursor to the item and hit enter. The display color of the item
  166. changes to a dark gray. The actual deletion will NOT take place until the file is saved. To finish
  167. flagging items for deletion, hit ESC. When you have flagged item to be deleted, a new function
  168. is available:  Undo deletion: F12/ALT-F2
  169.  
  170.      If you change you mind about deleting the items, you can either Quit and Exit (see below),
  171. hit F12 or ALT-F2. This will unmarked ALL the items currently marked for deletion. Under
  172. Windows F12 does not work. Use ALT-F2. If you're not using WIndows, you can use either F12
  173. or ALT-F2.
  174.  
  175.  
  176.                               Change Quantity: F3
  177.  
  178.      After depressing F3, the top of the screen changes to:
  179.  
  180.                Finished: ESC Increase quantity by 1: F1
  181.                Decrease quantity by 1: F2 Enter New quantity: F3
  182.                Current Quantity: 000
  183.  
  184.  
  185.      The data portion of the screen does not change. Move the cursor as above. The quantity of
  186. the item will be displayed at the top of the screen. When the cursor is under the item whose
  187. quantity you wish to change, depress the appropriate Function key. Increasing or decreasing
  188. the quantity will adjust the "Current quantity", and the quantity above the cursor at the same
  189. time. If you make an error, re-adjust the quantity, or QUIT & EXIT.
  190.  
  191.      To enter a new quantity, rather than doing multiple increase or decrease by 1, hit F3. The
  192. display changes to:
  193.  
  194.      Finished:Enter Cancel new quantity: ESC Correct error: BACKSPACE
  195.      Enter new quantity: 000
  196.  
  197.      As you type numbers, they are loaded right to left, i.e. change the to quantity to 15: 000 goes
  198. to 001 to 015. If you make a mistake, use the backspace key, 015 would go to 001. When the
  199. quantity is "right" hit enter. If you change your mind, hit ESC to cancel this function and return
  200. to the previous screen. NOTE: You can change the quantity of item marked for deletion. Why
  201. you would want to do this is beyond me, but you can if you
  202. want to.
  203.  
  204.                                    Change Description: F4
  205.  
  206.      To change a description move cursor to the item whose description you wish to change, and
  207. hit F4. The bottom of the display will change to show to current, or old description, and a line
  208. appears for entering a new description. To keep the "old" description, hit enter without entering
  209. anything.
  210.  
  211.                     Change Sort Field: F5
  212.  
  213.    This option allows you to specify the field to be used when sorting the inventory file.  The
  214. screen changes to:
  215.  
  216.      Finished: ESC  Sort By Item: F1 Sort by Quantity: F2 Sort by Description: F3
  217.      Current sort field is: CURRENT SORT.
  218.  
  219. By depressing the appropriate Function key, you can PERMANENTLY change the sort field.
  220. The new order is shown immediately. This sort field remains in effect, for this file, until it is
  221. changed.
  222.  
  223.                    Set Search Criteria: F6
  224.  
  225.     This function allows you to search the entire file for specific words, or letters, in the
  226. description field. The screen changes to:
  227.  
  228.      Done Searching: Esc Start Searching: F1 Print Search Results: F3
  229.      Reset search Criteria: F4
  230.  
  231.   Selecting F1 prompts you to enter the characters to search for. Enter the characters and hit
  232. enter. All the descriptions will be searched for these characters. When any matches are found,
  233. the item number will be displayed in white. DO NOT BE CONFUSED BY THE DISPLAYED
  234. DESCRIPTION. IT IS ASSOCIATED WITH THE CURSOR NOT THE HIGHLIGHTED
  235. ITEM NUMBER. Additional searchs DO NOT RESET THE ITEM NUMBER DISPLAY. You
  236. can search for multiple descriptions and have all the results displayed at once. F3 will print ALL
  237. highlighted item numbers. This allows you to search for red, blue and green, and do 1 printing of
  238. these items. F4 will reset the items to their original color and you can start afresh.
  239.  
  240.                Color Code: F7
  241.  
  242.    This function allows you to color code the individual items. Each function key is associated
  243. with a different color. Select the color, move the cursor and hit enter. WINDOW USERS: USE
  244. ALT F2 INSTEAD OF F11 AND ALT F1 INSTEAD OF F12.  The colors you cannot select
  245. are: White, Dark Gray and Black. Light Gray is the default.
  246.  
  247.                Print Function: F8
  248.  
  249.    This function allows you to print part, or all, of the inventory. The screen changes to:
  250.  
  251.      Finished Printing: ESC Print Entire Inventory: F1 Select Items to print: F2
  252.  
  253. Selecting F1 will print the entire inventory. Selecting F2 allows you to select specific items.
  254. Move the cursor to the desired item, hit enter. The selected item will blink.  Hit ESC when you
  255. are finished selecting items. After selecting items, a third option os available: Print Selected
  256. Items: F3.
  257.  
  258. NOTE: MAKE SURE THE PRINTER IS READY, I DON'T. IF YOU GET A PRINTER ERROR, ABORT WILL THROW YOU
  259. OUT OF THE PROGRAM WITHOUT SAVING YOUR WORK.
  260.  
  261.  
  262.                                         Save and Continue: F9
  263.  
  264.      This function key will save the current inventory, deleting any items that have been marked
  265. to deletion. The inventory is then re-loaded, and you can continue.
  266.  
  267.                                         Save and Exit: F10
  268.  
  269.      This function key will save the current inventory, deleting any items that have been marked
  270. for deletion. You are then returned to the file selection screen to either select a another
  271. inventory file, create a new inventory file, or exit from the program.
  272.  
  273.  
  274.                  Quit and Exit: F11/ESC
  275.  
  276.      When running INVENT under Windows, F11 does not work, use ESC. If you are NOT using
  277. Windows, you can use either ESC or F11. This function key returns you to the file selection
  278. screen. The inventory file is NOT updated. ANY WORK THAT YOU DID SINCE THE LAST
  279. SAVE IS LOST!.
  280.  
  281.  
  282.                          CREATING NEW FILES
  283.  
  284.      You can create new inventory files by entering the number shown on the file selection screen.
  285. You are prompted for a file name. Enter up to 8 characters. DO NOT ENTER THE .INV, THIS
  286. WILL BE DONE AUTOMATICALLY. Hit ENTER when done. If you do not enter a name,
  287. and you hit enter, you will be returned to the file selection screen.
  288.  
  289.      If you attempt to create a file that already exists you will receive an error message and be
  290. returned to the file selection screen. After naming the new file, the ADD NEW ITEMS screen is
  291. presented. You can begin adding the items to the file. (See above for manipulating the inventory
  292. once you've loaded it) NOTE: Quit and exit will NOT save the new file. This is the only time
  293. you can "re-create" a file.
  294.  
  295.                                         CONCLUSION
  296.  
  297.      I hope you find the program useful. Any suggestions for upgrades are welcome. Any
  298. comments about the display, the function keys etc are also welcome. If any part of this
  299. document are unclear, please let me know.
  300.  
  301.  
  302.  
  303.                                    FOR THE REALLY CURIOUS
  304.  
  305. Those of you who are curious about the format of the .INV files, here it is:
  306.  
  307. Starting in Column 1:
  308. maximum of 6 characters and a "/". The "/" is the indicates the end of the identifier. This is for
  309. reading in the item identifier,  and allows for spaces.
  310. 1 space.
  311. the quantity.
  312. 1 space.
  313. 7 - this is  controls the color uses to display this item. (Version 2.0 will use this)
  314. 1 space.
  315. The description, again terminated with a "/".
  316.  
  317. If you want to enter the data outside INVENT:  USE A ASCII EDITOR NOT A WORD
  318. PROCESSOR.  FOLLOW THE ABOVEFORMAT. IF YOU DO THIS AND IT DOES NOT
  319. WORK, E-MAIL ME THE FILE AND I'LL  LOOK AT IT.
  320.  
  321.