home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 19 / CD_ASCQ_19_010295.iso / vrac / timclk11.zip / TIMECLK.TXT < prev   
Text File  |  1994-11-05  |  37KB  |  991 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                              PC-TimeClock (TM)
  9.                            Shareware Version 1.1
  10.                      Documentation Version 1.5 11/5/94
  11.  
  12.                 PC-TimeClock Copyright 1994 KMR Consulting
  13.          PC-TimeClock Documentation Copyright 1994 KMR Consulting
  14.                             All Rights Reserved
  15.  
  16.  
  17.                             Warranty Disclaimer
  18.  
  19. THIS SOFTWARE IS PROVIDED AS-IS.  THERE ARE  NO  WARRANTIES,  EXPRESSED  OR
  20. IMPLIED.    KMR  Consulting  DISCLAIMS  ALL  WARRANTIES  RELATING  TO  THIS
  21. SOFTWARE, WHETHER EXPRESS OR IMPLIED, INCLUDING  BUT  NOT  LIMITED  TO  ANY
  22. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
  23. AND ALL SUCH WARRANTIES ARE EXPRESSLY AND SPECIFICALLY DISCLAIMED.  NEITHER
  24. KMR Consulting, NOR ANYONE ELSE WHO HAS BEEN INVOLVED IN THE CREATION, PRO-
  25. DUCTION, OR DELIVERY OF THIS SOFTWARE SHALL BE  LIABLE  FOR  ANY  INDIRECT,
  26. CONSEQUENTIAL, OR INCIDENTAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO
  27. USE SUCH SOFTWARE EVEN IF KMR Consulting HAS BEEN ADVISED OF THE  POSSIBIL-
  28. ITY  OF SUCH DAMAGES OR CLAIMS.  IN NO EVENT SHALL KMR Consulting's LIABIL-
  29. ITY FOR ANY DAMAGES EVER EXCEED THE PRICE PAID FOR THE LICENSE TO  USE  THE
  30. SOFTWARE, REGARDLESS OF THE FORM OF THE CLAIM.  THE PERSON OR PERSONS USING
  31. THE SOFTWARE BEAR ALL RISK  AS  TO  THE  QUALITY  AND  PERFORMANCE  OF  THE
  32. SOFTWARE.  Some states do not allow the exclusion of the limit of liability
  33. for consequential or incidental damages, so the above  limitation  may  not
  34. apply to you.
  35.  
  36.  
  37.                                   License
  38.  
  39. PC-TimeClock is copyrighted software.  It is not in the public domain,  nor
  40. is  it  distributed  for  free.   The  author  retains  all  rights to this
  41. software.
  42.  
  43. PC-TimeClock is distributed as Shareware so you can try it out without risk
  44. to  see  if you like it. This license allows you to use PC-TimeClock for up
  45. to one month.  If you don't like it, simply delete it and owe nothing.   If
  46. you  continue to use PC-TimeClock after the trial period, you must register
  47. your copy.  The advantages of registration, a fee schedule, and a registra-
  48. tion  form  may  be found in the file "register.txt"; to register, fill out
  49. this form and mail it with your payment to:
  50.  
  51.                               KMR Consulting
  52.                               3090 Griffin Rd
  53.                       Churchville, NY USA 14428-9512
  54.  
  55. Thank you for helping to make the Shareware concept work.
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                    - i -
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.                              Table of Contents
  75.  
  76.  
  77.  
  78.  
  79. 1    Introduction ....................................................    1
  80. 1.1  The Fine Print ..................................................    1
  81. 1.2  Printing this Document ..........................................    1
  82.  
  83. 2    Installation and a Quick Example ................................    1
  84. 2.1  Selecting a Directory ...........................................    1
  85. 2.2  Step by Step Procedure ..........................................    1
  86. 2.3  A First Look at PC-TimeClock ....................................    2
  87. 2.3.1 Starting PC-TimeClock Automatically ............................    2
  88. 2.4  Uninstalling PC-TimeClock .......................................    3
  89.  
  90. 3    Using PC-TimeClock ..............................................    3
  91. 3.1  Overview ........................................................    3
  92. 3.2  Punching In and Out .............................................    3
  93. 3.3  Adding a Memo ...................................................    4
  94. 3.4  Specifying Colors ...............................................    4
  95. 3.5  Creating the Projects File ......................................    5
  96. 3.5.1 Category Entries ...............................................    5
  97. 3.5.2 Project Entries ................................................    5
  98. 3.6  The Initialization File .........................................    6
  99. 3.7  The Log File ....................................................    7
  100. 3.7.1 Log File Format ................................................    8
  101. 3.7.2 Repairing A Damaged Log File ...................................    8
  102.  
  103. 4    PC-TimeClock Reporter ...........................................   10
  104. 4.1  Overview ........................................................   10
  105. 4.2  The PC-TimeClock Reporter Window ................................   10
  106. 4.3  Summary Report Format ...........................................   12
  107. 4.4  Activity Report Format ..........................................   12
  108. 4.5  Accuracy and Rounding of Times ..................................   13
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. 1.5                               - ii -                            11/5/94
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.                                PC-TimeClock
  138.  
  139.  
  140. 1.  Introduction
  141.  
  142. 1.1.  The Fine Print
  143.  
  144.      Thank you for trying PC-TimeClock!  Please read the warranty disclai-
  145. mer and license statement found earlier in this manual.  The lack of war-
  146. ranty accompanying most software seems distressing at first glance.  Chief
  147. among the reasons for doing this is the proliferation of different hardware
  148. and software environments, and the existence of computers made by different
  149. manufacturers who claim that they are IBM-PC compatible.  Software authors
  150. have no control over the type of hardware and the operating system you
  151. have, or other programs you may use, nor can we guarantee that you will use
  152. this program correctly.  Yet any of these things might cause a malfunction.
  153.  
  154.      However, the best part about Shareware is that you had the opportunity
  155. to actually use the program before registering it.  We also provide one
  156. year of free technical support to our registered users, so from a practical
  157. point of view, then, there is little for us to warrant, as you already know
  158. that the software works on your machine.
  159.  
  160. 1.2.  Printing this Document
  161.  
  162.      If you wish to print this manual, you will get the best results by
  163. using an editor that prints exactly 66 lines per page.  Of course, you can
  164. read it into a word processor and fiddle with it if have the time.
  165.  
  166. 2.  Installation and a Quick Example
  167.  
  168. 2.1.  Selecting a Directory
  169.  
  170.      Before installing PC-TimeClock, you should decide what directory you
  171. want to put it in.  To avoid conflicts with other software, we recommend
  172. against installing it in a directory which contains anything else; it is
  173. better to create a new directory for it.
  174.  
  175. 2.2.  Step by Step Procedure
  176.  
  177.      Installing the shareware version of PC-TimeClock is easy.  First, you
  178. must unpack the archive file containing the distribution (if you're reading
  179. this, you have done that already).  You should have the following files:
  180.  
  181.     timeclk.exe   PC-TimeClock
  182.     tcreport.exe  PC-TimeClock Reporter
  183.     timeclk.ini   sample initialization file
  184.     project.txt   sample project file
  185.     timeclk.txt   the file you are reading now
  186.     register.txt  registration form
  187.     timeclk.log   sample log file to illustrate PC-TimeClock Reporter
  188.  
  189. Copy all these files to the directory you decided upon earlier.
  190.  
  191.  
  192.  
  193.  
  194.  
  195. 1.5                                - 1 -                            11/5/94
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.                                PC-TimeClock
  204.  
  205.  
  206. 2.3.  A First Look at PC-TimeClock
  207.  
  208.      The shareware version of PC-TimeClock comes with some sample data
  209. files so you can get an idea of what it does and how easy it is to use.  To
  210. start, open the File Manager and display the directory containing PC-
  211. TimeClock.  Now double-click the mouse pointer on "timeclk.exe".  The
  212. display that you see is based on the information in the sample project
  213. file; you will be modifying this file to suit your own needs.  Select one
  214. of the projects shown on the screen by clicking on it with the left mouse
  215. button; this "punches you in" on that project.  Select another one; PC-
  216. TimeClock "punches you out" (nasty phrase!) of the old project before
  217. punching you into the new one.  Now click the right mouse button anywhere
  218. on the screen: this punches you out of the current project without punching
  219. you into a new one.  Keeping track of your time is as easy as punching into
  220. a new project when you begin working on it.
  221.  
  222.      To see what PC-TimeClock Reporter produces, go back to the File
  223. Manager and double-click on "tcreport.exe".  Then click on the "Create
  224. Report" button.  If you are punched into a project when you generate the
  225. report, a window will appear that contains an error message telling you
  226. that the log file has a check-in entry with no corresponding check-out
  227. entry; you may ignore this error for now by closing this window.
  228.  
  229.      The report is displayed using Notepad so that you can examine it on
  230. the screen or print it as you wish.  The report format is described in more
  231. detail later, but from the sample output it is easy to see the kinds of
  232. information that PC-TimeClock provides.
  233.  
  234.      Try some of the other buttons in PC-TimeCLock Reporter to see examples
  235. of the specialized reports you can create.  When you are finished, click
  236. the "Done" button.
  237.  
  238.      NOTE:  Be sure to delete the "timeclk.log" file that came with the
  239. distribution before starting to use PC-TimeClock to record your actual
  240. usage.  This sample log file was distributed only to demonstrate the output
  241. of PC-TimeClock Reporter.
  242.  
  243. 2.3.1.  Starting PC-TimeClock Automatically
  244.  
  245.      Should you choose to register PC-TimeClock, you may wish to add it to
  246. the StartUp group in the Program Manager.  Here is how that is done:
  247.  
  248.     1) Open the StartUp group.
  249.     2) Select File|New from the Program Manager.
  250.     3) Verify that the box which appears says "New Program Item"; click OK.
  251.     4) Enter the following values:
  252.          Description:         PC-TimeClock
  253.          Command Line:        timeclk.exe
  254.          Working Directory:   (the directory where you put PC-TimeClock)
  255.     5) Click the OK button.
  256.  
  257. Now PC-TimeClock will start automatically every time Windows is started.
  258.  
  259.  
  260.  
  261. 1.5                                - 2 -                            11/5/94
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.                                PC-TimeClock
  270.  
  271.  
  272. 2.4.  Uninstalling PC-TimeClock
  273.  
  274.      To uninstall PC-TimeClock, simply delete the entire directory into
  275. which you copied it.  If you put a PC-TimeClock icon in the StartUp group,
  276. remember to delete it as well.
  277.  
  278. 3.  Using PC-TimeClock
  279.  
  280. 3.1.  Overview
  281.  
  282.      PC-TimeClock keeps track of the time you have spent on one or more
  283. projects, and allows you to group these projects into one or more
  284. categories.  Some examples of projects might include taxes, games and
  285. entertainment, word processing, and system maintenance.  These can be
  286. grouped into categories such as business and pleasure.
  287.  
  288.      When you begin working on a project, you punch in, and when you fin-
  289. ish, you punch out.  PC-TimeClock records these events in a log file, which
  290. can be listed or summarized with PC-TimeClock Reporter.
  291.  
  292. 3.2.  Punching In and Out
  293.  
  294.      PC-TimeClock displays your projects on the screen with a separate
  295. column for each category.  The categories, and the projects within them,
  296. are shown in the order in which you put them in the projects file.  Many
  297. people put the projects they use most often at the top of the file so they
  298. are easier to find on the screen.
  299.  
  300.      When you begin working on a project, find the name of that project on
  301. the PC-TimeClock screen.  Move the mouse pointer over the name, and click
  302. the left mouse button.  This punches you in to the project, and causes an
  303. entry to be written to the PC-TimeClock log file noting the date, time, and
  304. project you chose.  The project name will be highlighted and added to PC-
  305. TimeClock's title bar to make it easy to see your current project.  When
  306. you punch in, PC-TimeClock also starts a clock, which shows the approximate
  307. time you have spent on the project so far this session.
  308.  
  309.      Note: after punching in to a project, be sure that you minimize PC-
  310. TimeClock (make it an icon); do not close (terminate) it.  Normally, PC-
  311. TimeClock will minimize itself when you punch into a project, but you can
  312. change this by modifying the initialization file (see below).
  313.  
  314.      To punch out of a project, click the right mouse button.  It does not
  315. matter where the mouse pointer is, as long as it is somewhere in the PC-
  316. TimeClock window.  If you are going to begin another project right away,
  317. you may simply punch in to it; PC-TimeClock will automatically punch you
  318. out of the old project.
  319.  
  320.      If you terminate PC-TimeClock while you are still punched in on a pro-
  321. ject, it will automatically punch you out of that project first.  The same
  322. is true when Windows exits.  If your system crashes, though, the log file
  323. may be left with a "punch in" entry which has no corresponding "punch out"
  324. entry.  PC-TimeClock Reporter will notify you of any such errors, and you
  325.  
  326.  
  327. 1.5                                - 3 -                            11/5/94
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.                                PC-TimeClock
  336.  
  337.  
  338. can correct them as described in the section below on the log file.
  339.  
  340. 3.3.  Adding a Memo
  341.  
  342.      If you wish, you may enter a memo when you punch in describing the
  343. work you are about to begin; you may enter any message up to 125 characters
  344. long.  PC-TimeClock records the memo in the log file, and PC-TimeClock
  345. Reporter prints them in the activity report.
  346.  
  347.      To enter a memo, hold the Shift key down while you punch in to your
  348. project.  A box will appear asking you to enter your memo; type the desired
  349. memo and then either press Return or click the OK button.  If you make a
  350. typing mistake, you may correct it either by backspacing or by using the
  351. mouse or arrow keys.  If you click the Cancel button, no memo will be
  352. recorded.
  353.  
  354.      If you find that you are entering memos more often than not, you may
  355. instruct PC-TimeClock to ask you for a memo whenver you punch into a pro-
  356. ject.  This is done by adding an entry to the initialization file; see the
  357. section describing this file for specific instruction on how this is done.
  358. Starting the next time you run PC-TimeClock, you will be asked to enter a
  359. memo every time you check into a project.  If you want to check in without
  360. entering a memo, simply click the Cancel button and no memo will be
  361. recorded.
  362.  
  363. 3.4.  Specifying Colors
  364.  
  365.      The initialization file and the project file both allow you to select
  366. the colors that will be used on PC-TimeClock's screen.  This is done by
  367. giving intensities for red, green and blue as a list of three values, like
  368. this:
  369.  
  370.     0,255,0
  371.  
  372. Each value is a number in the range 0 - 255.  While it is possible to
  373. specify 16,777,216 different colors in this way, Windows ordinarily can
  374. display only 16.  Here are the different colors you can specify:
  375.  
  376.         __________________________________________________________
  377.        |___V_a_l_u_e_s___________C_o_l_o_r______|____V_a_l_u_e_s__________C_o_l_o_r______|
  378.        | 255,255,255   White        |  128,128,128   Dark gray   |
  379.        | 192,192,192   Light gray   |  0,0,0         Black       |
  380.        | 255,0,0       Light red    |  128,0,0       Dark red    |
  381.        | 0,255,0       Light green  |  0,128,0       Dark green  |
  382.        | 0,0,255       Light blue   |  0,0,128       Dark blue   |
  383.        | 255,255,0     Light yellow |  128,128,0     Dark yellow |
  384.        | 255,0,255     Light magenta|  128,0,128     Dark magenta|
  385.        | 0,255,255     Light cyan   |  0,128,128     Dark cyan   |
  386.        |_____________________________|_____________________________|
  387.  
  388. If you use any other combination of red, green, and blue intensities, the
  389. closest color above will be used instead.
  390.  
  391.  
  392.  
  393. 1.5                                - 4 -                            11/5/94
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.                                PC-TimeClock
  402.  
  403.  
  404. 3.5.  Creating the Projects File
  405.  
  406.      The projects file is where you list all of the various projects you
  407. wish to track, and the categories to which they belong.  The file is named
  408. "project.txt" and resides in the PC-TimeClock directory.
  409.  
  410.      The file contains two types of entries, one for projects and one for
  411. categories.  They may be intermixed, but each category entry must appear
  412. before any project entries in the category.  The file may also contain
  413. blank lines, and lines starting with a "#" are ignored.
  414.  
  415. 3.5.1.  Category Entries
  416.  
  417.      A category entry looks like this:
  418.  
  419.     -category
  420.  
  421. The dash at the beginning of the line is important; it is what identifies
  422. the entry as a category.  Enter the category name where "category" is shown
  423. above.  This may contain letters, digits, spaces, and any punctuation marks
  424. except for the colon.
  425.  
  426.      You may also specify category entries in this manner:
  427.  
  428.     -category:red,green,blue
  429.  
  430. In this form, the category name is followed by a colon, and a color specif-
  431. ication (see above).  This sets the color that will be used to display
  432. entries from this category in PC-TimeClock.  If the color specification is
  433. omitted, black is used.
  434.  
  435.      Up to 10 different categories may be specified.  However, the more
  436. categories you have, the narrower the columns in which PC-TimeClock
  437. displays the project names.
  438.  
  439.      Two category entries are shown below as an example:
  440.  
  441.     -Business:0,255,0
  442.     -Personal:0,0,255
  443.  
  444.  
  445. 3.5.2.  Project Entries
  446.  
  447.      Project names are specified with entries that look like this:
  448.  
  449.     project-category
  450.  
  451. "project" is the name of the project, and "category" is the name of the
  452. category to which it belongs.  The project name may contain letters,
  453. digits, spaces, and any punctuation except for the dash, but may not begin
  454. with a "#".  The name given for category must match the name given in a
  455. previous category entry.
  456.  
  457.  
  458.  
  459. 1.5                                - 5 -                            11/5/94
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.                                PC-TimeClock
  468.  
  469.  
  470.      Up to 25 projects may be given for each category.  The project names
  471. within a category must be unique, but it is acceptable to have the same
  472. project name in two or more categories.  The list below shows some example
  473. project entries:
  474.  
  475.     Correspondence-Personal
  476.     Games-Personal
  477.     Inventory-Business
  478.     Recipe manager-Personal
  479.     System maintenance-Business
  480.     Taxes-Business
  481.     Taxes-Personal
  482.  
  483.  
  484. 3.6.  The Initialization File
  485.  
  486.      The initialization file contains information that affects the way in
  487. which PC-TimeClock runs.  This file is only consulted when PC-TimeClock
  488. begins, so changes made to the initialization file will have no effect
  489. until the next time PC-TimeClock begins.
  490.  
  491.      The initialization file is named "timeclk.ini" and resides in the PC-
  492. TimeClock directory.  Like the projects file, any blank lines or lines
  493. beginning with "#" are ignored.
  494.  
  495.      The first entry in the initialization file looks like this:
  496.  
  497.     [timeclk]
  498.  
  499. This marks the beginning of the entries that pertain to the PC-TimeClock
  500. program.
  501.  
  502.      After this, any of the following entries may appear.  Each entry has a
  503. default behavior and an optional behavior.  If the default behavior for an
  504. entry is what you want, you don't need to have that entry in the file.  The
  505. initialization file itself is needed only if you need to specify one or
  506. more entries.  The entry names are not case sensitive, so the "CloseOn-
  507. Select" entry may be written this way, or "closeonselect", "CLOSEONSELECT",
  508. or "cLoSeOnSeLeCt", whichever you prefer.
  509.  
  510. AskMemo
  511.      Normally, PC-TimeClock does not ask you for a memo unless you hold the
  512.      Shift key down while punching into a project.  If you prefer to enter
  513.      a memo every time you punch in, add the line
  514.  
  515.          AskMemo = yes
  516.  
  517.      to the initialization file.  Beginning the next time you run PC-
  518.      TimeClock, you will be asked to enter a memo every time you punch into
  519.      a new project.
  520.  
  521. CloseOnSelect
  522.      By default, PC-TimeClock minimizes itself when you punch in to a
  523.  
  524.  
  525. 1.5                                - 6 -                            11/5/94
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.                                PC-TimeClock
  534.  
  535.  
  536.      project.  Specifying
  537.  
  538.          CloseOnSelect = no
  539.  
  540.      in this entry prevents this from happening.  The initialization file
  541.      provided with the shareware version specifies this option so that you
  542.      can see how to punch in and out of projects without the window closing
  543.      each time.  When you begin to actually use PC-TimeClock, you may wish
  544.      to delete this so that the window automatically closes when you punch
  545.      into a project.
  546.  
  547. BkColor
  548.      The default background color of the PC-TimeClock window is light gray.
  549.      To change the color, the "BkColor" entry is used to specify the
  550.      desired color (see above).  The sample entries shown below give a dark
  551.      gray, light green, and dark blue background, respectively.
  552.  
  553.          BkColor = 128,128,128
  554.          BkColor = 0,255,0
  555.          BkColor = 0,0,128
  556.  
  557.  
  558. LogFile
  559.      By default, the log file created by PC-TimeClock is called
  560.      "timeclk.log".  This entry allows you to specify a different name; an
  561.      example is shown below:
  562.  
  563.          LogFile = my_time.log
  564.  
  565.      It is recommended that you use the ".log" extension, as that makes it
  566.      easier for PC-TimeClock Reporter to locate the file.
  567.  
  568. ProjectFile
  569.      By default, the projects file is called "project.txt".  This entry
  570.      allows you to specify a different name; an example is shown below.
  571.  
  572.          ProjectFile = my_work.txt
  573.  
  574.      The ".txt" extension is not required, but does make it easier to
  575.      modify this file when needed.
  576.  
  577. 3.7.  The Log File
  578.  
  579.      PC-TimeClock writes its punch in/out data to the log file.  It is very
  580. important to never run more than one PC-TimeClock at a time.  If this were
  581. done, the entries written by the two programs would be interspersed with
  582. each other in the log file, and PC-TimeClock Reporter would not be able to
  583. sort them out.  On computers connected to a network, make sure that PC-
  584. TimeClock on each computer writes to its own private log file.
  585.  
  586.      You do not ordinarily need to examine the log file itself, as PC-
  587. TimeClock Reporter can summarize as well as list the individual entries in
  588. the file.  However, if you want to import the log data into another program
  589.  
  590.  
  591. 1.5                                - 7 -                            11/5/94
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.                                PC-TimeClock
  600.  
  601.  
  602. or into a spreadsheet, you will need to know what the file contains.
  603. Furthermore, you must know what the entries in this file are supposed to
  604. look like in order to repair any damage caused by a system crash or other
  605. unexpected event.
  606.  
  607. 3.7.1.  Log File Format
  608.  
  609.      The log file contains pairs of entries; the first entry in each pair
  610. is a "punch in" entry, and the second one is a "punch out" entry.  The for-
  611. mat of these entries is shown below.  The symbol "->" is shown to represent
  612. the tab character, which separates the fields in the file.
  613.  
  614.     date/time->in/out->project-category->memo
  615.  
  616. The first field gives the date and time of the event.  The date is record
  617. in yyyy/mm/dd format to avoid any problems when the year 2000 is reached.
  618. It is followed by one space and then the time, which is in hh:mm:ss format.
  619.  
  620.      The second field is either the word "IN" or the word "OUT", and iden-
  621. tifies the type of the entry.  The log file should begin with an "IN"
  622. entry, and all the remaining entries should alternate "OUT", "IN", "OUT",
  623. etc.
  624.  
  625.      The third field shows the project and category.  This must be the same
  626. for each entry in an in/out pair.  The last field is the memo.  This only
  627. appears on the "IN" entry; if no memo was entered, then the last thing on
  628. the entry is the project and category.
  629.  
  630.      A sample pair of entries is shown below.  The places in each entry
  631. that look like several spaces are really each one tab.
  632.  
  633.     1994/02/25 13:12:57         IN            Taxes-Business Fed
  634.     1994/02/25 14:45:28         OUT           Taxes-Business
  635.  
  636.  
  637. 3.7.2.  Repairing A Damaged Log File
  638.  
  639.      If PC-TimeClock Reporter finds any errors in the log file, it prints
  640. an error message that gives the line number of the damaged entry and a
  641. brief description of the problem.  The error messages are described below.
  642. The damaged entry itself is then printed to assist you in understanding the
  643. problem.  To repair a damaged log file, use a text editor such as Notepad.
  644. Do not use a word processor such as Write or Word, as this may damage the
  645. file further.
  646.  
  647. Malformed entry
  648.      This describes an entry that is not in the proper format.  This is
  649.      usually the result of an unsuccessful attempt to correct some other
  650.      problem in a log file.  If you see dozens or hundreds of these errors
  651.      for a log file, it is likely that the file you have given PC-TimeClock
  652.      Reporter isn't a log file at all.
  653.  
  654.  
  655.  
  656.  
  657. 1.5                                - 8 -                            11/5/94
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.                                PC-TimeClock
  666.  
  667.  
  668. Too many project categories
  669.      This indicates that there are more than 20 different categories in the
  670.      log file, and PC-TimeClock Reporter cannot handle them.  Projects
  671.      belonging to the excess categories will not be included on the report.
  672.  
  673.      While PC-TimeClock is limited to at most ten categories, you can
  674.      delete them, add new ones, or change their names.  Over time, the log
  675.      file may accumulate entries for far more than the ten categories you
  676.      can use at any one time.  If there are more than 20, this error will
  677.      occur.  There are three ways to solve this problem:
  678.  
  679. (1)  Split the log file into two or more smaller ones at some convenient
  680.      date.  Then produce a separate report from each file.  This is a good
  681.      approach if you wanted different reports for the different time
  682.      periods anyway.
  683.  
  684. (2)  Edit the log file and change names of some of the categories so that
  685.      they are the same.  This is the best way to fix problems caused by
  686.      typos.  For example, if a category name is initially entered as "busi-
  687.      ness" and you later decide to change it to "Business", it is really
  688.      the same category.  Entries in the log file ending in "-business"
  689.      should then be changed to read "-Business".
  690.  
  691. (3)  Split the log file into two or more smaller ones, each containing the
  692.      entries from a few categories.  This is a good solution if it is not
  693.      important for the time spent in each category to be compared with the
  694.      others.
  695.  
  696. Too many projects for this category
  697.      PC-TimeClock Reporter can handle up to 50 projects in each category.
  698.      This message indicates that more than 50 projects were found in one
  699.      category.  The excess projects will not appear on the report.
  700.  
  701.      This is very similar to "Too many project categories" described above,
  702.      and the same remedies apply.
  703.  
  704. Check-out entry with no prior check-in
  705.      A punch-out entry was not preceded by a punch-in entry.  The orphan
  706.      entry is ignored.
  707.  
  708.      The most likely cause for this unusual error is a log file that was
  709.      incorrectly edited.  There are two ways to fix this problem:
  710.  
  711. (1)  Delete the orphaned entry.  If you don't know when the work begin, or
  712.      the project is not an important one, this is probably the best
  713.      approach.
  714.  
  715. (2)  Add a new punch-in entry just ahead of the orphaned entry.  The sim-
  716.      plest way to do this is to make a copy of the orphaned entry, change
  717.      the "OUT" to "IN", and adjust the time field to a reasonable value,
  718.      which will never be earlier than the time in the preceding entry.
  719.  
  720.  
  721.  
  722.  
  723. 1.5                                - 9 -                            11/5/94
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730.  
  731.                                PC-TimeClock
  732.  
  733.  
  734. Check-in with no subsequent check-out
  735.      By far the most common error, this indicates that you punched in to a
  736.      project but the log file contains no record that you ever punched out.
  737.      It is usually caused by the computer crashing, which prevents PC-
  738.      TimeClock from writing the punch-out entry to the log file.
  739.  
  740.      The remedy for this is the same as for "Check-out with no prior
  741.      check-in" described above.  If the computer was restarted immediately
  742.      after the crash, the time in the next entry may be used to add a
  743.      punch-out entry to the file.  However, if the computer was not res-
  744.      tarted until the next morning, then you will have to guess at when
  745.      work on the project actually stopped.
  746.  
  747. Check-out occurred before check-in
  748.      This obviously cannot happen in real life.  If you see this in your
  749.      log file, the computer's clock was probably reset between punch-in and
  750.      punch-out.  If the dates and times in the entries make it obvious what
  751.      is wrong, then simply fix one or the other entry.  Otherwise, delete
  752.      them.
  753.  
  754. 4.  PC-TimeClock Reporter
  755.  
  756. 4.1.  Overview
  757.  
  758.      PC-TimeClock Reporter reads the data in the log file and produces
  759. various reports from it.  The Windows interface makes it easy to specify
  760. exactly what information you want.  The report is written to a disk file,
  761. and then displayed with Notepad.  It may be printed using Notepad's print-
  762. ing capabilities.  If any errors were found in the log file, PC-TimeClock
  763. Reporter tells you the line number in the log file where the problem
  764. occurred, the nature of the error, and the faulty entries.  You may choose
  765. to ignore the errors and use the report as is, or you may repair the log
  766. file as described earlier and create another report.
  767.  
  768.      Note that if you are punched into a project when you generate a
  769. report, an error will be reported on the last line in the log file.  This
  770. is because there is no punch-out entry yet for the last punch-in entry.
  771. You may either ignore this error, or punch out of the project and create a
  772. new report.
  773.  
  774.      It is possible that the log file contains projects or categories which
  775. were later deleted from the projects file.  The log file may therefore con-
  776. tain more project or category names than are allowed in the projects file.
  777. For this reason, PC-TimeClock Reporter was designed to handle more entries
  778. than PC-TimeClock itself: up to 20 categories, and up to 50 projects in
  779. each category.
  780.  
  781. 4.2.  The PC-TimeClock Reporter Window
  782.  
  783.      The various controls of the PC-TimeClock Reporter are described below.
  784. It might be helpful to run it and examine its window while reading these
  785. descriptions for the first time.
  786.  
  787.  
  788.  
  789. 1.5                               - 10 -                            11/5/94
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.  
  797.                                PC-TimeClock
  798.  
  799.  
  800. Dates
  801.      Select the dates you want included in the report here.  The default is
  802.      to include all entries from the log file, but you can also limit the
  803.      report to a specific range of dates.  The following ranges may be
  804.      selected from the "Dates" control:
  805.  
  806.          All entries
  807.          This year
  808.          This quarter
  809.          This month
  810.          Last year
  811.          Last quarter
  812.          Last month
  813.  
  814.      When one of these is selected, the "From" and "To" fields show the
  815.      actual dates that will be used.  In addition, you may enter any dates
  816.      you wish in the "From" and "To" fields.
  817.  
  818. Category
  819.      This control selects which categories you want on the report.  The
  820.      default is "All", but by clicking on the button at the right of the
  821.      control you can obtain a list of all category names.  Selecting a name
  822.      from this list limits the report to only the projects in that
  823.      category.
  824.  
  825. Project
  826.      This control specifies which projects should be included in the
  827.      report, and works the same as the "Category" control.  If a project is
  828.      selected which appears in more than one category, they will all appear
  829.      on the report unless a specific category was chosen above.
  830.  
  831. Summary
  832.      If this button is marked, a summary report is produced.  The format of
  833.      this report is described below.
  834.  
  835. Activity
  836.      If this button is marked, an activity report is produced.  The format
  837.      of this report is described below.
  838.  
  839. Report file:
  840.      The name of the output file is shown here.  Click on the "Report File"
  841.      button to select a different name.
  842.  
  843. Log file
  844.      This button allows you to select a log file to report from.  PC-
  845.      TimeClock Reporter looks in the directory from which it was started
  846.      for a file with the ".log" extension; if exactly one is found, that
  847.      file is opened.  Otherwise, it asks you to enter the name of a log
  848.      file.  This button can be used to change to a different log file at
  849.      any time.
  850.  
  851. Report File
  852.      This button allows you to change the name of the file that the report
  853.  
  854.  
  855. 1.5                               - 11 -                            11/5/94
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.  
  863.                                PC-TimeClock
  864.  
  865.  
  866.      will be written to.  By default, the name "report.txt" is used.  If
  867.      several reports are created one after another, each will replace the
  868.      previous report in this file.  Unless each one is printed before the
  869.      next one is created, the earlier ones will be lost.  By giving each
  870.      report a different filename, they will not replace one another.
  871.  
  872. Create Report
  873.      When you finish specifying which entries you want, click this button
  874.      to generate the report.  The cursor changes to an hourglass while the
  875.      data is being processed.  When the report is complete, it will be
  876.      displayed using Notepad.  If any errors were found in the log file,
  877.      descriptions of them will be written to an error file.  The name of
  878.      this file is identical to the name of the report file except it has
  879.      the extension ".err".  This file is also displayed with Notepad.  If
  880.      no errors were found, no error file is created or displayed.
  881.  
  882. Done When you have the reports you need, click this button to exit PC-
  883.      TimeClock Reporter.
  884.  
  885. 4.3.  Summary Report Format
  886.  
  887.      A summary report contains two sections.  The first summarizes usage by
  888. project.  A list is printed for each category showing the projects in that
  889. category.  The following values are shown for each project.
  890.  
  891.  
  892.     hours (and tenths of an hour) spent on the project,
  893.     the percentage of the total use that this project represents,
  894.     the percentage of the use in this category that this project represents,
  895.     the number of sessions for the project,
  896.     the average duration of each session (hours, minutes, seconds), and
  897.     the project name.
  898.  
  899. At the end of each category's list is a line showing the totals for that
  900. category.
  901.  
  902.      The second section is a summary of usage by category.  For each
  903. category, the following values are shown:
  904.  
  905.  
  906.     hours spent on projects in the category,
  907.     the percentage of the total use that this category represents,
  908.     the number of sessions for projects in the category,
  909.     the average duration of each session, and
  910.     the category name.
  911.  
  912.  
  913. 4.4.  Activity Report Format
  914.  
  915.      The activity report lists each session whose date, project and
  916. category match the specified input criteria.  The following values are
  917. shown:
  918.  
  919.  
  920.  
  921. 1.5                               - 12 -                            11/5/94
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.  
  929.                                PC-TimeClock
  930.  
  931.  
  932.     the date and time when the session began,
  933.     the length of the session in hours and tenths,
  934.     the project and category names, and
  935.     the memo (if any) entered when punching in.
  936.  
  937.  
  938. 4.5.  Accuracy and Rounding of Times
  939.  
  940.      PC-TimeClock records the time of each punch-in and punch-out to the
  941. second, and PC-TimeClock Reporter processes them with full precision.  How-
  942. ever, some time values are rounded to the nearest tenth of an hour for
  943. printing, which can result in what seems to be errors in summary reports.
  944.  
  945.      To illustrate, consider the following activity report.
  946.  
  947.     06/19/1994 11:32:22   1.2 System maint-Both
  948.     09/01/1994 20:16:51   1.2 System maint-Both
  949.     09/05/1994 17:57:51   1.2 System maint-Both
  950.  
  951. We would expect a summary report of these entries to show a total of 3.6
  952. hours of time.
  953.  
  954.      However, any duration from one hour and nine minutes to one hour and
  955. 14 minutes would be rounded to 1.2 hours in this report.  If each of these
  956. sessions were one hour and 14 minutes, the summary total would be 3.7
  957. hours, and if they were one hour and nine minutes, it would be 3.5 hours.
  958. Because they are computed before any rounding is done, the totals shown on
  959. the summary report are more accurate than the total you would obtain by
  960. adding the values on the activity report.
  961.  
  962.  
  963.  
  964.  
  965.  
  966.  
  967.  
  968.  
  969.  
  970.  
  971.  
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987. 1.5                               - 13 -                            11/5/94
  988.  
  989.  
  990.  
  991.