home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / busi / blkbk512.zip / BLAKBOOK.DOC < prev    next >
Text File  |  1989-10-01  |  23KB  |  480 lines

  1.                            BLAQUE BOOK
  2.  
  3.  
  4. Important notes
  5.  
  6. --current  version  1.2 users make sure you read the  update
  7. section below regarding use of  SQZBB.COM to upgrade you existing
  8. database.    This  will  convert  your  BLKBOOK.DAT  file  to one
  9. compatible  with version  2,3 which  you then  can convert  using
  10. UPGRADE.EXE to the current datafile format.
  11.  
  12. --current version 2 - 3  users see UPGRADE information to version
  13.     5.1.
  14.  
  15.   Macros now available - see section on 5.1.
  16.  
  17. =================================================================
  18.  
  19. Blaque Book
  20.  
  21. Tired  of  rewriting your address book every  year  or  so?   The
  22. Blaque  Book  can save you considerable time and writer's  cramp.
  23. As a Database it is limited to Name, Address and Phone number and
  24. ,for that alone, it is surpassed by many general purpose database
  25. systems. Its forte is in the printed output which is formatted in
  26. mini,  alphabetized pages  which you  can assemble  into a pocket
  27. sized address  book.  There is  extra room under each  letter for
  28. additional entries which you can  later enter into your database.
  29. When you are ready for an updated address book, just print one.
  30.  
  31. I wrote the program because I had a need for the output  booklet.
  32. I  never  could see the value of a name and phone  number  (only)
  33. database because you usually need the numbers when you are not in
  34. front of the computer.   If you are in front of a computer, there
  35. is always SideKick.   I also wanted to learn more about Borland's
  36. Turbo Access system which seems to work just great.
  37.  
  38. System requirements: IBM-PC, 256K (mem) and a compatible printer.
  39. Your printer needs to be  capable of compressed printing and have
  40. adjustable  vertical  line  spacing  (most  do).    Adjustment of
  41. vertical spacing to about 9 lines per inch seems best.
  42.  
  43. Instructions:
  44.  
  45. The  program  is  essentially  menu  driven.   Several files will
  46. eventually be on your disk:
  47.  
  48. Blakbook.EXE -- Main Program
  49. Blakbook.DAT  -- Database File
  50. Blakbook.IXN  -- Name Index File
  51. Blkbk30.CFG  -- Configuration file
  52. Blakbook.MAC -- Macro file
  53. Util.EXE -- Blakbook utility file.
  54.  
  55. Except  for  the main program files (.EXE),  each  will  be
  56. created by the program as needed.   If you don't need the utility
  57. functions, you  only need BLAKBOOK.EXE to  start with, the others
  58. will  be  created.    However,  the  CFG  file  does have several
  59. printers present which you may select  from or use as examples in
  60. configuring your own.
  61.  
  62. Creating  your  database  is  done  by  using  the  U)date / A)dd
  63. options.   Enter the data as  requested.  Duplicate Keys  are not
  64. allowed.  The key is created  from the some of the lastname, some
  65. of the firstname,  some of the first address line  and the last 4
  66. digits of  the phone number.   If you  accidentally get an  error
  67. notice, you  must change something  in the above  fields to allow
  68. entry.  In this way, you can enter a name twice to get a business
  69. and home listing  if necessary.  Editing during  A)dd or E)dit is
  70. made easy by the  use of the arrow keys (or ^S,  ^D, ^E, ^X).  ^Y
  71. will erase  entry from the  cursor to the  right.  DEL,  ^G erase
  72. character under  the cursor and  back arrow deletes  character to
  73. left  of cursor.   The   added/edited entry  is updated  into the
  74. database by  either using the  enter (carriage return)  key while
  75. the cursor is in the last field or  by using ^Z at any time.  You
  76. may cancel your entry or edit by using the ESC key at any time.
  77.  
  78. You may review your data on the screen using the B)rowse option.
  79.  
  80. P)rint  will send  output to  the printer.   The  default printer
  81. configuration is for  an Okidata with Plug 'N  Play (original IBM
  82. dot matrix printer  foramt). If you have another  printer, a menu
  83. option   is  available   to  create   a  configuration   file  to
  84. set-up/select your printer.  This set-up need only be done once.
  85.  
  86. The printer output is as follows:
  87.  
  88. < Section Deleted  -- update in Section on 3.0 >
  89.  
  90. After  printing all you need to do is get out your  scissors and
  91. stapler.
  92.  
  93. Exiting the Program
  94.  
  95. It  is  very important that you exit the program  using  the Q)uit
  96. options  until  you reach DOS  level.   This  enables proper
  97. updating and closing of all files.  ^C and Break Keys have been
  98. disabled to help keep your database file and index intact.   Using
  99. Ctrl-Alt-Del may irretrievably disrupt them. Keeping  backup copies
  100. of your Blkbook.DAT  and  Blkbook.IXN files is recommended.
  101.  
  102. ==================================================================
  103.  
  104. The history of Blaque Book
  105.  
  106. Modifications from BLAQUE BOOK Version 1.0 to 2.0
  107.  
  108. FIRST  AND FOREMOST -- The data STRUCTURE HAS BEEN  CHANGED. All
  109. is not lost however.   You need to run the SQZBB.COM  program on
  110. your existing BLKBOOK.DAT file.  This compresses your existing data
  111. by about 14% and will make it compatable with version  2.0.
  112. Important--ONLY  RUN this program once.   Once you convert it,  I
  113. recommend you remove SQZBB.COM from your active disk.
  114.  
  115. The  working  program BLAKBOOK.COM still runs  as  described above.
  116. It  needs only the BLKBOOK.DAT and BLKBOOK.IXN files  to operate.
  117. It  will  create  those files and you  may  optionally create  a
  118. BLKBOOK.CFG  file if you need  it  to  configure  your printer for
  119. proper output.
  120.  
  121. Thanks for the comments and suggestions.  I have included in Ver
  122. 2.0 some of the more easily implemented ones.   I have  also
  123. included  some  information  about the file structure  for  those
  124. interested in playing with the database itself.
  125.  
  126. When  I  originally created the program,  it  started  as  a kludge
  127. from  the BTREE file distributed as a demo from  Borland. The
  128. database  management  is  still  essentially  through  Turbo
  129. Toolbox routines.   You can find a description of those  routines
  130. in Borland's Toolbox package.   Many of you requested information
  131. on the file structure so that you might be able to convert to and
  132. from  other databases.   I have included 2 files (BBTOTXT.PAS and
  133. TXTTOBB.PAS)  in  which you can see the data  structure  and  the
  134. basic retrieval and storage routines.
  135.  
  136. BLAKBOOK.COM  has been modified to allow the printing  of  a label
  137. or envelope from the entry/edit form.  It is the 'P' option
  138. available  after  you have found and displayed the desired  name.
  139. It will prompt for the number of spaces to the right of the  left
  140. margin you want to print the address.   The printer output format
  141. is default.
  142.  
  143. A  selection of utilities have been added.  They are contained in
  144. BBUTIL.COM  which  can  be either chained  to  from  BLAKBOOK  or
  145. executed from DOS.  It does not need to be present on your Blaque
  146. Book  disk unless you want to chain to it from the main menu (new
  147. option).    It  requires a copy of BLKBOOK.DAT be present on  the
  148. same disk and directory.  Functions thus far enabled are:
  149.  
  150. 1. Conversion to and from DBASEII
  151. 2. Conversion to and from DBASEIII
  152. 3. Conversion to and from PC-FILE
  153. 4. Conversion to and from Text files
  154. 5. One up mail label printing with Note field keys
  155. 6. Fix routine to help retrieve a corrupted index file
  156.  
  157. The conversion to DBASE (R) requires some knowledge of the use of
  158. DBASE II or III.   The conversion routine creates a special  text
  159. file  which  can  then  be APPENDED to a  DBASE  (R)  file.   The
  160. commands  to  use are demonstrated when  the  utility  conversion
  161. routines are run.
  162.  
  163. Modifications for BLAQUE BOOK Version 2.0
  164.  
  165. Conversion  to  PC-FILE (R) requires that the  PC-FILE  (R)  file
  166. structure  be created in advance.   Again,  you will be warned of
  167. this and given examples when the utility is run.
  168.  
  169. Conversions  back  to the BLAQUE BOOK are done directly from  the
  170. DBASE (R) or PC-File (R) files directly.   NOTE:  ALL conversions
  171. back  to BLKBOOK.DAT will CREATE a NEW BLKBOOK.DAT.   It  is  not
  172. appended.   I  strongly  suggest that you keep a backup  of  your
  173. original data on another disk or directory.
  174.  
  175. Lastly,  though this had been included in some of the version 1.2
  176. distribution, is an installation routine for terminal type.
  177.  
  178. I hope these additions make the program more useful and flexible.
  179. As  I  stated above,  I didn't want to write an  entire  database
  180. management  program  but  just create  a  conveniently  updatable
  181. address book.
  182.  
  183. Modificataions added in version 3.0
  184.  
  185. Due  to a bug which went unnoticed in the distribution of version
  186. 2.0, the output was completely distorted in blank entry sections.
  187. I  sent  out a quick fix but don't know if anyone  used  it.   It
  188. would be very discouraging to spend a couple of hours typing in a
  189. database  only  to find it printed out  garbage.   Because  of  a
  190. suggestion sent by Fred Ringwald, I decided to rewrite the output
  191. routine.   This  new version only prints two pages side by  side,
  192. and only 6 entries per minipage.  It is nicer, though, because it
  193. is a physically smaller book.  All of the blank entries have been
  194. omitted.   The  pages  are  printed  ascending on  the  left  and
  195. descending  on the right.   All you need to to is stack them  up,
  196. staple them in the middle and fold it in half.   Instructions are
  197. printed when you print the booklet.
  198.  
  199. The printer output is as follows:
  200.  
  201.      .---------------.
  202.      .     A .     Z .
  203.      .       .       .
  204.      .       .       .
  205.      .       .       .
  206.      .       .       .
  207.      .       .       .
  208.      .---------------.
  209.      .     B .     X .
  210.      .       .       .
  211.      .       .       .
  212.      .       .       .
  213.      .       .       .
  214.      .       .       .
  215.       ---------------
  216.  
  217. Also  due  to a number of requests,  a second datafile  has  been
  218. added  to  accomodate  the configuration routines  of  up  to  30
  219. printers.   You merely find your printer or add it,  make sure it
  220. is  the  currently selected one and then forget  about  it.   Any
  221. subsequent  Blaque  Book  printouts will be configured  for  your
  222. printer.  You may delete the BLAKBOOK.CFG file as it is no longer
  223. necessary (if you already have it).   It has been replaced by the
  224. BLBK30.CFG  file  for  the printer  configuration  storage  noted
  225. above.   I  have  only  information  available  on  a  couple  of
  226. printers.   If you are using one not listed and develop a working
  227. configuration protocol,  I would appreciate hearing what you used
  228. so I can include them in future distributions of the CFG file.
  229.  
  230. The  standard color format as distributed will be white on black.
  231. I  received  many comments regarding problems with  the  previous
  232. colors.   These can be changed by selecting the 'C olor'  command
  233. in  the first menu.   Then by use of the 'F oreground',  'B  ack-
  234. ground',  and  'M essage' toggles you can step through to  colors
  235. which  you  might like.   The selected colors will be saved in  a
  236. special spot in the printer configuration file (BLBK30.CFG) if it
  237. exists.
  238.  
  239. Modificataions added in version 3.0
  240.  
  241. Please NOTE-- there is a potential problem with saving the colors
  242. in  the  configuration file.   If some joker changes all  of  the
  243. colors to the same,  you will see only a blank screen (ie.  white
  244. on  white) after the initial sign on message.   If that  happens,
  245. use 'C' then 'F',  and 'M' in that order.   Then you will be able
  246. to see what you are doing.
  247.  
  248. The only programs needed to run this package are BLAKBOOK.COM and
  249. BBUTIL.COM all data, index and configuration files may be erased
  250. if you are having a hard time getting started.
  251.  
  252. Though  the SQZBB.COM program is still included,  it is ONLY  for
  253. those using Versions less that 2.0.
  254.  
  255. One  additional comment.   Some of you have written that you  get
  256. errors in the Find menu selection, some have included a print out
  257. showing  a screen with an indiciation of a very high or  negative
  258. number  of  records.   What  has probably happened is  that  your
  259. system  was  turned off or had the power interrupted  before  you
  260. exited the program using a 'Q' command.  The data/index files are
  261. then  out of sync or disrupted.   There are two potential  fixes.
  262. The  first is to run BBUTIL.COM and select the option  that  will
  263. re-create  the index file.   If that doesn't work,  then use  the
  264. option  that  converts Blaque Book to Text files.   Remember  the
  265. name you select (ie.  DUMMY).   The extension .TXT will be added.
  266. This routine looks only at valid data and does not use the  index
  267. file.   Then  re-create your entire database and index using  the
  268. Text  to  Blaque  Book  selection.  The input  for  this  routine
  269. requires  the  entire file name (ie DUMMY.TXT) to  be  typed  in.
  270. Then  use the Blaque Book selection or run Blaque Book from  DOS.
  271. You  will  have  to check through your database to see  what  you
  272. might  have lost during the power failure but at least most  will
  273. be saved.
  274.  
  275. 3.1
  276.  
  277. Utility  routine  for label printing enhanced to single or  three
  278. up.  Additional routine for creating a mailmerge file included in
  279. the utilities.
  280.  
  281. 3.2  -- Mailmerge modified to select on Note Keys.
  282.  
  283. As is mentioned in the program, considerable effort went into its
  284. development.  It is distributed  under the user supported concept
  285. and if you feel the program to  be of value, a contribution of $7
  286. (the  cost  of  a  good   address  book)  would  be  appreciated.
  287. Obviously,  I haven't  created this   program to  get rich.   The
  288. program has  been greatly enhanced  by user comments  and I would
  289. appreciate your comments  even if you don't think  it's worth $7.
  290. In any case,  please feel free to share  this program with others
  291. and upload it to your favorite bulletin board.
  292.  
  293. 3.31 -- Bug causing abort to DOS after color selection fixed.
  294.  
  295. 4.0  -- BLAKBOOK.EXE  and  BBUTIL.EXE  converted to  Turbo Pascal
  296. Version 5.0.   Database and Index slightly modified  to work with
  297. the upgraded Turbo Pascal database units.  Therefore, the program
  298. is NOT  COMPATIBLE with earlier  databases.  Conversion  is easy!
  299. Use BBUTIL.COM (from  the earlier version) to create  a text file
  300. (BB  to Text  conversion). Copy  the text  file to  a new disk or
  301. directory  where  you  have  BLAKBOOK.EXE  and  BBUTIL.EXE.   Use
  302. BBUTIL.EXE to  create your datafile  and index (TEXT  to BLAKBOOK
  303. routine).
  304.  
  305. A browse  function has  been added  to the  main menu.   You  may
  306. peruse through your entries and the select one to be edited.
  307.  
  308. The print out is unchanged.
  309.  
  310. The configuration file  is unchanged and may be  copied from your
  311. old 3.+  version.  The CFG  file included has had  a few printers
  312. added.
  313.  
  314. 5.0 -- Significant  upgrade.  In response to  many users, several
  315. more fields have been added.   Space for Company, Title, 2 Street
  316. address lines; separate fields for  City, State and Zip Codes, as
  317. well as  another note line have  been added.  This  about doubles
  318. the size  of the database  but for the  usual personnal name  and
  319. address  book this  is not  significant.   Because of  the larger
  320. record  size --  THE DATA  FILE IS  NOT COMPATIBLE  with previous
  321. versions.   An UPGRADE.EXE program has  been provided to generate
  322. your new data  file from the old.  It  attempts to separate city,
  323. state and zip  fields from the earlier second  address field.  It
  324. might not  be perfect but at  least it doesn't require  typing in
  325. all of  your data.   The default database  name for version  5 is
  326. BLAKBOOK.DAT.    Version  4  was  BLKBOOK.DAT  so  the  files can
  327. co-exist  in the  same directory.   UPGRADE  is executed from the
  328. command line by:
  329.  
  330.    C:UPGRADE BLKBOOK.DAT BLAKBOOK.DAT
  331.  
  332. you MUST have  two arguments so you'll need to  type in the above
  333. noted .DAT filenames.   Version 4 did allow  other datafile names
  334. (as does version  5 -- see below).  If  you have older files with
  335. datafiles  named  other  than  BLKBOOK  or  want  a different new
  336. filename, you may use the format:
  337.  
  338.    C:UPGRADE <oldfilename> <newfilename>
  339.  
  340. One last note  about upgrades.  If you have  a VERY early version
  341. (less than 2), UPGRADE.EXE will not convert your files.  You must
  342. first  run SQZBB.COM  -- ONCE!  on you  old database.   Then  use
  343. UPGRADE and select  2 for the input file type  (when asked).  See
  344. the above notes for further information on SQZBB.COM.
  345.  
  346. The booklet has also been significantly improved.  The program is
  347. "smarter" and  leaves out all of  the blank lines resulting  in a
  348. smaller   book.     Also  options   are  provided   to  eliminate
  349. company,title fields,  address fields, and  note fields from  the
  350. booklet.  Lastly, an option is provided to allow a second listing
  351. by  company (names  and numbers  only) at  the end  of the  first
  352. listing.   You  should be  able to  fashion exactly  the type  of
  353. listing you require.  Though  the database is capable of indexing
  354. millions  of  records,  the  page  locating  array  is limited by
  355. memory.  I have limited the  number to $1000 (4096) entries which
  356. should be more than most folks can  stuff into a pocket.  You can
  357. store a lot  more entries in the database  but the program cannot
  358. print using the small page format.
  359.  
  360. The utilities section has also been improved.  Selections are now
  361. provided from a pulldown menu that should be quite easy to figure
  362. out.    Output  to  a  mail  label  generator has been eliminated
  363. because  of increased  amount of  available data.   I  may add it
  364. again  later if  I can  figure out  a good  protocol.  Output and
  365. input from several types of files are available:
  366.  
  367.         PC-FILE (the earlier version)
  368.         DBASEII, DBASEIII -- output is  to SDF or delimited files
  369.                  which  must  be  APPENDED  to  an existing dbase
  370.                  file.   Input  from DBASE  is directly  from the
  371.                  .DBF  files.   Appending and  reading from these
  372.                  files  requires  that  the  files  be configured
  373.                  EXACTLY as  is the BLAQUE BOOK  database.  Field
  374.                  descriptions are well  outlined when the program
  375.                  is run.
  376.         SDF,CDF -Space  defined files (SDF)  are text files  with
  377.                  each field taking exactly  the space requred for
  378.                  each field.  You may  use this to mass edit your
  379.                  database and then reload  it.  Note: because the
  380.                  record  size is  over 255  characters some  text
  381.                  editors may not be able to be used.
  382.                  Comma  defined files  (CDF) are  also text files
  383.                  with each field separated by  a comma.  There is
  384.                  no extra space and the line length and file size
  385.                  is usually much smaller.  If your text editor is
  386.                  unable  to  untilize  the  larger  SDF file, you
  387.                  should be  able to mass  edit using a  CDF file.
  388.                  You'll just have to count commas to figure which
  389.                  field you are in.
  390.         Alpha  listing  -  to  a  file  or  output  directly to a
  391.                  printer.   This is a nice  plain vanilla listing
  392.                  of your phone list with empty fields ignored.
  393.  
  394. A FIX  routine is  still available  to salvage  lost or corrupted
  395. index files.
  396.  
  397. You may now use multiple databases.  Several users have requested
  398. this capability to allow more than one person to use the program.
  399. Different  databases  are  selectable  only  when  the program is
  400. initially  run.    ie  C:BLAKBOOK  MYDATA  would  setup  and  use
  401. MYDATA.DAT and  MYDATA.IXN.  The  same database is  automatically
  402. selected when you clone to  the uTility program (BBUTIL.EXE) from
  403. the main menu.  If you run  BBUTIL from the command line, you may
  404. also select another database (ie BBUTIL MYDATA).
  405.  
  406. BLAKBOOK Version 5.1 -- MACRO utility added.
  407.  
  408. A macro  key utility  is now  available.   You can  record a  key
  409. sequence to  any of the function  keys (plus shift, alt  and ctrl
  410. Function keys)  as well as Alt  letter keys.. You can  record any
  411. key  sequence that  you frequently  use to  make the program more
  412. convenient.  For example, you  might want to record several City,
  413. State, and Zip code combinations to various Alt-letter keys.  The
  414. next  time you  need the  combination, you  only need  to use the
  415. alt-letter key when you reach the city portion of the address and
  416. the information is immediately entered -- no errors!
  417.  
  418. The easiest way to use the macro recorder is to go to the portion
  419. of  the menu  or program  in which  you want  to start your macro
  420. sequence.  To  start recording use the <ALT>= key.   You will the
  421. be prompted for the key you wish to use (bottom line of display).
  422. Touch the Function key or Alt key  you wish to program.  You will
  423. then  be prompted  for the  Name you  wish to  call the sequence.
  424. (The name will be used to  list the available sequences.) Type in
  425. a name of up to 14 characters and finish with the ENTER key.  You
  426. will now  see the message RECORDING  MACRO on the bottom  line of
  427. the display.   From this point until you  turn off the recording,
  428. all keystrokes will be recorded (up to 1000 -- more than enough).
  429. Go through  the sequence you  wish to record.   It can  either be
  430. a menu command  sequence or an  entry sequence such  as the city,
  431. state, zip noted above.  After  you have entered the last desired
  432. keystroke of your macro, turn off the Macro recorder by using the
  433. <ALT>- key.  That's all there is to it.
  434.  
  435. A suggested macro that I use is to use F10 to file an entry.  You
  436. may  have  noted  that  on  adding  or  editing  an  entry to the
  437. database, you  must either repeatedly  use the enter  key to pass
  438. the last  note field or (if  you looked at the  help box) you can
  439. use the <CTRL>Z key combination from any field to file the entry.
  440. I used the macro recorder to store the <CTRL>Z key combination to
  441. the F10  key.  A single  key is always quicker  and easier than a
  442. key combination.  Now using F10 from any field in the Add or Edit
  443. section, will  store the data.   Obviously, I  could have written
  444. the program  to use the  F10 key in  this way.   But -- different
  445. strokes for  different folks.  This  way the system is  much more
  446. flexible and you can roll your own commands.
  447.  
  448. The macro file (BLAKBOOK.MAC)  is automatically loaded on running
  449. the program and saved when you Quit.   You may also use the Macro
  450. command from the main menu  to view currently programmed keys and
  451. to reload or save your current  macros.  Note: you don't need the
  452. Macro command to record or use  your macros -- it just allows you
  453. to see  them.  Macros  are recorded using  the <ALT>= and  <ALT>-
  454. keys  as  noted  above.    Once  recorded,  any  time you use the
  455. programmed   key,  the   macro  sequence   will  be   executed  -
  456. immediately.
  457.  
  458. One other  minor change in version  5.1.  You may  use the escape
  459. key  to  exit  from  the  Add/Edit  entry  form without filing or
  460. updating the data.
  461.  
  462.  
  463. Considerable  time  and  effort  has  gone  into  improving  this
  464. utility.  I have increased the registration to $10.
  465.  
  466. Send    contributions-registrations   and/or    suggestions   for
  467. improvement to:
  468.  
  469. Martin C. Beattie
  470. 285 Southmoreland Place
  471. Decatur, IL 62521
  472.  
  473. (217) 423-8361
  474.  
  475. Blaque Book (C) 1985, 1986, 1989
  476.  
  477.  
  478.  
  479.  
  480.