$Id: worklog,v 1.1 2000/04/01 08:20:25 dmetz Exp $
$crtd:  by  Derald Metzger  on  980725 $
$cmnt:
# This file is part of the Config File Manager (cfm) package.
# See README and the GNU GPL for license info.
  This file is a template for an item log using formatted plain text.
  Use item entries to:
  1. record and track problems,
  2. store blocks of textual data for keyword retrieval to screen or printer.
  3. Extract entries using the wle or bbe cmds with your keywords as args.
  4. Add entries using the ewl or ebb cmds.
  See the 0000 entry at the end of this file for formatting details.
  There have been VMS, Unix, MacOS and Windows compatable versions of 
  this log and its supporting wle tools.
  perl is required for the accompanying versions of ewl and wle.
#
  Copy this file to an accessable dir of your choosing.
  Modify <log_id> below to uniquely identify the worklog.
  Set and export env var WORKLOGDIR to indicate the dir.
#
   The lines just below following the $ are a template for making new entries.
   The entry template contains the next available sequence number.
   Copy/paste the template, including the empty line, to start a new entry.
   Always increment the sequence number of the template to indicate the next 
   available entry number as entries below it may be transferred to history.
   Do not place empty lines ahead of this header template in the worklog.
$
\  \your_log_id\0001  \  \
-what:
-stat:
-who:
-refs:
-mh:

\format\legend\searchkey  \logid\0000  \entry_date-user  \**close_date-user
-what:one_line_problem_description
-stat:one_line_problem_status
-who:assigned_to  next_report_date
-refs:people,names,numbers
-mh:man_hr_estimate,man_hr_expended,man_hr_remaining
   Initial problem description.
   date-initials. update info.
   980725-dam. This entry describes the format of log entries in a 
text file used to efficiently store and retrieve info about issues of 
value to you. The intent is to provide a means of quickly retrieving info 
using the computer to search for key words you provide as searchkeys in 
the 1st line of the entry. Here is a line-by-line description:
   0. An item entry is preceeded by an empty line.
      A line with spaces is not empty, it just looks empty.
   1. The 1st line consists of a sequence of searchkeys.
      The 1st searchkey must start in the 1st column of the 1st line.
      Each search key begins with a \ prefix. The remainder of a searchkey
      should be a word associated with the subject of the entry that can be
      used later to search for the entry. User provided search keys should
      be catenated without spaces at the beginning of the searchkey line.
      Additional searchkeys for log id, sequence number, entry date, and
      close date should always be present. The close date should be prefixed
      with a double asterix in addition to the leading backslash when the
      entry has been closed. Multiple backslashes at the beginning of the
      search key line may be used to establish the priority of an entry;
      ie \\searchkey would be of higher priority than \searchkey. Use the
      log extraction tool `wle' or `bbe' to extract entries from the cmdline.
      Searchkeys are case insensitive. Execute `wle' or `bbe' for more info.
     `wle format' will extract this entry.
   2. Additional entry formatting is optional. 
      This entry is intended as a model you may find effective.
   3. An empty line terminates an item entry. Note that a line with a
      space on it is not empty.
   4. Items that have been closed and other info that may be of value
      at a future date is best transfered to a history file (worklog.his).
   5. You may find it useful to create your own private log.
      A suggested location is $HOME/hold/worklog. An alias using the 
      -f option may be convienent.
