1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Template 2: Applet Manual For GNOME 1.x</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="apa.html" title="A. Document Templates"><link rel="previous" href="apa.html" title="A. Document Templates"><link rel="next" href="apas03.html" title="Template 2: Applet Manual For GNOME 2.x"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Template 2: Applet Manual For GNOME 1.x</th></tr><tr><td width="20%" align="left"><a href="apa.html">Prev</a>�</td><th width="60%" align="center">A. Document Templates</th><td width="20%" align="right">�<a href="apas03.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="template2-1x"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="template2-1x"></a>Template 2: Applet Manual For GNOME 1.x</h2></div></div><p> 2 The following templates should be used for all applet 3 manuals in GNOME 1.x releases. You can always get the latest 4 copy of these templates from <a href="http://developer.gnome.org/projects/gdp/templates.html" target="_top">GDP 5 Documentation Templates</a>. Note that the template 6 consists of two files; the first file calls the second as an 7 entity. You should name the first file 8 <tt><i><tt>appletname</tt></i>-applet.sgml</tt> 9 and the second file should be named 10 <tt><i><tt>appletname</tt></i>.sgml</tt>, 11 where 12 <tt><i><tt>appletname</tt></i></tt> is 13 the name of the applet. 14 <pre class="programlisting"> 15 16 17<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[ 18 <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml"> 19 <!-- Template Version: 1.0.1 (do not remove this line) --> 20]> 21 22<!-- This is a GNOME documentation template, designed by the GNOME 23 Documentation Project Team. Please use it for writing GNOME 24 documentation, making obvious changes. In particular, all the words 25 written in UPPERCASE (with the exception of GNOME) should be 26 replaced. As for "legalnotice", please leave the reference 27 unchanged,make sure to add/remove trademarks to the list as 28 appropriate for your document. 29 30 Please don't forget to remove these comments in your final documentation, 31 thanks ;-). 32--> 33 34<article id="index"> <!-- please do not change the id --> 35 36 <!-- ============= Document Header ============================= --> 37 <artheader> 38 <title>APPLETNAME Applet</title> 39 <copyright> 40 <year>2000</year> 41 <holder>YOURFULLNAME</holder> 42 </copyright> 43 44 <!-- translators: uncomment this: 45 46 <copyright> 47 <year>2000</year> 48 <holder>ME-THE-TRANSLATOR (Latin translation)</holder> 49 </copyright> 50 51 --> 52 53 <!-- do not put authorname in the header except in copyright - use 54 section "authors" below --> 55 56 <legalnotice> 57 <para> 58 Permission is granted to copy, distribute and/or modify this 59 document under the terms of the <citetitle>GNU Free Documentation 60 License</citetitle>, Version 1.1 or any later version published 61 by the Free Software Foundation with no Invariant Sections, no 62 Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy 63 of the <citetitle>GNU Free Documentation License</citetitle> from 64 the Free Software Foundation by visiting <ulink type="http" 65 url="http://www.fsf.org">their Web site</ulink> or by writing to: 66 Free Software Foundation, Inc., 59 Temple Place - Suite 330, 67 Boston, MA 02111-1307, USA. 68 </para> 69 <para> 70 Many of the names used by companies to distinguish their products and 71 services are claimed as trademarks. Where those names appear in any 72 GNOME documentation, and those trademarks are made aware to the members 73 of the GNOME Documentation Project, the names have been printed in caps 74 or initial caps. 75 </para> 76 </legalnotice> 77 78 <releaseinfo> 79 This is version XXX of the APPLETNAME applet manual. 80 </releaseinfo> 81 </artheader> 82 83 <!-- ============= Document Body ============================= --> 84 85 &APPLETNAME.sgml; 86 87</article> 88 89 90 91 92 93</pre> 94 <pre class="programlisting"> 95 96 <!-- Template Version: 1.0.1 (do not remove this line) --> 97 98 <sect1 id="APPLET"> 99 <title>APPLET Applet</title> 100 101 <para> 102 <application>APPLET</application> applet, shown in <xref 103 linkend="APPLETapplet-fig">, allows you to &hellip;. To add this 104 applet to a <interface>Panel</interface>, 105 right-click on the <interface>Panel</interface> and choose 106 <menuchoice> 107 <guimenu>Panel</guimenu> 108 <guisubmenu>Add to panel</guisubmenu> 109 <guisubmenu>Applet</guisubmenu> 110 <guisubmenu>SECTION</guisubmenu> 111 <guimenuitem>APPLET</guimenuitem> 112 </menuchoice>. 113 </para> 114 115 <figure id="APPLETapplet-fig"> 116 <title>APPLET Applet</title> 117 <screenshot> 118 <screeninfo>APPLET Applet</screeninfo> 119 <graphic format="png" fileref="APPLET_applet" 120 srccredit="YOURNAME"> 121 </graphic> 122 </screenshot> 123 </figure> 124 125 <!-- ============= Usage ================================ --> 126 <sect2 id="APPLET-usage"> 127 <title>Usage</title> 128 <para> 129 (Place a short description of how to use the applet here.) 130 </para> 131 132 <para> 133 Right-clicking on the applet brings up a menu containing the 134 following items: 135 <itemizedlist> 136 137 <listitem> 138 <para> 139 <guimenuitem>Properties&hellip;</guimenuitem> &mdash; 140 opens the <link linkend="APPLET-prefs"> 141 <guilabel>Properties</guilabel></link> dialog. 142 </para> 143 </listitem> 144 145 <listitem> 146 <para> 147 <guimenuitem>Help</guimenuitem> &mdash; 148 displays this document. 149 </para> 150 </listitem> 151 152 <listitem> 153 <para> 154 <guimenuitem>About&hellip;</guimenuitem> &mdash; 155 shows basic information about <application>APPLET 156 Applet</application>, including the applet's version and the 157 author's name. 158 </para> 159 </listitem> 160 161 </itemizedlist> 162 </para> 163 </sect2> 164 165 166 <!-- ============= Customization ============================= --> 167 <sect2 id="APPLET-prefs"> 168 <title>Customization</title> 169 <para> 170 You can customize <application>APPLET</application> 171 applet by right-clicking on it and choosing 172 <guimenuitem>Properties&hellip;</guimenuitem>. This will open the 173 <interface>Properties</interface> dialog(shown in <xref 174 linkend="APPLET-settings-fig">), which allows you to 175 change various settings. 176 </para> 177 178 <figure id="APPLET-settings-fig"> 179 <title>Properties dialog</title> 180 <screenshot> 181 <screeninfo>Properties dialog</screeninfo> 182 <graphic format="png" fileref="APPLET_settings" 183 srccredit="YOURNAME"> 184 </graphic> 185 </screenshot> 186 </figure> 187 188 <para> 189 The properties are: 190 <itemizedlist> 191 192 <listitem> 193 <para> 194 (Configuration Item Label) &mdash; If this button is 195 checked&hellip;(description) 196 </para> 197 </listitem> 198 199 <listitem> 200 <para> 201 (Configuration Item Label) &mdash; Selecting this 202 button&hellip;(description) 203 </para> 204 </listitem> 205 206 <listitem> 207 <para> 208 (Configuration Item Label) &mdash; Enter the name of 209 &hellip;(description) 210 </para> 211 </listitem> 212 </itemizedlist> 213 </para> 214 215 <para> 216 After you have made all the changes you want, click on 217 <guibutton>OK</guibutton> to apply the changes and close the 218 <interface>Properties</interface> dialog. To cancel the changes 219 and return to previous values, click the 220 <guibutton>Close</guibutton> button. 221 </para> 222 </sect2> 223 224 225 <!-- ============= Bugs ================================== --> 226 <!-- This section should describe known bugs and limitations of 227 the program if there are any - please be frank and list all 228 problems you know of --> 229 <sect2 id="bugs"> 230 <title>Known Bugs and Limitations</title> 231 <para> 232 This applet has no known bugs. 233 </para> 234 </sect2> 235 236 237 <!-- ============= Authors ================================ --> 238 239 <sect2 id="authors"> 240 <title>Authors</title> 241 <para> 242 <application>APPLET</application> was written by GNOME-HACKER 243 (<email>hacker@gnome.org</email>). Please send all comments, 244 suggestions, and bug 245 reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME 246 bug tracking database</ulink>. (Instructions for submitting bug 247 reports can be found <ulink 248 url="http://bugs.gnome.org/Reporting.html" type="http"> 249 on-line</ulink>. You can also use <application>Bug Report 250 Tool</application> (<command>bug-buddy</command>), available in the 251 <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main 252 Menu</guimenu>, for submitting bug reports. 253 </para> 254 255 <para> 256 This manual was written by ME 257 (<email>MYNAME@MYADDRESS</email>). Please send all comments and 258 suggestions regarding this manual to the <ulink type="http" 259 url="http://developer.gnome.org/projects/gdp">GNOME Documentation 260 Project</ulink> by sending an email to 261 <email>docs@gnome.org</email>. You can also submit comments online 262 by using the <ulink type="http" 263 url="http://www.gnome.org/gdp/doctable/">GNOME Documentation 264 Status Table</ulink>. 265 </para> 266 267 <!-- For translations: uncomment this: 268 269 <para> 270 Latin translation was done by ME 271 (<email>MYNAME@MYADDRESS</email>). Please send all comments and 272 suggestions regarding this translation to SOMEWHERE. 273 </para> 274 275 --> 276 277 </sect2> 278 279 280 <!-- ============= Application License ============================= --> 281 282 <sect2 id="license"> 283 <title>License</title> 284 <para> 285 This program is free software; you can redistribute it and/or 286 modify it under the terms of the <citetitle>GNU General Public 287 License</citetitle> as published by the Free Software Foundation; 288 either version 2 of the License, or (at your option) any later 289 version. 290 </para> 291 <para> 292 This program is distributed in the hope that it will be useful, but 293 WITHOUT ANY WARRANTY; without even the implied warranty of 294 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 295 <citetitle>GNU General Public License</citetitle> for more details. 296 </para> 297 <para> 298 A copy of the <citetitle>GNU General Public License</citetitle> is 299 included as an appendix to the <citetitle>GNOME Users 300 Guide</citetitle>. You may also obtain a copy of the 301 <citetitle>GNU General Public License</citetitle> from the Free 302 Software Foundation by visiting <ulink type="http" 303 url="http://www.fsf.org">their Web site</ulink> or by writing to 304 <address> 305 Free Software Foundation, Inc. 306 <street>59 Temple Place</street> - Suite 330 307 <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode> 308 <country>USA</country> 309 </address> 310 </para> 311 </sect2> 312 313 </sect1> 314 315 316 317 318 319 320 321 322</pre> 323 </p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a href="apa.html">Prev</a>�</td><td width="20%" align="center"><a href="index.html">Home</a></td><td width="40%" align="right">�<a href="apas03.html">Next</a></td></tr><tr><td width="40%" align="left">A. Document Templates�</td><td width="20%" align="center"><a href="apa.html">Up</a></td><td width="40%" align="right">�Template 2: Applet Manual For GNOME 2.x</td></tr></table></div></body></html> 324