[office/calligraplan] /: WIP: Documentation/whatsthis
Dag Andersen
null at kde.org
Thu Jun 30 09:25:36 BST 2022
Git commit 1e1f6f094ef4e395884ef8a6e2b165afec9bb554 by Dag Andersen.
Committed on 30/06/2022 at 07:47.
Pushed by danders into branch 'master'.
WIP: Documentation/whatsthis
M +13 -8 doc/portfolio/contenteditor.docbook
M +5 -1 doc/portfolio/ganttsummaryview.docbook
M +19 -19 doc/portfolio/index.docbook
M +3 -1 doc/portfolio/performanceview.docbook
M +4 -4 doc/portfolio/portfoliointroduction.docbook
M +214 -2 doc/portfolio/progressview.docbook
A +- -- doc/portfolio/progressview.png
A +- -- doc/portfolio/progressview_config.png
M +5 -1 doc/portfolio/resourceusageview.docbook
M +62 -2 doc/portfolio/schedulingview.docbook
M +10 -8 doc/portfolio/summaryview.docbook
A +- -- doc/portfolio/taskprogressdialog.png
M +11 -0 src/portfolio/GanttView.cpp
M +6 -4 src/portfolio/PortfolioView.cpp
M +19 -0 src/portfolio/ProgressView.cpp
M +9 -0 src/portfolio/ResourceUsageView.cpp
M +14 -0 src/portfolio/SchedulingView.cpp
M +1 -1 src/portfolio/SummaryView.cpp
https://invent.kde.org/office/calligraplan/commit/1e1f6f094ef4e395884ef8a6e2b165afec9bb554
diff --git a/doc/portfolio/contenteditor.docbook b/doc/portfolio/contenteditor.docbook
index 632bace3..fbb98637 100644
--- a/doc/portfolio/contenteditor.docbook
+++ b/doc/portfolio/contenteditor.docbook
@@ -1,4 +1,4 @@
-<chapter id="content-editor"><title>Portfolio Content Editor</title>
+<chapter id="content-editor"><title>Portfolio Content</title>
&WORK-IN-PROGRESS;
<para>
This editor enables you to configure the content of your portfolio.
@@ -6,14 +6,19 @@
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.
+ Add the projects you are managing and set <emphasis>Portfolio</emphasis> = <emphasis>Yes</emphasis>.
</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.
+ If you have resources that is used by projects not part of your portfolio and you want to re-schedule or inspect resource usage,
+ you need to add all relevant projects and set <emphasis>Portfolio</emphasis> = <emphasis>No</emphasis> for these projects.
+ </para>
+ <formalpara><title>Storage</title>
+ <para></para>
+ </formalpara>
+ <para>
+ Project changes can be saved 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 <emphasis>Store</emphasis> = <emphasis>External</emphasis> 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.
+ embedded while you are working on different scenarios. Set <emphasis>Store</emphasis> = <emphasis>Embedded</emphasis> in this case.
+ The projects external url is preserved if you later want to save the changes to the original file.
</para>
</chapter>
diff --git a/doc/portfolio/ganttsummaryview.docbook b/doc/portfolio/ganttsummaryview.docbook
index 60d384bc..da263344 100644
--- a/doc/portfolio/ganttsummaryview.docbook
+++ b/doc/portfolio/ganttsummaryview.docbook
@@ -1,6 +1,10 @@
-<chapter id="ganttsummary-view"><title>Gantt Summary</title>
+<chapter id="ganttsummary"><title>Gantt Summary</title>
+<sect1 id="description"><title>Description</title>
&WORK-IN-PROGRESS;
<para>
Shows a gantt chart of all projects in your portfolio.
+ </para><para>
+ A gantt view for a project can be shown by selecting <userinput>Context Menu->Open Project</userinput>.
</para>
+</sect1>
</chapter>
diff --git a/doc/portfolio/index.docbook b/doc/portfolio/index.docbook
index e15175ac..acb8995f 100644
--- a/doc/portfolio/index.docbook
+++ b/doc/portfolio/index.docbook
@@ -1,15 +1,15 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
-<!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 scheduling-view-chapter SYSTEM "schedulingview.docbook">
-<!ENTITY summary-view-chapter SYSTEM "summaryview.docbook">
-<!ENTITY performance-view-chapter SYSTEM "performanceview.docbook">
-<!ENTITY progress-view-chapter SYSTEM "progressview.docbook">
-<!ENTITY resourceusage-view-chapter SYSTEM "resourceusageview.docbook">
-<!ENTITY ganttsummary-view-chapter SYSTEM "ganttsummaryview.docbook">
+<!ENTITY introduction-chapter SYSTEM "portfoliointroduction.docbook">
+<!ENTITY introduction SYSTEM "introduction.docbook">
+<!ENTITY context-help SYSTEM "contexthelp.docbook">
+<!ENTITY content-editor SYSTEM "contenteditor.docbook">
+<!ENTITY scheduling SYSTEM "schedulingview.docbook">
+<!ENTITY summary SYSTEM "summaryview.docbook">
+<!ENTITY performance SYSTEM "performanceview.docbook">
+<!ENTITY progress SYSTEM "progressview.docbook">
+<!ENTITY resourceusage SYSTEM "resourceusageview.docbook">
+<!ENTITY ganttsummary SYSTEM "ganttsummaryview.docbook">
<!ENTITY portfolio-configuration-dialog SYSTEM "portfolioconfiguration.docbook">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
@@ -41,16 +41,16 @@
</keywordset>
</bookinfo>
- &portfolio-introduction-chapter;
- &content-editor-chapter;
- &scheduling-view-chapter;
- &summary-view-chapter;
- &progress-view-chapter;
- &performance-view-chapter;
- &resourceusage-view-chapter;
- &ganttsummary-view-chapter;
+ &introduction-chapter;
+ &content-editor;
+ &scheduling;
+ &summary;
+ &progress;
+ &performance;
+ &resourceusage;
+ &ganttsummary;
&portfolio-configuration-dialog;
-
+
<!--userbase-content-->
<chapter id="credits">
<title>Credits and License</title>
diff --git a/doc/portfolio/performanceview.docbook b/doc/portfolio/performanceview.docbook
index d33c5925..50c66381 100644
--- a/doc/portfolio/performanceview.docbook
+++ b/doc/portfolio/performanceview.docbook
@@ -1,6 +1,8 @@
-<chapter id="perfomance-view"><title>Performance</title>
+<chapter id="perfomance"><title>Performance</title>
+<sect1 id="perfomance-description"><title>Description</title>
&WORK-IN-PROGRESS;
<para>
Shows charts of the performance of selected project.
</para>
+</sect1>
</chapter>
diff --git a/doc/portfolio/portfoliointroduction.docbook b/doc/portfolio/portfoliointroduction.docbook
index c674c397..84bf5fdf 100644
--- a/doc/portfolio/portfoliointroduction.docbook
+++ b/doc/portfolio/portfoliointroduction.docbook
@@ -1,9 +1,9 @@
<!-- Note: Set id of chapter to the id the first section should have had -->
-<chapter id="introduction"><title>Introduction to Plan Portfolio</title>
- <sect1 id="introduction-section"><title>Introduction</title>
- &introduction-section;
+<chapter id="introduction-chapter"><title>Introduction to Plan Portfolio</title>
+ <sect1 id="introduction"><title>Introduction</title>
+ &introduction;
</sect1>
<sect1 id="context-help"><title>Context Help</title>
- &context-help-section;
+ &context-help;
</sect1>
</chapter>
diff --git a/doc/portfolio/progressview.docbook b/doc/portfolio/progressview.docbook
index 6e6e8cb5..ea441947 100644
--- a/doc/portfolio/progressview.docbook
+++ b/doc/portfolio/progressview.docbook
@@ -1,6 +1,218 @@
-<chapter id="progress-view"><title>Progress</title>
+<chapter id="progress"><title>Progress</title>
+<sect1 id="progress-description"><title>Description</title>
&WORK-IN-PROGRESS;
<para>
- Shows the status of tasks in the selected project and enables you to edit progress.
+ The progress view lists the projects in your portfolio on the left
+ and shows progress information for the selected project on the right.
</para>
+ <para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="progressview.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase></phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>The tasks are divided into groups dependent on the status of the task:
+ </para>
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>
+ <para>Not Started</para>
+ </entry>
+ <entry>
+ <para>Tasks that should have been started by now.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Running</para>
+ </entry>
+ <entry>
+ <para>Tasks that have been started, but not yet finished.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Finished</para>
+ </entry>
+ <entry>
+ <para>Tasks that were finished in this period</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Next Period</para>
+ </entry>
+ <entry>
+ <para>Tasks that are scheduled to be started in the next period.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+</sect1>
+<sect1 id="progress-editing-data"><title>Editing data</title>
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>
+ <para>Progress information can be edited in-line or by using the task progress dialog.</para>
+ </entry>
+ <entry>
+ <para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="taskprogressdialog.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase></phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot></para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ <para>The following columns are displayed as default:
+ </para>
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry><guilabel>Column</guilabel></entry>
+ <entry><guilabel>Description</guilabel></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>Name</para>
+ </entry>
+ <entry>
+ <para>The name of the task.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Status</para>
+ </entry>
+ <entry>
+ <para>Task status</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>% Completion</para>
+ </entry>
+ <entry>
+ <para>Task completion</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Planned Effort</para>
+ </entry>
+ <entry>
+ <para>The amount of work planned to be used at the end of the current period.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Actual Effort</para>
+ </entry>
+ <entry>
+ <para>The amount of work spent.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Remaining Effort</para>
+ </entry>
+ <entry>
+ <para>The remaining effort needed to complete the task.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Planned Cost</para>
+ </entry>
+ <entry>
+ <para>The planned cost at the end of the current period.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Actual Cost</para>
+ </entry>
+ <entry>
+ <para>The actual cost incurred.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Actual Start</para>
+ </entry>
+ <entry>
+ <para>The actual start time of the task.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Actual Finish</para>
+ </entry>
+ <entry>
+ <para>The actual finish time of the task.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+</sect1>
+<sect1 id="progress-configuration"><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>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>
+ <para>The configure dialog enables you to tailor the amount of information the view displays to fit your needs.</para>
+ </entry>
+ <entry>
+ <para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="progressview_config.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase></phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+</sect1>
</chapter>
diff --git a/doc/portfolio/progressview.png b/doc/portfolio/progressview.png
new file mode 100644
index 00000000..025011e5
Binary files /dev/null and b/doc/portfolio/progressview.png differ
diff --git a/doc/portfolio/progressview_config.png b/doc/portfolio/progressview_config.png
new file mode 100644
index 00000000..16c56726
Binary files /dev/null and b/doc/portfolio/progressview_config.png differ
diff --git a/doc/portfolio/resourceusageview.docbook b/doc/portfolio/resourceusageview.docbook
index 3c6c6018..9a58dea7 100644
--- a/doc/portfolio/resourceusageview.docbook
+++ b/doc/portfolio/resourceusageview.docbook
@@ -1,6 +1,10 @@
-<chapter id="resourceusage-view"><title>Resource Usage</title>
+<chapter id="resourceusage"><title>Resource Usage</title>
+<sect1 id="resourceusage-description"><title>Description</title>
+
&WORK-IN-PROGRESS;
<para>
Shows a chart of the load planned for selected resource color coded per task.
+
</para>
+</sect1>
</chapter>
diff --git a/doc/portfolio/schedulingview.docbook b/doc/portfolio/schedulingview.docbook
index 6a5a007b..d5890724 100644
--- a/doc/portfolio/schedulingview.docbook
+++ b/doc/portfolio/schedulingview.docbook
@@ -1,6 +1,66 @@
-<chapter id="scheduling-view"><title>Scheduling</title>
+<chapter id="scheduling"><title>Scheduling</title>
+<sect1 id="scheduling-description"><title>Description</title>
+
&WORK-IN-PROGRESS;
<para>
- Schedule projects.
+ The Scheduling view lets you schedule the projects in your portfolio. The projects are scheduled according to their priority.
+ </para><para>
+ Set <emphasis>Control</emphasis> to <emphasis>Schedule</emphasis> for the project or projects you want to schedule.
+ Set <emphasis>Control</emphasis> to <emphasis>Include</emphasis> to have resource assignments included in resource leveling.
+ Set <emphasis>Control</emphasis> to <emphasis>Exclude</emphasis> if you want to exclude the project.
</para>
+ <tip><para>
+ If your projects share resources with projects that are not part of your portfolio,
+ these projects needs to be included for resource leveling to work properly.
+ See <xref linkend="content-editor"/>.
+ </para></tip>
+ <para>
+ </para><para>
+ The view has tree sections:
+ <itemizedlist>
+ <listitem><para><xref linkend="scheduling-projecttable" xrefstyle="select:title"/>.</para></listitem>
+ <listitem><para><xref linkend="scheduling-control" xrefstyle="select:title"/>.</para></listitem>
+ <listitem><para><xref linkend="scheduling-log" xrefstyle="select:title"/>.</para></listitem>
+ </itemizedlist>
+ </para>
+</sect1>
+<sect1 id="scheduling-projecttable"><title>Table of Projects</title>
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead><row>
+ <entry><guilabel>Name</guilabel></entry>
+ <entry><guilabel>Description</guilabel></entry>
+ </row></thead>
+ <tbody>
+ <row><entry>Name</entry><entry>Project name</entry></row>
+ <row><entry>Schedule</entry><entry>Schedule name</entry></row>
+ <row><entry>Status</entry><entry>Scheduling status</entry></row>
+ <row><entry>Control</entry>
+ <entry>
+ Scheduling control can have the following values:
+ <itemizedlist>
+ <listitem><para><emphasis>Schedule:</emphasis> The project will be scheduled.</para></listitem>
+ <listitem><para><emphasis>Include:</emphasis> Resource bookings will be included in resource levelling.</para></listitem>
+ <listitem><para><emphasis>Exclude:</emphasis> The project will not be included.</para></listitem>
+ </itemizedlist>
+ </entry>
+ </row>
+ <row><entry>Priority</entry><entry>Project priority. A higer number means higher priority.</entry></row>
+ <row><entry>Target Start</entry><entry>The earliest project start time</entry></row>
+ <row><entry>Target End</entry><entry>The latest project finish time</entry></row>
+ <row><entry>Description</entry><entry>Project description</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+</sect1>
+<sect1 id="scheduling-control"><title>Scheduling Control</title>
+ <para>
+ </para>
+</sect1>
+<sect1 id="scheduling-log"><title>Scheduling Log</title>
+ <para>
+ </para>
+</sect1>
</chapter>
diff --git a/doc/portfolio/summaryview.docbook b/doc/portfolio/summaryview.docbook
index 1b9d6c86..b59f22e8 100644
--- a/doc/portfolio/summaryview.docbook
+++ b/doc/portfolio/summaryview.docbook
@@ -1,16 +1,13 @@
-<chapter id="summary-view"><title>Summary</title>
+<chapter id="summary"><title>Summary</title>
&WORK-IN-PROGRESS;
<para>
- Summarizes performance data for all projects in your portfolio.
+ This view summarizes performance data for the projects in your portfolio.
</para><para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
+ <informaltable><tgroup cols="2">
+ <thead><row>
<entry><guilabel>Name</guilabel></entry>
<entry><guilabel>Description</guilabel></entry>
- </row>
- </thead>
+ </row></thead>
<tbody>
<row><entry>Name</entry><entry>Project name</entry></row>
<row><entry>Schedule</entry><entry>Schedule name</entry></row>
@@ -21,5 +18,10 @@
</tbody>
</tgroup>
</informaltable>
+ </para><para>
+ SPI indicates if the progress is on schedule (1), behind schedule (less than 1) or ahead of schedule (greater than 1).
+ CPI indicates how much it has cost to obtain the actual progress. A value of 1 means as planned,
+ less than 1 means it has cost more than it should have done and a value greater than 1 means that
+ the progress has bean obtained with less resource usage than planned.
</para>
</chapter>
diff --git a/doc/portfolio/taskprogressdialog.png b/doc/portfolio/taskprogressdialog.png
new file mode 100644
index 00000000..c3de5be1
Binary files /dev/null and b/doc/portfolio/taskprogressdialog.png differ
diff --git a/src/portfolio/GanttView.cpp b/src/portfolio/GanttView.cpp
index 0c252617..5a03eb95 100644
--- a/src/portfolio/GanttView.cpp
+++ b/src/portfolio/GanttView.cpp
@@ -77,6 +77,17 @@ GanttView::GanttView(KoPart *part, KoDocument *doc, QWidget *parent)
tv->setContextMenuPolicy(Qt::CustomContextMenu);
connect(tv, &QTreeView::customContextMenuRequested, this, &GanttView::slotCustomContextMenuRequested);
+
+ setWhatsThis(xi18nc("@info:whatsthis",
+ "<title>Gantt Summary</title>"
+ "<para>"
+ "Shows a gantt chart of all projects in your portfolio."
+ "</para><para>"
+ "A gantt view for a project can be shown by selecting <interface>Context Menu->Open Project</interface>."
+ "<nl/><link url='%1'>More...</link>"
+ "</para>", QStringLiteral("portfolio:ganttsummary")
+ ));
+
}
GanttView::~GanttView()
diff --git a/src/portfolio/PortfolioView.cpp b/src/portfolio/PortfolioView.cpp
index 0b2c9efb..a413a02a 100644
--- a/src/portfolio/PortfolioView.cpp
+++ b/src/portfolio/PortfolioView.cpp
@@ -139,10 +139,12 @@ PortfolioView::PortfolioView(KoPart *part, KoDocument *doc, QWidget *parent)
"Select <interface>Edit|Add</interface> or press <interface>Add...</interface> to add projects to your portfolio.<nl/>"
"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 for these projects."
- "<nl/><link url='%1'>More...</link>"
+ "Add the projects you are managing and set <emphasis>Portfolio</emphasis> = <emphasis>Yes</emphasis>."
+ "</para><para>"
+ "<note>If you have resources that are shared between multiple projects and you want to re-schedule or inspect resource usage, you need to add all relevant projects"
+ " and then set <emphasis>Portfolio</emphasis> = <emphasis>No</emphasis> for these projects.</note>"
+ "</para><para>"
+ "<link url='%1'>More...</link>"
"</para>", QStringLiteral("portfolio:content-editor")
)
);
diff --git a/src/portfolio/ProgressView.cpp b/src/portfolio/ProgressView.cpp
index fb39cbb0..dc392eb0 100644
--- a/src/portfolio/ProgressView.cpp
+++ b/src/portfolio/ProgressView.cpp
@@ -58,11 +58,30 @@ ProgressView::ProgressView(KoPart *part, KoDocument *doc, QWidget *parent)
<< KPlato::NodeModel::NodeDescription;
m_detailsView->showColumns(show);
m_detailsView->setViewSplitMode(false);
+ m_detailsView->setWhatsThis(QLatin1String()); // remove default text
insertChildClient(m_detailsView);
connect(m_view->selectionModel(), &QItemSelectionModel::selectionChanged, this, &ProgressView::selectionChanged);
sp->setStretchFactor(1, 10);
+
+ setWhatsThis(xi18nc("@info:whatsthis",
+ "<title>Progress</title>"
+ "<para>"
+ "This view is used to inspect and edit task progress information for the selected project."
+ "<nl/>The tasks are divided into groups dependent on the task status:"
+ "<list>"
+ "<item><emphasis>Not Started:</emphasis> Tasks that should have been started by now.</item>"
+ "<item><emphasis>Running:</emphasis> Tasks that has been started, but not yet finished.</item>"
+ "<item><emphasis>Finished:</emphasis> Tasks that where finished in this period.</item>"
+ "<item><emphasis>Next Period:</emphasis> Tasks that is scheduled to be started in the next period.</item>"
+ "</list>"
+ "The time period is configurable."
+ "</para><para>"
+ "This view supports configuration and printing using the context menu."
+ "<nl/><link url='%1'>More...</link>"
+ "</para>", QStringLiteral("portfolio:progress")
+ ));
}
ProgressView::~ProgressView()
diff --git a/src/portfolio/ResourceUsageView.cpp b/src/portfolio/ResourceUsageView.cpp
index 8c7b4f27..2ba83d6d 100644
--- a/src/portfolio/ResourceUsageView.cpp
+++ b/src/portfolio/ResourceUsageView.cpp
@@ -11,6 +11,7 @@
#include "MainDocument.h"
#include <KoIcon.h>
+#include <Help.h>
#include <ScrollableChart.h>
@@ -87,6 +88,14 @@ ResourceUsageView::ResourceUsageView(KoPart *part, KoDocument *doc, QWidget *par
// turn off waitcursor
QTimer::singleShot(0, this, &ResourceUsageView::slotDrawingFinished);
+
+ setWhatsThis(xi18nc("@info:whatsthis",
+ "<title>Resource Usage</title>"
+ "<para>"
+ "This view shows the resources task assignments for each day."
+ "</para><para>"
+ "<nl/><link url='%1'>More...</link>"
+ "</para>", QStringLiteral("portfolio:resourceusage")));
}
ResourceUsageView::~ResourceUsageView()
diff --git a/src/portfolio/SchedulingView.cpp b/src/portfolio/SchedulingView.cpp
index 249373c2..a670d0da 100644
--- a/src/portfolio/SchedulingView.cpp
+++ b/src/portfolio/SchedulingView.cpp
@@ -105,6 +105,20 @@ SchedulingView::SchedulingView(KoPart *part, KoDocument *doc, QWidget *parent)
connect(ui.tomorrowRB, &QRadioButton::toggled, this, &SchedulingView::slotTomorrowToggled);
connect(ui.timeRB, &QRadioButton::toggled, this, &SchedulingView::slotTimeToggled);
connect(ui.calculate, &QPushButton::clicked, this, &SchedulingView::calculate);
+
+ setWhatsThis(xi18nc("@info:whatsthis",
+ "<title>Scheduling</title>"
+ "<para>"
+ "The Scheduling view lets you schedule the projects in your portfolio. The projects are scheduled according to their priority."
+ "</para><para>"
+ "Set <emphasis>Control</emphasis> to <emphasis>Schedule</emphasis> for the project or projects you want to schedule."
+ "<nl/>Set <emphasis>Control</emphasis> to <emphasis>Include</emphasis> to have resource assignments included in resource leveling."
+ "<nl/>Set <emphasis>Control</emphasis> to <emphasis>Exclude</emphasis> if you want to exclude the project."
+ "</para><para>"
+ "<note>If your projects share resources with projects that are not part of your portfolio, these projects needs to be included for resource leveling to work properly.</note>"
+ "</para><para>"
+ "<link url='%1'>More...</link>"
+ "</para>", QStringLiteral("portfolio:scheduling")));
}
SchedulingView::~SchedulingView()
diff --git a/src/portfolio/SummaryView.cpp b/src/portfolio/SummaryView.cpp
index 2f925705..52b1e725 100644
--- a/src/portfolio/SummaryView.cpp
+++ b/src/portfolio/SummaryView.cpp
@@ -83,7 +83,7 @@ SummaryView::SummaryView(KoPart *part, KoDocument *doc, QWidget *parent)
"Performance indexes are shown for both cost based and effort based calculations."
"</para><para>"
"<nl/><link url='%1'>More...</link>"
- "</para>", QStringLiteral("portfolio:summary-view")
+ "</para>", QStringLiteral("portfolio:summary")
)
);
}
More information about the kde-doc-english
mailing list