Commit 39bfc781 authored by Kurt Maute's avatar Kurt Maute

Updated user guide for v0.14

parent ecccdba7
2006-05-23 Kurt Maute <Kurt@Maute.us>
* docs/user-guide/C/planner.xml
Updated user guide
2006-05-23 Kurt Maute <Kurt@Maute.us>
* data/ui/gantt-view.ui
* src/planner-gantt-background.c
......
......@@ -2,9 +2,9 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY appversion "0.13">
<!ENTITY manrevision "0.13">
<!ENTITY date "4 Mar 2005">
<!ENTITY appversion "0.14">
<!ENTITY manrevision "0.14">
<!ENTITY date "4 Apr 2005">
<!ENTITY app "Planner">
<!ENTITY cmd "planner">
<!-- Information about the entities
......@@ -33,6 +33,7 @@
<year>2003</year>
<year>2004</year>
<year>2005</year>
<year>2006</year>
<holder>Kurt Maute, PMP</holder>
</copyright>
<copyright>
......@@ -121,6 +122,25 @@
<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
<!-- to V3.0, and so on. -->
<revhistory>
<revision>
<revnumber>&app; User Guide V0.14
</revnumber>
<date>17 May 2006</date>
<authorinitials>kmm</authorinitials>
<revdescription>
<para>Reorganized task usage section, breaking out 'Useing Gantt View' section</para>
<para></para>
<para>
Additions for new features:
<itemizedlist>
<listitem><para>Nonstandard days visualization</para></listitem>
<listitem><para>Simple priority scheduling</para></listitem>
<listitem><para>Columns Editor</para></listitem>
<listitem><para>Show guide lines in gantt view</para></listitem>
</itemizedlist>
</para>
</revdescription>
</revision>
<revision>
<revnumber>&app; User Guide V0.13
</revnumber>
......@@ -283,6 +303,8 @@
<para>
Tasks are also shown on the Gantt view, but the Task view shows
more detail for each task.
</para>
<para>
<figure id="task-view" float="1">
<title>&app; Task View</title>
<screenshot>
......@@ -328,6 +350,8 @@
doesn't offer any features that are not available in the other views,
but it is a valuable Project Management tool for the way it
allows the user to see the project data.
</para>
<para>
<figure id="gantt-view" float="1">
<title>&app; Gantt View</title>
<screenshot>
......@@ -350,6 +374,15 @@
<para>View resources assigned to each task</para>
</listitem>
</itemizedlist>
<para>
You can change what columns are visible by choosing
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Edit Visible Columns</guimenuitem>
</menuchoice>.
This dialog will allow you to add, remove, and reorder the columns in the Gantt view.
The same feature is available in the other views as well.
</para>
</sect2>
<sect2 id="mrp-resource-view">
<title>Resource View</title>
......@@ -447,7 +480,7 @@
<para>Choose
<menuchoice>
<guisubmenu>Office</guisubmenu>
<guimenuitem>Project Planner</guimenuitem>
<guimenuitem>Project Management</guimenuitem>
</menuchoice>. </para>
</listitem>
</varlistentry>
......@@ -522,6 +555,8 @@
will have its own &app; window. Try it by pressing "CTRL-N" several
times. You should get something similar to
<xref linkend="several-projects"/>.
</para>
<para>
<figure float="1" id="several-projects">
<title>Several projects at the same time</title>
<screenshot>
......@@ -574,6 +609,14 @@
<para>
<xref linkend="mrp-resources"/></para>
</listitem>
<listitem>
<para>
<xref linkend="mrp-scheduling"/></para>
</listitem>
<listitem>
<para>
<xref linkend="mrp-gantt-view-using"/></para>
</listitem>
<listitem>
<para>
<xref linkend="mrp-print"/></para>
......@@ -804,6 +847,8 @@
editor. Use the select button on this dialog to change the project default
calendar. See the section <xref linkend="mrp-calendars"/> for more
information on calendars.
</para>
<para>
<figure id="project-properties" float="1">
<title>Project Properties</title>
<screenshot>
......@@ -816,6 +861,8 @@
<para>The <guilabel>Custom properties</guilabel> Tab</para>
<para>You can add custom properties to the project by clicking the <guibutton>add
</guibutton> button.
</para>
<para>
<figure id="project-properties-custom" float="1">
<title>Custom Project Properties</title>
<screenshot>
......@@ -827,6 +874,8 @@
description, and set the property type to either text, integer number, or floating point
number. Once you have added your new property, you can set its value by clicking in the
value field of the Custom project properties dialog.
</para>
<para>
<figure id="project-properties-custom-add" float="1">
<title>Custom Project Properties Add Dialog</title>
<screenshot>
......@@ -882,7 +931,8 @@
</para>
</listitem>
</itemizedlist>
</para>
<para>
<figure id="calendar" float="1">
<title>Project Calendar Editor</title>
<screenshot>
......@@ -922,6 +972,8 @@
</para>
</listitem>
</itemizedlist>
</para>
<para>
<figure id="calendar-new" float="1">
<title>New Calendar Dialog</title>
<screenshot>
......@@ -940,6 +992,8 @@
day type. This dialog also displays the working time scheduled for the selected
day type. Be sure to click <guibutton>Apply</guibutton> before <guibutton>Close
</guibutton> to save your changes.
</para>
<para>
<figure id="calendar-week" float="1">
<title>Default Week Dialog</title>
<screenshot>
......@@ -958,6 +1012,8 @@
and the working hours for the currently selected type on the right. Time is
entered in 24 hour format as am/pm indicators are not supported (i.e. 5:00 PM
would be entered as 17:00).
</para>
<para>
<figure id="calendar-working-time" float="1">
<title>Working Time Dialog</title>
<screenshot>
......@@ -975,6 +1031,8 @@
<guibutton>Add</guibutton> and <guibutton>Remove</guibutton> buttons
to manage the list. Note that you cannot remove the default day types
"Working" and "Nonworking".
</para>
<para>
<figure id="day-types" float="1">
<title>Day Types Dialog</title>
<screenshot>
......@@ -1004,6 +1062,8 @@
name of the task and amount of work effort and press <keycap>Enter
</keycap>. The new task will be added, and the dialog will remain
open and ready for your next task entry. Details can be added later.
</para>
<para>
<figure>
<title>Insert Task</title>
<graphic fileref="figures/task-insert.png" format="PNG" ></graphic>
......@@ -1025,14 +1085,12 @@
name of the task and the work effort.
You can also launch the task properties dialog from here by right clicking on
a task and choosing <guimenuitem>Edit task</guimenuitem>.
<figure>
<title>Gantt View</title>
<graphic fileref="figures/gantt-view.png" format="PNG" ></graphic>
</figure>
</para>
<para>
In the Task View you can edit more fields for a task than in the Gantt
View, and is the preferred view when you start to add tasks to a project.
</para>
<para>
<figure>
<title>Task View</title>
<graphic fileref="figures/task-view.png" format="PNG" ></graphic>
......@@ -1051,6 +1109,7 @@
<itemizedlist>
<listitem>
<para>The <guilabel>General</guilabel> tab contains the following fields:
</para>
<itemizedlist>
<listitem>
<para><guilabel>Name</guilabel> - the name of the task</para>
......@@ -1109,6 +1168,7 @@
</para>
</listitem>
</itemizedlist>
<para>
<figure>
<title>Task properties dialog</title>
<graphic fileref="figures/task-properties-dialog.png" format="PNG"></graphic>
......@@ -1123,6 +1183,8 @@
<guilabel>Assigned</guilabel> column to allocate the resource
to the current task. Use the Units field to enter the percent
of the resource that is allocated to the task.
</para>
<para>
<figure>
<title>Task resources dialog</title>
<graphic fileref="figures/task-edit-resources.png" format="PNG"></graphic>
......@@ -1131,6 +1193,8 @@
the right of the bar. If a short name was entered in the
resource view, then the short name will display in the Gantt,
otherwise, the full name will be displayed.
</para>
<para>
<figure>
<title>A resource has been assigned to a task</title>
<graphic fileref="figures/task-edit-resource-assigned.png" format="PNG"></graphic>
......@@ -1144,6 +1208,8 @@
start. In this example, we have three tasks. In
<xref linkend="predecessors"/>, the third task, t3, requires
that t2 be complete before it can start.
</para>
<para>
<figure id="predecessors">
<title>Task predecessors dialog</title>
<graphic fileref="figures/task-edit-predecessors.png" format="PNG"></graphic>
......@@ -1167,6 +1233,8 @@
example, if you enter a lag time of 1 in a Finish to Start
relationship, it means that the current task may begin 1 day
after the predecessor task has completed.
</para>
<para>
<figure>
<title>Add predecessors dialog</title>
<graphic fileref="figures/task-edit-predecessors-add.png" format="PNG"></graphic>
......@@ -1187,6 +1255,8 @@
You can add notes to the task using the editor in the
<guilabel>Notes</guilabel> tab. You can also insert the current
time to the note using the button that appears in the dialog.
</para>
<para>
<figure>
<title>Task notes dialog</title>
<graphic fileref="figures/task-edit-note.png" format="PNG"></graphic>
......@@ -1204,84 +1274,14 @@
divided in subtasks is called a summary task. The summary task's
start date and the duration can't be edited because it is calculated
from the subtasks.
</para>
<para>
<figure>
<title>A Task with subtasks</title>
<graphic fileref="figures/task-view.png" format="PNG"></graphic>
</figure>
</para>
</sect3>
<sect3 id="mrp-task-deps">
<title>Predecessors Revisited</title>
<subtitle>Using the Gantt view to create dependencies between tasks
</subtitle>
<para>
To start a task, you often have to finish other tasks first.
Dependencies can either be set up by using the <guilabel>Predecessors
</guilabel> tab in the task edit dialog as shown above, or it can be
done graphically in the Gantt chart. If you click on the
bar that represents the predecessor (and hold down the mouse button),
an arrow appears. Dragging that arrow onto the bar that represents
the dependent task will create the dependency. The Gantt chart will
immediately reflect the new relationship by shifting the dependent
task to start when the predecessor is scheduled to complete. By
creating a dependent relationship this way, &app; always assumes a
Finish Start relationship with zero lag time. You can modify this
relationship by opening the task edit dialog of the dependent
task, and selecting the <guilabel>Predecessors</guilabel> tab.
<figure>
<title>Creating a task dependency</title>
<graphic fileref="figures/group1-task-linking.png" format="PNG"></graphic>
</figure>
If you want to remove the dependency, you can select either
of the two tasks and delete the link by clicking the <guiicon>Unlink
</guiicon>icon on the toolbar, or by right clicking either task and
selecting <guimenuitem>Unlink</guimenuitem> from the pop up.
</para>
</sect3>
<sect3 id="mrp-critical-path">
<title>Highlighting the Critical Path</title>
<para>To show the tasks along the critical path of the project, choose
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Highlight Critical Tasks</guimenuitem>
</menuchoice>. The names of the tasks along the critical path will
be shown in red, and in the Gantt view, the task bar will also be red.
</para>
</sect3>
<sect3 id="mrp-moving-tasks">
<title>Moving tasks</title>
<para>
If you need to rearrange the order that tasks are displayed in the
task view, you can do so by selecting the task you want to move, and
utilizing the
<guiicon>Move Up</guiicon> and <guiicon>Move Down</guiicon> icons on
the toolbar.
</para>
</sect3>
<sect3 id="mrp-zooming-gantt">
<title>Zooming in the Gantt View</title>
<para>
The tasks in a project can have very different durations and
sometimes you need to have a close view of the time line to see the
details of some task dependencies, but other times you need a higher
level view of the whole project.
To support both needs, &app; has a powerful zoom system that
lets you zoom to fit the complete project, zoom in the view or
zoom out incrementally to whatever size you like (hours being the
lower limit, and years is the upper limit).
</para>
<para>
<guibutton>Zoom to fit</guibutton> shows the entire project duration
in the Gantt view.
</para>
<para>
You can use the <guibutton>Zoom in</guibutton> and
<guibutton>Zoom out</guibutton> icons to select the length of
time line in which you want to work. When the view is
zoomed to a detailed level, nonworking hours are shown for each day
in addition to weekends.
</para>
</sect3>
<sect3 id="mrp-task-constraints">
<title>Task constraints</title>
......@@ -1291,6 +1291,8 @@
times, however, when a dependency doesn't exist, but the task must
start on, or no earlier than a specific date. You can
specify these constraints in the start date dialog.
</para>
<para>
<figure id="constraints">
<title>Task constraints</title>
<graphic fileref="figures/task-constraints.png" format="PNG"></graphic>
......@@ -1315,6 +1317,8 @@
<guimenuitem>Edit Custom Properties</guimenuitem>
</menuchoice>. Clicking the <guibutton>Add</guibutton>
button will open the New Property dialog.
</para>
<para>
<figure id="task-custom-properties">
<title>Task constraints</title>
<graphic fileref="figures/task-custom-properties.png" format="PNG"></graphic>
......@@ -1373,7 +1377,8 @@
</para>
</listitem>
</itemizedlist>
</para>
<para>
<figure>
<title>Resource View</title>
<graphic fileref="figures/resource-editor.png" format="PNG"></graphic>
......@@ -1407,6 +1412,8 @@
will open the Insert Resource dialog. In a fashion similar to
<xref linkend="mrp-task-add"/>, you can quickly enter multiple
resources and add detail at a later time.
</para>
<para>
<figure>
<title>Insert Resource</title>
<graphic fileref="figures/resource-insert.png" format="PNG"></graphic>
......@@ -1425,6 +1432,8 @@
<guimenuitem>Import</guimenuitem>
<guimenuitem>EDS</guimenuitem>
</menuchoice>. You will be presented with the following dialog:
</para>
<para>
<figure>
<title>EDS Import</title>
<graphic fileref="figures/eds1.png" format="PNG"></graphic>
......@@ -1455,13 +1464,16 @@
view, right click on the resource and choose <guimenuitem>Edit
resource</guimenuitem>.
The General tab shows the same items that are in the resource view.
</para>
<para>
<figure>
<title>Resource Properties Dialog - General Tab</title>
<graphic fileref="figures/resource-properties-general.png" format="PNG"></graphic>
</figure>
</para>
<para>
The Calendar tab allows us to assign a calendar to a specific resource if the project default calendar is not appropriate. See
The Calendar tab allows us to assign a calendar to a specific resource
if the project default calendar is not appropriate. See
<xref linkend="mrp-properties"/> for more information on setting the
project default calendar.
To change the calendar assigned to a resource, simply select it from
......@@ -1472,9 +1484,12 @@
</para>
<para>
Any tasks assigned to a resource with a specific calendar will use
the calendar assigned to the resource to schedule the work to be done. Therefore, if a task appears to be scheduled for a longer than
the calendar assigned to the resource to schedule the work to be done.
Therefore, if a task appears to be scheduled for a longer than
expected time period, it is likely that the resource is using a
calendar that is different from the project default.
</para>
<para>
<figure>
<title>Resource Properties Dialog - Calendar Tab</title>
<graphic fileref="figures/resource-properties-calendar.png" format="PNG"></graphic>
......@@ -1504,14 +1519,167 @@
an option to specify the default group. If you specify a default
group, every new resource that you add will placed in this group.
Of course, you can still change the group to another as needed.
</para>
<para>
<figure>
<title>Group editor</title>
<graphic fileref="figures/resource-group-editor.png" format="PNG"></graphic>
</figure>
</para>
</sect3>
</sect2>
<sect3 id="mrp-print" xreflabel="Print">
<!-- ================ Usage Subsection ================================ -->
<sect2 id="mrp-scheduling" xreflabel="Scheduling">
<title>Scheduling</title>
<para>
&app; now includes an experimental simple priority based scheduling feature. To use it, &app;
must be built with the feature enabled. This feature will divert resources from one or more
tasks to a high priority task, and reschedule the tasks accordingly.
</para>
<para>
Assuming you have an existing project plan with resourced tasks, you can divert the resources
to the higher proirity task by doing the following to the higher priority task:
<itemizedlist>
<listitem><para>Set the task priority to 9999</para></listitem>
<listitem><para>Set the task to Start on a Fixed Date</para></listitem>
<listitem><para>Assign a resource to the task</para></listitem>
</itemizedlist>
</para>
</sect2>
<!-- ================ Usage Subsection ================================ -->
<sect2 id="mrp-gantt-view-using" xreflabel="Using the Gantt View">
<title>Using the Gantt View</title>
<para>The Gantt View has a number of features that are worth exploring in more detail.
</para>
<para>
<figure>
<title>Gantt View</title>
<graphic fileref="figures/gantt-view.png" format="PNG" ></graphic>
</figure>
</para>
<sect3 id="mrp-task-deps">
<title>Creating Dependencies with the Gantt Chart</title>
<subtitle>Using the Gantt view to create dependencies between tasks
</subtitle>
<para>
To start a task, you often have to finish other tasks first.
Dependencies can either be set up by using the <guilabel>Predecessors
</guilabel> tab in the task edit dialog as shown above, or it can be
done graphically in the Gantt chart. If you click on the
bar that represents the predecessor (and hold down the mouse button),
an arrow appears. Dragging that arrow onto the bar that represents
the dependent task will create the dependency. The Gantt chart will
immediately reflect the new relationship by shifting the dependent
task to start when the predecessor is scheduled to complete. By
creating a dependent relationship this way, &app; always assumes a
Finish Start relationship with zero lag time. You can modify this
relationship by opening the task edit dialog of the dependent
task, and selecting the <guilabel>Predecessors</guilabel> tab.
</para>
<para>
<figure>
<title>Creating a task dependency</title>
<graphic fileref="figures/group1-task-linking.png" format="PNG"></graphic>
</figure>
If you want to remove the dependency, you can select either
of the two tasks and delete the link by clicking the <guiicon>Unlink
</guiicon>icon on the toolbar, or by right clicking either task and
selecting <guimenuitem>Unlink</guimenuitem> from the pop up.
</para>
</sect3>
<sect3 id="mrp-critical-path">
<title>Highlighting the Critical Path</title>
<para>To show the tasks along the critical path of the project, choose
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Highlight Critical Tasks</guimenuitem>
</menuchoice>. The names of the tasks along the critical path will
be shown in red, and in the Gantt view, the task bar will also be red.
</para>
</sect3>
<sect3 id="mrp-guidelines">
<title>Showing Guide Lines</title>
<para>The <guimenuitem>Show Guide Lines</guimenuitem> option displays
horizontal guide lines in the
Gantt chart to help the user visually line up the chart bars with the
task list on the left hand side of the window. To enable the guide
lines, choose
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Show Guide Lines</guimenuitem>
</menuchoice>.
</para>
</sect3>
<sect3 id="mrp-nonstandard-days">
<title>Displaying Nonstandard Days</title>
<para>In the <xref linkend="mrp-calendars"/> section, we showed how to
define valid working times for the resources of our project. In the
Gantt view, there's an easy way to show where a resource has a working
or nonworking time that differs from the default calendar. You can enable
the diplay of nonstandard working days by choosing:
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Nonstandard Days</guimenuitem>
</menuchoice>.
</para>
<para>
The visualization of nonstandard working/nonworking time is as follows:
<itemizedlist>
<listitem><para>Nonworking time for some resource(s) on the task during
a default working time is displayed as a grey bar below the gantt bar
</para></listitem>
<listitem><para>Working time for some resource(s) on the task during
a default nonworking time is displayed as a white bar below the gantt bar
</para></listitem>
<listitem><para>Nonworking time for all resources on the task during
a default working time is displayed as grey bars above and below the gantt bar
</para></listitem>
<listitem><para>Working time for all resources on the task during
a default nonworking time is displayed as white bars above and below the gantt bar
</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="mrp-moving-tasks">
<title>Moving tasks</title>
<para>
If you need to rearrange the order that tasks are displayed in the
task view, you can do so by selecting the task you want to move, and
utilizing the
<guiicon>Move Up</guiicon> and <guiicon>Move Down</guiicon> icons on
the toolbar.
</para>
</sect3>
<sect3 id="mrp-zooming-gantt">
<title>Zooming in the Gantt View</title>
<para>
The tasks in a project can have very different durations and
sometimes you need to have a close view of the time line to see the
details of some task dependencies, but other times you need a higher
level view of the whole project.
To support both needs, &app; has a powerful zoom system that
lets you zoom to fit the complete project, zoom in the view or
zoom out incrementally to whatever size you like (hours being the
lower limit, and years is the upper limit).
</para>
<para>
<guibutton>Zoom to fit</guibutton> shows the entire project duration
in the Gantt view.
</para>
<para>
You can use the <guibutton>Zoom in</guibutton> and
<guibutton>Zoom out</guibutton> icons to select the length of
time line in which you want to work. When the view is
zoomed to a detailed level, nonworking hours are shown for each day
in addition to weekends.
</para>
</sect3>
</sect2>
<!-- ================ Usage Subsection ================================ -->
<sect2 id="mrp-print" xreflabel="Print">
<title>Printing</title>
<para>You can print your project information by choosing
<menuchoice>
......@@ -1530,6 +1698,8 @@
on available printers, or to a PDF file. If you choose to print to
a PDF file, your location options will change so that you can
specify the path and filename of the output file.
</para>
<para>
<figure>
<title>Printer Tab</title>
<graphic fileref="figures/print-project.png" format="PNG"></graphic>
......@@ -1537,7 +1707,10 @@
</para>
</listitem>
<listitem>
<para>In the Select Views tab, you can choose to print the Gantt, Task, or Resource views, or all of them. The default is all.
<para>In the Select Views tab, you can choose to print the Gantt,
Task, or Resource views, or all of them. The default is all.
</para>
<para>
<figure>
<title>Select Views Tab</title>
<graphic fileref="figures/print-project-selectviews.png" format="PNG"></graphic>
......@@ -1547,6 +1720,8 @@
<listitem>
<para>The Paper tab allows you to specify the size, orientation, and
layout of your paper prior to printing.
</para>
<para>
<figure>
<title>Paper Tab</title>
<graphic fileref="figures/print-project-paper.png" format="PNG"></graphic>
......@@ -1555,8 +1730,6 @@
</listitem>
</itemizedlist>
</para>
</sect3>
</sect2>
</sect1>
<!-- Customization/Settings not yet implemented...
......@@ -1943,11 +2116,12 @@
<title>About &app;</title>
<para> &app; is maintained by Imendio and GNOME community volunteers.
To find more information about
&app;, please visit Imendio's
<ulink url="http://www.imendio.com/projects/planner" type="http">&app;
Web site</ulink> or
<ulink url="http://www.planetplanner.org" type="http"> Planet &app;
</ulink>. </para>
&app;, please visit the
<ulink url="http://live.gnome.org/Planner" type="http">&app;
Web site</ulink>, where you can find information about subscribing
to the mailing list, searching the list archive, status of current
development efforts, and additional documentation.
</para>
<para>
To report a bug or make a suggestion regarding this application or
this manual, you can submit them using
......@@ -1955,21 +2129,12 @@
type="http">bugzilla</ulink>.
</para>
<para>
Another excellent source of information are the &app;
<ulink url="http://lists.imendio.com/mailman/listinfo/planner"
type="http">user</ulink> and
<ulink url="http://lists.imendio.com/mailman/listinfo/planner-dev"
type="http">developer</ulink> mailing lists. In addition to
subscribing, you might also want to browse the list archives, available
via these same links.
</para>
<para> This program is distributed 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. A copy of this license can be found at this
<ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
any later version. A copy of this license can be found
<ulink url="http://www.gnu.org/copyleft/gpl.html"
type="http">here</ulink>, or in the file named
COPYING included with the source code of this program. </para>
</sect1>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment