summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDarrell Anderson <humanreadable@yahoo.com>2014-01-25 17:21:07 -0600
committerDarrell Anderson <humanreadable@yahoo.com>2014-01-25 17:21:07 -0600
commitb92652ad385cfdbdfc53a04924b4aa165df1ba08 (patch)
treef9086e1e247348afd760384b5a4a268ea051349a /doc
parentc9ab64d8ea1f83b79fa18c14eaf74a9297e1e998 (diff)
downloadkstreamripper-b92652ad385cfdbdfc53a04924b4aa165df1ba08.tar.gz
kstreamripper-b92652ad385cfdbdfc53a04924b4aa165df1ba08.zip
Update incomplete (template-only) help handbook to new default format.
Diffstat (limited to 'doc')
-rw-r--r--doc/en/index.docbook160
1 files changed, 62 insertions, 98 deletions
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
index 35ee79e..9b5367a 100644
--- a/doc/en/index.docbook
+++ b/doc/en/index.docbook
@@ -1,101 +1,65 @@
<?xml version="1.0" ?>
-<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY kappname "&KStreamRipper;">
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+ <!ENTITY kstreamripper "<application>KStreamripper</application>">
+ <!ENTITY kappname "&kstreamripper;">
<!ENTITY % addindex "IGNORE">
- <!ENTITY % English "INCLUDE" > <!-- change language only here -->
+ <!ENTITY % English "INCLUDE">
]>
-<!-- Important note: please use template.docbook instead of this file.
- This is only the conversion of app.sgml into DocBook SGML.
- template.docbook gives you more information on what you can and
- should do. Thanks. -->
-
-<book lang="&language;">
-
- <bookinfo>
- <title>The KStreamRipper Handbook</title>
- <authorgroup>
- <author>
- <firstname></firstname>
- <surname>Michael Goettsche</surname>
- <affiliation><address><email>mail&#64;tuxipuxi&#46;de</email></address></affiliation>
- </author>
- </authorgroup>
- <date>date</date>
- <releaseinfo>0&#46;1</releaseinfo>
- <abstract>
- <para>SHORT DESCRIPTION GOES HERE</para>
- </abstract>
- <keywordset>
- <keyword>KDE</keyword>
- <keyword>KStreamRipper</keyword>
- </keywordset>
- </bookinfo>
-
- <chapter id="introduction">
- <title>Introduction</title>
-
- <sect1 id="features">
- <title>Features</title>
- <para></para>
- </sect1>
- </chapter>
-
- <chapter id="installation">
- <title>Installation</title>
-
- <sect1 id="how-to-obtain-KStreamRipper">
- <title>How to obtain KStreamRipper</title>
- <para></para>
- </sect1>
-
- <sect1 id="requirements">
- <title>Requirements</title>
- <para></para>
- </sect1>
-
- <sect1 id="compilation-and-installation">
- <title>Compilation and Installation</title>
-
- <para>Compiling KStreamRipper is very easy. The following should do
- it: <screen>
-<prompt>%</prompt> <userinput><command>./configure</command></userinput>
-<prompt>%</prompt> <userinput><command>make</command></userinput>
-<prompt>%</prompt> <userinput><command>make</command> install</userinput></screen>
- </para>
-
- <para>That should do it! Should you run into any problems,
- please report them to the <ulink
- url="mailto:mail&#64;tuxipuxi&#46;de">author</ulink></para>
- </sect1>
- </chapter>
-
- <chapter id="using-KStreamRipper">
- <title>Using KStreamRipper</title>
- <para></para>
- </chapter>
-
- <chapter id="questionsanswersandtips">
- <title>Questions, Answers, and Tips</title>
-
- <qandaset id="faq">
- <title>Frequently asked questions</title>
- <qandaentry>
- <question>
- <para>Question 1</para>
- </question>
- <answer>
- <para>The answer</para>
- </answer>
- </qandaentry>
- </qandaset>
-
- </chapter>
-</book>
-<!--
-Local Variables:
-mode: sgml
-sgml-omittag: nil
-sgml-shorttag: t
-sgml-general-insert-case: lower
-End:
--->
+
+<!-- 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 &kstreamripper; Handbook</title>
+
+<articleinfo>
+<title>The &kstreamripper; 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>
+&kstreamripper; is a graphical frontend to streamripper.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>TDE</keyword>
+</keywordset>
+
+</articleinfo>
+
+<sect1 id="apologies">
+<title>We Apologize</title>
+<para>No documentation has yet been written for &kstreamripper;.</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>