Git commit a347bfa142086c5ca08d84599990a653ad0751d9 by Dag Andersen. Committed on 28/02/2020 at 12:00. Pushed by danders into branch 'master'.
Documentation: Fix some mistakes M +3 -3 doc/creatingodtreporttemplates.docbook M +8 -7 doc/reportsgeneratorview.docbook M +2 -0 doc/resourceassignmentganttview.docbook M +7 -3 doc/resourceassignmentview.docbook https://commits.kde.org/calligraplan/a347bfa142086c5ca08d84599990a653ad0751d9 diff --git a/doc/creatingodtreporttemplates.docbook b/doc/creatingodtreporttemplates.docbook index e9d7c231..5f045a3b 100644 --- a/doc/creatingodtreporttemplates.docbook +++ b/doc/creatingodtreporttemplates.docbook @@ -2,7 +2,7 @@ <sect1 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 field s are defined. + <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> @@ -1229,11 +1229,11 @@ </sect2> </sect1> <sect1 id="chart"><title>Chart</title> - <para>Use by placing a variable with name chartX (X=number) with a value project before the chart that shall be used. + <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: </para> - <para>Variable: <varname>Name: chartX (X=number) Value: project; values=<replaceable>data</replaceable>;</varname> + <para>Variable: <varname>Name: chartX (X=some text) Value: project; values=<replaceable>data</replaceable>;</varname> </para> <para>where <replaceable>data</replaceable> is a comma separated list of values to be include in the chart. </para> diff --git a/doc/reportsgeneratorview.docbook b/doc/reportsgeneratorview.docbook index 019eeacf..ee9324a2 100644 --- a/doc/reportsgeneratorview.docbook +++ b/doc/reportsgeneratorview.docbook @@ -6,7 +6,7 @@ <tbody> <row> <entry> - <para>The Reports Generator View is used to add and generate reports in Open Document Text (odt) format.</para><para>The reports can be based on the supplied report templates, or you can <link linkend="creating-odt-report-templates">write your own templates</link> + <para>The Reports Generator View is used to add and generate reports in Open Document Text (odt) format.</para><para>The reports can be based on the supplied report templates, or you can <link linkend="creating-odt-report-templates">write your own templates</link>. </para> </entry> @@ -28,11 +28,6 @@ </tgroup> </informaltable> </para> - <itemizedlist> - <listitem><para><emphasis>Nothing</emphasis>; use the filename as is</para></listitem> - <listitem><para><emphasis>Number</emphasis>; add a sequence number to the file name</para></listitem> - <listitem><para><emphasis>Date</emphasis>; add the current date to the file name</para></listitem> - </itemizedlist> <para> <informaltable> <tgroup cols="2"> @@ -72,7 +67,13 @@ <para>Add</para> </entry> <entry> - <para>Information that can be added to the report file name to distinguish it from previously generated versions. This can be:</para></entry> + <para>Information that can be added to the report file name to distinguish it from previously generated versions. This can be:</para> + <itemizedlist> + <listitem><para><emphasis>Nothing</emphasis>; use the filename as is</para></listitem> + <listitem><para><emphasis>Number</emphasis>; add a sequence number to the file name</para></listitem> + <listitem><para><emphasis>Date</emphasis>; add the current date to the file name</para></listitem> + </itemizedlist> + </entry> </row> </tbody> </tgroup> diff --git a/doc/resourceassignmentganttview.docbook b/doc/resourceassignmentganttview.docbook index c015c2cd..c33383bb 100644 --- a/doc/resourceassignmentganttview.docbook +++ b/doc/resourceassignmentganttview.docbook @@ -2,6 +2,7 @@ <sect1 id="description37"><title>Description</title> <para>The Resource Assignment Gantt View displays the scheduled task-resource assignments in a Gantt chart. </para> + <!-- <para> <screenshot> <screeninfo></screeninfo> @@ -18,6 +19,7 @@ </mediaobject> </screenshot> </para> + --> </sect1> <sect1 id="data38"><title>Data</title> <para>The following columns are displayed as default: diff --git a/doc/resourceassignmentview.docbook b/doc/resourceassignmentview.docbook index 96434732..b5c92f87 100644 --- a/doc/resourceassignmentview.docbook +++ b/doc/resourceassignmentview.docbook @@ -1,8 +1,11 @@ <chapter id="resource-assignment-view"><title>Resource Assignment View</title> <sect1 id="description33"><title>Description</title> - <para>The Resource Assignment View displays the scheduled task-resource assignments. + <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> </para> <para> + <!-- <screenshot> <screeninfo></screeninfo> <mediaobject> @@ -10,13 +13,14 @@ <imagedata fileref="plan_resourceassignmentview.png" format="PNG"/> </imageobject> <textobject> - <phrase>Gantt View</phrase> + <phrase>Resource assignment table</phrase> </textobject> <caption> - <para>Gantt View</para> + <para>Resource Assignment Table</para> </caption> </mediaobject> </screenshot> + --> </para> </sect1> <sect1 id="data34"><title>Data</title>
