[office/calligraplan] doc: Docs: Add application entities and some markup fixes

Dag Andersen null at kde.org
Thu Jun 30 09:25:37 BST 2022


Git commit 888a21c20511f7923d519d5c733375e6db2710db by Dag Andersen.
Committed on 30/06/2022 at 07:47.
Pushed by danders into branch 'master'.

Docs: Add application entities and some markup fixes

M  +8    -4    doc/plan/creatingproject.docbook
M  +3    -0    doc/plan/index.docbook
M  +1    -1    doc/plan/managingresources.docbook
M  +2    -2    doc/plan/taskeditor.docbook
M  +1    -1    doc/portfolio/introduction.docbook
M  +1    -1    doc/portfolio/portfoliointroduction.docbook

https://invent.kde.org/office/calligraplan/commit/888a21c20511f7923d519d5c733375e6db2710db

diff --git a/doc/plan/creatingproject.docbook b/doc/plan/creatingproject.docbook
index 0ad2573a..e0a9dbf4 100644
--- a/doc/plan/creatingproject.docbook
+++ b/doc/plan/creatingproject.docbook
@@ -1,13 +1,17 @@
 <sect2><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>A new project can be created by pressing the <guibutton>New Project</guibutton> 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 <xref linkend="configure-plan-dialog" xrefstyle="select:title"/>  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>.
+<para>This will create a new project with default values defined in <xref linkend="configure-plan-dialog" xrefstyle="select:title"/>
+    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>.
 </para>
-<para>When you create your first project, consider creating resources in a separate file. When you refer to this file in your project(s), you do not need to define your resources again, and you can coordinate resource usage across projects.
+<para>When you create your first project, consider creating resources in a separate file.
+    When you refer to this file in your project(s), you do not need to define your resources again, and you can coordinate resource usage across projects.
 </para>
 <para>See <xref linkend="managing-resources" xrefstyle="select:title"/>.
 </para>
-<para>To coordinate resource usage across projects you can use the Portfolio Manager.
+<para>To coordinate resource usage across projects you can use the &portfolio;.
 </para>
 <para>A useful structure could be something like this:
 </para>
diff --git a/doc/plan/index.docbook b/doc/plan/index.docbook
index 1bbccd5e..b7db5ea9 100644
--- a/doc/plan/index.docbook
+++ b/doc/plan/index.docbook
@@ -1,5 +1,8 @@
 <?xml version="1.0" ?>
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
+<!ENTITY plan "<application>Plan</application>">
+<!ENTITY portfolio "<application>Plan Portfolio Manager</application>">
+<!ENTITY work "<application>Plan Work</application>">
 <!ENTITY plan-introduction-chapter SYSTEM "planintroduction.docbook">
 <!ENTITY guidelines-chapter SYSTEM "guidelines.docbook">
 <!ENTITY common-user-interface-chapter SYSTEM "commonuserinterface.docbook">
diff --git a/doc/plan/managingresources.docbook b/doc/plan/managingresources.docbook
index c594b017..c37911e7 100644
--- a/doc/plan/managingresources.docbook
+++ b/doc/plan/managingresources.docbook
@@ -1,7 +1,7 @@
 <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.
+  <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.
   </para>
   <para>If you are managing projects that use totally different resource pools you can create multiple resource files, but one project can only refer to one resource file.
   </para>
diff --git a/doc/plan/taskeditor.docbook b/doc/plan/taskeditor.docbook
index 7b1dc27a..0ff7abf8 100644
--- a/doc/plan/taskeditor.docbook
+++ b/doc/plan/taskeditor.docbook
@@ -313,7 +313,7 @@
   </para>
   <para>A task module is inserted into your project by dragging it from the docker and dropping it into your project.
   </para>
-  <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.
+  <para>A task module is a regular plan file, and is designed using &plan; in the same way as designing a regular project.
   </para>
   <para>A task module, however, typically includes only tasks, estimates, and dependencies.
   </para>
@@ -323,7 +323,7 @@
   </para>
   <para>The modules can be grouped by storing them in different directories. Where to search for them is configured using the Project Settings Dialog.
   </para>
-  <para>Default values for new projects can be defined using the Plan Configuration Dialog.
+  <para>Default values for new projects can be defined using the configuration dialog, see <xref linkend="configure-plan-dialog" xrefstyle="select:title"/>.
   </para>
 </sect3>
 <sect3 id="resources-docker"><title>Resources Docker</title>
diff --git a/doc/portfolio/introduction.docbook b/doc/portfolio/introduction.docbook
index 24328537..930fe6dc 100644
--- a/doc/portfolio/introduction.docbook
+++ b/doc/portfolio/introduction.docbook
@@ -1,6 +1,6 @@
 <sect2><title/>
   &WORK-IN-PROGRESS;
-<para>The Portfolio Manager lets you manage multiple projects from a single application.
+<para>The &portfolio; lets you manage multiple projects from a single application.
 </para>
 <para>Two use cases:
 <itemizedlist>
diff --git a/doc/portfolio/portfoliointroduction.docbook b/doc/portfolio/portfoliointroduction.docbook
index 84bf5fdf..c6eaaa90 100644
--- a/doc/portfolio/portfoliointroduction.docbook
+++ b/doc/portfolio/portfoliointroduction.docbook
@@ -1,5 +1,5 @@
 <!-- Note: Set id of chapter to the id the first section should have had -->
-<chapter id="introduction-chapter"><title>Introduction to Plan Portfolio</title>
+<chapter id="introduction-chapter"><title>Introduction to &portfolio;</title>
   <sect1 id="introduction"><title>Introduction</title>
     &introduction;
   </sect1>



More information about the kde-doc-english mailing list