Browse Source

Update incomplete (template-only) help handbook to new default format.

tags/r14.0.0
Darrell Anderson 6 years ago
parent
commit
b92652ad38
2 changed files with 63 additions and 103 deletions
  1. +62
    -98
      doc/en/index.docbook
  2. +1
    -5
      src/kstreamripper.desktop

+ 62
- 98
doc/en/index.docbook View File

@@ -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>

+ 1
- 5
src/kstreamripper.desktop View File

@@ -7,9 +7,5 @@ Exec=kstreamripper
Icon=kstreamripper
Type=Application
Comment=A streamripper GUI for TDE
# 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 and a resulting error message of
# 'There is no documentation available for /xyz/index.html.'
# DocPath=kstreamripper/index.html
DocPath=kstreamripper/index.html
Categories=Qt;TDE;AudioVideo;Audio;Player;

Loading…
Cancel
Save