home *** CD-ROM | disk | FTP | other *** search
/ Boston 2 / boston-2.iso / DOS / GRAFIK / TOOLS / PIX / PIXFILE.DOC < prev    next >
Text File  |  1993-12-01  |  24KB  |  453 lines

  1.                         PIXFILER Ver. 1.0
  2.                                 by
  3.                            Kirk Vistain
  4.  
  5.                           April 16, 1991
  6.  
  7.                            DESCRIPTION
  8.                            -----------  
  9. PIXFILER is a catalog program, specially enhanced for tracking PCX 
  10. and GIF files.  It gives you the power to view, comment, and group 
  11. pictures, all from one spot.  You can choose your viewer, and 
  12. password-protect both picture-viewing and comment display.  
  13. PIXFILER also reads the header of the picture files and stores 
  14. their specifications for easy reference.  If you have lots of 
  15. pictures scattered around your hard-drive, or want to be able to 
  16. attach comments, or control access, PIXFILER is for you.
  17.  
  18.                              FEATURES
  19.                              --------
  20. Directory Auto-Scan (no data entry for the user)
  21. Automatically enters file statistics
  22. Decoder (Viewer) is User Selectable
  23. Password Protection - if and when you want it
  24.  User must have security clearance to view a picture, or even see
  25.  the comments.  
  26. Auto-deletion from database if file not found
  27. Keyed searches
  28. Viewing possible from main screen or selection set (Find Screen) 
  29. Prints a password protected list of picture files. 
  30.  
  31.                  SPECIFICATIONS AND REQUIREMENTS
  32.                  -------------------------------
  33.             1.  IBM or compatible computer.
  34.             2.  DOS 3.1 or later.
  35.             3.  At least 384k of free memory.
  36.             4.  A decoder or viewer that can display GIF or PCX 
  37.                files, and accepts a filename passed to it 
  38.                from the DOS command line.  I tested this system 
  39.                with VGIF & VPIC by Bob Montgomery, and PICEM, by John
  40.                Bridges.  These decoders and others are
  41.                available from the Compuserve Graphics Support Forum.
  42.                GO PICS.  I'd recommend VPIC40.ZIP, the latest 
  43.                version of VPIC.
  44.             5. I suppose you could run the program without a hard 
  45.                drive, but I dont recommend it.
  46.  
  47.             PIXFILER could presumably work with any type of 
  48. picture, providing an appropriate viewer is available.  However, 
  49. it can currently read the header on GIF and PCX files only.  
  50.  
  51.      Remember, PIXFILER relies 100% on the particular decoder you 
  52. pick to display pictures.  It can't display them on it's own.  All 
  53. it really does is shell to DOS, and execute the decoder (viewer), 
  54. passing it the current file path and name as a parameter.  It's up 
  55. to the decoder to be compatible with your display, and reset the 
  56. screen to text mode on exit.  If you have trouble viewing 
  57. pictures, it's probably because of the viewer or inadequate 
  58. memory.  Try running the viewer on its own to get it set up 
  59. correctly.
  60.  
  61.                               SETUP
  62.                               ----- 
  63.      Put all the PIXFILER program files into their own directory.  
  64. It doesn't matter where the picture files are.  Run the batch file
  65. "START.BAT" to load the memory resident database engine and start 
  66. the menu.  If you wish to use password protection, you can set 
  67. that up now.  Skip down to that section in the instructions and 
  68. come back here when done.
  69.  
  70.      The program will make its own new data files if it finds none 
  71. in the data directory.  PIXFILER uses two, one to hold the records 
  72. describing the picture files, the other to hold records describing 
  73. the decoder program, and what extensions it works with.  
  74.  
  75.      Next you need to tell PIXFILER what decoder 
  76. (viewer) to use, and where to find it.  After selecting option 1 
  77. from the main menu, you will see the main data screen for file 1.  
  78. You need to switch to screen 2, to add the viewer name.  To do 
  79. this, press <+>.  Now A)dd the name of the viewer, including its 
  80. complete path and extension.  If PIXFILER doesn't find it, you'll 
  81. hear a beep, and will be unable to add the record.  You also must 
  82. specify what extension identifies files this decoder can handle.  
  83. You may have only one decoder (viewer) per extension, but you may 
  84. have many extensions for a particular viewer.  For example, VPIC, 
  85. by Bob Montgomery, can handle .PCX or .GIF files.  You would enter 
  86. its path twice, once with the picture extension GIF, once with PCX.
  87. When done with this, go back to the first screen by pressing <->.
  88.  
  89.                              Concept
  90.                              -------
  91.      PIXFILER follows a relational database model.  At its heart is 
  92. a database engine, with enhancements added to customize it.  
  93. PIXFILER is really a collection of programs, tied together with a 
  94. menu.
  95.  
  96.      Normally, you interact with PIXFILER by viewing screens and 
  97. selecting from menus.  Most screens have a status line at the top 
  98. and an information line at the bottom.  The information line 
  99. usually gives a selection of possible actions (a menu), while the 
  100. status line shows other things, such as date, time, number of 
  101. records in the file, or error messages.
  102.  
  103.      Think of screens as capable of displaying data and performing 
  104. certain functions, depending on the type of screen.  PIXFILER uses 
  105. several different screen types:
  106.  
  107.      Name          Data Displayed       Functions
  108.      ----          --------------       ---------
  109. Menu Screen        Programs to Run      Log on with password, 
  110.                                         select datafile path  
  111. Data Screen        Single data record   Add, Edit, Delete, Find, etc.
  112. Edit Screen        Single data record   Enter data, move cursor
  113. Find Screen        Selected data for    Cursor functions
  114.                    multiple selected
  115.                    records 
  116.  
  117.      A little further on, we'll cover these in more detail, but 
  118. first, let's talk about how to get the PIXFILER running.
  119.  
  120.                            The Programs
  121.                            ------------
  122.      As I mentioned before, PIXFILER is an application, made up of 
  123. several programs (modules), which you select from an opening menu.
  124. The most basic program is the memory-resident database engine, 
  125. called DBIO33.EXE.  Most of PIXFILER's modules use the functions in 
  126. DBIO33, so it makes sense to run it only once and leave it in 
  127. memory during the entire session.  Using this common module for 
  128. all the application's programs reduces disk-space requirements 
  129. because it is not duplicated in every program, and speeds program 
  130. loading.  When you're done with the application, a program called 
  131. REMDBIO.EXE, removes it from memory.
  132.      You can do all this from the command line if you like, but I 
  133. have included a batch file called START.BAT to do it for you.  You 
  134. may rename it if you like.  This is the text of START.BAT.
  135.      @ECHO OFF
  136.      DBIO33
  137.      PIXFILE
  138.      REMDBIO
  139.      You should put all PIXFILER's files into their own separate 
  140. directory.  This makes maintenance much easier.  It is possible to 
  141. maintain different sets of datafiles in different directories, but 
  142. normally you won't need this capability.
  143.  
  144.                     Terminology & Conventions
  145.                     -------------------------
  146.      Throughout PIXFILER, I've observed certain common keystrokes.
  147. <ESC> normally quits the current function and returns you to the 
  148. previous menu. While you're editing, pressing <ESC> will throw away 
  149. any changes or additions you've made and return you to the data 
  150. screen.  On the other hand, pressing <F10> completes the edit, 
  151. saving the record.  <F1> normally invokes help.  If there is none 
  152. available for the current item, you will see a message to that 
  153. effect in the lower (information) line of the screen.
  154.  
  155.      Indexes are files, much like the indexes in a book, which 
  156. allow you to view database records in a particular order.  Indexes 
  157. use keys, derived from one or more data record fields.  They keep 
  158. track of the value of the key fields for all records.  Indexes 
  159. make it easier to find things in a data file.
  160.  
  161.      One index is designated the primary.  It determines 
  162. the order in which the main data screen displays.  The other, 
  163. secondary, indexes allow you to view the database records in a 
  164. variety of ways, via the find screen.  The program maintains the 
  165. indexes automatically. However, random events, disk failures, or 
  166. improper termination of the program may corrupt the indexes.  For 
  167. that reason, PIXFILER includes an option that corrects these 
  168. problems, insofar as possible. 
  169.  
  170.                          Learning PIXFILER
  171.                          -----------------
  172.      The best way to learn PIXFILER is to run it.  Most of the 
  173. screens and functions explain themselves.  Why not run the 
  174. program now and see what happens?  Once you have the data screen 
  175. up and running, using selection 1 from the menu, you can press 
  176. <F1> or H)elp to get a quick description of the commands. 
  177.  
  178.                        Main, or Data Screen
  179.                        --------------------
  180.      You start PIXFILER by typing START<ENTER> from the DOS command 
  181. line.  The first screen that pops up is the main menu.  You have 
  182. several choices.  One lets you view or maintain (add, edit, 
  183. delete, etc.) records.  Another lets you fix or re-index the data file 
  184. in case something goes wrong with the indexes, or the computer is 
  185. turned off before you properly quit the program after making 
  186. changes.
  187.  
  188.      Lets say you chose selection 1.  You'll see the main data 
  189. screen.  At the top is a line that gives the file number and how 
  190. many records it has.  If you've just started PIXFILER, you probably 
  191. have 0 records.  The line across the bottom of the screen shows 
  192. the commands available for this screen.  Most are obvious.
  193.  
  194.      N)ext and P)revious move you from one record to another, in 
  195. primary index order.  Of course, just now, there are no records.  
  196. D)elete removes a record and any linked records in other files, 
  197. after first asking you to confirm. <ESC> quits back to the 
  198. previous menu, saving any changes.  H)elp or <F1> displays a 
  199. screen describing what the other commands do.
  200.  
  201.      A)dd, E)dit, and C)opy all let you modify the contents of a 
  202. record.  Until now you've just been looking at them.  When you 
  203. invoke any of them, the cursor jumps up into the data record, and 
  204. the list of available commands on the bottom of the screen 
  205. changes.  You have now switched from command to edit mode.  When 
  206. you add or edit, PIXFILER validates some fields to help 
  207. avoid errors.  If a problem occurs, you'll hear a beep and see a 
  208. message at the top of the screen.  A)dd makes new data records.  
  209. E)dit modifies one already added. C)opy makes an exact duplicate 
  210. of the one you see on the screen, then switches to edit mode, to 
  211. allow you to change it.  This is helpful if you want to change 
  212. only a few things for the new record.
  213.  
  214.      Be advised that some fields or combinations must be unique.  
  215. Under these conditions, the program will warn you if you try to 
  216. enter a record with the same field values as another.  Not all 
  217. fields need to be unique - more on this later.  
  218.  
  219.      The main data screen also offers a F)ind function, that 
  220. allows you to search the file indexes on a particular key.  When 
  221. you press <F>, the bottom line of the main screen shows the name 
  222. of the currently selected index field.  By pressing the cursor up 
  223. or down arrows, you can select which index to search.  Another way 
  224. of saying this is that you have a choice of order in which to view the 
  225. records.  When you see the one you want, press <ENTER>, and the 
  226. line at the bottom of the screen prompts you for a pattern to 
  227. search for.  If you press <ENTER> it will display all the records 
  228. in the selected order, on the find screen.  If you enter a string 
  229. of characters, then <ENTER>, it will display all records for which 
  230. those characters occur as the first ones in the selected field 
  231. (key).
  232.  
  233.      When a F)ind is successful, and more than one record 
  234. satisfies your request, you see the records displayed, one line 
  235. per record, on a Find Screen.  This screen has a status line, that 
  236. describes it, at the top, and an information line, telling you how 
  237. to move through the records, at the bottom.  Note that, due to 
  238. space restrictions, only selected fields for a given record 
  239. appear.  You'll find special instructions for the PIXFILER Find 
  240. Screen farther on in this document.
  241.  
  242.      Again, the best way to learn how to use PIXFILER is to 
  243. use it.  Play around until you've figured it out, then start 
  244. adding data seriously.
  245.  
  246.                     SPECIAL PIXFILER FUNCTIONS
  247.                     --------------------------
  248.                Password (Security Level) Protection
  249.                ------------------------------------
  250.      There may be some pictures whose viewing you wish to restrict 
  251. to a limited number of people. PIXFILER offers this option via the 
  252. menu system.  If you simply select Menu Option 1 without first 
  253. performing L)ogon, the program automatically assigns you a level 
  254. 0.  You can still use most of PIXFILER's functions, but you will 
  255. be unable to view pictures, see comments, or edit any records that 
  256. have a level higher than your current one (0).  Of course, if you 
  257. want to ignore the password option altogether, just remember to 
  258. assign a level of 0 to all picture records.
  259.  
  260.      To logon with a higher level, you first need to define 
  261. passwords for PIXFILER.  Only someone with a level of 9 may modify 
  262. the password file.  PIXFILER provides the default password 
  263. "MASTER," to allow you to access it the first time.  Then you may 
  264. use the normal database functions to add your passwords and 
  265. assign levels.  You may wish to delete "MASTER" since anyone with 
  266. the program knows it to be the default.  It is also best to assign
  267. only one password a level 9 access.  When you're done with the 
  268. password file, <ESC> and you will return to the main menu.
  269.  
  270.      Pressing L for L)ogon, pops up a box into which you type the 
  271. desired password.  Then proceed to use PIXFILER as normal.  The 
  272. password protection is transparent until you try to violate it.
  273.  
  274.                      R)ead and Load Directory
  275.                      ------------------------
  276.      This function allows you to specify a directory to scan for a 
  277. particular extension.  PIXFILER will look for all files matching 
  278. the criteria, then attempt to read their headers, and 
  279. insert the data into the database. You have the option of 
  280. assigning security level and category to each automatically.  As 
  281. the scan progresses, the program increments a counter toward the 
  282. bottom of the screen.  When completed, it returns you to the main 
  283. (data) screen.  You may then view or edit as you wish.
  284.  
  285.      PIXFILER will not allow two records describing the exact same picture 
  286. and path to exist in the file.  Each path + picture name + picture 
  287. extension is unique.  For example, if you attempt to read and load the sam 
  288. directory twice, PIXFILER will simply ignore the results of the second 
  289. scan.  This makes it impossible for someone to reread a directory with a 
  290. lower security level and make the pictures available to at the lower level.
  291. Also, if you attempt to type in a duplicate record, PIXFILER will notify 
  292. you that it is not possible.  
  293.  
  294.                           V)iew Pictures
  295.                           -------------- 
  296.                        From the Data Screen
  297.                        --------------------
  298.      Assuming your computer has enough free memory, and you have 
  299. entered the name of the GIF or PCX decoder properly in the second 
  300. data screen, you can view the picture whose data currently appearrs on the sxcreen.  .  If PIXFILER doesn't find the picture (Perhaps you 
  301. erased or moved it since the last directory scan.), it will show 
  302. an error message to taht effect at the top of the screen, then 
  303. prompt you for deletion of the data record.  Presumably, there is 
  304. no point in keeping track of a file which no longer exists.  
  305. Remember that the database contains records that describe the 
  306. picture files.  It does not contain the files themselves.  When 
  307. you delete or otherwise alter a record, it doesn't affect on the 
  308. picture file it describes.
  309.  
  310.                From the Find (Selection Set) Screen
  311.                ------------------------------------
  312.      One convenience of an indexed datafile is the 
  313. ability to search out and list specific records in various sort 
  314. orders.  This makes it easier to find what you're looking for.  
  315. Once you've narrowed your search to the desired records, PIXFILER
  316. offers you the ability to view them.  Here's an example of how you 
  317. might use it.  Say you have 200 picture files scattered about your 
  318. hard drive.  You want to view all  with a category of 
  319. WEATHER.  Rather than having to N)ext or P)rev through the file, 
  320. you can simply F)ind, on CATEGORY, the key word WEATHER.  If more 
  321. than one record satisfies the conditions, you will see a list on- 
  322. screen, which summarizes the record data.  Note that the complete 
  323. record does not appear.  You can now move back and forth through the 
  324. list, using the cursor commands shown at the bottom of the screen, 
  325. viewing any pictures you wish.  It isn't necessary for you to 
  326. remember where they are on the disk, or to search the entire 200 
  327. records manually to find what you want.
  328.  
  329.      PIXFILER checks authorization level, existence of the picture 
  330. file, and existence of the decoder for that particular extension, 
  331. before displaying the picture.  If a check fails, you 
  332. will see an error message at the top of the screen.  
  333.  
  334.                           F)ind Function
  335.                           --------------
  336.      The main data screen offers a function that allows you to 
  337. search the file indexes on a particular key.  PIXFILER maintains 
  338. the indexes automatically.  The primary key is ordered 
  339. alphabetically by picture name + extension.  Whenever you are 
  340. viewing the main data screen, the records appear in this order.  
  341. You can choose other indexes to allow displaying the records in 
  342. different orders.  However, you can only see them in this order 
  343. via the Find screen.  Information in the find screen is a subset 
  344. of that in the main data record.
  345.  
  346.      When you press <F> the bottom line of the main screen shows 
  347. the name of the currently selected index field.  By pressing the 
  348. cursor up or down arrows, you can select the index to search.  
  349. When you find it, press <ENTER>, and the line at the bottom of the 
  350. screen prompts you for a pattern to search for.  If you press 
  351. <ENTER> it will display all the records in the selected order, on 
  352. the find screen.  If you enter a string of characters, then 
  353. <ENTER>, it will display all records for which those characters 
  354. occur as the first ones in the selected field (key).
  355.  
  356.  
  357.                               Report
  358.                               ------
  359.      You can print out a list of your picture files on any ASCII 
  360. printer, using the Report option from the main menu.  Only files 
  361. for which the operator has authorization will print.  By leaving 
  362. the selection criteria at their defaults, the program will print a 
  363. list of all files.  You may choose a particular combination of 
  364. picture type and category, if you like.  You can also choose to 
  365. send the list to the screen, instead of the printer.  The report 
  366. program prints in order of path+name+extension. 
  367.  
  368.                       Files Used by PIXFILER
  369.                       ----------------------
  370.  
  371. START    BAT   The batch file you use to run PIXFILER
  372. PIXFIL1  DAT#  The data file that contains picture information. 
  373. PIXFIL2  DAT#  The data file that contains viewer (decoder) names.
  374. DBIO33   EXE   The memory-resident database engine.
  375. PASSWD   EXE   The password program.
  376. PASSWFIX EXE   The password re-indexing program.
  377. PIXFIFIX EXE   The PIXFILER re-indexing program.
  378. PIXFIL   EXE   The main PIXFILER program.
  379. PIXFILE  EXE   The PIXFILER Menu.
  380. PIXREP   EXE   The report program.
  381. REMDBIO  EXE   Program to remove the database engine after use.
  382. PIXFIL1  K* #  Index files for PIXFIL1.DAT.
  383. PIXFIL2  K* #  Index files for PIXFIL2.DAT.
  384. PIXFILE  PK*#  Index files for PIXFILE.PWD.   
  385. PIXFILE  PWD#  Data file containing passwords.
  386.  
  387.      Files marked with # are generated by PIXFILER if it doesn't
  388. find them in the datafile path at start-up.  
  389. -------------------------------------------------------------------
  390.                            REGISTRATION
  391.                            ------------
  392.      PIXFILER and all its attendant documentation is (c) 1991, by 
  393. Kirk Vistain.  All rights reserved.
  394.  
  395.      I'm distributing the program under the "Shareware" concept.  It is 
  396. NOT free software and it HAS NOT been released to the public domain.
  397.  
  398.      DBIO33.EXE is (c) 1989,1990 by Top Gun Systems.
  399.  
  400.      If you find PIXFILER and associated programs useful and          
  401. convenient, you can register for $25.  This will entitle you to 
  402.  
  403.    1. Technical assistance via my Compuserve or Genie mailbox.
  404.       Sorry, but, no registration = no assistance. 
  405.    2. Notification of updates and other information pertaining to 
  406.       PIXFILER.       
  407.  
  408.      Make check or money order payable to Kirk Vistain.  Sorry, no charge
  409. cards.  All terms and specifications subject to change without notice.   
  410.                                                                  
  411.                            Kirk Vistain
  412.                        16035 Mulberry Lane
  413.                          Gurnee, IL 60031
  414.                      Compuserve : 72356,1355
  415.                        Genie   : K.VISTAIN
  416.  ----------------------------------------------------------------------------
  417.                          The Legal Stuff
  418.                          ---------------
  419.      Limitations:  You may make and keep one (1)back-up copy of 
  420. the software for your personal use, provided that (i) you copy all 
  421. the copyright, trademark, and other information indicated on the 
  422. initial screen display onto your backup diskette Label, and (ii) 
  423. you have registered.
  424.  
  425.     Also you may distribute copies to other persons, but solely 
  426. for their evaluation (i.e., to decide whether to continue using 
  427. the product and therefore register) and solely for evaluation by 
  428. such other persons during that thirty (30) day period.  PIXFILER 
  429. must NOT be sold or otherwise provided as part of a larger system, 
  430. or as a part of a more inclusive product or service, without the 
  431. express written permission of Kirk Vistain.
  432.  
  433.                              WARRANTY
  434.  
  435.      THIS PRODUCT IS LICENSED "AS IS" WITHOUT ANY WARRANTY OF 
  436. MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, PERFORMANCE, 
  437. OR OTHERWISE; ALL WARRANTIES ARE EXPRESSLY DISCLAIMED.  BY USING 
  438. THE PIXFILER PRODUCT, YOU AGREE THAT KIRK VISTAIN WILL NOT BE 
  439. LIABLE TO YOU OR ANY THIRD PARTY FOR ANY USE OF (OR
  440. INABILITY TO USE) OR PERFORMANCE OF THIS PRODUCT, OR FOR ANY 
  441. DAMAGES WHATSOEVER WHETHER BASED ON CONTRACT, TORT OR OTHERWISE, 
  442. EVEN IF I AM NOTIFIED OF SUCH POSSIBILITY IN ADVANCE.  (SOME 
  443. STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR 
  444. CONSEQUENTIAL DAMAGES, SO THE FOREGOING LIMITATION MAY NOT
  445. APPLY TO YOU.) 
  446.  
  447.      You may not reverse-engineer, disassemble, modify, decompile 
  448. or create derivative works of the product.  You acknowledge that 
  449. the product includes certain trade secrets and confidential 
  450. information, all of which is the copyrighted intellectual property 
  451. of Kirk Vistain. 
  452.  
  453.