Git commit 9e6282bc3b5a6a122fa157a262e6c0894ac95e7b by Dag Andersen. Committed on 28/02/2020 at 12:00. Pushed by danders into branch 'master'.
Documentation: Create a saner structure than userbase export was able to do. A +4 -0 doc/commonuserinterface.docbook M +2 -2 doc/contexthelp.docbook M +8 -8 doc/costbreakdownstructureeditor.docbook M +26 -26 doc/creatingodtreporttemplates.docbook M +2 -2 doc/creatingproject.docbook M +5 -5 doc/definitions.docbook A +5 -0 doc/guidelines.docbook M +36 -54 doc/index.docbook M +2 -2 doc/introduction.docbook M +10 -10 doc/mainworkspace.docbook M +4 -4 doc/managingresources.docbook M +8 -8 doc/milestoneganttview.docbook A +5 -0 doc/planintroduction.docbook M +4 -4 doc/projectperformanceview.docbook A +3 -0 doc/reports.docbook M +6 -6 doc/reportsgeneratorview.docbook M +10 -10 doc/resourceassignmentganttview.docbook M +10 -10 doc/resourceassignmentview.docbook M +10 -10 doc/resourceeditor.docbook M +10 -10 doc/scheduleseditor.docbook M +2 -2 doc/startupview.docbook M +8 -8 doc/taskdependencyeditorgraphical.docbook M +2 -2 doc/taskdependencyeditorlist.docbook M +16 -16 doc/taskeditor.docbook M +8 -8 doc/taskexecutionview.docbook M +8 -8 doc/taskganttview.docbook M +2 -2 doc/taskperformanceview.docbook M +8 -8 doc/taskstatusview.docbook M +8 -8 doc/usingtheviews.docbook A +18 -0 doc/viewsandeditors.docbook M +6 -6 doc/workandvacationeditor.docbook https://commits.kde.org/calligraplan/9e6282bc3b5a6a122fa157a262e6c0894ac95e7b diff --git a/doc/commonuserinterface.docbook b/doc/commonuserinterface.docbook new file mode 100644 index 00000000..f24a569d --- /dev/null +++ b/doc/commonuserinterface.docbook @@ -0,0 +1,4 @@ +<chapter id="common-user-interface"><title>Common User Interface</title> + &main-work-space-section; + &using-the-views-section; +</chapter> diff --git a/doc/contexthelp.docbook b/doc/contexthelp.docbook index 6b49d467..a0bd5018 100644 --- a/doc/contexthelp.docbook +++ b/doc/contexthelp.docbook @@ -1,8 +1,8 @@ -<chapter id="context-help"><title>Context Help</title> +<sect1 id="context-help"><title>Context Help</title> <para>Many functions and views have help and hints that can be displayed with the <emphasis>What's This</emphasis> function. </para> <para>You can activate it with the menu entry <menuchoice><guimenu>Help</guimenu><guimenuitem>WhatsThis</guimenuitem></menuchoice> or keboard shortcut <keycombo>&Shift;<keycap>F1</keycap></keycombo>. </para> <para>In dialogs it is activated by pressing the <varname>?</varname> in the dialogs title bar. </para> -</chapter> +</sect1> diff --git a/doc/costbreakdownstructureeditor.docbook b/doc/costbreakdownstructureeditor.docbook index eb198696..6de617b3 100644 --- a/doc/costbreakdownstructureeditor.docbook +++ b/doc/costbreakdownstructureeditor.docbook @@ -1,5 +1,5 @@ -<chapter id="cost-breakdown-structure-editor"><title>Cost Breakdown Structure Editor</title> - <sect1 id="description12"><title>Description</title> +<sect1 id="cost-breakdown-structure-editor"><title>Cost Breakdown Structure Editor</title> + <sect2 id="description12"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -30,8 +30,8 @@ </para> <para>The default account accumulates costs incurred from tasks that are not connected to an account. </para> - </sect1> - <sect1 id="toolbar13"><title>Toolbar</title> + </sect2> + <sect2 id="toolbar13"><title>Toolbar</title> <para>The toolbar provides the means to create and delete accounts: </para> <para> @@ -81,8 +81,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data14"><title>Editing data</title> + </sect2> + <sect2 id="editing-data14"><title>Editing data</title> <para>Data can be edited inline as described <link linkend="using-the-views">here</link>. </para> <para>The following columns are available: @@ -117,5 +117,5 @@ </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/creatingodtreporttemplates.docbook b/doc/creatingodtreporttemplates.docbook index 5f045a3b..b489e539 100644 --- a/doc/creatingodtreporttemplates.docbook +++ b/doc/creatingodtreporttemplates.docbook @@ -1,17 +1,17 @@ -<chapter id="creating-odt-report-templates"><title>Creating ODT Report Templates</title> - <sect1 id="description1"><title>Description</title> +<sect1 id="creating-odt-report-templates"><title>Creating ODT Report Templates</title> + <sect2 id="description1"><title>Description</title> <para>Open Document Text report templates are regular ODT files that can be designed using any ODT word processor like <emphasis>Calligra Words</emphasis> or <emphasis>LibreOffice Writer</emphasis>. The technique used is to use <emphasis>user field</emphasis> variables to hold references to the information that shall be fetched from the project. The variables are called <emphasis>User Fields</emphasis> in <emphasis>Writer</emphasis> and can be found under <menuchoice><guimenu>Insert</guimenu><guisubmenu>Field</guisubmenu><guimenuitem>More Fields</guimenuitem><guimenuitem>Variables</guimenuitem><guimenuitem>User Fields</guimenuitem></menuchoice>. In <emphasis>Words</emphasis> they are called <emphasis>Custom Variables</emphasis> and can be found under <menuchoice><guimenu>Text Editing docker</guimenu><guisubmenu>Variable</guisubmenu><guimenuitem>Custom</guimenuitem></menuchoice>. </para> <para>The easiest way to create a new report template is to modify an existing one as all user fields are defined. </para> - </sect1> - <sect1 id="user-field-variables"><title>User Field Variables</title> - <sect2 id="variables"><title>Variables</title> + </sect2> + <sect2 id="user-field-variables"><title>User Field Variables</title> + <sect3 id="variables"><title>Variables</title> <para>The variables are used to enable the generator to extract data from the project. </para> <para>A variable can be a reference to a single data field, a reference to table data or a reference to chart data. </para> - <sect3 id="single-data-field"><title>Single Data Field</title> + <sect4 id="single-data-field"><title>Single Data Field</title> <para>A single data field variable has the following format: </para> <para><replaceable>data group name</replaceable>.<replaceable>property</replaceable> = <replaceable>property identifier</replaceable> @@ -23,8 +23,8 @@ <listitem><para><replaceable>property</replaceable> makes the user field name unique.</para></listitem> <listitem><para><replaceable>property identity</replaceable> identifies the property in the data group.</para></listitem> </itemizedlist> - </sect3> - <sect3 id="table-data"><title>Table Data</title> + </sect4> + <sect4 id="table-data"><title>Table Data</title> <para>A table in a report template consists of a variable to specify the data table to use. </para> <para>The variable name must start with <replaceable>table</replaceable> (⪚ tableTasks) and the variable value must be the name of the data table (⪚ tasks). @@ -41,8 +41,8 @@ <listitem><para><guilabel>property</guilabel> makes the user field name unique.</para></listitem> <listitem><para><guilabel>property identity</guilabel> identifies the property in the data group.</para></listitem> </itemizedlist> - </sect3> - <sect3 id="chart-data"><title>Chart Data</title> + </sect4> + <sect4 id="chart-data"><title>Chart Data</title> <para>A chart in a report template consists of a variable to specify the data to use in the chart. </para> <para>The variable name must start with <replaceable>chart</replaceable> (⪚ chartBudgetCost) and the variable value specifies the data group and values to populate the chart. @@ -62,9 +62,9 @@ </para> <para>chartBudget = project; values=bcws cost, bcwp cost, acwp cost; </para> - </sect3> - </sect2> - <sect2 id="translated-labels"><title>Translated Labels</title> + </sect4> + </sect3> + <sect3 id="translated-labels"><title>Translated Labels</title> <para>Translated labels enable us to produce general report templates that can be used in different languages. </para> <para> @@ -144,8 +144,8 @@ </tgroup> </informaltable> </para> - </sect2> - <sect2 id="project-values"><title>Project Values</title> + </sect3> + <sect3 id="project-values"><title>Project Values</title> <para>Shows values from the main project. </para> <para> @@ -294,8 +294,8 @@ </tgroup> </informaltable> </para> - </sect2> - <sect2 id="schedule-values"><title>Schedule Values</title> + </sect3> + <sect3 id="schedule-values"><title>Schedule Values</title> <para>Shows values from the current schedule. </para> <para> @@ -422,8 +422,8 @@ </tgroup> </informaltable> </para> - </sect2> - <sect2 id="tables"><title>Tables</title> + </sect3> + <sect3 id="tables"><title>Tables</title> <para>Supported table types: </para> <itemizedlist> @@ -1226,9 +1226,9 @@ </tgroup> </informaltable> </para> - </sect2> - </sect1> - <sect1 id="chart"><title>Chart</title> + </sect3> + </sect2> + <sect2 id="chart"><title>Chart</title> <para>Use by placing a variable with name chartX (X=some text to make the variable name unique) with a value project before the chart that shall be used. </para> <para>The variable has this format: @@ -1259,9 +1259,9 @@ </para> <para>Note that you cannot mix effort- and cost-based values. If you want to show both, create two charts. </para> - <sect2 id="gantt"><title>Gantt</title> + <sect3 id="gantt"><title>Gantt</title> <para>Not supported. </para> - </sect2> - </sect1> -</chapter> + </sect3> + </sect2> +</sect1> diff --git a/doc/creatingproject.docbook b/doc/creatingproject.docbook index 47405af4..be6b62e7 100644 --- a/doc/creatingproject.docbook +++ b/doc/creatingproject.docbook @@ -1,4 +1,4 @@ -<chapter id="creating-a-project"><title>Creating a Project</title> +<sect1 id="creating-a-project"><title>Creating a Project</title> <para>A new project can be created by pressing the <emphasis>New Project</emphasis> button or selecting a <emphasis>project template</emphasis> in the <link linkend="startup-view">Startup View</link>. </para> <para>This will create a new project with default values defined in <ulink url="http://userbase.kde.org/Special:myLanguage/Plan/Manual/Configure Plan Dialog">Settings</ulink> or from values defined in the template. The Project Settings Dialog will open to enable you to define project specific properties like <emphasis>project name</emphasis>, <emphasis>manager</emphasis> and <emphasis>target times</emphasis>. @@ -26,4 +26,4 @@ </screen> </para> -</chapter> +</sect1> diff --git a/doc/definitions.docbook b/doc/definitions.docbook index c53e9939..f28db41a 100644 --- a/doc/definitions.docbook +++ b/doc/definitions.docbook @@ -1,11 +1,11 @@ -<chapter id="definitions"><title>Definitions</title> -<sect1 id="introduction0"><title>Introduction</title> +<sect1 id="definitions"><title>Definitions</title> + <sect2 id="introduction0"><title>Introduction</title> <para>In project management, terms may be used in different ways in different programs or different companies or project types. Looking at more exhaustive project management glossaries, one will find alternative definitions for most terms. </para> <para>This list defines how certain terms are used in <guilabel>Plan</guilabel>. </para> -</sect1> -<sect1 id="terms"><title>Terms</title> + </sect2> + <sect2 id="terms"><title>Terms</title> <variablelist> <varlistentry><term id="account"><emphasis role="bold">Account</emphasis></term> <listitem> @@ -149,5 +149,5 @@ </varlistentry> </variablelist> + </sect2> </sect1> -</chapter> diff --git a/doc/guidelines.docbook b/doc/guidelines.docbook new file mode 100644 index 00000000..3d002f62 --- /dev/null +++ b/doc/guidelines.docbook @@ -0,0 +1,5 @@ +<chapter id="guidelines"><title>Guidelines</title> + &creating-project-section; + &managing-resources-section; + &creating-odt-report-templates-section; +</chapter> diff --git a/doc/index.docbook b/doc/index.docbook index 422431ab..f4a92601 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,31 +1,35 @@ <?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ -<!ENTITY managing-resources-chapter SYSTEM "managingresources.docbook"> -<!ENTITY introduction-chapter SYSTEM "introduction.docbook"> -<!ENTITY definitions-chapter SYSTEM "definitions.docbook"> -<!ENTITY context-help-chapter SYSTEM "contexthelp.docbook"> -<!ENTITY creating-project-chapter SYSTEM "creatingproject.docbook"> -<!ENTITY managing-resources-chapter SYSTEM "managingresources.docbook"> -<!ENTITY creating-odt-report-templates-chapter SYSTEM "creatingodtreporttemplates.docbook"> -<!ENTITY main-work-space-chapter SYSTEM "mainworkspace.docbook"> -<!ENTITY using-the-views-chapter SYSTEM "usingtheviews.docbook"> -<!ENTITY startup-view-chapter SYSTEM "startupview.docbook"> -<!ENTITY task-editor-chapter SYSTEM "taskeditor.docbook"> -<!ENTITY resource-editor-chapter SYSTEM "resourceeditor.docbook"> -<!ENTITY work-and-vacation-editor-chapter SYSTEM "workandvacationeditor.docbook"> -<!ENTITY cost-breakdown-structure-editor-chapter SYSTEM "costbreakdownstructureeditor.docbook"> -<!ENTITY task-dependency-editor-graphical-chapter SYSTEM "taskdependencyeditorgraphical.docbook"> -<!ENTITY task-dependency-editor-list-chapter SYSTEM "taskdependencyeditorlist.docbook"> -<!ENTITY schedules-editor-chapter SYSTEM "scheduleseditor.docbook"> -<!ENTITY project-performance-view-chapter SYSTEM "projectperformanceview.docbook"> -<!ENTITY task-performance-view-chapter SYSTEM "taskperformanceview.docbook"> -<!ENTITY task-status-view-chapter SYSTEM "taskstatusview.docbook"> -<!ENTITY task-execution-view-chapter SYSTEM "taskexecutionview.docbook"> -<!ENTITY task-gantt-view-chapter SYSTEM "taskganttview.docbook"> -<!ENTITY milestone-gantt-view-chapter SYSTEM "milestoneganttview.docbook"> -<!ENTITY resource-assignment-view-chapter SYSTEM "resourceassignmentview.docbook"> -<!ENTITY resource-assignment-gantt-view-chapter SYSTEM "resourceassignmentganttview.docbook"> -<!ENTITY reports-generator-view-chapter SYSTEM "reportsgeneratorview.docbook"> +<!ENTITY plan-introduction-chapter SYSTEM "planintroduction.docbook"> +<!ENTITY guidelines-chapter SYSTEM "guidelines.docbook"> +<!ENTITY common-user-interface-chapter SYSTEM "commonuserinterface.docbook"> +<!ENTITY views-and-editors-chapter SYSTEM "viewsandeditors.docbook"> +<!ENTITY reports-chapter SYSTEM "reports.docbook"> +<!ENTITY introduction-section SYSTEM "introduction.docbook"> +<!ENTITY definitions-section SYSTEM "definitions.docbook"> +<!ENTITY context-help-section SYSTEM "contexthelp.docbook"> +<!ENTITY creating-project-section SYSTEM "creatingproject.docbook"> +<!ENTITY managing-resources-section SYSTEM "managingresources.docbook"> +<!ENTITY creating-odt-report-templates-section SYSTEM "creatingodtreporttemplates.docbook"> +<!ENTITY main-work-space-section SYSTEM "mainworkspace.docbook"> +<!ENTITY using-the-views-section SYSTEM "usingtheviews.docbook"> +<!ENTITY startup-view-section SYSTEM "startupview.docbook"> +<!ENTITY task-editor-section SYSTEM "taskeditor.docbook"> +<!ENTITY resource-editor-section SYSTEM "resourceeditor.docbook"> +<!ENTITY work-and-vacation-editor-section SYSTEM "workandvacationeditor.docbook"> +<!ENTITY cost-breakdown-structure-editor-section SYSTEM "costbreakdownstructureeditor.docbook"> +<!ENTITY task-dependency-editor-graphical-section SYSTEM "taskdependencyeditorgraphical.docbook"> +<!ENTITY task-dependency-editor-list-section SYSTEM "taskdependencyeditorlist.docbook"> +<!ENTITY schedules-editor-section SYSTEM "scheduleseditor.docbook"> +<!ENTITY project-performance-view-section SYSTEM "projectperformanceview.docbook"> +<!ENTITY task-performance-view-section SYSTEM "taskperformanceview.docbook"> +<!ENTITY task-status-view-section SYSTEM "taskstatusview.docbook"> +<!ENTITY task-execution-view-section SYSTEM "taskexecutionview.docbook"> +<!ENTITY task-gantt-view-section SYSTEM "taskganttview.docbook"> +<!ENTITY milestone-gantt-view-section SYSTEM "milestoneganttview.docbook"> +<!ENTITY resource-assignment-view-section SYSTEM "resourceassignmentview.docbook"> +<!ENTITY resource-assignment-gantt-view-section SYSTEM "resourceassignmentganttview.docbook"> +<!ENTITY reports-generator-view-section SYSTEM "reportsgeneratorview.docbook"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"><!-- change language only here --> ]> @@ -50,34 +54,12 @@ <keyword>KDE</keyword> </keywordset> </bookinfo> - <!--userbase <timestamp>2019-11-01T14:58:49Z</timestamp>--> - - <!--userbase-content--> - &introduction-chapter; - &definitions-chapter; - &context-help-chapter; - &creating-project-chapter; - &managing-resources-chapter; - &creating-odt-report-templates-chapter; - &main-work-space-chapter; - &using-the-views-chapter; - &startup-view-chapter; - &task-editor-chapter; - &resource-editor-chapter; - &work-and-vacation-editor-chapter; - &cost-breakdown-structure-editor-chapter; - &task-dependency-editor-graphical-chapter; - &task-dependency-editor-list-chapter; - &schedules-editor-chapter; - &project-performance-view-chapter; - &task-performance-view-chapter; - &task-status-view-chapter; - &task-execution-view-chapter; - &task-gantt-view-chapter; - &milestone-gantt-view-chapter; - &resource-assignment-view-chapter; - &resource-assignment-gantt-view-chapter; - &reports-generator-view-chapter; + + &plan-introduction-chapter; + &guidelines-chapter; + &common-user-interface-chapter; + &views-and-editors-chapter; + &reports-chapter; <!--userbase-content--> <chapter id="credits"> diff --git a/doc/introduction.docbook b/doc/introduction.docbook index e66f2783..42d9eafd 100644 --- a/doc/introduction.docbook +++ b/doc/introduction.docbook @@ -1,4 +1,4 @@ -<chapter id="introduction"><title>Introduction</title> +<sect1 id="introduction"><title>Introduction</title> <para>Features include: </para> <itemizedlist> @@ -28,4 +28,4 @@ </para></listitem> <listitem><para>Task tracking using the <link linkend="task-execution-view">Task Execution View</link> or <link linkend="task-status-view">Task Status View</link> </para></listitem> </itemizedlist> -</chapter> +</sect1> diff --git a/doc/mainworkspace.docbook b/doc/mainworkspace.docbook index a52a52da..1cafae5b 100644 --- a/doc/mainworkspace.docbook +++ b/doc/mainworkspace.docbook @@ -1,6 +1,6 @@ -<chapter id="main-work-space"><title>Main Work Space</title> +<sect1 id="main-work-space"><title>Main Work Space</title> - <sect1 id="description2"><title>Description</title> + <sect2 id="description2"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -31,8 +31,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="the-view-selector"><title>The View Selector</title> + </sect2> + <sect2 id="the-view-selector"><title>The View Selector</title> <para>The <link linkend="the-view-selector">View Selector</link> enables you to select the data view you want to display from the currently listed views. </para> <para>Views are grouped into categories for easier retrieval: Editors, Views, Execution and Reports by default: @@ -45,13 +45,13 @@ </itemizedlist> <para>Views can also be moved within or across categories, or added to or removed from the <link linkend="the-view-selector">View Selector</link>. </para> - </sect1> - <sect1 id="schedule-selector"><title>Schedule Selector</title> + </sect2> + <sect2 id="schedule-selector"><title>Schedule Selector</title> <para>The Schedule Selector enables you to select the schedule all the views (⪚ <link linkend="task-gantt-view">Gantt View</link>) shall display values from. Tasks which has not been scheduled in the selected schedule are not normally shown in any of the views. (They are shown in editors, of course.) </para> - </sect1> - <sect1 id="status-bar"><title>Status Bar</title> + </sect2> + <sect2 id="status-bar"><title>Status Bar</title> <para>The status bar shows messages and progress information. Most notably is the currently selected schedule shown at the right of the status bar. Note that most of the views in the <emphasis>Views</emphasis> category display information depending on the selected schedule, so if the project is not scheduled (<emphasis>Not Scheduled</emphasis>), most views will be empty. </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/managingresources.docbook b/doc/managingresources.docbook index c302894f..c49b5a64 100644 --- a/doc/managingresources.docbook +++ b/doc/managingresources.docbook @@ -1,5 +1,5 @@ -<chapter id="managing-resources"><title>Managing Resources</title> - <sect1 id="description"><title>Description</title> +<sect1 id="managing-resources"><title>Managing Resources</title> + <sect2 id="description"><title>Description</title> <para>You can create resources for a project using the <link linkend="resource-editor">Resource Editor</link> and <link linkend="work-and-vacation-editor">Work and Vacation Editor</link>. </para> <para>However, if you are going to use the same resources in many projects (which is often the case) it is more convenient to maintain resources in a separate file. The best way to do this is to create your resources file first and then set up Plan to always load this file when creating a new project. @@ -8,5 +8,5 @@ </para> <para>You can select the resource file to use when creating a new project. </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/milestoneganttview.docbook b/doc/milestoneganttview.docbook index 269d7fa1..551112fe 100644 --- a/doc/milestoneganttview.docbook +++ b/doc/milestoneganttview.docbook @@ -1,5 +1,5 @@ -<chapter id="milestone-gantt-view"><title>Milestone Gantt View</title> - <sect1 id="description30"><title>Description</title> +<sect1 id="milestone-gantt-view"><title>Milestone Gantt View</title> + <sect2 id="description30"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -29,8 +29,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data31"><title>Editing data</title> + </sect2> + <sect2 id="editing-data31"><title>Editing data</title> <para>Milestone description and progress can be edited using the context menu. </para> <para>The following columns are displayed as default: @@ -72,8 +72,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="configuration32"><title>Configuration</title> + </sect2> + <sect2 id="configuration32"><title>Configuration</title> <para> <informaltable> <tgroup cols="2"> @@ -105,5 +105,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/planintroduction.docbook b/doc/planintroduction.docbook new file mode 100644 index 00000000..389ff5ef --- /dev/null +++ b/doc/planintroduction.docbook @@ -0,0 +1,5 @@ +<chapter id="plan-introduction"><title>Introduction to Plan</title> + &introduction-section; + &definitions-section; + &context-help-section; +</chapter> diff --git a/doc/projectperformanceview.docbook b/doc/projectperformanceview.docbook index e7fc18e3..09a1c7d2 100644 --- a/doc/projectperformanceview.docbook +++ b/doc/projectperformanceview.docbook @@ -1,5 +1,5 @@ -<chapter id="project-performance-view"><title>Project Performance View</title> - <sect1 id="description21"><title>Description</title> +<sect1 id="project-performance-view"><title>Project Performance View</title> + <sect2 id="description21"><title>Description</title> <para>The Project performance view is a project management chart where can be understood the actual situation of the project according to the Earned Value Method. </para> <para> @@ -30,5 +30,5 @@ <listitem><para>CPI is the Cost Performance Index,</para></listitem> <listitem><para>SPI is the Schedule Performance Index.</para></listitem> </itemizedlist> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/reports.docbook b/doc/reports.docbook new file mode 100644 index 00000000..b6349ffa --- /dev/null +++ b/doc/reports.docbook @@ -0,0 +1,3 @@ +<chapter id="reports"><title>Reports</title> + &reports-generator-view-section; +</chapter> diff --git a/doc/reportsgeneratorview.docbook b/doc/reportsgeneratorview.docbook index ee9324a2..48c90088 100644 --- a/doc/reportsgeneratorview.docbook +++ b/doc/reportsgeneratorview.docbook @@ -1,5 +1,5 @@ -<chapter id="reports-generator-view"><title>Reports Generator View</title> - <sect1 id="description41"><title>Description</title> +<sect1 id="reports-generator-view"><title>Reports Generator View</title> + <sect2 id="description41"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -79,8 +79,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="toolbar42"><title>Toolbar</title> + </sect2> + <sect2 id="toolbar42"><title>Toolbar</title> <para>The toolbar provides the means to add, remove and generate reports. </para> <para> @@ -130,5 +130,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/resourceassignmentganttview.docbook b/doc/resourceassignmentganttview.docbook index c33383bb..7cba743e 100644 --- a/doc/resourceassignmentganttview.docbook +++ b/doc/resourceassignmentganttview.docbook @@ -1,5 +1,5 @@ -<chapter id="resource-assignment-gantt-view"><title>Resource Assignment Gantt View</title> - <sect1 id="description37"><title>Description</title> +<sect1 id="resource-assignment-gantt-view"><title>Resource Assignment Gantt View</title> + <sect2 id="description37"><title>Description</title> <para>The Resource Assignment Gantt View displays the scheduled task-resource assignments in a Gantt chart. </para> <!-- @@ -20,8 +20,8 @@ </screenshot> </para> --> - </sect1> - <sect1 id="data38"><title>Data</title> + </sect2> + <sect2 id="data38"><title>Data</title> <para>The following columns are displayed as default: </para> <para> @@ -69,12 +69,12 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data39"><title>Editing data</title> + </sect2> + <sect2 id="editing-data39"><title>Editing data</title> <para>The task description and progress can be edited using the context menu. </para> - </sect1> - <sect1 id="configuration40"><title>Configuration</title> + </sect2> + <sect2 id="configuration40"><title>Configuration</title> <para> <informaltable> <tgroup cols="2"> @@ -106,5 +106,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/resourceassignmentview.docbook b/doc/resourceassignmentview.docbook index b5c92f87..c6130a8d 100644 --- a/doc/resourceassignmentview.docbook +++ b/doc/resourceassignmentview.docbook @@ -1,5 +1,5 @@ -<chapter id="resource-assignment-view"><title>Resource Assignment View</title> - <sect1 id="description33"><title>Description</title> +<sect1 id="resource-assignment-view"><title>Resource Assignment View</title> + <sect2 id="description33"><title>Description</title> <para> The Resource Assignment View displays the scheduled task-resource assignments in a table. <note><para>This view can severly impact performance in large projects.</para></note> @@ -22,8 +22,8 @@ </screenshot> --> </para> - </sect1> - <sect1 id="data34"><title>Data</title> + </sect2> + <sect2 id="data34"><title>Data</title> <para>The following columns are displayed as default: </para> <para> @@ -63,12 +63,12 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data35"><title>Editing data</title> + </sect2> + <sect2 id="editing-data35"><title>Editing data</title> <para>The task description and progress can be edited using the context menu. </para> - </sect1> - <sect1 id="configuration36"><title>Configuration</title> + </sect2> + <sect2 id="configuration36"><title>Configuration</title> <para> <informaltable> <tgroup cols="2"> @@ -100,5 +100,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/resourceeditor.docbook b/doc/resourceeditor.docbook index e2155543..99826206 100644 --- a/doc/resourceeditor.docbook +++ b/doc/resourceeditor.docbook @@ -1,5 +1,5 @@ -<chapter id="resource-editor"><title>Resource Editor</title> - <sect1 id="description6"><title>Description</title> +<sect1 id="resource-editor"><title>Resource Editor</title> + <sect2 id="description6"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -32,8 +32,8 @@ </para> <para>Resources can be <emphasis>Shared</emphasis> or <emphasis>Local</emphasis>. A local resource is only used in the current project. A shared resource can be shared between multiple projects and is stored in a separate file, see <link linkend="managing-resources">Managing Resources</link>. </para> - </sect1> - <sect1 id="toolbar7"><title>Toolbar</title> + </sect2> + <sect2 id="toolbar7"><title>Toolbar</title> <para>The toolbar provides the means to create and delete resources and resource groups: </para> <para> @@ -89,8 +89,8 @@ </para> <para><note><para>When moving a resource, the resource will lose any allocations.</para></note> </para> - </sect1> - <sect1 id="editing-data8"><title>Editing data</title> + </sect2> + <sect2 id="editing-data8"><title>Editing data</title> <para>Data can be edited inline as described <link linkend="using-the-views">here</link>. </para> <para>Resources can also be edited using the Resource Settings Dialog. @@ -198,8 +198,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="configuration9"><title>Configuration</title> + </sect2> + <sect2 id="configuration9"><title>Configuration</title> <para> <informaltable> <tgroup cols="2"> @@ -228,5 +228,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/scheduleseditor.docbook b/doc/scheduleseditor.docbook index 41669ec2..08b4c407 100644 --- a/doc/scheduleseditor.docbook +++ b/doc/scheduleseditor.docbook @@ -1,5 +1,5 @@ -<chapter id="schedules-editor"><title>Schedules Editor</title> - <sect1 id="description17"><title>Description</title> +<sect1 id="schedules-editor"><title>Schedules Editor</title> + <sect2 id="description17"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -73,8 +73,8 @@ </mediaobject> </screenshot> </para> - </sect1> - <sect1 id="toolbar18"><title>Toolbar</title> + </sect2> + <sect2 id="toolbar18"><title>Toolbar</title> <para>The toolbar provides the means to create, delete and calculate schedules: </para> <para> @@ -157,8 +157,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data19"><title>Editing data</title> + </sect2> + <sect2 id="editing-data19"><title>Editing data</title> <para>Data can be edited in-line as described <link linkend="using-the-views">here</link>. </para> <para>The following columns are displayed as default: @@ -254,8 +254,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="configuration20"><title>Configuration</title> + </sect2> + <sect2 id="configuration20"><title>Configuration</title> <para> <informaltable> <tgroup cols="2"> @@ -284,5 +284,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/startupview.docbook b/doc/startupview.docbook index cd410959..b1afdf55 100644 --- a/doc/startupview.docbook +++ b/doc/startupview.docbook @@ -1,4 +1,4 @@ -<chapter id="startup-view"><title>Startup View</title> +<sect1 id="startup-view"><title>Startup View</title> <para>The Startup View is shown at startup and when <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> is selected. </para> <para>It has 3 sections for: @@ -8,4 +8,4 @@ <listitem><para>Opening existing projects. This section gives you the possibility to open an existing project file or one of the 10 most recent projects you have opened.</para></listitem> <listitem><para>The Help section gives you links to introductory pages, documentation and community forum.</para></listitem> </itemizedlist> -</chapter> +</sect1> diff --git a/doc/taskdependencyeditorgraphical.docbook b/doc/taskdependencyeditorgraphical.docbook index 93d7f6a4..d54e254f 100644 --- a/doc/taskdependencyeditorgraphical.docbook +++ b/doc/taskdependencyeditorgraphical.docbook @@ -1,5 +1,5 @@ -<chapter id="task-dependency-editor-graphical"><title>Task Dependency Editor (Graphical)</title> - <sect1 id="description15"><title>Description</title> +<sect1 id="task-dependency-editor-graphical"><title>Task Dependency Editor (Graphical)</title> + <sect2 id="description15"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -67,8 +67,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-dependencies"><title>Editing dependencies</title> + </sect2> + <sect2 id="editing-dependencies"><title>Editing dependencies</title> <para>Dependencies are created by first selecting a start- or finish area of the predecessor task, then selecting the start- or finish area of the successor task. </para> <para>This can be done using the mouse or the keyboard. @@ -79,8 +79,8 @@ </para> <para>You can also open the context menu on a connection area which will enable you to edit all dependencies connected to that area. </para> - </sect1> - <sect1 id="toolbar16"><title>Toolbar</title> + </sect2> + <sect2 id="toolbar16"><title>Toolbar</title> <para>The toolbar provides the means to create and delete tasks: </para> <para> @@ -140,5 +140,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/taskdependencyeditorlist.docbook b/doc/taskdependencyeditorlist.docbook index dd492e2a..9bae799f 100644 --- a/doc/taskdependencyeditorlist.docbook +++ b/doc/taskdependencyeditorlist.docbook @@ -1,7 +1,7 @@ -<chapter id="task-dependency-editor-list"><title>Task Dependency Editor (List)</title> +<sect1 id="task-dependency-editor-list"><title>Task Dependency Editor (List)</title> <para><note><para>This view is not shown by default. For large projects, it can impact performance severely</para></note> </para> <para>It can be activated using the <link linkend="the-view-selector">View Selector</link> context menu. </para> -</chapter> +</sect1> diff --git a/doc/taskeditor.docbook b/doc/taskeditor.docbook index 42f508d6..872c4c7e 100644 --- a/doc/taskeditor.docbook +++ b/doc/taskeditor.docbook @@ -1,5 +1,5 @@ -<chapter id="task-editor"><title>Task Editor</title> - <sect1 id="description4"><title>Description</title> +<sect1 id="task-editor"><title>Task Editor</title> + <sect2 id="description4"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -28,8 +28,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="toolbar"><title>Toolbar</title> + </sect2> + <sect2 id="toolbar"><title>Toolbar</title> <para>The toolbar provides the means to create, delete and move tasks and milestones: </para> <para> @@ -137,8 +137,8 @@ </para> <para>Note that you can also move tasks with drag and drop. </para> - </sect1> - <sect1 id="editing-data5"><title>Editing data</title> + </sect2> + <sect2 id="editing-data5"><title>Editing data</title> <para>Data can be edited inline as described <link linkend="using-the-views">here</link> or by using the Task Settings Dialog. </para> <para>The following columns are displayed as default: @@ -316,8 +316,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="task-modules-docker"><title>Task Modules Docker</title> + </sect2> + <sect2 id="task-modules-docker"><title>Task Modules Docker</title> <para>Task Modules are groups of tasks that can be reused across projects. </para> <para>This makes it possible to draw on past experience and to standardize similar operations. @@ -336,18 +336,18 @@ </para> <para>Default values for new projects can be defined using the Plan Configuration Dialog. </para> - </sect1> - <sect1 id="resources-docker"><title>Resources Docker</title> + </sect2> + <sect2 id="resources-docker"><title>Resources Docker</title> <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. </para> <para>A resource can also be dropped on the <emphasis>Responsible</emphasis> column. </para> - </sect1> - <sect1 id="allocations-docker"><title>Allocations Docker</title> + </sect2> + <sect2 id="allocations-docker"><title>Allocations Docker</title> <para>The Allocations Docker displays the current resource allocation for the selected task. </para> - </sect1> - <sect1 id="configuration"><title>Configuration</title> + </sect2> + <sect2 id="configuration"><title>Configuration</title> <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. </para> <para> @@ -376,5 +376,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/taskexecutionview.docbook b/doc/taskexecutionview.docbook index 0482e520..762039e9 100644 --- a/doc/taskexecutionview.docbook +++ b/doc/taskexecutionview.docbook @@ -1,5 +1,5 @@ -<chapter id="task-execution-view"><title>Task Execution View</title> - <sect1 id="description25"><title>Description</title> +<sect1 id="task-execution-view"><title>Task Execution View</title> + <sect2 id="description25"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -26,8 +26,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="data"><title>Data</title> + </sect2> + <sect2 id="data"><title>Data</title> <para> <informaltable> <tgroup cols="2"> @@ -149,8 +149,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="configuration26"><title>Configuration</title> + </sect2> + <sect2 id="configuration26"><title>Configuration</title> <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. </para> <para> @@ -179,5 +179,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/taskganttview.docbook b/doc/taskganttview.docbook index 3f5e50cf..0bcf4337 100644 --- a/doc/taskganttview.docbook +++ b/doc/taskganttview.docbook @@ -1,5 +1,5 @@ -<chapter id="task-gantt-view"><title>Task Gantt View</title> - <sect1 id="description27"><title>Description</title> +<sect1 id="task-gantt-view"><title>Task Gantt View</title> + <sect2 id="description27"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -29,8 +29,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data28"><title>Editing data</title> + </sect2> + <sect2 id="editing-data28"><title>Editing data</title> <para>Task description and progress can be edited using the context menu. </para> <para>The following columns are displayed as default: @@ -80,8 +80,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="configuration29"><title>Configuration</title> + </sect2> + <sect2 id="configuration29"><title>Configuration</title> <para> <informaltable> <tgroup cols="2"> @@ -113,5 +113,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/taskperformanceview.docbook b/doc/taskperformanceview.docbook index c9e79aa3..8771cc72 100644 --- a/doc/taskperformanceview.docbook +++ b/doc/taskperformanceview.docbook @@ -1,4 +1,4 @@ -<chapter id="task-performance-view"><title>Task Performance View</title> +<sect1 id="task-performance-view"><title>Task Performance View</title> <para>On the task performance chart, we can analyze deeply each subtask or task with the same indexes as for the project performance view. </para> <para>This is really useful in a long and complicated project. @@ -33,4 +33,4 @@ <listitem><para>CPI is the Cost Performance Index,</para></listitem> <listitem><para>SPI is the Schedule Performance Index.</para></listitem> </itemizedlist> -</chapter> +</sect1> diff --git a/doc/taskstatusview.docbook b/doc/taskstatusview.docbook index b8ff6fe4..f82660e7 100644 --- a/doc/taskstatusview.docbook +++ b/doc/taskstatusview.docbook @@ -1,5 +1,5 @@ -<chapter id="task-status-view"><title>Task Status View</title> - <sect1 id="description22"><title>Description</title> +<sect1 id="task-status-view"><title>Task Status View</title> + <sect2 id="description22"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -67,8 +67,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data23"><title>Editing data</title> + </sect2> + <sect2 id="editing-data23"><title>Editing data</title> <para> <informaltable> <tgroup cols="2"> @@ -190,8 +190,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="configuration24"><title>Configuration</title> + </sect2> + <sect2 id="configuration24"><title>Configuration</title> <para>Using the context menu, the view can be configured to split / unsplit the tree view or it can be configured using the configure dialog. </para> <para> @@ -220,5 +220,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/usingtheviews.docbook b/doc/usingtheviews.docbook index 3cc52d8a..0439d94c 100644 --- a/doc/usingtheviews.docbook +++ b/doc/usingtheviews.docbook @@ -1,6 +1,6 @@ -<chapter id="using-the-views"><title>Using the Views</title> +<sect1 id="using-the-views"><title>Using the Views</title> - <sect1 id="description3"><title>Description</title> + <sect2 id="description3"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -27,8 +27,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="navigation"><title>Navigation</title> + </sect2> + <sect2 id="navigation"><title>Navigation</title> <para>You can navigate the tree structure using the keyboard: </para> <para> @@ -118,8 +118,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data"><title>Editing data</title> + </sect2> + <sect2 id="editing-data"><title>Editing data</title> <para>Editable items are opened for editing by double-clicking on the item or, if using the keyboard, pressing <keycap>F2</keycap> will open the current item. </para> <para>When editing an item you can navigate to the next editable item as follows: @@ -163,5 +163,5 @@ </tgroup> </informaltable> </para> - </sect1> -</chapter> + </sect2> +</sect1> diff --git a/doc/viewsandeditors.docbook b/doc/viewsandeditors.docbook new file mode 100644 index 00000000..7bb0b792 --- /dev/null +++ b/doc/viewsandeditors.docbook @@ -0,0 +1,18 @@ +<chapter id="views-and-editors"><title>Views and Editors</title> + &startup-view-section; + &task-editor-section; + &resource-editor-section; + &work-and-vacation-editor-section; + &cost-breakdown-structure-editor-section; + &task-dependency-editor-graphical-section; + &task-dependency-editor-list-section; + &schedules-editor-section; + &project-performance-view-section; + &task-performance-view-section; + &task-status-view-section; + &task-execution-view-section; + &task-gantt-view-section; + &milestone-gantt-view-section; + &resource-assignment-view-section; + &resource-assignment-gantt-view-section; +</chapter> diff --git a/doc/workandvacationeditor.docbook b/doc/workandvacationeditor.docbook index 4cb22473..bf2ef012 100644 --- a/doc/workandvacationeditor.docbook +++ b/doc/workandvacationeditor.docbook @@ -1,5 +1,5 @@ -<chapter id="work-and-vacation-editor"><title>Work and Vacation Editor</title> - <sect1 id="description10"><title>Description</title> +<sect1 id="work-and-vacation-editor"><title>Work and Vacation Editor</title> + <sect2 id="description10"><title>Description</title> <para> <informaltable> <tgroup cols="2"> @@ -83,8 +83,8 @@ </tgroup> </informaltable> </para> - </sect1> - <sect1 id="editing-data11"><title>Editing data</title> + </sect2> + <sect2 id="editing-data11"><title>Editing data</title> <para>Calendar name and time zone can be edited inline as described <link linkend="using-the-views">here</link>. </para> <para>The state of days and weekdays are edited by selecting the day or days you want to edit and open the context menu. @@ -92,5 +92,5 @@ <para>Selecting <emphasis>Work...</emphasis> opens the Edit Work Intervals Dialog. </para> - </sect1> -</chapter> + </sect2> +</sect1>
