Replace template-only help handbook with new default format.

Darrell Anderson 9 years ago
parent 1d0cc0fb61
commit 3852ddd97a

@ -1,555 +1,63 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY guidance "<application>Guidance</application>">
<!ENTITY kappname "&guidance;"><!-- Do *not* replace kappname-->
<!ENTITY package "kde-module"><!-- tdebase, tdeadmin, etc -->
<!ENTITY kappname "&guidance;">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
<!-- Do not define any other entities; instead, use the entities
from kde-genent.entities and $LANG/user.entities. -->
<!ENTITY % English "INCLUDE">
<!-- kdoctemplate v0.8 October 1 1999
Minor update to "Credits and Licenses" section on August 24, 2000
Removed "Revision history" section on 22 January 2001
Changed to Installation/Help menu entities 18 October 2001
Other minor cleanup and changes 18 October 2001 -->
<article lang="&language;">
<title>The &kappname; Handbook</title>
This template was designed by: David Rugge
with lots of help from: Eric Bischoff
and Frederik Fouvry
of the KDE DocBook team.
You may freely use this template for writing any sort of KDE documentation.
If you have any changes or improvements, please let us know.
- in XML, the case of the <tags> and attributes is relevant ;
- also, quote all attributes.
Please don't forget to remove all these comments in your final documentation,
thanks ;-).
<!-- ................................................................ -->
<!-- The language must NOT be changed here. -->
<book lang="&language;">
<!-- This header contains all of the meta-information for the document such
as Authors, publish date, the abstract, and Keywords -->
<title>The &guidance; Handbook</title>
<title>The &kappname; Handbook</title>
<surname>Simon Edwards</surname>
<date>Reviewed: &tde-release-date;</date>
<holder>Simon Edwards</holder>
<!-- Translators: put here the copyright notice of the translation -->
<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook
and in the FDL itself on how to use it. -->
<!-- Date and version information of the documentation
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (YYYY-MM-DD) and of the version
(V.MM.LL), it could be used by automation scripts.
Do NOT change these in the translation. -->
<!-- Abstract about this handbook -->
&guidance; is an application specially designed to do nothing you would
ever want.
&kappname; is a collection of system administration tools for &tde;.
<!-- This is a set of Keywords for indexing by search engines.
Please at least include KDE, the KDE package it is in, the name
of your application, and a few relevant keywords. -->
<keyword>nothing else</keyword>
<!-- The contents of the documentation begin here. Label
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
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. -->
<chapter id="introduction">
<!-- The introduction chapter contains a brief introduction for the
application that explains what it does and where to report
problems. Basically a long version of the abstract. Don't include a
revision history. (see installation appendix comment) -->
&guidance; is a program that lets you do absolutely nothing. Please report
any problems or feature requests to the &kde; mailing lists.
<chapter id="using-testapp">
<title>Using &guidance;</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
your application. -->
<!-- Note that all graphics should be in .png format. Use no gifs because of
patent issues. -->
<screeninfo>Here's a screenshot of &guidance;</screeninfo>
<imagedata fileref="screenshot.png" format="PNG"/>
<imagedata fileref="screenshot.eps" format="EPS"/>
<sect1 id="testapp-features">
<title>More &guidance; features</title>
<para>It slices! It dices! and it comes with a free toaster!</para>
The Squiggle Tool <guiicon><inlinemediaobject>
<imagedata fileref="squiggle.png" format="PNG"/>
<imagedata fileref="squiggle.eps" format="EPS"/>
</inlinemediaobject></guiicon> is used to draw squiggly lines all over
the &guidance; main window. It's not a bug, it's a feature!
<chapter id="commands">
<title>Command Reference</title>
<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
application windows and their menubar and toolbar commands for easy reference.
Also include any keys that have a special function but have no equivalent in the
menus or toolbars. This may not be necessary for small apps or apps with no tool
or menu bars. -->
<sect1 id="testapp-mainwindow">
<title>The main &guidance; window</title>
<title>The File Menu</title>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
<listitem><para><action>Creates a new document</action></para></listitem>
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
<listitem><para><action>Saves the document</action></para></listitem>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
<listitem><para><action>Quits</action> &guidance;</para></listitem>
<sect1 id="apologies">
<title>We Apologize</title>
<para>No documentation has yet been written for &kappname;.</para>
<title>The <guimenu>Help</guimenu> Menu</title>
<para>If you need help, please check <ulink url="">The &tde;
web site</ulink>, submit questions to the <ulink url="">
&tde; mail lists</ulink>, or file a bug report at the <ulink url="">
&tde; bug tracker</ulink>.</para>
<!-- Assuming you have a standard help menu (help, what's this, about -->
<!-- &guidance;, about KDE) then the documentation is already written. -->
<!-- The following entity is valid anywhere that a variablelist is -->
<!-- valid. -->
<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>
<chapter id="developers">
<title>Developer's Guide to &guidance;</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. -->
Programming &guidance; plugins is a joy to behold. Just read through the next
66 pages of API's to learn how!
<!-- Use refentries to describe APIs. Refentries are fairly complicated and you
should consult the docbook reference for further details. The example below was
taken from that reference and shortened a bit for readability. -->
<refentry id="re-1007-unmanagechildren-1">
<refmiscinfo>Xt - Geometry Management</refmiscinfo>
<refpurpose>remove a list of children from a parent widget's managed
<indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm>
<indexterm id="ix-1007-unmanagechildren-2"><primary>XtUnmanageChildren</primary></indexterm>
<date>4 March 1996</date>
void XtUnmanageChildren(<replaceable class="parameter">children</replaceable>, <replaceable class="parameter">num_children</replaceable>)
WidgetList <replaceable class="parameter">children</replaceable>;
Cardinal <replaceable class="parameter">num_children</replaceable>;
<refsect2 id="r2-1007-unmanagechildren-1">
<term><replaceable class="parameter">children</replaceable>
<para>Specifies an array of child widgets. Each child must be of
class RectObj or any subclass thereof.
<term><replaceable class="parameter">num_children</replaceable>
<para>Specifies the number of elements in <replaceable class="parameter">children</replaceable>.
<refsect1 id="r1-1007-unmanagechildren-1">
<para><function>XtUnmanageChildren()</function> unmaps the specified widgets
and removes them from their parent's geometry management.
The widgets will disappear from the screen, and (depending
on its parent) may no longer have screen space allocated for
<para>Each of the widgets in the <replaceable class="parameter">children</replaceable> array must have
the same parent.
<para>See the &ldquo;Algorithm&rdquo; section below for full details of the
widget unmanagement procedure.
<refsect1 id="r1-1007-unmanagechildren-2">
<para>Unmanaging widgets is the usual method for temporarily
making them invisible. They can be re-managed with
<para>You can unmap a widget, but leave it under geometry
management by calling <function>XtUnmapWidget()</function>. You can
destroy a widget's window without destroying the widget by
calling <function>XtUnrealizeWidget()</function>. You can destroy a
widget completely with <function>XtDestroyWidget()</function>.
<para>If you are only going to unmanage a single widget, it is
more convenient to call <function>XtUnmanageChild()</function>. It is
often more convenient to call <function>XtUnmanageChild()</function>
several times than it is to declare and initialize an array
of widgets to pass to <function>XtUnmanageChildren()</function>. Calling
<function>XtUnmanageChildren()</function> is more efficient, however,
because it only calls the parent's <function>change_managed()</function>
method once.
<refsect1 id="r1-1007-unmanagechildren-3">
<para><function>XtUnmanageChildren()</function> performs the following:
<para>Ignores the child if it already is unmanaged or is being
<para>Otherwise, if the child is realized, it makes it nonvisible
by unmapping it.
<refsect1 id="r1-1007-unmanagechildren-4">
<para>The <type>WidgetList</type> type is simply an array of widgets:
<screen id="sc-1007-unmanagechildren-1">typedef Widget *WidgetList;
<chapter id="faq">
<title>Questions and Answers</title>
<!-- (OPTIONAL but recommended) This chapter should include all of the silly
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
should be reserved for BRIEF questions and answers! If one question uses more
than a page or so then it should probably be part of the
"Using this Application" chapter instead. You should use links to
cross-reference questions to the parts of your documentation that answer them.
This is also a great place to provide pointers to other FAQ's if your users
must do some complicated configuration on other programs in order for your
application work. -->
<qandaset id="faqlist">
<para>My Mouse doesn't work. How do I quit &guidance;?</para>
<para>You silly goose! Check out the <link linkend="commands">Commands
Section</link> for the answer.</para>
<para>Why can't I twiddle my documents?</para>
<para>You can only twiddle your documents if you have the foobar.lib
<chapter id="credits">
<!-- 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
distribution. -->
<title>Credits and License</title>
Program copyright %{YEAR} Simon Edwards <email></email>
<listitem><para>Konqui the KDE Dragon <email></email></para>
<listitem><para>Tux the Linux Penguin <email></email></para>
Documentation copyright %{YEAR} Simon Edwards <email></email>
&underFDL; <!-- FDL: do not remove -->
<!-- Determine which license your application is licensed under,
and delete all the remaining licenses below:
(NOTE: All documentation are licensed under the FDL,
regardless of what license the application uses) -->
&underGPL; <!-- GPL License -->
&underBSDLicense; <!-- BSD License -->
&underArtisticLicense; <!-- BSD Artistic License -->
&underX11License; <!-- X11 License -->
<appendix id="installation">
<sect1 id="getting-testapp">
<title>How to obtain &guidance;</title>
<!-- This first entity contains boiler plate for applications that are
part of KDE CVS. You should remove it if you are releasing your
application -->
<sect1 id="requirements">
List any special requirements for your application here. This should include:
.Libraries or other software that is not included in tdesupport,
tdelibs, or tdebase.
.Hardware requirements like amount of RAM, disk space, graphics card
capabilities, screen resolution, special expansion cards, etc.
.Operating systems the app will run on. If your app is designed only for a
specific OS, (you wrote a graphical LILO configurator for example) put this
information here.
In order to successfully use &guidance;, you need &kde; 1.1. Foobar.lib is
required in order to support the advanced &guidance; features. &guidance; uses
about 5 megs of memory to run, but this may vary depending on your
platform and configuration.
All required libraries as well as &guidance; itself can be found
on <ulink url="">The &guidance; home page</ulink>.
<!-- For a list of updates, you may refer to the application web site
or the ChangeLog file, or ... -->
You can find a list of changes at <ulink
<sect1 id="compilation">
<title>Compilation and Installation</title>
<!-- This entity contains the boilerplate text for standard -->
<!-- compilation instructions. If your application requires any -->
<!-- special handling, remove it, and replace with your own text. -->
<sect1 id="configuration">
<para>Don't forget to tell your system to start the <filename>dtd</filename>
dicer-toaster daemon first, or &guidance; won't work !</para>
Local Variables:
mode: sgml