[office/calligraplan] doc: Documentation: Add start of portfolio docs

Dag Andersen null at kde.org
Thu Jun 9 09:34:47 BST 2022


Git commit cd79f023bed156f0335213edd8519cf1454f8bc2 by Dag Andersen.
Committed on 09/06/2022 at 08:23.
Pushed by danders into branch 'master'.

Documentation: Add start of portfolio docs

M  +1    -0    doc/CMakeLists.txt
A  +2    -0    doc/portfolio/CMakeLists.txt
A  +8    -0    doc/portfolio/contexthelp.docbook
A  +44   -0    doc/portfolio/index.docbook
A  +4    -0    doc/portfolio/introduction.docbook
A  +9    -0    doc/portfolio/portfoliointroduction.docbook

https://invent.kde.org/office/calligraplan/commit/cd79f023bed156f0335213edd8519cf1454f8bc2

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 7d2ef74d..3fe0c873 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -11,4 +11,5 @@ macro_optional_find_package(KF5 ${REQUIRED_KF5_VERSION} QUIET COMPONENTS DocTool
 
 if(KF5_FOUND)
   add_subdirectory(plan)
+  add_subdirectory(portfolio)
 endif()
diff --git a/doc/portfolio/CMakeLists.txt b/doc/portfolio/CMakeLists.txt
new file mode 100644
index 00000000..57196790
--- /dev/null
+++ b/doc/portfolio/CMakeLists.txt
@@ -0,0 +1,2 @@
+
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR calligraplanportfolio)
diff --git a/doc/portfolio/contexthelp.docbook b/doc/portfolio/contexthelp.docbook
new file mode 100644
index 00000000..c6d003af
--- /dev/null
+++ b/doc/portfolio/contexthelp.docbook
@@ -0,0 +1,8 @@
+<sect2><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 keyboard 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>
+</sect2>
diff --git a/doc/portfolio/index.docbook b/doc/portfolio/index.docbook
new file mode 100644
index 00000000..35018c1c
--- /dev/null
+++ b/doc/portfolio/index.docbook
@@ -0,0 +1,44 @@
+<?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 % addindex "IGNORE">
+<!ENTITY % English "INCLUDE"><!-- change language only here -->
+]>
+<book lang="&language;">
+  <bookinfo>
+    <title>The Plan Portfolio Handbook</title>
+    <authorgroup>
+      <author>
+        <personname>
+          <firstname>Dag</firstname><surname>Andersen</surname>
+        </personname>
+      </author>
+      <!-- TRANS:ROLES_OF_TRANSLATORS -->
+    </authorgroup>
+    <legalnotice>&FDLNotice;</legalnotice>
+    <date>2021-12-14</date>
+    <releaseinfo>WIP</releaseinfo>
+    <abstract>
+      <para></para>
+    </abstract>
+    <keywordset>
+      <keyword>KDE</keyword>
+      <keyword>Office</keyword>
+      <keyword>Project Management</keyword>
+    </keywordset>
+  </bookinfo>
+
+  &portfolio-introduction-chapter;
+  
+  <!--userbase-content-->
+  <chapter id="credits">
+    <title>Credits and License</title>
+    <para>
+    </para>
+    <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+    &underFDL;
+  </chapter>
+  &documentation.index;
+</book>
diff --git a/doc/portfolio/introduction.docbook b/doc/portfolio/introduction.docbook
new file mode 100644
index 00000000..f0eb82af
--- /dev/null
+++ b/doc/portfolio/introduction.docbook
@@ -0,0 +1,4 @@
+<sect2><title/>
+<para>Features include:
+</para>
+</sect2>
diff --git a/doc/portfolio/portfoliointroduction.docbook b/doc/portfolio/portfoliointroduction.docbook
new file mode 100644
index 00000000..c674c397
--- /dev/null
+++ b/doc/portfolio/portfoliointroduction.docbook
@@ -0,0 +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;
+  </sect1>
+  <sect1 id="context-help"><title>Context Help</title>
+    &context-help-section;
+  </sect1>
+</chapter>



More information about the kde-doc-english mailing list