summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDarrell Anderson <humanreadable@yahoo.com>2014-01-25 18:46:32 -0600
committerDarrell Anderson <humanreadable@yahoo.com>2014-01-25 18:46:32 -0600
commited1cbe6880dcfff931f3a261b688c7aed3fc97bd (patch)
tree5122b4af0e5612bb862b11a653ae13e2ae12073f
parenta8250b6b7500c24d3f128635ee91c8d950ba9769 (diff)
downloadknetload-ed1cbe6880dcfff931f3a261b688c7aed3fc97bd.tar.gz
knetload-ed1cbe6880dcfff931f3a261b688c7aed3fc97bd.zip
Add template-only help handbook to new default format.
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/en/Makefile.am2
-rw-r--r--doc/en/index.docbook65
-rw-r--r--knetload/knetload.desktop8
-rw-r--r--subdirs1
5 files changed, 72 insertions, 7 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..5c0b20e
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,3 @@
+KDE_LANG = en
+KDE_DOCS = AUTO
+SUBDIRS = $(AUTODIRS)
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
new file mode 100644
index 0000000..3eaded9
--- /dev/null
+++ b/doc/en/Makefile.am
@@ -0,0 +1,2 @@
+KDE_LANG = en
+KDE_DOCS = knetload
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
new file mode 100644
index 0000000..d68cbd1
--- /dev/null
+++ b/doc/en/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 knetload "<application>KNetLoad</application>">
+ <!ENTITY kappname "&knetload;">
+ <!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 &knetload; Handbook</title>
+
+<articleinfo>
+<title>The &knetload; 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>
+&knetload; is a small network load meter for the &tde; panel.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>TDE</keyword>
+</keywordset>
+
+</articleinfo>
+
+<sect1 id="apologies">
+<title>We Apologize</title>
+<para>No documentation has yet been written for &knetload;.</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/knetload/knetload.desktop b/knetload/knetload.desktop
index c321ddd..5d80aab 100644
--- a/knetload/knetload.desktop
+++ b/knetload/knetload.desktop
@@ -3,13 +3,7 @@ Encoding=UTF-8
Type=Application
Exec=knetload
Icon=knetload
-# 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=knetload/index.html
+DocPath=knetload/index.html
Terminal=false
Name=KNetLoad
Name[et]=KNetLoad
diff --git a/subdirs b/subdirs
index 38a3fc8..8597f5e 100644
--- a/subdirs
+++ b/subdirs
@@ -1,3 +1,4 @@
+doc
icons
knetload
po