<?xml version="1.0" encoding="iso-8859-1"?>
<chapter id="modules_projects">
  <title>The projects module</title>
  
  <para>The projects module allows to manage projects. Those projects
    have basic attributes like start and (planned) end date, responsible
    persons and status. The possibility to create GANTT diagrams allows
    to get an overview of projects.
  </para>
  
  <para>Additionally you can define occupations, with individual
    rates, that can then be used by users to create timesheets for
    recording time spent on projects. This allows to judge the
    efficiency of staff and the expected costs of a project
  </para>
  
  <figure>
    <title>The list of defined projects</title>
    <graphic fileref="images/modules/projects/projects_list.png"/>
  </figure>
  
  <section id="modules_projects_create_edit">
    <title>Creating and editing projects</title>
    
    <para>To create a project just click on the new link (or icon) in
      the project list view. You will see a form where you can give the
      project a name, and select a customer (from the companies present
      in the contact module). You can create internal projects as well.
    </para>
    
    <figure>
      <title>Creating a project</title>
      <graphic fileref="images/modules/projects/projects_create.png"/>
    </figure>
    
    <para>Next you should fill in a project description, and select
      the people in charge of the project. There are two possible
      positions, project leader and key account manager.
    </para>
    
    <para>The last fields allow you to set start and (projected) end
      date for the project, as well as a project status (not started,
      started, finished ,...). If you want to create GANTT diagrams, it
      is helpful to know that only projects with start and end date are
      shown there!
    </para>
    
    <para>Finally click save to create the project and return to the
      project list.
    </para>
    
    <para>If you want to edit a project later, just click on the edit
      link or icon in the project list. You will see the same form
      again, and can make changes to the project. Click save to save
      your changes.
    </para>
    
    <para>If a project is finished, you may finally want to delete
      it. This is as simple as clicking the delete link (or icon) in the
      projects list and confirming the deletion in the following
      question. Deleting a project will delete all related timesheets as
      well.
    </para>
    
    <important>
      <para>Adeletion cannot be undone!</para>
    </important>
    
  </section>
  
  <section id="modules_projects_gantt">
    <title>GANTT diagrams</title>
    
    <para>From the project list view you can call up GANTT diagrams to get an overview of the projects. At the time of writing all projects with start and end date are shown in full length. In later releases support for viewing only specific projects and date ranges will be added, as well as support for showing the timesheets associated with projects.</para>
    
    <figure>
      <title>A GANTT diagram showing two projects</title>
      <graphic fileref="images/modules/projects/projects_gantt.png"/>
    </figure>
    
  </section>
  
  <section id="modules_projects_time">
    <title>Tracking time spent on projects</title>
    
    <para>The projects module uses a way of time tracking that is
      based on so called 'timesheets'. Those record the time that a user has
      spent on a project with a certain occupation. To be able to use the
      time tracking, you thus need to define occupations first. Then you can
      create timesheets
    </para>
    
    <section id="modules_projects_occupations">
      <title>Creating and editing occupations</title>
      
      <para>An occupation is nothing else than a certain type of task
        that is to be done. This may be database design, programming, writing
        letters, doing phonecalls, whatever.
      </para>
      
      <figure>
        <title>The list of available occupations</title>
        <graphic fileref="images/modules/projects/projects_occupations_list.png"/>
      </figure>
      
      <para>To create an occupation, go to the occupations list, and
        click the new link (or icon). You will a simple form where you can
        enter a name for the occupation as well as a description. Click create
        to finish. You will see the occupations list again.
      </para>
      
      <figure>
        <title>Creating an occupation</title>
        <graphic fileref="images/modules/projects/projects_occupations_create.png"/>
      </figure>
      
      <para>Editing an occupation is pretty straigt forward, just click
        the edit link (or icon) in the occupations overview, and you will see
        the form you already know from creating an occupation. Do your changes
        and click save or cancel, as you see fit.
      </para>
      
      <para>To delete an occupation click the delete link (or icon) in the
        occupations list and confirm the deletion in the following
        question.
      </para>
      
      <important>
        <para>Adeletion cannot be undone!</para>
      </important>
      
      <para>To be able to calculate how much money has been earned on a
        project, more.groupware needs to know the hourly rates for the
        occupations you defined. Those can be edited by clicking on the 'Edit
        Rates' link (or the little calculator icon) in the occupations
        list. You will see a form that has a project drop down list and an
        input field.
      </para>
      
      <figure>
        <title>Editing an occupation's hourly rate</title>
        <graphic fileref="images/modules/projects/projects_occupations_rates.png"/>
      </figure>
      
      <para>You can have individual rates for each project, aside from a
        default rate. If no individual rate is defined for a combination of
        project and occupation, the default rate is used.
      </para>
      
      <para>Now you can just select the project and either look up the default
        rate by clicking on 'Get Current Rate', or just enter an amount on the
        input field. Then click save to finish.
      </para>
      
    </section>
    
    <section id="modules_projects_timesheets_edit">
      <title>Creating and editing timesheets</title>
      
      <para>A timesheet has the purpose to record the amount of time
        spent on a certain project with a certain occupation. You may see it as a 'task' as well.
      </para>
      
      <para>To create a timesheet call up the corresponding form by clicking on the 'New Timesheet' item in the submenu bar. In the form you the need to select a project and an occupation, and you should fill in a description that explains what you did. Then select the date the work started on (the current day is always preselected) and enter how many hours you plan to spend on the project with that occupation in total. As a last thing you must enter a percentage that indicates how far you got with that specific task so far.
      </para>
      
      <figure>
        <title>Creating a timesheet</title>
        <graphic fileref="images/modules/projects/projects_timesheets_create.png"/>
      </figure>
      
      <note>
        <para>Fractions of hours can be entered as well, but the number is treated as a decimal! So entering '4:35' will not work! This may change in a later release.</para>
      </note>
      
      <para>To edit a timesheet call up the list of timesheets for the project you are working on, and click on the edit link (or icon) for the timesheet you wish to edit. This way you can update the status (as well as the other attributes) on the timesheet as work progresses. Just update the form and click the 'Edit' button.</para>
      
      <para>To edit a timesheet call up the list of timesheets for the project you are working on, and click on the delete link (or icon) for the timesheet you wish to delete, and confirm the following question.</para>
      
    </section>
    
    <section id="modules_projects_timesheets_overview">
      <title>Listing and evaluating timesheets</title>
      
      <para>The simplest way to drill down into the timesheets is to click the 'Timesheets' item in the submenu bar. This presents you with a list of projects, their status and the number of timesheets belonging to that project. Additionally the sum of planned hours and the sum of already spent hours is shown along with the total revenue calculated from the occupation's hourly rates and the planned hours of work.</para>
      
      <figure>
        <title>Listing projects and timesheets</title>
        <graphic fileref="images/modules/projects/projects_timesheets_list.png"/>
      </figure>
      
      <para>Each line has a 'Details' link (or icon) that will call up a screen that shows a list of timesheets just for one project. Each timesheet is listed with it's owner, occupation, description, planned duration, hourly rate and total revenue. This should give you a good overview on the selected project as a whole.</para>
      
      <figure>
        <title>Listing timesheets for a project</title>
        <graphic fileref="images/modules/projects/projects_timesheets_list_details.png"/>
      </figure>
      
      <para>You can check timesheet details, call up the edit screen for a timesheet and delete timesheets from this list.</para>
      
      <para>Another way of calling up a list of timesheets is the 'See Timesheets' choice from the submenu bar. It calls up a form where you can narrow down the returned timesheets by any combination of project, user and timesheet creation date. A click on 'View Project' returns a list of matching timesheets.</para>
      
    </section>
    
  </section>
</chapter>
