ttplog

Copyright (C) 2005 Oliver Hitz

Introduction

ttplog is a web-based multi-user time tracker and project log. It allows you to keep track of your time in a straightforward diary-like form and provides you with reports on the time spent on your projects.

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Requirements

ttplog requires a web server with PHP4 support and a MySQL database.

Installing

Follow these steps for a successful installation:

1. Create a MySQL database to hold the ttplog data.
2. Import the ttplog.sql into this database.
3. Copy the entire ttplog directory to your web server.
4. Copy the file ttplog/index.php.dist to ttplog/index.php. Modify it according to your needs (database connection etc.).
5. Finally, access the program at http://your-server/ttplog/. You can now log in using the username admin and password admin.
6. Once logged in, click on Users and modify the standard password of your admin user.

Using ttplog

ttplog features the following concepts, which are accessible through the links on the upper-right corner:

• The Diary is where all users record their activities. Every activity can be associated to a project stage.
• A Project can contain any number of of Stages. A stage can be either active or inactive, in which case it is not possible to add activities to this stage. A project that contains no active stage is also inactive.
• The list of Users defines who is allowed to enter his activities. A user with administrative rights is allowed to add and remove users, projects and stages. Other users are only allowed to edit their activities. Inactive users may not log into the system.

Text Formatting

Activities and project descriptions can be formatted using simple a Wiki-like language. The following formatting directives exist:

• Headings: =section=, ==subsection==, ===subsubsection===
• Emphasis: ''emphasis'', '''strong emphasis'''
• Lists: *bullet list entry, #numbered list entry
• Preformatted text: all lines starting with a space character are considered preformatted

Todo

• Week and month overviews
• Better reports
• More comprehensive documentation
• Todo lists

Thanks for sending us bug reports, enhancements, suggestions etc!

$Id: README.html,v 1.1 2005/03/03 20:44:16 oli Exp $