summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDarrell Anderson <humanreadable@yahoo.com>2014-01-25 15:35:00 -0600
committerDarrell Anderson <humanreadable@yahoo.com>2014-01-25 15:35:00 -0600
commitf77e1ad45a5df67474781ea873aab59064ac0f2d (patch)
tree4dbbc2ba2a4f1afc79853ec9c63e36dadf2a6d28
parent7346ba4f4a77871f7c4b086d6f663019b0c96ace (diff)
downloadtdeaccessibility-f77e1ad4.tar.gz
tdeaccessibility-f77e1ad4.zip
Update non-existent and incomplete (template-only) help handbooks to new default format.
-rw-r--r--doc/ksayit/CMakeLists.txt9
-rw-r--r--doc/ksayit/Makefile.am3
-rw-r--r--doc/ksayit/index.docbook65
-rw-r--r--ksayit/src/ksayit.desktop8
4 files changed, 78 insertions, 7 deletions
diff --git a/doc/ksayit/CMakeLists.txt b/doc/ksayit/CMakeLists.txt
new file mode 100644
index 0000000..2100cef
--- /dev/null
+++ b/doc/ksayit/CMakeLists.txt
@@ -0,0 +1,9 @@
+#################################################
+#
+# Improvements and feedback are welcome
+#
+# This file is released under GPL >= 2
+#
+#################################################
+
+tde_create_handbook( DESTINATION ksayit )
diff --git a/doc/ksayit/Makefile.am b/doc/ksayit/Makefile.am
new file mode 100644
index 0000000..4169155
--- /dev/null
+++ b/doc/ksayit/Makefile.am
@@ -0,0 +1,3 @@
+KDE_LANG = en
+KDE_DOCS = AUTO
+
diff --git a/doc/ksayit/index.docbook b/doc/ksayit/index.docbook
new file mode 100644
index 0000000..297915a
--- /dev/null
+++ b/doc/ksayit/index.docbook
@@ -0,0 +1,65 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+ <!ENTITY ksayit "<application>KSayIt</application>">
+ <!ENTITY kappname "&ksayit;">
+ <!ENTITY % addindex "IGNORE">
+ <!ENTITY % English "INCLUDE">
+]>
+
+<!-- Note: When updating this empty handbook, remember that usually most handbooks -->
+<!-- use the book model rather than article. Feel free to use article if the new handbook -->
+<!-- remains really short. -->
+
+<article lang="&language;">
+<title>The &ksayit; Handbook</title>
+
+<articleinfo>
+<title>The &ksayit; Handbook</title>
+
+<authorgroup>
+<corpauthor>&tde-team;</corpauthor>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<releaseinfo>&tde-release-version;</releaseinfo>
+<date>Reviewed: &tde-release-date;</date>
+
+<copyright>
+<year>&tde-copyright-date;</year>
+<holder>&tde-team;</holder>
+</copyright>
+
+<!-- <legalnotice>&FDLNotice;</legalnotice> -->
+
+<abstract>
+<para>
+&ksayit; is a text to speech frontend for TDE.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>TDE</keyword>
+</keywordset>
+
+</articleinfo>
+
+<sect1 id="apologies">
+<title>We Apologize</title>
+<para>No documentation has yet been written for &ksayit;.</para>
+
+<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde;
+web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php">
+&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/">
+&tde; bug tracker</ulink>.</para>
+
+<para>If you are interested in helping, please consider writing the help file.
+Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para>
+
+<para>Thank you for helping and thank you for your patience.</para>
+
+&underFDL;
+
+</sect1>
+
+&documentation.index;
+</article>
diff --git a/ksayit/src/ksayit.desktop b/ksayit/src/ksayit.desktop
index 706ae54..cfbcfa1 100644
--- a/ksayit/src/ksayit.desktop
+++ b/ksayit/src/ksayit.desktop
@@ -2,13 +2,7 @@
Type=Application
Exec=ksayit -caption "%c" %i
Icon=ksayit
-# Restore the following key and remove this comment when a help handbook
-# is written. Disabling this key prevents populating the main handbook
-# table of contents with a non-existent document, which results in a
-# main handbook error message of
-# 'There is no documentation available for /xyz/index.html.'
-# Also disable this key when there exists only a useless template handbook.
-# DocPath=ksayit/index.html
+DocPath=ksayit/index.html
Terminal=false
Name=KSayIt
Name[hi]=के-से-इट