Skip to content

Commit

Permalink
Fix bug #12566: Time Tracking: copy wiki note in administration_guide
Browse files Browse the repository at this point in the history
Provided patch was adapted to new xml manual based on Publican
  • Loading branch information
giallu committed Nov 29, 2010
1 parent 0e2335c commit 8a6228c
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 1 deletion.
72 changes: 72 additions & 0 deletions docbook/Admin_Guide/en-US/Configuration.xml
Expand Up @@ -3001,4 +3001,76 @@
</varlistentry>
</variablelist>
</section>

<section id="admin.config.timetracking">
<title>Time Tracking</title>

<variablelist>

<varlistentry>
<term>$g_time_tracking_enabled</term>
<listitem>
<para>
Turns Time Tracking features ON or OFF - Default is OFF
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>$g_time_tracking_without_note</term>
<listitem>
<para>
Allow time tracking to be recorded without writing some text in the associated bugnote - Default is ON
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>$g_time_tracking_with_billing</term>
<listitem>
<para>
Adds calculation links to workout how much time has been spent between a particular time frame. Currently it will allow you to enter a cost/hour and will work out some billing information. This will become more extensive in the future. Currently it is more of a proof of concept.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>$g_time_tracking_stopwatch</term>
<listitem>
<para>
Instead of a text field turning this option on places a stopwatch on the page with <guibutton>Start/Stop</guibutton> and <guibutton>Reset</guibutton> buttons next to it. You must have $g_use_javascript switched on for this to take effect. A bit gimickie, but who cares.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>$g_time_tracking_view_threshold</term>
<listitem>
<para>
Access level required to view time tracking information - Default DEVELOPER.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>$g_time_tracking_edit_threshold</term>
<listitem>
<para>
Access level required to add/edit time tracking information (If you give a user $g_time_tracking_edit_threshold you must give them $g_time_tracking_view_threshold aswell) - Default DEVELOPER.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>$g_time_tracking_reporting_threshold</term>
<listitem>
<para>
Access level required to run reports (not completed yet) - Default MANAGER.
</para>
</listitem>
</varlistentry>

</variablelist>
</section>

</chapter>
21 changes: 20 additions & 1 deletion docbook/Admin_Guide/en-US/Project_Management.xml
Expand Up @@ -213,7 +213,26 @@ http://www.example.com/mantisbt/project_page.php?project_id=1
<section id="admin.project.timetracking">
<title>Time Tracking</title>

<para></para>
<para>
This is currently a work in progress. To follow the work have a look on the wiki page <ulink url="http://www.mantisbt.org/wiki/doku.php/mantisbt:issue:4428">Time Tracking (Issue 4428)</ulink>
</para>

<para>
To activate the Time Tracking feature you have to set the configuration option "time_tracking_enabled" to ON. To activating the Time Tracking you can :
<itemizedlist>
<listitem><para>
Static solution : change the variable '$g_time_tracking_enabled' in the configuration file 'config_defaults_inc.php', this will change the configuration for all the MantisBT instance ;
</para></listitem>
<listitem><para>
Dynamic and "project by project" solution : Use the administration page "Manage Configuration" and set the variable 'time_tracking_enabled' to '1' for which user and which project of you choice.
</para></listitem>
</itemizedlist>
</para>

<para>
All Time Tracking configuration options are described in the configuration section off this guide.
</para>

</section>

<section id="admin.project.graphs">
Expand Down

0 comments on commit 8a6228c

Please sign in to comment.