|
|
|
@ -1,13 +1,13 @@
|
|
|
|
|
<?xml version="1.0" ?>
|
|
|
|
|
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
|
|
|
|
|
<!-- Define an entity for your application if it is not part of KDE
|
|
|
|
|
CVS -->
|
|
|
|
|
<!ENTITY kmyapplication "<application>KMyApp</application>">
|
|
|
|
|
<!ENTITY kappname "&kmyapplication;"><!-- replace kmyapplication here
|
|
|
|
|
<!-- Define an entity for your application if it is not part of TDE
|
|
|
|
|
GIT -->
|
|
|
|
|
<!ENTITY TDEMyApplication "<application>TDEMyApp</application>">
|
|
|
|
|
<!ENTITY kappname "&tdemyapplication;"><!-- replace TDEMyApplication here
|
|
|
|
|
do *not* replace kappname-->
|
|
|
|
|
<!ENTITY package "kde-module"><!-- tdebase, tdeadmin, etc. Leave
|
|
|
|
|
<!ENTITY package "tde-module"><!-- tdebase, tdeadmin, etc. Leave
|
|
|
|
|
this unchanged if your
|
|
|
|
|
application is not maintained in KDE CVS -->
|
|
|
|
|
application is not maintained in TDE GIT -->
|
|
|
|
|
<!ENTITY % addindex "IGNORE">
|
|
|
|
|
<!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English
|
|
|
|
|
original documentation, change
|
|
|
|
@ -28,9 +28,9 @@
|
|
|
|
|
This template was designed by: David Rugge davidrugge@mindspring.com
|
|
|
|
|
with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
|
|
|
|
|
and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
|
|
|
|
|
of the KDE DocBook team.
|
|
|
|
|
of the TDE DocBook team.
|
|
|
|
|
|
|
|
|
|
You may freely use this template for writing any sort of KDE documentation.
|
|
|
|
|
You may freely use this template for writing any sort of TDE documentation.
|
|
|
|
|
If you have any changes or improvements, please let us know.
|
|
|
|
|
|
|
|
|
|
Remember:
|
|
|
|
@ -52,14 +52,14 @@ thanks ;-).
|
|
|
|
|
as Authors, publish date, the abstract, and Keywords -->
|
|
|
|
|
|
|
|
|
|
<bookinfo>
|
|
|
|
|
<title>The &kmyapplication; Handbook</title>
|
|
|
|
|
<title>The &tdemyapplication; Handbook</title>
|
|
|
|
|
|
|
|
|
|
<authorgroup>
|
|
|
|
|
<author>
|
|
|
|
|
<!-- This is just put in as an example. For real documentation, please
|
|
|
|
|
define a general entity in entities/contributor.entities, e.g.
|
|
|
|
|
<!ENTITY George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>">
|
|
|
|
|
<!ENTITY George.N.Ugnacious.mail "<email>gnu@kde.org</email>">
|
|
|
|
|
<!ENTITY George.N.Ugnacious.mail "<email>gnu@trinitydesktop.org</email>">
|
|
|
|
|
and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
|
|
|
|
|
-->
|
|
|
|
|
<personname>
|
|
|
|
@ -67,7 +67,7 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
|
|
|
|
|
<othername>N.</othername>
|
|
|
|
|
<surname>Ugnacious</surname>
|
|
|
|
|
</personname>
|
|
|
|
|
<email>gnu@kde.org</email>
|
|
|
|
|
<email>gnu@trinitydesktop.org</email>
|
|
|
|
|
</author>
|
|
|
|
|
</authorgroup>
|
|
|
|
|
|
|
|
|
@ -96,17 +96,17 @@ Do NOT change these in the translation. -->
|
|
|
|
|
|
|
|
|
|
<abstract>
|
|
|
|
|
<para>
|
|
|
|
|
&kmyapplication; is an application specially designed to do nothing you would
|
|
|
|
|
&tdemyapplication; is an application specially designed to do nothing you would
|
|
|
|
|
ever want.
|
|
|
|
|
</para>
|
|
|
|
|
</abstract>
|
|
|
|
|
|
|
|
|
|
<!-- This is a set of Keywords for indexing by search engines.
|
|
|
|
|
Please at least include KDE, the KDE package it is in, the name
|
|
|
|
|
Please at least include TDE, the TDE package it is in, the name
|
|
|
|
|
of your application, and a few relevant keywords. -->
|
|
|
|
|
|
|
|
|
|
<keywordset>
|
|
|
|
|
<keyword>KDE</keyword>
|
|
|
|
|
<keyword>TDE</keyword>
|
|
|
|
|
<keyword>tdeutils</keyword>
|
|
|
|
|
<keyword>Kapp</keyword>
|
|
|
|
|
<keyword>nothing</keyword>
|
|
|
|
@ -119,10 +119,10 @@ Please at least include KDE, the KDE package it is in, the name
|
|
|
|
|
each chapter so with the id attribute. This is necessary for two reasons: it
|
|
|
|
|
allows you to easily reference the chapter from other chapters of your
|
|
|
|
|
document, and if there is no ID, the name of the generated HTML files will vary
|
|
|
|
|
from time to time making it hard to manage for maintainers and for the CVS
|
|
|
|
|
from time to time making it hard to manage for maintainers and for the GIT
|
|
|
|
|
system. Any chapter labelled (OPTIONAL) may be left out at the author's
|
|
|
|
|
discretion. Other chapters should not be left out in order to maintain a
|
|
|
|
|
consistent documentation style across all KDE apps. -->
|
|
|
|
|
consistent documentation style across all TDE apps. -->
|
|
|
|
|
|
|
|
|
|
<chapter id="introduction">
|
|
|
|
|
<title>Introduction</title>
|
|
|
|
@ -133,13 +133,13 @@ problems. Basically a long version of the abstract. Don't include a
|
|
|
|
|
revision history. (see installation appendix comment) -->
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
&kmyapplication; is a program that lets you do absolutely nothing. Please report
|
|
|
|
|
any problems or feature requests to the &kde; mailing lists.
|
|
|
|
|
&tdemyapplication; is a program that lets you do absolutely nothing. Please report
|
|
|
|
|
any problems or feature requests to the &tde; mailing lists.
|
|
|
|
|
</para>
|
|
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter id="using-kapp">
|
|
|
|
|
<title>Using &kmyapplication;</title>
|
|
|
|
|
<title>Using &tdemyapplication;</title>
|
|
|
|
|
|
|
|
|
|
<!-- This chapter should tell the user how to use your app. You should use as
|
|
|
|
|
many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
|
|
|
|
@ -151,7 +151,7 @@ your application. -->
|
|
|
|
|
patent issues. -->
|
|
|
|
|
|
|
|
|
|
<screenshot>
|
|
|
|
|
<screeninfo>Here's a screenshot of &kmyapplication;</screeninfo>
|
|
|
|
|
<screeninfo>Here's a screenshot of &tdemyapplication;</screeninfo>
|
|
|
|
|
<mediaobject>
|
|
|
|
|
<imageobject>
|
|
|
|
|
<imagedata fileref="screenshot.png" format="PNG"/>
|
|
|
|
@ -168,7 +168,7 @@ patent issues. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<sect1 id="kapp-features">
|
|
|
|
|
<title>More &kmyapplication; features</title>
|
|
|
|
|
<title>More &tdemyapplication; features</title>
|
|
|
|
|
|
|
|
|
|
<para>It slices! It dices! and it comes with a free toaster!</para>
|
|
|
|
|
<para>
|
|
|
|
@ -183,7 +183,7 @@ The Squiggle Tool <guiicon><inlinemediaobject>
|
|
|
|
|
<phrase>Squiggle</phrase>
|
|
|
|
|
</textobject>
|
|
|
|
|
</inlinemediaobject></guiicon> is used to draw squiggly lines all over
|
|
|
|
|
the &kmyapplication; main window. It's not a bug, it's a feature!
|
|
|
|
|
the &tdemyapplication; main window. It's not a bug, it's a feature!
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
</sect1>
|
|
|
|
@ -199,7 +199,7 @@ menus or toolbars. This may not be necessary for small apps or apps with no tool
|
|
|
|
|
or menu bars. -->
|
|
|
|
|
|
|
|
|
|
<sect1 id="kapp-mainwindow">
|
|
|
|
|
<title>The main &kmyapplication; window</title>
|
|
|
|
|
<title>The main &tdemyapplication; window</title>
|
|
|
|
|
|
|
|
|
|
<sect2>
|
|
|
|
|
<title>The File Menu</title>
|
|
|
|
@ -233,7 +233,7 @@ or menu bars. -->
|
|
|
|
|
<guimenu>File</guimenu>
|
|
|
|
|
<guimenuitem>Quit</guimenuitem>
|
|
|
|
|
</menuchoice></term>
|
|
|
|
|
<listitem><para><action>Quits</action> &kmyapplication;</para></listitem>
|
|
|
|
|
<listitem><para><action>Quits</action> &tdemyapplication;</para></listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
</variablelist>
|
|
|
|
|
</para>
|
|
|
|
@ -244,7 +244,7 @@ or menu bars. -->
|
|
|
|
|
<title>The <guimenu>Help</guimenu> Menu</title>
|
|
|
|
|
|
|
|
|
|
<!-- Assuming you have a standard help menu (help, what's this, about -->
|
|
|
|
|
<!-- &kmyapplication;, about KDE) then the documentation is already written. -->
|
|
|
|
|
<!-- &tdemyapplication;, about TDE) then the documentation is already written. -->
|
|
|
|
|
<!-- The following entity is valid anywhere that a variablelist is -->
|
|
|
|
|
<!-- valid. -->
|
|
|
|
|
|
|
|
|
@ -256,14 +256,14 @@ or menu bars. -->
|
|
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter id="developers">
|
|
|
|
|
<title>Developer's Guide to &kmyapplication;</title>
|
|
|
|
|
<title>Developer's Guide to &tdemyapplication;</title>
|
|
|
|
|
|
|
|
|
|
<!-- (OPTIONAL) A Programming/Scripting reference chapter should be
|
|
|
|
|
used for apps that use plugins or that provide their own scripting hooks
|
|
|
|
|
and/or development libraries. -->
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
Programming &kmyapplication; plugins is a joy to behold. Just read through the next
|
|
|
|
|
Programming &tdemyapplication; plugins is a joy to behold. Just read through the next
|
|
|
|
|
66 pages of API's to learn how!
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
@ -418,7 +418,7 @@ application work. -->
|
|
|
|
|
<qandaset id="faqlist">
|
|
|
|
|
<qandaentry>
|
|
|
|
|
<question>
|
|
|
|
|
<para>My Mouse doesn't work. How do I quit &kmyapplication;?</para>
|
|
|
|
|
<para>My Mouse doesn't work. How do I quit &tdemyapplication;?</para>
|
|
|
|
|
</question>
|
|
|
|
|
<answer>
|
|
|
|
|
<para>You silly goose! Check out the <link linkend="commands">Commands
|
|
|
|
@ -441,21 +441,21 @@ installed.</para>
|
|
|
|
|
|
|
|
|
|
<!-- Include credits for the programmers, documentation writers, and
|
|
|
|
|
contributors here. The license for your software should then be included below
|
|
|
|
|
the credits with a reference to the appropriate license file included in the KDE
|
|
|
|
|
the credits with a reference to the appropriate license file included in the TDE
|
|
|
|
|
distribution. -->
|
|
|
|
|
|
|
|
|
|
<title>Credits and License</title>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
&kmyapplication;
|
|
|
|
|
&tdemyapplication;
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
Program copyright 1997 John Q. Hacker <email>jqh@kde.org</email>
|
|
|
|
|
Program copyright 1997 John Q. Hacker <email>jqh@trinitydesktop.org</email>
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
Contributors:
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
<listitem><para>Konqui the KDE Dragon <email>konqui@kde.org</email></para>
|
|
|
|
|
<listitem><para>Konqui the TDE Dragon <email>konqui@trinitydesktop.org</email></para>
|
|
|
|
|
</listitem>
|
|
|
|
|
<listitem><para>Tux the Linux Penguin <email>tux@linux.org</email></para>
|
|
|
|
|
</listitem>
|
|
|
|
@ -463,7 +463,7 @@ Contributors:
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
Documentation Copyright © 1999 George N. Ugnacious <email>gnu@kde.org</email>
|
|
|
|
|
Documentation Copyright © 1999 George N. Ugnacious <email>gnu@trinitydesktop.org</email>
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
|
|
|
|
@ -487,10 +487,10 @@ Documentation Copyright © 1999 George N. Ugnacious <email>gnu@kde.org</emai
|
|
|
|
|
<title>Installation</title>
|
|
|
|
|
|
|
|
|
|
<sect1 id="getting-kapp">
|
|
|
|
|
<title>How to obtain &kmyapplication;</title>
|
|
|
|
|
<title>How to obtain &tdemyapplication;</title>
|
|
|
|
|
|
|
|
|
|
<!-- This first entity contains boiler plate for applications that are
|
|
|
|
|
part of KDE CVS. You should remove it if you are releasing your
|
|
|
|
|
part of TDE GIT. You should remove it if you are releasing your
|
|
|
|
|
application -->
|
|
|
|
|
|
|
|
|
|
&install.intro.documentation;
|
|
|
|
@ -512,22 +512,22 @@ information here.
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
In order to successfully use &kmyapplication;, you need &kde; 1.1. Foobar.lib is
|
|
|
|
|
required in order to support the advanced &kmyapplication; features. &kmyapplication; uses
|
|
|
|
|
In order to successfully use &tdemyapplication;, you need &tde; 1.1. Foobar.lib is
|
|
|
|
|
required in order to support the advanced &tdemyapplication; features. &tdemyapplication; uses
|
|
|
|
|
about 5 megs of memory to run, but this may vary depending on your
|
|
|
|
|
platform and configuration.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
All required libraries as well as &kmyapplication; itself can be found
|
|
|
|
|
on <ulink url="ftp://ftp.kapp.org">The &kmyapplication; home page</ulink>.
|
|
|
|
|
All required libraries as well as &tdemyapplication; itself can be found
|
|
|
|
|
on <ulink url="ftp://ftp.kapp.org">The &tdemyapplication; home page</ulink>.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<!-- For a list of updates, you may refer to the application web site
|
|
|
|
|
or the ChangeLog file, or ... -->
|
|
|
|
|
<para>
|
|
|
|
|
You can find a list of changes at <ulink
|
|
|
|
|
url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>.
|
|
|
|
|
url="http://trinitydesktop.org/tdeapp">http://trinitydesktop.org/tdeapp</ulink>.
|
|
|
|
|
</para>
|
|
|
|
|
</sect1>
|
|
|
|
|
|
|
|
|
@ -546,7 +546,7 @@ url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>.
|
|
|
|
|
<title>Configuration</title>
|
|
|
|
|
|
|
|
|
|
<para>Don't forget to tell your system to start the <filename>dtd</filename>
|
|
|
|
|
dicer-toaster daemon first, or &kmyapplication; won't work !</para>
|
|
|
|
|
dicer-toaster daemon first, or &tdemyapplication; won't work !</para>
|
|
|
|
|
|
|
|
|
|
</sect1>
|
|
|
|
|
|