Git commit 7e5c49f51e97268715b1b3abf27419d685d1ecff by Dag Andersen. Committed on 09/06/2022 at 08:23. Pushed by danders into branch 'master'.
Doc: Improve documentation A +9 -0 doc/plan/costbreakdownview.docbook M +7 -1 doc/plan/index.docbook A +26 -0 doc/plan/planconfiguration.docbook M +3 -0 doc/plan/viewsandeditors.docbook A +19 -0 doc/portfolio/contenteditor.docbook M +1 -0 doc/portfolio/contexthelp.docbook M +7 -0 doc/portfolio/index.docbook M +1 -0 doc/portfolio/introduction.docbook A +5 -0 doc/portfolio/portfolioconfiguration.docbook https://invent.kde.org/office/calligraplan/commit/7e5c49f51e97268715b1b3abf27419d685d1ecff diff --git a/doc/plan/costbreakdownview.docbook b/doc/plan/costbreakdownview.docbook new file mode 100644 index 00000000..3c13b18a --- /dev/null +++ b/doc/plan/costbreakdownview.docbook @@ -0,0 +1,9 @@ +<sect2><title/> + &WIP; + <para> + [Work In Progress, Do Not Translate!] + </para> + <para> + The Cost Breakdown View lets you inspect planned cost pr day as well as agregated. + </para> +</sect2> diff --git a/doc/plan/index.docbook b/doc/plan/index.docbook index 490501b2..1bbccd5e 100644 --- a/doc/plan/index.docbook +++ b/doc/plan/index.docbook @@ -30,8 +30,13 @@ <!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 cost-breakdown-view-section SYSTEM "costbreakdownview.docbook"> +<!ENTITY plan-configuration-chapter SYSTEM "planconfiguration.docbook"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"><!-- change language only here --> + +<!ENTITY WIP "<para>WIP: Work In Progress. Do not translate!</para>"> + ]> <book lang="&language;"> <bookinfo> @@ -59,7 +64,8 @@ &guidelines-chapter; &views-and-editors-chapter; &reports-chapter; - + &plan-configuration-chapter; + <!--userbase-content--> <chapter id="credits"> <title>Credits and License</title> diff --git a/doc/plan/planconfiguration.docbook b/doc/plan/planconfiguration.docbook new file mode 100644 index 00000000..a88add3e --- /dev/null +++ b/doc/plan/planconfiguration.docbook @@ -0,0 +1,26 @@ +<chapter id="configure-plan-dialog"><title>Configuring Plan</title> + <sect1 id="configure-project-defaults"><title>Project Defaults</title> + &WIP; + </sect1> + <sect1 id="configure-work-and-vacation"><title>Work and Vacation</title> + &WIP; + </sect1> + <sect1 id="configure-task-defaults"><title>Task Defaults</title> + &WIP; + </sect1> + <sect1 id="configure-task-colors"><title>Task Colors</title> + &WIP; + </sect1> + <sect1 id="configure-task-modules"><title>Task Modules</title> + &WIP; + </sect1> + <sect1 id="configure-work-package"><title>Work Package</title> + &WIP; + </sect1> + <sect1 id="configure-project-templates"><title>Project Templates</title> + &WIP; + </sect1> + <sect1 id="configure-document"><title>Document</title> + &WIP; + </sect1> +</chapter> diff --git a/doc/plan/viewsandeditors.docbook b/doc/plan/viewsandeditors.docbook index ed78ba94..615305b8 100644 --- a/doc/plan/viewsandeditors.docbook +++ b/doc/plan/viewsandeditors.docbook @@ -47,4 +47,7 @@ <sect1 id="resource-assignment-view"><title>Resource Assignment View</title> &resource-assignment-view-section; </sect1> + <sect1 id="cost-breakdown-view"><title>Cost Breakdown View</title> + &cost-breakdown-view-section; + </sect1> </chapter> diff --git a/doc/portfolio/contenteditor.docbook b/doc/portfolio/contenteditor.docbook new file mode 100644 index 00000000..c57e8788 --- /dev/null +++ b/doc/portfolio/contenteditor.docbook @@ -0,0 +1,19 @@ +<chapter id="content-editor"><title>Portfolio Content Editor</title> + &WIP; + <para> + This editor enables you to configure the content of your portfolio. + </para><para> + Select <interface>Edit|Add</interface> or press <interface>Add...</interface> to add projects to your portfolio. + Select <interface>Edit|Remove</interface> or press <interface>Remove</interface> to remove selected projects. + </para><para> + Add the projects you are managing and set Portfolio = Yes. + If you have resources that is shared between multiple projects and you want to re-schedule, you need to add all relevant projects + and then set Portfolio = No. + </para><para> + Project changes can be stored to the original project file or it can be embedded into the portfolio file. + If you are managing projects, they should normally be saved to their original files. Set Store = External in this case. + However, if you just want to see what impact changes might have, you may want to store projects + embedded while you are working on different scenarios. Set Store = Embedded in this case. + The projects external url is preserved if you later want to save the changes. + </para> +</chapter> diff --git a/doc/portfolio/contexthelp.docbook b/doc/portfolio/contexthelp.docbook index c6d003af..661ac7f4 100644 --- a/doc/portfolio/contexthelp.docbook +++ b/doc/portfolio/contexthelp.docbook @@ -1,4 +1,5 @@ <sect2><title/> + &WIP; <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 keyboard shortcut <keycombo>&Shift;<keycap>F1</keycap></keycombo>. diff --git a/doc/portfolio/index.docbook b/doc/portfolio/index.docbook index 35018c1c..368d4d91 100644 --- a/doc/portfolio/index.docbook +++ b/doc/portfolio/index.docbook @@ -3,8 +3,13 @@ <!ENTITY portfolio-introduction-chapter SYSTEM "portfoliointroduction.docbook"> <!ENTITY introduction-section SYSTEM "introduction.docbook"> <!ENTITY context-help-section SYSTEM "contexthelp.docbook"> +<!ENTITY content-editor-chapter SYSTEM "contenteditor.docbook"> +<!ENTITY portfolio-configuration-dialog SYSTEM "portfolioconfiguration.docbook"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"><!-- change language only here --> + +<!ENTITY WIP "<para>WIP: Work In Progress. Do not translate!</para>"> + ]> <book lang="&language;"> <bookinfo> @@ -31,6 +36,8 @@ </bookinfo> &portfolio-introduction-chapter; + &content-editor-chapter; + &portfolio-configuration-dialog; <!--userbase-content--> <chapter id="credits"> diff --git a/doc/portfolio/introduction.docbook b/doc/portfolio/introduction.docbook index f0eb82af..ae4e9fb0 100644 --- a/doc/portfolio/introduction.docbook +++ b/doc/portfolio/introduction.docbook @@ -1,4 +1,5 @@ <sect2><title/> + &WIP; <para>Features include: </para> </sect2> diff --git a/doc/portfolio/portfolioconfiguration.docbook b/doc/portfolio/portfolioconfiguration.docbook new file mode 100644 index 00000000..e9ef184a --- /dev/null +++ b/doc/portfolio/portfolioconfiguration.docbook @@ -0,0 +1,5 @@ +<chapter id="configure-portfolio-dialog"><title>Configuring Portfolio</title> + <sect1 id="configure-document"><title>Document</title> + &WIP; + </sect1> +</chapter>
