2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
3
<!ENTITY kredentials "<application>kredentials 0.1</application>">
4
<!ENTITY kappname "&kredentials;"><!-- Do *not* replace kappname-->
5
<!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc -->
6
<!ENTITY % addindex "IGNORE">
7
<!ENTITY % English "INCLUDE"><!-- change language only here -->
10
<!-- Do not define any other entities; instead, use the entities
11
from kde-genent.entities and $LANG/user.entities. -->
13
<!-- kdoctemplate v0.8 October 1 1999
14
Minor update to "Credits and Licenses" section on August 24, 2000
15
Removed "Revision history" section on 22 January 2001
16
Changed to Installation/Help menu entities 18 October 2001
17
Other minor cleanup and changes 18 October 2001 -->
21
This template was designed by: David Rugge davidrugge@mindspring.com
22
with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
23
and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
24
of the KDE DocBook team.
26
You may freely use this template for writing any sort of KDE documentation.
27
If you have any changes or improvements, please let us know.
30
- in XML, the case of the <tags> and attributes is relevant ;
31
- also, quote all attributes.
33
Please don't forget to remove all these comments in your final documentation,
37
<!-- ................................................................ -->
39
<!-- The language must NOT be changed here. -->
41
<book lang="&language;">
43
<!-- This header contains all of the meta-information for the document such
44
as Authors, publish date, the abstract, and Keywords -->
47
<title>The &kredentials; Handbook</title>
51
<firstname></firstname>
52
<othername></othername>
53
<surname>Noah Meyerhans</surname>
55
<address><email>noahm@csail.mit.edu</email></address>
60
<!-- TRANS:ROLES_OF_TRANSLATORS -->
65
<holder>Noah Meyerhans</holder>
67
<!-- Translators: put here the copyright notice of the translation -->
68
<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook
69
and in the FDL itself on how to use it. -->
70
<legalnotice>&FDLNotice;</legalnotice>
72
<!-- Date and version information of the documentation
73
Don't forget to include this last date and this last revision number, we
74
need them for translation coordination !
75
Please respect the format of the date (YYYY-MM-DD) and of the version
76
(V.MM.LL), it could be used by automation scripts.
77
Do NOT change these in the translation. -->
79
<date>2001-10-18</date>
80
<releaseinfo>0.1</releaseinfo>
82
<!-- Abstract about this handbook -->
86
&kredentials; is an application specially designed to do nothing you would
91
<!-- This is a set of Keywords for indexing by search engines.
92
Please at least include KDE, the KDE package it is in, the name
93
of your application, and a few relevant keywords. -->
96
<keyword>KDE</keyword>
97
<keyword>kredentials</keyword>
98
<keyword>nothing</keyword>
99
<keyword>nothing else</keyword>
104
<!-- The contents of the documentation begin here. Label
105
each chapter so with the id attribute. This is necessary for two reasons: it
106
allows you to easily reference the chapter from other chapters of your
107
document, and if there is no ID, the name of the generated HTML files will vary
108
from time to time making it hard to manage for maintainers and for the CVS
109
system. Any chapter labelled (OPTIONAL) may be left out at the author's
110
discretion. Other chapters should not be left out in order to maintain a
111
consistent documentation style across all KDE apps. -->
113
<chapter id="introduction">
114
<title>Introduction</title>
116
<!-- The introduction chapter contains a brief introduction for the
117
application that explains what it does and where to report
118
problems. Basically a long version of the abstract. Don't include a
119
revision history. (see installation appendix comment) -->
122
&kredentials; is a program that lets you do absolutely nothing. Please report
123
any problems or feature requests to the &kde; mailing lists.
127
<chapter id="using-kredentials">
128
<title>Using &kredentials;</title>
130
<!-- This chapter should tell the user how to use your app. You should use as
131
many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
132
your application. -->
136
<!-- Note that all graphics should be in .png format. Use no gifs because of
140
<screeninfo>Here's a screenshot of &kredentials;</screeninfo>
143
<imagedata fileref="screenshot.png" format="PNG"/>
146
<imagedata fileref="screenshot.eps" format="EPS"/>
149
<phrase>Screenshot</phrase>
156
<sect1 id="kredentials-features">
157
<title>More &kredentials; features</title>
159
<para>It slices! It dices! and it comes with a free toaster!</para>
161
The Squiggle Tool <guiicon><inlinemediaobject>
163
<imagedata fileref="squiggle.png" format="PNG"/>
166
<imagedata fileref="squiggle.eps" format="EPS"/>
169
<phrase>Squiggle</phrase>
171
</inlinemediaobject></guiicon> is used to draw squiggly lines all over
172
the &kredentials; main window. It's not a bug, it's a feature!
178
<chapter id="commands">
179
<title>Command Reference</title>
181
<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
182
application windows and their menubar and toolbar commands for easy reference.
183
Also include any keys that have a special function but have no equivalent in the
184
menus or toolbars. This may not be necessary for small apps or apps with no tool
187
<sect1 id="kredentials-mainwindow">
188
<title>The main &kredentials; window</title>
191
<title>The File Menu</title>
197
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
199
<guimenu>File</guimenu>
200
<guimenuitem>New</guimenuitem>
202
<listitem><para><action>Creates a new document</action></para></listitem>
207
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
209
<guimenu>File</guimenu>
210
<guimenuitem>Save</guimenuitem>
212
<listitem><para><action>Saves the document</action></para></listitem>
217
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
219
<guimenu>File</guimenu>
220
<guimenuitem>Quit</guimenuitem>
222
<listitem><para><action>Quits</action> &kredentials;</para></listitem>
230
<title>The <guimenu>Help</guimenu> Menu</title>
232
<!-- Assuming you have a standard help menu (help, what's this, about -->
233
<!-- &kredentials;, about KDE) then the documentation is already written. -->
234
<!-- The following entity is valid anywhere that a variablelist is -->
237
&help.menu.documentation;
244
<chapter id="developers">
245
<title>Developer's Guide to &kredentials;</title>
247
<!-- (OPTIONAL) A Programming/Scripting reference chapter should be
248
used for apps that use plugins or that provide their own scripting hooks
249
and/or development libraries. -->
252
Programming &kredentials; plugins is a joy to behold. Just read through the next
253
66 pages of API's to learn how!
256
<!-- Use refentries to describe APIs. Refentries are fairly complicated and you
257
should consult the docbook reference for further details. The example below was
258
taken from that reference and shortened a bit for readability. -->
260
<refentry id="re-1007-unmanagechildren-1">
262
<refentrytitle>XtUnmanageChildren</refentrytitle>
263
<refmiscinfo>Xt - Geometry Management</refmiscinfo>
266
<refname>XtUnmanageChildren
268
<refpurpose>remove a list of children from a parent widget's managed
270
<indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm>
271
<indexterm id="ix-1007-unmanagechildren-2"><primary>XtUnmanageChildren</primary></indexterm>
277
<date>4 March 1996</date>
278
</refsynopsisdivinfo>
280
void XtUnmanageChildren(<replaceable class="parameter">children</replaceable>, <replaceable class="parameter">num_children</replaceable>)
281
WidgetList <replaceable class="parameter">children</replaceable>;
282
Cardinal <replaceable class="parameter">num_children</replaceable>;
285
<refsect2 id="r2-1007-unmanagechildren-1">
286
<title>Inputs</title>
289
<term><replaceable class="parameter">children</replaceable>
292
<para>Specifies an array of child widgets. Each child must be of
293
class RectObj or any subclass thereof.
298
<term><replaceable class="parameter">num_children</replaceable>
301
<para>Specifies the number of elements in <replaceable class="parameter">children</replaceable>.
306
</refsect2></refsynopsisdiv>
308
<refsect1 id="r1-1007-unmanagechildren-1">
311
<para><function>XtUnmanageChildren()</function> unmaps the specified widgets
312
and removes them from their parent's geometry management.
313
The widgets will disappear from the screen, and (depending
314
on its parent) may no longer have screen space allocated for
317
<para>Each of the widgets in the <replaceable class="parameter">children</replaceable> array must have
320
<para>See the “Algorithm” section below for full details of the
321
widget unmanagement procedure.
325
<refsect1 id="r1-1007-unmanagechildren-2">
327
<para>Unmanaging widgets is the usual method for temporarily
328
making them invisible. They can be re-managed with
329
<function>XtManageChildren()</function>.
331
<para>You can unmap a widget, but leave it under geometry
332
management by calling <function>XtUnmapWidget()</function>. You can
333
destroy a widget's window without destroying the widget by
334
calling <function>XtUnrealizeWidget()</function>. You can destroy a
335
widget completely with <function>XtDestroyWidget()</function>.
337
<para>If you are only going to unmanage a single widget, it is
338
more convenient to call <function>XtUnmanageChild()</function>. It is
339
often more convenient to call <function>XtUnmanageChild()</function>
340
several times than it is to declare and initialize an array
341
of widgets to pass to <function>XtUnmanageChildren()</function>. Calling
342
<function>XtUnmanageChildren()</function> is more efficient, however,
343
because it only calls the parent's <function>change_managed()</function>
348
<refsect1 id="r1-1007-unmanagechildren-3">
351
<para><function>XtUnmanageChildren()</function> performs the following:
358
<para>Ignores the child if it already is unmanaged or is being
367
<para>Otherwise, if the child is realized, it makes it nonvisible
377
<refsect1 id="r1-1007-unmanagechildren-4">
378
<title>Structures</title>
379
<para>The <type>WidgetList</type> type is simply an array of widgets:
381
<screen id="sc-1007-unmanagechildren-1">typedef Widget *WidgetList;
389
<title>Questions and Answers</title>
391
<!-- (OPTIONAL but recommended) This chapter should include all of the silly
392
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
393
should be reserved for BRIEF questions and answers! If one question uses more
394
than a page or so then it should probably be part of the
395
"Using this Application" chapter instead. You should use links to
396
cross-reference questions to the parts of your documentation that answer them.
397
This is also a great place to provide pointers to other FAQ's if your users
398
must do some complicated configuration on other programs in order for your
399
application work. -->
402
&updating.documentation;
404
<qandaset id="faqlist">
407
<para>My Mouse doesn't work. How do I quit &kredentials;?</para>
410
<para>You silly goose! Check out the <link linkend="commands">Commands
411
Section</link> for the answer.</para>
416
<para>Why can't I twiddle my documents?</para>
419
<para>You can only twiddle your documents if you have the foobar.lib
426
<chapter id="credits">
428
<!-- Include credits for the programmers, documentation writers, and
429
contributors here. The license for your software should then be included below
430
the credits with a reference to the appropriate license file included in the KDE
433
<title>Credits and License</title>
439
Program copyright 2004 Noah Meyerhans <email>noahm@csail.mit.edu</email>
444
<listitem><para>Konqui the KDE Dragon <email>konqui@kde.org</email></para>
446
<listitem><para>Tux the Linux Penguin <email>tux@linux.org</email></para>
452
Documentation copyright 2004 Noah Meyerhans <email>noahm@csail.mit.edu</email>
455
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
457
&underFDL; <!-- FDL: do not remove -->
459
<!-- Determine which license your application is licensed under,
460
and delete all the remaining licenses below:
462
(NOTE: All documentation are licensed under the FDL,
463
regardless of what license the application uses) -->
465
&underGPL; <!-- GPL License -->
466
&underBSDLicense; <!-- BSD License -->
467
&underArtisticLicense; <!-- BSD Artistic License -->
468
&underX11License; <!-- X11 License -->
472
<appendix id="installation">
473
<title>Installation</title>
475
<sect1 id="getting-kredentials">
476
<title>How to obtain &kredentials;</title>
478
<!-- This first entity contains boiler plate for applications that are
479
part of KDE CVS. You should remove it if you are releasing your
482
&install.intro.documentation;
486
<sect1 id="requirements">
487
<title>Requirements</title>
490
List any special requirements for your application here. This should include:
491
.Libraries or other software that is not included in kdesupport,
493
.Hardware requirements like amount of RAM, disk space, graphics card
494
capabilities, screen resolution, special expansion cards, etc.
495
.Operating systems the app will run on. If your app is designed only for a
496
specific OS, (you wrote a graphical LILO configurator for example) put this
501
In order to successfully use &kredentials;, you need &kde; 1.1. Foobar.lib is
502
required in order to support the advanced &kredentials; features. &kredentials; uses
503
about 5 megs of memory to run, but this may vary depending on your
504
platform and configuration.
508
All required libraries as well as &kredentials; itself can be found
509
on <ulink url="ftp://ftp.kredentials.org">The &kredentials; home page</ulink>.
512
<!-- For a list of updates, you may refer to the application web site
513
or the ChangeLog file, or ... -->
515
You can find a list of changes at <ulink
516
url="http://apps.kde.org/kredentials">http://apps.kde.org/kredentials</ulink>.
520
<sect1 id="compilation">
521
<title>Compilation and Installation</title>
523
<!-- This entity contains the boilerplate text for standard -->
524
<!-- compilation instructions. If your application requires any -->
525
<!-- special handling, remove it, and replace with your own text. -->
527
&install.compile.documentation;
531
<sect1 id="configuration">
532
<title>Configuration</title>
534
<para>Don't forget to tell your system to start the <filename>dtd</filename>
535
dicer-toaster daemon first, or &kredentials; won't work !</para>
541
&documentation.index;
547
sgml-minimize-attributes:nil
548
sgml-general-insert-case:lower
553
vim:tabstop=2:shiftwidth=2:expandtab
added
removed
doc/en/index.docbook
