The following templates should be used for all applet manuals in GNOME 1.x releases. You can always get the latest copy of these templates from GDP Documentation Templates. Note that the template consists of two files; the first file calls the second as an entity. You should name the first file appletname-applet.sgml and the second file should be named appletname.sgml, where appletname is the name of the applet.
<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[ <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml"> <!-- Template Version: 1.0.1 (do not remove this line) --> ]> <!-- This is a GNOME documentation template, designed by the GNOME Documentation Project Team. Please use it for writing GNOME documentation, making obvious changes. In particular, all the words written in UPPERCASE (with the exception of GNOME) should be replaced. As for "legalnotice", please leave the reference unchanged,make sure to add/remove trademarks to the list as appropriate for your document. Please don't forget to remove these comments in your final documentation, thanks ;-). --> <article id="index"> <!-- please do not change the id --> <!-- ============= Document Header ============================= --> <artheader> <title>APPLETNAME Applet</title> <copyright> <year>2000</year> <holder>YOURFULLNAME</holder> </copyright> <!-- translators: uncomment this: <copyright> <year>2000</year> <holder>ME-THE-TRANSLATOR (Latin translation)</holder> </copyright> --> <!-- do not put authorname in the header except in copyright - use section "authors" below --> <legalnotice> <para> Permission is granted to copy, distribute and/or modify this document under the terms of the <citetitle>GNU Free Documentation License</citetitle>, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy of the <citetitle>GNU Free Documentation License</citetitle> from the Free Software Foundation by visiting <ulink type="http" url="http://www.fsf.org">their Web site</ulink> or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. </para> <para> Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps. </para> </legalnotice> <releaseinfo> This is version XXX of the APPLETNAME applet manual. </releaseinfo> </artheader> <!-- ============= Document Body ============================= --> &APPLETNAME.sgml; </article>
<!-- Template Version: 1.0.1 (do not remove this line) --> <sect1 id="APPLET"> <title>APPLET Applet</title> <para> <application>APPLET</application> applet, shown in <xref linkend="APPLETapplet-fig">, allows you to …. To add this applet to a <interface>Panel</interface>, right-click on the <interface>Panel</interface> and choose <menuchoice> <guimenu>Panel</guimenu> <guisubmenu>Add to panel</guisubmenu> <guisubmenu>Applet</guisubmenu> <guisubmenu>SECTION</guisubmenu> <guimenuitem>APPLET</guimenuitem> </menuchoice>. </para> <figure id="APPLETapplet-fig"> <title>APPLET Applet</title> <screenshot> <screeninfo>APPLET Applet</screeninfo> <graphic format="png" fileref="APPLET_applet" srccredit="YOURNAME"> </graphic> </screenshot> </figure> <!-- ============= Usage ================================ --> <sect2 id="APPLET-usage"> <title>Usage</title> <para> (Place a short description of how to use the applet here.) </para> <para> Right-clicking on the applet brings up a menu containing the following items: <itemizedlist> <listitem> <para> <guimenuitem>Properties…</guimenuitem> — opens the <link linkend="APPLET-prefs"> <guilabel>Properties</guilabel></link> dialog. </para> </listitem> <listitem> <para> <guimenuitem>Help</guimenuitem> — displays this document. </para> </listitem> <listitem> <para> <guimenuitem>About…</guimenuitem> — shows basic information about <application>APPLET Applet</application>, including the applet's version and the author's name. </para> </listitem> </itemizedlist> </para> </sect2> <!-- ============= Customization ============================= --> <sect2 id="APPLET-prefs"> <title>Customization</title> <para> You can customize <application>APPLET</application> applet by right-clicking on it and choosing <guimenuitem>Properties…</guimenuitem>. This will open the <interface>Properties</interface> dialog(shown in <xref linkend="APPLET-settings-fig">), which allows you to change various settings. </para> <figure id="APPLET-settings-fig"> <title>Properties dialog</title> <screenshot> <screeninfo>Properties dialog</screeninfo> <graphic format="png" fileref="APPLET_settings" srccredit="YOURNAME"> </graphic> </screenshot> </figure> <para> The properties are: <itemizedlist> <listitem> <para> (Configuration Item Label) — If this button is checked…(description) </para> </listitem> <listitem> <para> (Configuration Item Label) — Selecting this button…(description) </para> </listitem> <listitem> <para> (Configuration Item Label) — Enter the name of …(description) </para> </listitem> </itemizedlist> </para> <para> After you have made all the changes you want, click on <guibutton>OK</guibutton> to apply the changes and close the <interface>Properties</interface> dialog. To cancel the changes and return to previous values, click the <guibutton>Close</guibutton> button. </para> </sect2> <!-- ============= Bugs ================================== --> <!-- This section should describe known bugs and limitations of the program if there are any - please be frank and list all problems you know of --> <sect2 id="bugs"> <title>Known Bugs and Limitations</title> <para> This applet has no known bugs. </para> </sect2> <!-- ============= Authors ================================ --> <sect2 id="authors"> <title>Authors</title> <para> <application>APPLET</application> was written by GNOME-HACKER (<email>hacker@gnome.org</email>). Please send all comments, suggestions, and bug reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME bug tracking database</ulink>. (Instructions for submitting bug reports can be found <ulink url="http://bugs.gnome.org/Reporting.html" type="http"> on-line</ulink>. You can also use <application>Bug Report Tool</application> (<command>bug-buddy</command>), available in the <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main Menu</guimenu>, for submitting bug reports. </para> <para> This manual was written by ME (<email>MYNAME@MYADDRESS</email>). Please send all comments and suggestions regarding this manual to the <ulink type="http" url="http://developer.gnome.org/projects/gdp">GNOME Documentation Project</ulink> by sending an email to <email>docs@gnome.org</email>. You can also submit comments online by using the <ulink type="http" url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status Table</ulink>. </para> <!-- For translations: uncomment this: <para> Latin translation was done by ME (<email>MYNAME@MYADDRESS</email>). Please send all comments and suggestions regarding this translation to SOMEWHERE. </para> --> </sect2> <!-- ============= Application License ============================= --> <sect2 id="license"> <title>License</title> <para> This program is free software; you can redistribute it and/or modify it under the terms of the <citetitle>GNU General Public License</citetitle> as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. </para> <para> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the <citetitle>GNU General Public License</citetitle> for more details. </para> <para> A copy of the <citetitle>GNU General Public License</citetitle> is included as an appendix to the <citetitle>GNOME Users Guide</citetitle>. You may also obtain a copy of the <citetitle>GNU General Public License</citetitle> from the Free Software Foundation by visiting <ulink type="http" url="http://www.fsf.org">their Web site</ulink> or by writing to <address> Free Software Foundation, Inc. <street>59 Temple Place</street> - Suite 330 <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode> <country>USA</country> </address> </para> </sect2> </sect1>