modules/timemap/README.txt

; $Id$

Install
--------
1. move to your sites/all/modules directory
2. enable timemap in ?q=/admin/build/modules
3. assign permisions to appropriate roles in ?q=admin/user/access
4. place the 'Time Map Task Entry' block in ?q=admin/build/block

Use
-----
Users can add their own categories, or global categories can be added; all can 
be color coded.  Regardless of category source, users enter tasks as they begin
to work on them and associate the work with a category.  Entering a new task
automatically "closes out" the previous task.  When there is not more "next
task", (ie, user is done doing tasks that should be tracked) he clicks "Quitin' 
Time".  

When tasks and categories are mangaged from the block, the web location will not
change, allowing users to enter their task tracking info without having to "get
back" to where they previously were.


Aims
-----
The project has 2 goals and 1 core principle:

Goal #1:
The data entry into the system should be as absolutely easy as possible.  If it
becomes a chore to enter the data, then people won't do it, and this tool then 
has no advantage over a paper timesheet.

Goal #2:
The reporting be as robust and multi faceted as possible.  For this reason, 
there is a core time mapping report (via the simile timeline library) and will support 
hook_timemap_report(), which will allow 3rd party modules to add their own reports.

Core Principle:
The keeping and maintaining of timesheets is a personal tool to better 
understand what tasks and projects shape the hours of *your* day.  A person's 
understanding of how their own time is spent is much more personaly empowering 
than a facility to track another's time, or a staffs' billable hours, or 
otherwise.  The development of this module will only move in a direction that 
enables more self empowerment to the individual user.  While other appliations 
of this module may certainly develop in parrallel, the facility and 
functionality of the individual user is first priority.


Simile
-------
This module uses the Simile Timeline WebAPI from MIT 
(http://simile.mit.edu/timeline/).  This BSD Licence Library is loaded by 
timemap.module as a WebAPI over the Internet.  If, for any reason, Internet access 
is not avaiable and a local copy is needed for operation, the library can be 
placed in a directory named 'timeline' in the module's directory.  From there, 
it will be auto-detected and loaded locally instead of from the web.

Instructions on obtaining the library can be found at: 
http://simile.mit.edu/wiki/Timeline/Download_The_Source
(If you svn checkout the 1.2 tag, the contents of src/webapp/api are what should
go into the timeline/ directory.) 

Resulting in a dir structure similar to:

timemap/
  |
  |
  -timemap.module
  -timemap.info
  -timemap.install
  ...
  -timeline/
     |
     |
     -bundle.css
     -bundle.js
     -timeline-api.js
     -ext/
     -images/
     -scripts/
     -styles/


1	; $Id$
2
3	Install
4	--------
5	1. move to your sites/all/modules directory
6	2. enable timemap in ?q=/admin/build/modules
7	3. assign permisions to appropriate roles in ?q=admin/user/access
8	4. place the 'Time Map Task Entry' block in ?q=admin/build/block
9
10	Use
11	-----
12	Users can add their own categories, or global categories can be added; all can
13	be color coded. Regardless of category source, users enter tasks as they begin
14	to work on them and associate the work with a category. Entering a new task
15	automatically "closes out" the previous task. When there is not more "next
16	task", (ie, user is done doing tasks that should be tracked) he clicks "Quitin'
17	Time".
18
19	When tasks and categories are mangaged from the block, the web location will not
20	change, allowing users to enter their task tracking info without having to "get
21	back" to where they previously were.
22
23
24	Aims
25	-----
26	The project has 2 goals and 1 core principle:
27
28	Goal #1:
29	The data entry into the system should be as absolutely easy as possible. If it
30	becomes a chore to enter the data, then people won't do it, and this tool then
31	has no advantage over a paper timesheet.
32
33	Goal #2:
34	The reporting be as robust and multi faceted as possible. For this reason,
35	there is a core time mapping report (via the simile timeline library) and will support
36	hook_timemap_report(), which will allow 3rd party modules to add their own reports.
37
38	Core Principle:
39	The keeping and maintaining of timesheets is a personal tool to better
40	understand what tasks and projects shape the hours of your day. A person's
41	understanding of how their own time is spent is much more personaly empowering
42	than a facility to track another's time, or a staffs' billable hours, or
43	otherwise. The development of this module will only move in a direction that
44	enables more self empowerment to the individual user. While other appliations
45	of this module may certainly develop in parrallel, the facility and
46	functionality of the individual user is first priority.
47
48
49
50	Simile
51	-------
52	This module uses the Simile Timeline WebAPI from MIT
53	(http://simile.mit.edu/timeline/). This BSD Licence Library is loaded by
54	timemap.module as a WebAPI over the Internet. If, for any reason, Internet access
55	is not avaiable and a local copy is needed for operation, the library can be
56	placed in a directory named 'timeline' in the module's directory. From there,
57	it will be auto-detected and loaded locally instead of from the web.
58
59	Instructions on obtaining the library can be found at:
60	http://simile.mit.edu/wiki/Timeline/Download_The_Source
61	(If you svn checkout the 1.2 tag, the contents of src/webapp/api are what should
62	go into the timeline/ directory.)
63
64	Resulting in a dir structure similar to:
65
66	timemap/
67	\|
68	\|
69	-timemap.module
70	-timemap.info
71	-timemap.install
72	...
73	-timeline/
74	\|
75	\|
76	-bundle.css
77	-bundle.js
78	-timeline-api.js
79	-ext/
80	-images/
81	-scripts/
82	-styles/
83
84