home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / busi / wrklog12.zip / WORKLOG.DOC < prev   
Text File  |  1986-09-17  |  15KB  |  255 lines

  1.                               W O R K L O G 
  2.                               =============
  3.  
  4. WORKLOG was written by a freelance corporate communications consultant out 
  5. of necessity.  It is, basically, a "dedicated" spreadsheet for self-
  6. employed businessmen whose clients demand hourly accounting of services 
  7. rendered.
  8.  
  9. There is nothing particularly fancy about WORKLOG.  Most of the program 
  10. source code manages the workscreen and input/output to catch obvious 
  11. errors and prevent "accidents."  (In this respect WORKLOG is quite bullet-
  12. proof.)  Otherwise, anything you can do with WORKLOG, you can do with a 
  13. decent spreadsheet program.  But if all you want to do is keep logs of 
  14. time spent on client projects, calculate the amounts to be charged based 
  15. on hourly rates you specify, and print monthly records of time spent on 
  16. the projects, then you'll find WORKLOG a more efficient and, I hope, 
  17. elegant solution.
  18.  
  19. If your system has a fixed disk, put WORKLOG.COM on a separate directory, 
  20. and you'll have a quick, easy way to keep records of the time you spend on 
  21. various client projects.  You'll be able to see the effect any given 
  22. hourly rate has on total billings for the project for the month.  And, 
  23. when it's time to invoice your client, WORKLOG will print an itemized 
  24. listing of your services, which you can use as a "proof-of-performance" 
  25. attachment.
  26.  
  27. If you do not have a fixed disk, I suggest you put WORKLOG on a floppy 
  28. disk of its own.  WORKLOG generates data files as it is used (1626 bytes 
  29. for each month entered and saved), and you'll need a certain amount of 
  30. disk space to run the program and maintain records.
  31.  
  32. WORKLOG was written in Pascal and will run on IBM Personal Computers and 
  33. close compatibles.  It should run with any video display configuration, 
  34. but, to be frank, it has only been tested with the Monochrome Display and 
  35. the Color Graphics Adaptors.
  36.  
  37. ==========================================================================
  38.  
  39. USING WORKLOG
  40. -------------
  41.  
  42. To enter WORKLOG, simply type "WORKLOG" at the DOS prompt and hit <ENTER>.
  43.  
  44. After a brief program identification the main workscreen will appear.  It 
  45. is from this screen that you will perform all functions.
  46.  
  47. You will notice that the two bottom lines of the screen contain all the 
  48. available commands.  To invoke any of the commands, you simply press the 
  49. highlighted letter corresponding to the listed command.
  50.  
  51. Although the commands are either self-explanatory or self-documenting, you 
  52. may want to take a few seconds to read through the following notes.
  53.  
  54. ==========================================================================
  55.  
  56. WORKSCREEN COMMANDS
  57. -------------------
  58.  
  59. N - eNter line      This will probably be your most frequently used 
  60.                     command.  Use it to make an entry on the next 
  61.                     available line.  You are limited to a maximum of 24 
  62.                     entries per log.  If the log is already full, WORKLOG 
  63.                     will not let you make any more entries.  If you 
  64.                     haven't yet entered anything, WORKLOG will enter the 
  65.                     heading entry mode and will not allow you to enter on 
  66.                     line 1 until you complete the heading entry.  (See "H" 
  67.                     below).  Enter any alphanumeric string up to 6 
  68.                     characters long in the DATE field (e.g., "Mon 12").  
  69.                     Enter any alphanumeric string up to 48 characters long 
  70.                     in the SERVICES RENDERED field.  Enter the amount of 
  71.                     time you spent in hours in the HOURS field.  WORKLOG 
  72.                     keeps hours in 2-decimal-place numbers, so, for 
  73.                     example, "1 hour, 45 minutes" should be entered as 
  74.                     "1.75".  WORKLOG will not let you skip any fields 
  75.                     because an entry would be meaningless without all 
  76.                     three fields.  Neither will WORKLOG let you enter 
  77.                     weird hours, such as negative numbers or numbers 
  78.                     greater than 24.  (Try it!)
  79.  
  80. E - Edit line       "Edit" is probably the wrong word here.  This command 
  81.                     allows you to alter an entry by typing in a new one.  
  82.                     When you call this command, WORKLOG will ask you which 
  83.                     line you want to change.  Enter the desired line 
  84.                     number, then proceed as with the "N" (enter new line) 
  85.                     command.  If there is no entry at the specified line 
  86.                     number, you'll get an appropriate slap on the wrist.
  87.  
  88. D - Delete line     No explanation needed here.  But be careful: WORKLOG 
  89.                     cannot "undo" this kind of delete.
  90.  
  91. I - Insert line     Keeping entries in chronological order, or any other 
  92.                     order you choose, is entirely your responsibility.  
  93.                     WORKLOG is not smart enough to understand whatever 
  94.                     notation you may be using in the date field.  That's 
  95.                     where this command comes in handy.  When you invoke 
  96.                     it, you'll be prompted to enter the line number at 
  97.                     which you wish to insert an entry.  After that, the 
  98.                     procedure for making the insert is identical to that 
  99.                     for entering a new line (see "N" above).  When the 
  100.                     entry is completed, WORKLOG will automatically re-
  101.                     number the subsequent lines.  If you specify a line 
  102.                     number with no entry, WORKLOG will assume you still 
  103.                     want to make an entry and will default to the first 
  104.                     available line.  As with "N" (enter new line), WORKLOG 
  105.                     will not allow you to insert if the log is already 
  106.                     full.
  107.  
  108. C - Chg. rate       When you first start a new log, the hourly rate will 
  109.                     be set to zero.  You must use this command to enter 
  110.                     your hourly rate if you want WORKLOG to automatically 
  111.                     calculate the total time charge for the project.  You 
  112.                     can always change the rate at a later time by again 
  113.                     using this command.  WORKLOG will not accept bizarre 
  114.                     entries (such as negative numbers) in this field.  And 
  115.                     the maximum value you can enter as an hourly rate is 
  116.                     $999.99.  (If you charge more than that per hour, you 
  117.                     don't need this program.)
  118.  
  119. G - new loG         This command lets you start a new log without having 
  120.                     to exit and re-enter WORKLOG.  If you haven't already 
  121.                     saved the current on-screen log, you'll be given an 
  122.                     opportunity to do so.  (See "S" below.)
  123.  
  124. L - Load            Use this command to call up an existing log.  This 
  125.                     must be a file with an .WLG extension previously 
  126.                     created by WORKLOG using the Save command, and it must 
  127.                     reside on the same disk and directory as WORKLOG.  
  128.                     (See "S" below.)  When you enter the filename, WORKLOG 
  129.                     assumes the .WLG extension, so you don't need to type 
  130.                     it in.  If you haven't saved any on-screen log at the 
  131.                     time you invoke this command, you'll be given the 
  132.                     opportunity to do so.
  133.  
  134. S - Save            You can save your on-screen log at any time by using 
  135.                     this command.  WORKLOG will accept any DOS filname up 
  136.                     to 8 characters.  Don't bother entering an extension 
  137.                     because WORKLOG automatically adds a ".WLG" and will 
  138.                     not accept any characters after the first eight.  If 
  139.                     you had previously loaded a log from a disk file and 
  140.                     you've made some changes or additions to it during 
  141.                     this session, WORKLOG will ask you if you want to save 
  142.                     your updated log back to the same filename.  If you 
  143.                     answer affirmatively, WORKLOG will rename the old 
  144.                     version with a .BAK extension before saving the new.  
  145.                     The same is true if you specify a file that already 
  146.                     exists.  The only time WORKLOG overwrites a file is 
  147.                     when you save back to an existing filename that 
  148.                     already has a .BAK version.  In that case the old .BAK 
  149.                     will be wiped out by the new.
  150.  
  151. P - Page            You are limited to a maximum of 24 entries per log.  
  152.                     (If you need more than that, you'll have to start a 
  153.                     second log for the same project and month.)  But 
  154.                     WORKLOG can only display either the first or last 
  155.                     twelve entries at one time.  If you have more than 
  156.                     twelve entries, you can toggle back and forth between 
  157.                     pages 1 and 2 using this command.  Most of the time 
  158.                     page toggling will be automatic.  For example, if you 
  159.                     want to insert at line 15 but are looking at page 1, 
  160.                     WORKLOG will switch over to page 2 for you so you can 
  161.                     see what you're doing.
  162.  
  163. H - edit Heading    If you want to alter your log heading (client, 
  164.                     project, month, and year), you can do so with this 
  165.                     command.  When you start a new log, this is the first 
  166.                     command you should invoke.  In fact, if you try to 
  167.                     make a line entry without first entering heading 
  168.                     information, WORKLOG will automatically go into the 
  169.                     heading entry mode.  (See "N" above.)  You can enter 
  170.                     any alphanumeric string up to 47 characters long for 
  171.                     the CLIENT and PROJECT fields.  For the MONTH field, 
  172.                     simply enter a number between 1 and 12.  The YEAR 
  173.                     field only accepts 4-digit whole numbers between 1900 
  174.                     and 9999.  (We should all live so long.)  For MONTH 
  175.                     and YEAR you also have the option of entering "C".  
  176.                     This makes a call to DOS, and if the system date has 
  177.                     been properly set, you'll end up with the current 
  178.                     month and year in the respective fields.
  179.  
  180. R - pRint           Sorry I couldn't use "P" for this, but "Page" gets the 
  181.                     letter because it is bound to be a more frequently 
  182.                     called command.  When you select this command, you'll 
  183.                     be presented with two options.  I did this because I 
  184.                     was too lazy to study up on the variations in printer 
  185.                     control codes.  My printer (an IBM Quietwriter) can 
  186.                     print extended ASCII characters (above 127 decimal), 
  187.                     so I used them to create a more appealing printout.  
  188.                     If your printer can do the same, try entering "Y" at 
  189.                     the print option question.  I think I've avoided using 
  190.                     any control codes that are unique to the Quietwriter 
  191.                     printer, so most printers with the extended character 
  192.                     set should work.  If your printer produces garbage 
  193.                     characters or goes berserk with this option, enter "N" 
  194.                     at the question.  This latter option prints with 
  195.                     unfancy characters, like "-" and "=", so there 
  196.                     shouldn't be any problems.
  197.  
  198. X - eXit            Another self-explanatory command.  If you forgot to 
  199.                     save your log, WORKLOG will give you the opportunity 
  200.                     to do so before putting you back in DOS.
  201.  
  202. ==========================================================================
  203.  
  204. OTHER FEATURES
  205. --------------
  206.  
  207. Using WORKLOG should be fairly instinctive.  Single-letter entries, such 
  208. as the commands, do not require termination with the <ENTER> key.  
  209. Everything else does.  The backspace key does what you'd expect it to do 
  210. when you're making field entries.
  211.  
  212. But I've added a few features that'll make life easier, especially on 
  213. those occasions when you come to the realization that you've messed up but 
  214. good.  Commands with potentially annoying consequences have additional 
  215. steps that give you the chance to get out before you regret the move.  You 
  216. can start any single field over again by hitting the <ESC> key.  And, most 
  217. fields give you the opportunity to cancel and undo the entire command by 
  218. entering a "U".
  219.  
  220. ==========================================================================
  221.  
  222. SUGGESTIONS?  CONTRIBUTIONS?
  223. ----------------------------
  224.  
  225. WORKLOG does not pretend to perform fancy calculations.  Specifically, it 
  226. adds and multiplies.  And unless you have the need to keep logs of time 
  227. spent on multiple projects, it's quite useless.  But if, like me, you are 
  228. self-employed and have clients who require you to account for your time, 
  229. you may find WORKLOG handy.  As I stated at the outset, I wrote WORKLOG 
  230. out of necessity.  It does the job for me, and I'm pleased that it gives 
  231. me yet another justification for owning a PC.  I'd be even more pleased if 
  232. someone else out there finds this program remotely useful.
  233.  
  234. If you do find WORKLOG convenient and useful, I would appreciate a 
  235. voluntary contribution of, say, $15.  If you've done any programming, you 
  236. know that even a "simple" program like this represents many hours of work.  
  237. (A worklog of the time I spent developing WORKLOG would make long, boring 
  238. reading.)  If my efforts help make your life easier or give your business 
  239. a look of greater professionalism, a monetary show of appreciation would 
  240. encourage me to continue in this vein.
  241.  
  242. I am sure there are many ways in which I can improve WORKLOG.  I look 
  243. forward to receiving comments and suggestions from users.
  244.  
  245. Please send any comments, inquiries, and/or contributions to... 
  246.  
  247.                     Harron K. Appleman
  248.                     25 Waterside Plaza
  249.                     Suite UU
  250.                     New York, NY  10010
  251.  
  252. I can also be reached via CompuServe (ID# 73047,576).
  253.  
  254.                                  ###
  255.