TDE core libraries
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

template.docbook 17KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  3. <!-- Define an entity for your application if it is not part of TDE
  4. CVS -->
  5. <!ENTITY kmyapplication "<application>KMyApp</application>">
  6. <!ENTITY kappname "&kmyapplication;"><!-- replace kmyapplication here
  7. do *not* replace kappname-->
  8. <!ENTITY package "kde-module"><!-- tdebase, tdeadmin, etc. Leave
  9. this unchanged if your
  10. application is not maintained in TDE GIT -->
  11. <!ENTITY % addindex "IGNORE">
  12. <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English
  13. original documentation, change
  14. the language here -->
  15. <!-- Do not define any other entities; instead, use the entities
  16. from entities/general.entities and $LANG/user.entities. -->
  17. ]>
  18. <!-- kdoctemplate v0.9 January 10 2003
  19. Changes to comments to clarify entity usage January 10 2003
  20. Minor update to "Credits and Licenses" section on August 24, 2000
  21. Removed "Revision history" section on 22 January 2001
  22. Changed to Installation/Help menu entities 18 October 2001
  23. Other minor cleanup and changes 18 October 2001
  24. FPI change and minor changes November 2002 -->
  25. <!--
  26. This template was designed by: David Rugge davidrugge@mindspring.com
  27. with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
  28. and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
  29. of the KDE DocBook team.
  30. You may freely use this template for writing any sort of TDE documentation.
  31. If you have any changes or improvements, please let us know.
  32. Remember:
  33. - in XML, the case of the <tags> and attributes is relevant ;
  34. - also, quote all attributes.
  35. Please don't forget to remove all these comments in your final documentation,
  36. thanks ;-).
  37. -->
  38. <!-- ................................................................ -->
  39. <!-- The language must NOT be changed here. -->
  40. <!-- If you are writing original documentation in a language other -->
  41. <!-- than English, change the language above ONLY, not here -->
  42. <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 -->
  45. <bookinfo>
  46. <title>The &kmyapplication; Handbook</title>
  47. <authorgroup>
  48. <author>
  49. <!-- This is just put in as an example. For real documentation, please
  50. define a general entity in entities/contributor.entities, e.g.
  51. <!ENTITY George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>">
  52. <!ENTITY George.N.Ugnacious.mail "<email>gnu@kde.org</email>">
  53. and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
  54. -->
  55. <personname>
  56. <firstname>George</firstname>
  57. <othername>N.</othername>
  58. <surname>Ugnacious</surname>
  59. </personname>
  60. <email>gnu@kde.org</email>
  61. </author>
  62. </authorgroup>
  63. <!-- TRANS:ROLES_OF_TRANSLATORS -->
  64. <copyright>
  65. <year>2002</year>
  66. <holder>George N. Ugnacious</holder>
  67. </copyright>
  68. <!-- Translators: put here the copyright notice of the translation -->
  69. <!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook
  70. and in the FDL itself on how to use it. -->
  71. <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. -->
  78. <date>2003-01-10</date>
  79. <releaseinfo>1.01.00</releaseinfo>
  80. <!-- Abstract about this handbook -->
  81. <abstract>
  82. <para>
  83. &kmyapplication; is an application specially designed to do nothing you would
  84. ever want.
  85. </para>
  86. </abstract>
  87. <!-- This is a set of Keywords for indexing by search engines.
  88. Please at least include TDE, the TDE package it is in, the name
  89. of your application, and a few relevant keywords. -->
  90. <keywordset>
  91. <keyword>TDE</keyword>
  92. <keyword>tdeutils</keyword>
  93. <keyword>Kapp</keyword>
  94. <keyword>nothing</keyword>
  95. <keyword>nothing else</keyword>
  96. </keywordset>
  97. </bookinfo>
  98. <!-- The contents of the documentation begin here. Label
  99. each chapter so with the id attribute. This is necessary for two reasons: it
  100. allows you to easily reference the chapter from other chapters of your
  101. document, and if there is no ID, the name of the generated HTML files will vary
  102. from time to time making it hard to manage for maintainers and for the CVS
  103. system. Any chapter labelled (OPTIONAL) may be left out at the author's
  104. discretion. Other chapters should not be left out in order to maintain a
  105. consistent documentation style across all TDE apps. -->
  106. <chapter id="introduction">
  107. <title>Introduction</title>
  108. <!-- The introduction chapter contains a brief introduction for the
  109. application that explains what it does and where to report
  110. problems. Basically a long version of the abstract. Don't include a
  111. revision history. (see installation appendix comment) -->
  112. <para>
  113. &kmyapplication; is a program that lets you do absolutely nothing. Please report
  114. any problems or feature requests to the &tde; mailing lists.
  115. </para>
  116. </chapter>
  117. <chapter id="using-kapp">
  118. <title>Using &kmyapplication;</title>
  119. <!-- This chapter should tell the user how to use your app. You should use as
  120. many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
  121. your application. -->
  122. <para>
  123. <!-- Note that all graphics should be in .png format. Use no gifs because of
  124. patent issues. -->
  125. <screenshot>
  126. <screeninfo>Here's a screenshot of &kmyapplication;</screeninfo>
  127. <mediaobject>
  128. <imageobject>
  129. <imagedata fileref="screenshot.png" format="PNG"/>
  130. </imageobject>
  131. <imageobject>
  132. <imagedata fileref="screenshot.eps" format="EPS"/>
  133. </imageobject>
  134. <textobject>
  135. <phrase>Screenshot</phrase>
  136. </textobject>
  137. </mediaobject>
  138. </screenshot>
  139. </para>
  140. <sect1 id="kapp-features">
  141. <title>More &kmyapplication; features</title>
  142. <para>It slices! It dices! and it comes with a free toaster!</para>
  143. <para>
  144. The Squiggle Tool <guiicon><inlinemediaobject>
  145. <imageobject>
  146. <imagedata fileref="squiggle.png" format="PNG"/>
  147. </imageobject>
  148. <imageobject>
  149. <imagedata fileref="squiggle.eps" format="EPS"/>
  150. </imageobject>
  151. <textobject>
  152. <phrase>Squiggle</phrase>
  153. </textobject>
  154. </inlinemediaobject></guiicon> is used to draw squiggly lines all over
  155. the &kmyapplication; main window. It's not a bug, it's a feature!
  156. </para>
  157. </sect1>
  158. </chapter>
  159. <chapter id="commands">
  160. <title>Command Reference</title>
  161. <!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
  162. application windows and their menubar and toolbar commands for easy reference.
  163. Also include any keys that have a special function but have no equivalent in the
  164. menus or toolbars. This may not be necessary for small apps or apps with no tool
  165. or menu bars. -->
  166. <sect1 id="kapp-mainwindow">
  167. <title>The main &kmyapplication; window</title>
  168. <sect2>
  169. <title>The File Menu</title>
  170. <para>
  171. <variablelist>
  172. <varlistentry>
  173. <term><menuchoice>
  174. <shortcut>
  175. <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
  176. </shortcut>
  177. <guimenu>File</guimenu>
  178. <guimenuitem>New</guimenuitem>
  179. </menuchoice></term>
  180. <listitem><para><action>Creates a new document</action></para></listitem>
  181. </varlistentry>
  182. <varlistentry>
  183. <term><menuchoice>
  184. <shortcut>
  185. <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
  186. </shortcut>
  187. <guimenu>File</guimenu>
  188. <guimenuitem>Save</guimenuitem>
  189. </menuchoice></term>
  190. <listitem><para><action>Saves the document</action></para></listitem>
  191. </varlistentry>
  192. <varlistentry>
  193. <term><menuchoice>
  194. <shortcut>
  195. <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
  196. </shortcut>
  197. <guimenu>File</guimenu>
  198. <guimenuitem>Quit</guimenuitem>
  199. </menuchoice></term>
  200. <listitem><para><action>Quits</action> &kmyapplication;</para></listitem>
  201. </varlistentry>
  202. </variablelist>
  203. </para>
  204. </sect2>
  205. <sect2>
  206. <title>The <guimenu>Help</guimenu> Menu</title>
  207. <!-- Assuming you have a standard help menu (help, what's this, about -->
  208. <!-- &kmyapplication;, about TDE) then the documentation is already written. -->
  209. <!-- The following entity is valid anywhere that a variablelist is -->
  210. <!-- valid. -->
  211. &help.menu.documentation;
  212. </sect2>
  213. </sect1>
  214. </chapter>
  215. <chapter id="developers">
  216. <title>Developer's Guide to &kmyapplication;</title>
  217. <!-- (OPTIONAL) A Programming/Scripting reference chapter should be
  218. used for apps that use plugins or that provide their own scripting hooks
  219. and/or development libraries. -->
  220. <para>
  221. Programming &kmyapplication; plugins is a joy to behold. Just read through the next
  222. 66 pages of API's to learn how!
  223. </para>
  224. <!-- Use refentries to describe APIs. Refentries are fairly complicated and you
  225. should consult the docbook reference for further details. The example below was
  226. taken from that reference and shortened a bit for readability. -->
  227. <refentry id="re-1007-unmanagechildren-1">
  228. <refmeta>
  229. <refentrytitle>XtUnmanageChildren</refentrytitle>
  230. <refmiscinfo>Xt - Geometry Management</refmiscinfo>
  231. </refmeta>
  232. <refnamediv>
  233. <refname>XtUnmanageChildren
  234. </refname>
  235. <refpurpose>remove a list of children from a parent widget's managed
  236. list.
  237. <indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm>
  238. <indexterm id="ix-1007-unmanagechildren-2"><primary>XtUnmanageChildren</primary></indexterm>
  239. </refpurpose>
  240. </refnamediv>
  241. <refsynopsisdiv>
  242. <refsynopsisdivinfo>
  243. <date>4 March 1996</date>
  244. </refsynopsisdivinfo>
  245. <synopsis>
  246. void XtUnmanageChildren(<replaceable class="parameter">children</replaceable>, <replaceable class="parameter">num_children</replaceable>)
  247. WidgetList <replaceable class="parameter">children</replaceable>;
  248. Cardinal <replaceable class="parameter">num_children</replaceable>;
  249. </synopsis>
  250. <refsect2 id="r2-1007-unmanagechildren-1">
  251. <title>Inputs</title>
  252. <variablelist>
  253. <varlistentry>
  254. <term><replaceable class="parameter">children</replaceable>
  255. </term>
  256. <listitem>
  257. <para>Specifies an array of child widgets. Each child must be of
  258. class RectObj or any subclass thereof.
  259. </para>
  260. </listitem>
  261. </varlistentry>
  262. <varlistentry>
  263. <term><replaceable class="parameter">num_children</replaceable>
  264. </term>
  265. <listitem>
  266. <para>Specifies the number of elements in <replaceable class="parameter">children</replaceable>.
  267. </para>
  268. </listitem>
  269. </varlistentry>
  270. </variablelist>
  271. </refsect2></refsynopsisdiv>
  272. <refsect1 id="r1-1007-unmanagechildren-1">
  273. <title>Description
  274. </title>
  275. <para><function>XtUnmanageChildren()</function> unmaps the specified widgets
  276. and removes them from their parent's geometry management.
  277. The widgets will disappear from the screen, and (depending
  278. on its parent) may no longer have screen space allocated for
  279. them.
  280. </para>
  281. <para>Each of the widgets in the <replaceable class="parameter">children</replaceable> array must have
  282. the same parent.
  283. </para>
  284. <para>See the &ldquo;Algorithm&rdquo; section below for full details of the
  285. widget unmanagement procedure.
  286. </para>
  287. </refsect1>
  288. <refsect1 id="r1-1007-unmanagechildren-2">
  289. <title>Usage</title>
  290. <para>Unmanaging widgets is the usual method for temporarily
  291. making them invisible. They can be re-managed with
  292. <function>XtManageChildren()</function>.
  293. </para>
  294. <para>You can unmap a widget, but leave it under geometry
  295. management by calling <function>XtUnmapWidget()</function>. You can
  296. destroy a widget's window without destroying the widget by
  297. calling <function>XtUnrealizeWidget()</function>. You can destroy a
  298. widget completely with <function>XtDestroyWidget()</function>.
  299. </para>
  300. <para>If you are only going to unmanage a single widget, it is
  301. more convenient to call <function>XtUnmanageChild()</function>. It is
  302. often more convenient to call <function>XtUnmanageChild()</function>
  303. several times than it is to declare and initialize an array
  304. of widgets to pass to <function>XtUnmanageChildren()</function>. Calling
  305. <function>XtUnmanageChildren()</function> is more efficient, however,
  306. because it only calls the parent's <function>change_managed()</function>
  307. method once.
  308. </para>
  309. </refsect1>
  310. <refsect1 id="r1-1007-unmanagechildren-3">
  311. <title>Algorithm
  312. </title>
  313. <para><function>XtUnmanageChildren()</function> performs the following:
  314. </para>
  315. <variablelist>
  316. <varlistentry>
  317. <term>-
  318. </term>
  319. <listitem>
  320. <para>Ignores the child if it already is unmanaged or is being
  321. destroyed.
  322. </para>
  323. </listitem>
  324. </varlistentry>
  325. <varlistentry>
  326. <term>-
  327. </term>
  328. <listitem>
  329. <para>Otherwise, if the child is realized, it makes it nonvisible
  330. by unmapping it.
  331. </para>
  332. </listitem>
  333. </varlistentry>
  334. </variablelist>
  335. <para>
  336. </para>
  337. </refsect1>
  338. <refsect1 id="r1-1007-unmanagechildren-4">
  339. <title>Structures</title>
  340. <para>The <type>WidgetList</type> type is simply an array of widgets:
  341. </para>
  342. <screen id="sc-1007-unmanagechildren-1">typedef Widget *WidgetList;
  343. </screen>
  344. </refsect1>
  345. </refentry>
  346. </chapter>
  347. <chapter id="faq">
  348. <title>Questions and Answers</title>
  349. <!-- (OPTIONAL but recommended) This chapter should include all of the silly
  350. (and not-so-silly) newbie questions that fill up your mailbox. This chapter
  351. should be reserved for BRIEF questions and answers! If one question uses more
  352. than a page or so then it should probably be part of the
  353. "Using this Application" chapter instead. You should use links to
  354. cross-reference questions to the parts of your documentation that answer them.
  355. This is also a great place to provide pointers to other FAQ's if your users
  356. must do some complicated configuration on other programs in order for your
  357. application work. -->
  358. &reporting.bugs;
  359. &updating.documentation;
  360. <qandaset id="faqlist">
  361. <qandaentry>
  362. <question>
  363. <para>My Mouse doesn't work. How do I quit &kmyapplication;?</para>
  364. </question>
  365. <answer>
  366. <para>You silly goose! Check out the <link linkend="commands">Commands
  367. Section</link> for the answer.</para>
  368. </answer>
  369. </qandaentry>
  370. <qandaentry>
  371. <question>
  372. <para>Why can't I twiddle my documents?</para>
  373. </question>
  374. <answer>
  375. <para>You can only twiddle your documents if you have the foobar.lib
  376. installed.</para>
  377. </answer>
  378. </qandaentry>
  379. </qandaset>
  380. </chapter>
  381. <chapter id="credits">
  382. <!-- Include credits for the programmers, documentation writers, and
  383. contributors here. The license for your software should then be included below
  384. the credits with a reference to the appropriate license file included in the TDE
  385. distribution. -->
  386. <title>Credits and License</title>
  387. <para>
  388. &kmyapplication;
  389. </para>
  390. <para>
  391. Program copyright 1997 John Q. Hacker <email>jqh@kde.org</email>
  392. </para>
  393. <para>
  394. Contributors:
  395. <itemizedlist>
  396. <listitem><para>Konqui the TDE Dragon</para>
  397. </listitem>
  398. <listitem><para>Tux the Linux Penguin</para>
  399. </listitem>
  400. </itemizedlist>
  401. </para>
  402. <para>
  403. Documentation Copyright &copy; 1999 George N. Ugnacious <email>gnu@kde.org</email>
  404. </para>
  405. <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
  406. &underFDL; <!-- FDL: do not remove -->
  407. <!-- Determine which license your application is licensed under,
  408. and delete all the remaining licenses below:
  409. (NOTE: All documentation are licensed under the FDL,
  410. regardless of what license the application uses) -->
  411. &underGPL; <!-- GPL License -->
  412. &underBSDLicense; <!-- BSD License -->
  413. &underArtisticLicense; <!-- BSD Artistic License -->
  414. &underX11License; <!-- X11 License -->
  415. </chapter>
  416. <appendix id="installation">
  417. <title>Installation</title>
  418. <sect1 id="getting-kapp">
  419. <title>How to obtain &kmyapplication;</title>
  420. <!-- This first entity contains boiler plate for applications that are
  421. part of TDE GIT. You should remove it if you are releasing your
  422. application -->
  423. &install.intro.documentation;
  424. </sect1>
  425. <sect1 id="requirements">
  426. <title>Requirements</title>
  427. <!--
  428. List any special requirements for your application here. This should include:
  429. .Libraries or other software that is not included in tdesupport,
  430. tdelibs, or tdebase.
  431. .Hardware requirements like amount of RAM, disk space, graphics card
  432. capabilities, screen resolution, special expansion cards, etc.
  433. .Operating systems the app will run on. If your app is designed only for a
  434. specific OS, (you wrote a graphical LILO configurator for example) put this
  435. information here.
  436. -->
  437. <para>
  438. In order to successfully use &kmyapplication;, you need &tde; R14. Foobar.lib is
  439. required in order to support the advanced &kmyapplication; features. &kmyapplication; uses
  440. about 5 megs of memory to run, but this may vary depending on your
  441. platform and configuration.
  442. </para>
  443. <para>
  444. All required libraries as well as &kmyapplication; itself can be found
  445. on <ulink url="ftp://ftp.kapp.org">The &kmyapplication; home page</ulink>.
  446. </para>
  447. <!-- For a list of updates, you may refer to the application web site
  448. or the ChangeLog file, or ... -->
  449. <para>
  450. You can find a list of changes at <ulink
  451. url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>.
  452. </para>
  453. </sect1>
  454. <sect1 id="compilation">
  455. <title>Compilation and Installation</title>
  456. <!-- This entity contains the boilerplate text for standard -->
  457. <!-- compilation instructions. If your application requires any -->
  458. <!-- special handling, remove it, and replace with your own text. -->
  459. &install.compile.documentation;
  460. </sect1>
  461. <sect1 id="configuration">
  462. <title>Configuration</title>
  463. <para>Don't forget to tell your system to start the <filename>dtd</filename>
  464. dicer-toaster daemon first, or &kmyapplication; won't work !</para>
  465. </sect1>
  466. </appendix>
  467. &documentation.index;
  468. </book>
  469. <!--
  470. Local Variables:
  471. mode: xml
  472. sgml-minimize-attributes:nil
  473. sgml-general-insert-case:lower
  474. sgml-indent-step:0
  475. sgml-indent-data:nil
  476. End:
  477. vim:tabstop=2:shiftwidth=2:expandtab
  478. kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
  479. -->