calligraplan/doc/taskeditor.docbook

0001 <sect2><title/>
0002 <sect3 id="description4"><title>Description</title>
0003   <para>
0004     The Task Editor is used to create, edit, and delete tasks.</para><para>Tasks can be organized into a hierarchical tree structure to any depth.
0005   </para>
0006   <para>
0007     <screenshot>
0008       <screeninfo></screeninfo>
0009       <mediaobject>
0010         <imageobject>
0011           <imagedata fileref="plan_taskeditor.png" format="PNG"/>
0012         </imageobject>
0013         <textobject>
0014           <phrase></phrase>
0015         </textobject>
0016       </mediaobject>
0017     </screenshot>
0018   </para>
0019 </sect3>
0020 <sect3 id="toolbar"><title>Toolbar</title>
0021   <para>The toolbar provides the means to create, delete and move tasks and milestones:
0022   </para>
0023   <para>
0024     <informaltable>
0025       <tgroup cols="3">
0026         <thead>
0027           <row>
0028             <entry><guilabel>Button</guilabel></entry>
0029             <entry><guilabel>Shortcut</guilabel></entry>
0030             <entry><guilabel>Description</guilabel></entry>
0031           </row>
0032         </thead>
0033         <tbody>
0034           <row>
0035             <entry>
0036               <para>Add Task</para>
0037             </entry>
0038             <entry>
0039               <para><keycombo>&Ctrl;<keycap>I</keycap></keycombo></para>
0040             </entry>
0041             <entry>
0042               <para>Dropdown box to create a task or milestone. The new item is positioned after the currently selected item on the same level as the selected item. If no item is selected, the new item is appended at the top level.</para>
0043             </entry>
0044           </row>
0045           <row>
0046             <entry><para>&nbsp;</para></entry>
0047             <entry>
0048               <para><keycombo>&Ctrl;&Alt;<keycap>I</keycap></keycombo></para>
0049             </entry>
0050           </row>
0051           <row>
0052             <entry>
0053               <para>Add Sub-task</para>
0054             </entry>
0055             <entry>
0056               <para><keycombo>&Ctrl;&Shift;<keycap>I</keycap></keycombo></para>
0057             </entry>
0058             <entry>
0059               <para>Dropdown box to create a sub-task or -milestone. The new item is appended as a child to the currently selected item.</para>
0060             </entry>
0061           </row>
0062           <row>
0063             <entry><para>&nbsp;</para></entry>
0064             <entry>
0065               <para><keycombo>&Ctrl;&Shift;&Alt;<keycap>I</keycap></keycombo></para>
0066             </entry>
0067           </row>
0068           <row>
0069             <entry>
0070               <para>Delete Task</para>
0071             </entry>
0072             <entry>
0073               <para><keycap>Delete</keycap></para>
0074             </entry>
0075             <entry>
0076               <para>Deletes the selected tasks.</para>
0077             </entry>
0078           </row>
0079           <row>
0080             <entry>
0081               <para>Indent Task</para>
0082             </entry>
0083             <entry>
0084               <para></para>
0085             </entry>
0086             <entry>
0087               <para>Appends the selected task as a child to the task above.</para>
0088             </entry>
0089           </row>
0090           <row>
0091             <entry>
0092               <para>Unindent Task</para>
0093             </entry>
0094             <entry>
0095               <para></para>
0096             </entry>
0097             <entry>
0098               <para>Moves the selected task one level up, inserting it after its current parent task.</para>
0099             </entry>
0100           </row>
0101           <row>
0102             <entry>
0103               <para>Move Up</para>
0104             </entry>
0105             <entry>
0106               <para></para>
0107             </entry>
0108             <entry>
0109               <para>Moves the selected task up one place.</para>
0110             </entry>
0111           </row>
0112           <row>
0113             <entry>
0114               <para>Move Down</para>
0115             </entry>
0116             <entry>
0117               <para></para>
0118             </entry>
0119             <entry>
0120               <para>Moves the selected task down one place.</para></entry>
0121           </row>
0122         </tbody>
0123       </tgroup>
0124     </informaltable>
0125   </para>
0126   <para>
0127     Note that you can also move or copy tasks using drag and drop or copy/paste.
0128   </para>
0129 </sect3>
0130 <sect3 id="editing-data5"><title>Editing data</title>
0131   <para>Data can be edited inline as described <link linkend="using-the-views">here</link>  or by using the Task Settings Dialog.
0132   </para>
0133   <para>The following columns are displayed as default:
0134   </para>
0135   <para>
0136     <informaltable>
0137       <tgroup cols="2">
0138         <thead>
0139           <row>
0140             <entry><guilabel>Column</guilabel></entry>
0141             <entry><guilabel>Description</guilabel></entry>
0142           </row>
0143         </thead>
0144         <tbody>
0145           <row>
0146             <entry>
0147               <para>Name</para>
0148             </entry>
0149             <entry>
0150               <para>The name of the task.</para>
0151             </entry>
0152           </row>
0153           <row>
0154             <entry>
0155               <para>Status</para>
0156             </entry>
0157             <entry>
0158               <para>Task status</para>
0159             </entry>
0160           </row>
0161           <row>
0162             <entry>
0163               <para>Responsible</para>
0164             </entry>
0165             <entry>
0166               <para>The person responsible for this task.</para>
0167             </entry>
0168           </row>
0169           <row>
0170             <entry>
0171               <para>Allocation</para>
0172             </entry>
0173             <entry>
0174               <para>List of resource allocations.</para>
0175             </entry>
0176           </row>
0177           <row>
0178             <entry>
0179               <para>Type</para>
0180             </entry>
0181             <entry>
0182               <para>The type of task or the estimate type of the task.</para><para>The type can be set to <emphasis>Milestone</emphasis>, <emphasis>Effort</emphasis> or <emphasis>Duration</emphasis>.
0183               </para>
0184               <para><guilabel>Note:</guilabel> If the type is <emphasis>Summary</emphasis> or <emphasis>Project</emphasis> the type is not editable.
0185               </para>
0186
0187             </entry>
0188           </row>
0189           <row>
0190             <entry>
0191               <para>Calendar</para>
0192             </entry>
0193             <entry>
0194               <para>The calendar used when estimate type is <emphasis>Duration</emphasis>.</para>
0195             </entry>
0196           </row>
0197           <row>
0198             <entry>
0199               <para>Estimate</para>
0200             </entry>
0201             <entry>
0202               <para>The most likely estimate. The estimate is the expected amount of effort or time needed to complete a task. It can be expressed in different units: h (hours), d (days), w (weeks) and M (months).</para>
0203             </entry>
0204           </row>
0205           <row>
0206             <entry>
0207               <para>Optimistic Ratio</para>
0208             </entry>
0209             <entry>
0210               <para>Optimistic estimate expressed as a negative percentage of the most likely estimate. (E.g. -20%).</para><para>This is only used if a PERT distribution is used.
0211               </para>
0212
0213             </entry>
0214           </row>
0215           <row>
0216             <entry>
0217               <para>Pessimistic Ratio</para>
0218             </entry>
0219             <entry>
0220               <para>Pessimistic estimate expressed as a positive percentage of the most likely estimate. (E.g. 50%).</para><para>This is only used if a PERT distribution is used.
0221               </para>
0222
0223             </entry>
0224           </row>
0225           <row>
0226             <entry>
0227               <para>Risk</para>
0228             </entry>
0229             <entry>
0230               <para>Risk controls the PERT distribution used when calculating the actual estimate for this task.</para>
0231             </entry>
0232           </row>
0233           <row>
0234             <entry>
0235               <para>Constraint</para>
0236             </entry>
0237             <entry>
0238               <para>The timing constraint type.</para>
0239             </entry>
0240           </row>
0241           <row>
0242             <entry>
0243               <para>Constraint Start</para>
0244             </entry>
0245             <entry>
0246               <para>Constraint start time.</para>
0247             </entry>
0248           </row>
0249           <row>
0250             <entry>
0251               <para>Constraint End</para>
0252             </entry>
0253             <entry>
0254               <para>Constraint end time.</para>
0255             </entry>
0256           </row>
0257           <row>
0258             <entry>
0259               <para>Running Account</para>
0260             </entry>
0261             <entry>
0262               <para>Account for running costs.</para>
0263             </entry>
0264           </row>
0265           <row>
0266             <entry>
0267               <para>Startup Account</para>
0268             </entry>
0269             <entry>
0270               <para>Account for cost incurred at startup of the task.</para>
0271             </entry>
0272           </row>
0273           <row>
0274             <entry>
0275               <para>Startup Cost</para>
0276             </entry>
0277             <entry>
0278               <para>The cost incurred at startup of the task.</para>
0279             </entry>
0280           </row>
0281           <row>
0282             <entry>
0283               <para>Shutdown Account</para>
0284             </entry>
0285             <entry>
0286               <para>Account for cost incurred at shutdown of the task.</para>
0287             </entry>
0288           </row>
0289           <row>
0290             <entry>
0291               <para>Shutdown Cost</para>
0292             </entry>
0293             <entry>
0294               <para>The cost incurred at shutdown of the task.</para>
0295             </entry>
0296           </row>
0297           <row>
0298             <entry>
0299               <para>Description</para>
0300             </entry>
0301             <entry>
0302               <para>Task notes.</para></entry>
0303           </row>
0304         </tbody>
0305       </tgroup>
0306     </informaltable>
0307   </para>
0308 </sect3>
0309 <sect3 id="task-modules-docker"><title>Task Modules Docker</title>
0310   <para>Task Modules are groups of tasks that can be reused across projects.
0311   </para>
0312   <para>This makes it possible to draw on past experience and to standardize similar operations.
0313   </para>
0314   <para>A task module is inserted into your project by dragging it from the docker and dropping it into your project.
0315   </para>
0316   <para>A task module is a regular plan file, and is designed using <guilabel>Plan</guilabel> in the same way as designing a regular project.
0317   </para>
0318   <para>A task module, however, typically includes only tasks, estimates, and dependencies.
0319   </para>
0320   <para>The project name is displayed in the docker, and the description is used as the tooltip.
0321   </para>
0322   <para>A module can be opened for inspection or editing by double-clicking on the module.
0323   </para>
0324   <para>The modules can be grouped by storing them in different directories. Where to search for them is configured using the Project Settings Dialog.
0325   </para>
0326   <para>Default values for new projects can be defined using the Plan Configuration Dialog.
0327   </para>
0328 </sect3>
0329 <sect3 id="resources-docker"><title>Resources Docker</title>
0330   <para>The Resources Docker offers a simple way to allocate resources to tasks by selecting the resources you need and dragging them onto the <emphasis>Allocation</emphasis> column.
0331   </para>
0332   <para>A resource can also be dropped on the <emphasis>Responsible</emphasis> column.
0333   </para>
0334 </sect3>
0335 <sect3 id="allocations-docker"><title>Allocations Docker</title>
0336   <para>The Allocations Docker displays the current resource allocation for the selected task.
0337   </para>
0338 </sect3>
0339 <sect3 id="configuration"><title>Configuration</title>
0340   <para>Using the context menu, the view can be configured to show / hide the Project, split / unsplit the tree view or it can be configured using the configure dialog.
0341   </para>
0342   <para>
0343     <informaltable>
0344       <tgroup cols="2">
0345         <tbody>
0346           <row>
0347             <entry>
0348               <para>The configure dialog enables you to tailor the amount of information the view displays to fit your needs.</para>
0349             </entry>
0350             <entry>
0351               <para>
0352                 <screenshot>
0353                   <screeninfo></screeninfo>
0354                   <mediaobject>
0355                     <imageobject>
0356                       <imagedata fileref="plan_taskeditor_config.png" format="PNG"/>
0357                     </imageobject>
0358                     <textobject>
0359                       <phrase></phrase>
0360                     </textobject>
0361                   </mediaobject>
0362                   </screenshot></para></entry>
0363           </row>
0364         </tbody>
0365       </tgroup>
0366     </informaltable>
0367   </para>
0368 </sect3>
0369 </sect2>