[keurocalc] /: Fix documentation support following the KF5 port

Luigi Toscano null at kde.org
Thu Oct 4 18:24:03 BST 2018


Git commit 6cdea0479e020a1a5c759cea41dbddebbe453632 by Luigi Toscano.
Committed on 04/10/2018 at 13:59.
Pushed by ltoscano into branch 'master'.

Fix documentation support following the KF5 port

- look for KDocTools and enable the doc directory, and
  use the KDocTools macro to compile the documentation;
- apply the last guidelines to the doc:
  * use the native KF5 DTD (otherwise KDELibs4Support is needed);
  * remove the installation section;
  * remove an outdated entity.

M  +2    -0    CMakeLists.txt
M  +1    -1    doc/CMakeLists.txt
M  +1    -47   doc/index.docbook

https://commits.kde.org/keurocalc/6cdea0479e020a1a5c759cea41dbddebbe453632

diff --git a/CMakeLists.txt b/CMakeLists.txt
index e536945..237553c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -23,9 +23,11 @@ find_package(Qt5 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS
 
 find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS
     CoreAddons
+    DocTools
     I18n
     KIO
 )
 
 add_subdirectory( keurocalc )
+add_subdirectory( doc )
 add_subdirectory( curconvd )
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 645bd83..5ec4173 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -1 +1 @@
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR keurocalc)
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR keurocalc)
diff --git a/doc/index.docbook b/doc/index.docbook
index 73029aa..bc9f8da 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,7 +1,6 @@
 <?xml version="1.0" ?>
-<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
   <!ENTITY keurocalc '<application>KEuroCalc</application>'>
-  <!ENTITY kappname "&keurocalc;">
   <!ENTITY % addindex "IGNORE">
   <!ENTITY % English "INCLUDE"><!-- change language only here -->
 ]>
@@ -716,51 +715,6 @@ when &keurocalc; starts.</para>
 
 </chapter>
 
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="getting-keurocalc">
-<title>How to obtain &keurocalc;</title>
-
-<para>
-&keurocalc; is part of the <ulink url="http://extragear.kde.org/">KDE extragear-utils</ulink>
-package. The latest version of &keurocalc; can be downloaded from the
-<ulink url="https://websvn.kde.org/trunk/extragear/utils/">KDE extragear-utils source repository</ulink>.
-</para>
-
-</sect1>
-
-<sect1 id="requirements">
-<title>Requirements</title>
-
-<para>In order to successfully use &keurocalc;, you need &kde; Frameworks 5.</para>
-
-</sect1>
-
-<sect1 id="compilation">
-<title>Compilation and Installation</title>
-
-<para>
-In order to compile and install &keurocalc; on your system, type the
-following in the base directory of the &keurocalc; distribution:
-
-<screen width="40">
-<prompt>%</prompt> <userinput>mkdir build</userinput>
-<prompt>%</prompt> <userinput>cd build</userinput>
-<prompt>%</prompt> <userinput>cmake ..</userinput>
-<prompt>%</prompt> <userinput>make</userinput>
-<prompt>%</prompt> <userinput>make install</userinput>
-</screen>
-</para>
-
-<para>It might be needed to pass a number of variables to <command>cmake</command>
-to inform it about the location of the developer libraries on your system.
-Should you run into problems please report them to &keurocalc;'s authors.</para>
-
-</sect1>
-
-</appendix>
-
 &documentation.index;
 </book>
 <!--



More information about the kde-doc-english mailing list