summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuigi Toscano <luigi.toscano@tiscali.it>2015-09-27 16:25:37 (GMT)
committerLuigi Toscano <luigi.toscano@tiscali.it>2015-09-27 16:25:37 (GMT)
commite675c836f141b82bb0d6ef6ef02e824dcc6597f8 (patch)
tree3033f0b6a6d902ae933300572677529bf25d4788
parent6bc3ede380de6cf2977528765f62d5d4e267c43c (diff)
Basic updates for documentation (doc and man)
- requires KDocTools; - use the new DTDs; - basic changes according the new guidelines: update release info/product, remove installation instructions; - remove now useless 'package' entity; - cleanup man page options; - small wording change ('KDE' usage).
-rw-r--r--CMakeLists.txt1
-rw-r--r--doc/index.docbook20
-rw-r--r--doc/man-ktouch.1.docbook15
3 files changed, 12 insertions, 24 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 8001fd1..7456cf0 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -34,6 +34,7 @@ find_package(KF5 REQUIRED COMPONENTS
ConfigWidgets
CoreAddons
Declarative
+ DocTools
I18n
KIO
NewStuff
diff --git a/doc/index.docbook b/doc/index.docbook
index 3fc31c0..2fb59c8 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,9 +1,8 @@
<?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 i18n-ktouch "<application>Typewriting Trainer</application>">
<!ENTITY kappname "&i18n-ktouch;"><!-- replace kapp here -->
-<!ENTITY package "kdeedu">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
]>
@@ -52,8 +51,8 @@
<legalnotice>&FDLNotice;</legalnotice>
-<date>2014-05-01</date>
-<releaseinfo>2.3.0</releaseinfo>
+<date>2015-09-27</date>
+<releaseinfo>&ktouch; 2.3.0 (Applications 15.12)</releaseinfo>
<abstract>
<para>&i18n-ktouch; is a program for learning to touch type. &i18n-ktouch;
@@ -1555,17 +1554,6 @@ contributors of keyboard and lesson files.</emphasis>
</chapter>
-<appendix id="installation">
-<title>How to obtain and install &i18n-ktouch;</title>
-
-&install.intro.documentation;
-
-<sect1 id="Compilation">
-<title>Compilation and Installation</title>
-&install.compile.documentation;
-</sect1>
-</appendix>
-
&documentation.index;
</book>
<!--
diff --git a/doc/man-ktouch.1.docbook b/doc/man-ktouch.1.docbook
index e34286b..dabfa5b 100644
--- a/doc/man-ktouch.1.docbook
+++ b/doc/man-ktouch.1.docbook
@@ -1,16 +1,17 @@
<?xml version="1.0" ?>
-<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
<!ENTITY % English "INCLUDE">
]>
<refentry lang="&language;">
<refentryinfo>
-<title>KDE User's Manual</title>
+<title>&ktouch; User's Manual</title>
<author><firstname>Ben</firstname><surname>Burton</surname>
<contrib>KTouch man page.</contrib>
<email>bab@debian.org</email></author>
-<date>2012-11-18</date>
-<productname>K Desktop Environment</productname>
+<date>2015-09-27</date>
+<releaseinfo>&ktouch; 2.3.0 (Applications 15.12)</releaseinfo>
+<productname>KDE Applications</productname>
</refentryinfo>
<refmeta>
@@ -20,16 +21,14 @@
<refnamediv>
<refname><command>ktouch</command></refname>
-<refpurpose>a typing tutor for KDE</refpurpose>
+<refpurpose>a typing tutor by KDE</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ktouch</command>
<group choice="opt"><option>URL</option></group>
-<arg choice="opt">KDE Generic Options</arg>
-<arg choice="opt">Qt Generic Options</arg>
-<arg choice="opt">KTouch Options</arg>
+<arg choice="opt">options</arg>
</cmdsynopsis>
</refsynopsisdiv>