- First draft of an applet manual template, based on

2006-12-10  Joachim Noreiko  <jnoreiko@yahoo.com>

	* data/templates/gnome-applet-template.xml:
	- First draft of an applet manual template, based on
	  http://developer.gnome.org/projects/gdp/templates.html

1 files changed, 522 insertions, 0 deletions

diff --git a/data/templates/gnome-applet-template.xml b/data/templates/gnome-applet-template.xml
new file mode 100644
index 0000000..178cc2c
--- /dev/null
+++ b/data/templates/gnome-applet-template.xml
@@ -0,0 +1,522 @@
+<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+  <!ENTITY applet "<application>MY-GNOME-APPLET</application>">
+  <!ENTITY appletversion "2.0">
+  <!ENTITY manrevision   "2.0">
+  <!ENTITY date "March 2002">
+
+  <!-- Information about the entities.
+       The legal.xml file contains legal information, there is no need to edit the file. 
+       Use the appletversion entity to specify the version of the applet.
+       Use the manrevision entity to specify the revision number of this manual.
+       Use the date entity to specify the release date of this manual.
+       Use the applet entity to specify the name of the applet. -->
+
+]>
+<!-- 
+  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.
+
+  Remember that this is a guide, rather than a perfect model to follow
+  slavishly. Make your manual logical and readable.  And don't forget
+  to remove these comments in your final documentation!  ;-)
+-->
+<!-- 
+      (Do not remove this comment block.)
+  Maintained by the GNOME Documentation Project
+  http://developer.gnome.org/projects/gdp
+  Template version: 3.0 beta
+  Template last modified 2006-12-10 and whatever it says in CVS
+-->
+<!-- =============Document Header ============================= -->
+
+<article id="index" lang="en">
+<!-- please do not change the id; for translations, change lang to -->
+<!-- appropriate code -->
+  <articleinfo> 
+	  <title>&applet; Applet Manual</title> 
+
+    <copyright> 
+      <year>2006</year> 
+      <holder>GNOME Documentation Project</holder> 
+    </copyright> 
+
+    <!-- An address can be added to the publisher information. -->
+    <publisher role="maintainer"> 
+      <publishername>GNOME Documentation Project</publishername> 
+    </publisher>
+
+	  <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <!-- The file legal.xml contains link to license for the documentation, 
+        and other legal stuff such as "NO WARRANTY" statement. 
+        Please do not change any of this. -->
+
+    <authorgroup> 
+      <author> 
+    		<firstname>Documentation</firstname> 
+    		<surname>Writer 2</surname> 
+    		<affiliation> 
+  	  		<orgname>GNOME Documentation Project</orgname> 
+  	  		<!-- The email address of the author is optional and is commented out by default. 
+  			<address> <email>doc-writer2@gnome.org</email> </address> 
+  			-->
+    		</affiliation> 
+      </author> 
+      <author> 
+    		<firstname>Documentation</firstname> 
+    		<surname>Writer 1</surname> 
+    		<affiliation> 
+  	  		<orgname>GNOME Documentation Project</orgname> 
+  	  		<!-- The email address of the author is optional and is commented out by default. 
+  			<address> <email>doc-writer2@gnome.org</email> </address> 
+  			-->
+    		</affiliation> 
+      </author> 
+    </authorgroup>
+
+<!-- According to GNU FDL, revision history is mandatory if you are -->
+<!-- modifying/reusing someone else's document.  If not, you can omit it. -->
+<!-- Remember to remove the &manrevision; entity from the revision entries other
+-->
+<!-- than the current revision. -->
+<!-- The revision numbering system for GNOME manuals is as follows: -->
+<!-- * the revision number consists of two components -->
+<!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
+<!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
+<!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
+<!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
+<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
+<!-- to V3.0, and so on. -->  
+	 <revhistory>
+		<revision> 
+		  <revnumber>&applet; Applet Manual V&manrevision;</revnumber> 
+		  <date>&date;</date> 
+		  <revdescription> 
+			 <para role="author">Documentation Writer 2
+				<email>docwriter2@gnome.org</email></para> 
+			 <para role="publisher">GNOME Documentation Project</para> 
+		  </revdescription> 
+		</revision> 
+		<revision> 
+		  <revnumber>Full title of previous manual.</revnumber> 
+		  <date>Release date of previous manual.</date> 
+		  <revdescription> 
+			 <para role="author">Documentation Writer 1
+				<email>docwriter2@gnome.org</email></para> 
+			 <para role="publisher">GNOME Documentation Project</para> 
+		  </revdescription> 
+		</revision> 
+	 </revhistory> 
+	 <releaseinfo> This manual describes version &appletversion; of &applet;.
+		</releaseinfo> 
+		
+    <legalnotice> 
+      <title>Feedback</title> 
+      <para>To report a bug or make a suggestion regarding the &app; applet or
+      this manual, follow the directions in the 
+      <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>. 
+      </para>
+<!-- Translators may also add here feedback address for translations -->
+    </legalnotice> 
+    
+  </articleinfo> 
+  <indexterm zone="index"> 
+	 <primary>MY-GNOME-APPLET</primary> 
+  </indexterm> 
+  <indexterm zone="index"> 
+	 <primary>mygnomeapplet</primary> 
+  </indexterm>
+<!-- ============= Document Body ============================= -->
+<!-- ============= Introduction ============================== -->
+<!-- Use the Introduction section to give a brief overview of what
+     the applet is and what it does. -->
+  <sect1 id="myapplet-introduction"> 
+    <title>Introduction</title> 
+    <!-- You should start the Introduction with a screenshot of the applet in a panel -->
+
+    <!-- ==== Figure ============================================= -->
+    <figure id="applet-fig"> 
+    <title>&applet; Applet</title> 
+    <screenshot> 
+      <mediaobject> 
+    	 <imageobject><imagedata fileref="figures/myapplet_applet.png"
+    		format="PNG"/> 
+    	 </imageobject>
+      <!-- EPS versions of the figures are not required at the moment. -->
+    <!-- 
+        <imageobject>
+      		<imagedata fileref="figures/myapplet_applet.ps" format="EPS"/>
+    		    </imageobject>
+        -->
+    	 <textobject> 
+    		<phrase>Shows &applet; applet. Contains default character buttons.
+    		</phrase> 
+    	 </textobject> 
+      </mediaobject> 
+    </screenshot> 
+    </figure> 
+    <!-- ==== End of Figure ======================================= -->
+
+    <para>
+    Use &applet; applet to quickly access magic beans from a panel.
+    With &applet;, you can plant beans, watch the grow, and climb up them to kill giants.
+    </para>
+
+    <para>To add &applet; to a panel:</para>
+    <orderedlist>
+      <listitem>
+        <para>Right-click on the panel to open the panel popup menu, then choose 
+        <menuchoice> 
+          <guimenu>Add to Panel</guimenu>
+        </menuchoice>.
+        </para>
+      </listitem>
+      <listitem>
+        <para>Select &applet; in the <guilabel>Add to Panel</guilabel> dialog, then click <guibutton>Add</guibutton>.</para>
+      </listitem>
+    </orderedlist>
+    <para>
+    For more information on this, see the <ulink url="ghelp:user-guide?panels-addobject" type="help">GNOME User Guide</ulink>.
+     </para> 
+  </sect1>
+
+<!-- ================ Usage ================================ -->
+<!-- Use this section to describe how to use the applet to perform the tasks for 
+     which the applet is designed. -->
+  <sect1 id="myapplet-usage"> 
+	 <title>Usage</title> 
+	 <para>When you add &applet; to a panel for the
+		first time, the applet displays a default list of characters. You can select a
+		character from the default list, or you can select a character from predefined
+		groups of characters. Each predefined group of characters is associated with a
+		standard character on your keyboard. 
+    </para>
+
+	 <!-- ================ Usage Subsection ================================ -->
+	 <sect2 id="myapplet-charselect"> 
+		<title>Topic 1</title> 
+		<para>To select a character from the applet
+and insert the character into a text 
+		string, perform the following steps: 
+		  <orderedlist> 
+			 <listitem> 
+				<para>Click on the character in the applet that you require. The
+				  character button is pressed in to indicate that the character is selected.
+				  </para> 
+			 </listitem> 
+			 <listitem> 
+				<para>Point to the location in an application where you want to put
+				  the character and middle-click to insert the character. You can also paste the
+				  character into the application if a paste facility is available. You can repeat
+				  the insertion as many times as you want because the character remains selected
+				  until you click on another character in the applet. </para> 
+			 </listitem> 
+		  </orderedlist></para> 
+		<para>Some applications do not support the full ISO-8859-1 character set
+		  specification. You can not insert unsupported characters into an
+		  application.</para> 
+	 </sect2> 
+    <!-- ================ Usage Subsection ================================ -->
+
+	 <sect2 id="myapplet-display-chargroup"> 
+		<title>Topic 2</title> 
+		<para>You can change the characters that are displayed in the applet from
+		  the default list to a predefined group of characters.</para> 
+		<para>To display a group of predefined characters, perform the following
+		  steps: 
+		  <orderedlist> 
+			 <listitem> 
+				<para>Click on any character in the default list to activate the
+				  applet. </para> 
+			 </listitem> 
+			 <listitem> 
+				<para>Press the keyboard character that is associated with the
+				  group of characters that you want to display. For example, press 
+				  <keycap>A</keycap> to display the group of characters in the
+				  following figure. 
+              <!-- ==== Figure ============================================= -->
+
+				  <figure id="applet-fig2"> 
+					 <title>Character Group Associated With the A Key</title> 
+					 <screenshot> 
+						<mediaobject> 
+						  <imageobject><imagedata fileref="figures/myapplet_fig2"
+							 format="PNG"/> 
+						  </imageobject>
+              <!-- EPS versions of the figures are not required at the moment. -->
+<!-- 
+		              <imageobject>
+      		        <imagedata fileref="figures/myapplet_fig2" format="EPS"/>
+    		           </imageobject>
+		        -->
+						  <textobject> 
+							 <phrase>Screen shot of the character group associated
+								with the "A" key. </phrase> 
+						  </textobject> 
+						</mediaobject> 
+					 </screenshot> 
+				  </figure> 
+              <!-- ==== End of Figure ======================================= -->
+
+				</para> 
+			 </listitem> 
+		  </orderedlist></para> 
+		<para>You can select the character that you require from the group of
+		  characters in the applet, then insert the character into your text string.
+		  </para> 
+		<para>The following chart lists keyboard characters and their associated
+		  groups of characters. The keyboard characters are listed in the first column of
+		  each section in the chart. The character groups that are associated with each
+		  keyboard character are shown in the other columns. </para>
+      <!-- ==== Figure ============================================= -->
+		<figure id="applet-fig3"> 
+		  <title>Character Groups Associated With Keyboard Keys</title> 
+		  <screenshot> 
+			 <mediaobject> 
+				<imageobject><imagedata fileref="figures/myapplet_fig3"
+				  format="PNG"/> 
+				</imageobject>
+
+          <!-- EPS versions of the figures are not required at the moment. -->
+<!-- 
+		    <imageobject>
+      		<imagedata fileref="figures/myapplet_fig3" format="EPS"/>
+    		    </imageobject>
+		    -->
+				<textobject> 
+				  <phrase>Screen shot of character groups associated with various
+					 keyboard keys. </phrase> 
+				</textobject> 
+			 </mediaobject> 
+		  </screenshot> 
+		</figure> 
+      <!-- ==== End of Figure ======================================= -->
+	 </sect2> 
+    <!-- ================ Usage Subsection ================================ -->
+	 <sect2 id="myapplet-default-list"> 
+		<title>Topic 3</title> 
+		<para>To return to the current default character list, click on any
+		  character in the applet, then press the space bar on your keyboard. </para> 
+	 </sect2>
+
+    <!-- ================ Usage Subsection ================================ -->
+	 <sect2 id="myapplet-default-new"> 
+		<title>Topic 4</title> 
+		<para>You can use a character selection application such as
+		  <application>GNOME Character Map</application> to set up a new default list.
+		  For example, to create a new default list with <application>GNOME Character
+		  Map</application>, perform the following steps: </para> 
+		<orderedlist> 
+		  <listitem> 
+			 <para> Right-click anywhere in the applet, then select 
+				<guimenuitem>Properties</guimenuitem>. </para> 
+		  </listitem> 
+		  <listitem> 
+			 <para> In the 
+				<guilabel>Character Picker Settings</guilabel> dialog, click on the
+				
+				<guilabel>Default List</guilabel> tab. </para> 
+		  </listitem> 
+		  <listitem> 
+			 <para> Select the contents of the 
+				<guilabel>Default character list</guilabel> text box, then press 
+				<keycap>Back Space</keycap> to delete the current default list.
+				</para> 
+		  </listitem> 
+		  <listitem> 
+			 <para> Open <application>GNOME Character Map</application>, then
+				select the characters you want for your new default list. You can select up to
+				25 characters. </para> 
+		  </listitem> 
+		  <listitem> 
+			 <para> Copy the contents of the 
+				<guilabel>Text to copy</guilabel> text box from <application>GNOME
+				Character Map</application> to the 
+				<guilabel>Default character list</guilabel> text box. </para> 
+		  </listitem> 
+		  <listitem> 
+			 <para> Click 
+				<guibutton>Apply</guibutton> to view the new default list in the
+				applet, then click 
+				<guibutton>OK</guibutton>. </para> 
+		  </listitem> 
+		</orderedlist> 
+	 </sect2> 
+    <!-- ================ Usage Subsection ================================ -->
+
+	 <sect2 id="myapplet-change-size"> 
+		<title>Topic 5</title> 
+		<para>You can configure the size characteristics of the applet in the
+		  following ways: 
+		  <itemizedlist> 
+			 <listitem> 
+				<para>To make the applet adjust to fit into a panel, select the 
+				  <guilabel>Follow panel size</guilabel> option, see 
+				  <xref linkend="myapplet-size"/>. The only other options you
+				  can specify in this case are the minimum number of cells and the size of the
+				  cells. The applet adjusts the number of rows and columns to fit the display to
+				  the panel dimensions in the most optimum way. </para> 
+			 </listitem> 
+			 <listitem> 
+				<para>To make the panel adjust to accommodate the applet, deselect
+				  the 
+				  <guilabel>Follow panel size</guilabel> option, see 
+				  <xref linkend="myapplet-size"/>. You can choose the number of
+				  rows, the number of columns and the size of the cells. The configuration you
+				  specify might produce a display size that is larger than the panel dimensions,
+				  in which case the panel adjusts in size to accept the applet. </para> 
+			 </listitem> 
+		  </itemizedlist></para> 
+	 </sect2> 
+  </sect1>
+
+<!-- ============= Customization ============================= -->
+<!-- Use this section to describe how to customize the applet. -->
+  <sect1 id="myapplet-prefs"> 
+	 <title>Settings</title> 
+	 <para>To configure &applet;, right-click on the
+		applet, then choose 
+		<guimenuitem>Properties</guimenuitem> from the popup menu.</para> 
+	 <para>The 
+		<guimenuitem>Properties</guimenuitem> dialog contains the following
+		tabbed sections: </para> 
+	 <itemizedlist> 
+		<listitem> 
+		  <para> 
+			 <xref linkend="myapplet-size"/></para> 
+		</listitem> 
+		<listitem> 
+		  <para> 
+			 <xref linkend="myapplet-set-default"/></para> 
+		</listitem> 
+	 </itemizedlist>
+
+
+<!-- =============== Customization Subsection ================ -->
+<!-- Use a new section to describe different tabbed sections on the Settings or Preferences
+	     dialog. -->
+	 <sect2 id="myapplet-size"> 
+		<title>Size</title> 
+		<variablelist> 
+		  <varlistentry> 
+			 <term> 
+				<guilabel>Follow panel size</guilabel></term> 
+			 <listitem> 
+				<para>Select this option to automatically set the appropriate
+				  number of columns and rows of characters in the applet to fit in your
+				  panel.</para> 
+				<para>Default: selected.</para> 
+			 </listitem> 
+		  </varlistentry> 
+		  <varlistentry> 
+			 <term> 
+				<guilabel>Minimum number of cells: (for autosize)</guilabel></term>
+
+			 
+			 <listitem> 
+				<para>Use this spin box to specify the minimum number of character
+				  cells in the applet. You can specify up to 25 cells. If you specify a low
+				  minimum number of cells, some characters might not be visible.</para> 
+				<para>Default: 8 cells.</para> 
+			 </listitem> 
+		  </varlistentry> 
+		  <varlistentry> 
+			 <term> 
+				<guilabel>Number of rows of buttons</guilabel></term> 
+			 <listitem> 
+				<para>Use this spin box to specify the number of character rows in
+				  the applet. You can specify up to 5 rows. </para> 
+				<para>Default: 2 rows.</para> 
+			 </listitem> 
+		  </varlistentry> 
+		  <varlistentry> 
+			 <term> 
+				<guilabel>Number of columns of buttons</guilabel></term> 
+			 <listitem> 
+				<para>Use this spin box to specify the number of character columns
+				  in the applet. You can specify up to 5 columns.</para> 
+				<para>Default: 4 columns. </para> 
+			 </listitem> 
+		  </varlistentry> 
+		  <varlistentry> 
+			 <term> 
+				<guilabel>Size of buttons: (pixels)</guilabel></term> 
+			 <listitem> 
+				<para>Use this spin box to specify the size in pixels of each
+				  character cell in the applet. You can specify a button size up to 40
+				  pixels.</para> 
+				<para>Default: 22 pixels.</para> 
+			 </listitem> 
+		  </varlistentry> 
+		</variablelist> 
+	 </sect2>
+
+<!-- ============= Customization Subsection ===================== -->
+<!-- Another tabbed section on the Preferences dialog. -->
+	 <sect2 id="myapplet-set-default"> 
+		<title>Default List</title> 
+		<variablelist> 
+		  <varlistentry> 
+			 <term> 
+				<guilabel>Default character list</guilabel></term> 
+			 <listitem> 
+				<para>Use this text box to specify your own default character
+				  list.</para> 
+			 </listitem> 
+		  </varlistentry> 
+		</variablelist> 
+	 </sect2> 
+  </sect1>
+
+<!-- ============= Bugs ================================== -->
+<!-- This section is optional and is commented out by default. 
+     You can use it to describe known bugs and limitations of the 
+	  program if there are any - please be frank and list all
+     problems you know of. 
+  
+  <sect1 id="myapplet-bugs">
+  <title>Known Bugs and Limitations</title>
+  <para> </para>
+ </sect1>
+-->
+<!-- ============= About ================================== -->
+<!-- This section contains info about the program (not docs), such as
+     author's name(s), web page, license, feedback address. This
+     section is optional: primary place for this info is "About.." box of
+     the program. However, if you do wish to include this info in the
+     manual, this is the place to put it. Alternatively, you can put this 
+     information in the title page.-->
+
+  <sect1 id="myapplet-about">
+    <title>About &applet;</title>
+      <para>
+        &applet; was written by GNOME-HACKER
+        (<email>hacker@gnome.org</email>). To find more information about
+        &applet;, please visit the <ulink
+        url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
+        page</ulink>. 
+      </para>  
+      
+      <para>
+      To report a bug or make a suggestion regarding this application or
+      this manual, follow the directions in the
+      <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>.
+      </para>
+
+      <para> This program is distributed under the terms of the GNU
+      General Public license as published by the Free Software
+      Foundation; either version 2 of the License, or (at your option)
+      any later version. A 
+      <ulink url="ghelp:gpl" type="help">copy of this license</ulink>
+      is included with this documentation; another can be found in the file
+      COPYING included with the source code of this program.
+      </para>     
+      
+  </sect1> 
+
+</article>