1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Packaging Applet Documentation</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="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs08.html" title="Application Help Buttons"><link rel="next" href="indexs10.html" title="Writing Context Sensitive Help (coming in GNOME-2.0)"></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">Packaging Applet Documentation</th></tr><tr><td width="20%" align="left"><a href="indexs08.html">Prev</a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a href="indexs10.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="packagingappletdocs"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="packagingappletdocs"></a>Packaging Applet Documentation</h2></div></div><div class="sect2"><a name="appletfiles"></a><div class="titlepage"><div><h3 class="title"><a name="appletfiles"></a>Applet Documentation Files</h3></div></div><p> 2 In GNOME 2.0 each applet will have its own documentation 3 installed separately, and the GNOME 2.0 help 4 browser (Nautilus) will dynamically 5 merge the applet documents into a single virtual book 6 called <i>GNOME Applets</i>. During the 7 transitionary stage between GNOME 1.0 and GNOME 2.0, each 8 applet in the gnome-applets package has its own manual(stored 9 with the applet in CVS), but they are merged together manually 10 to create the <i>GNOME Applets</i> book before 11 distribution. Telsa 12 <tt><<a href="mailto:hobbit@aloss.ukuu.org.uk">hobbit@aloss.ukuu.org.uk</a>></tt> is the maintainer of 13 this document. Applet documentation should be sent to Telsa 14 (or placed in CVS) who will make sure they are correctly 15 packaged with the applets. The applet author should be 16 contacted to modify the menu items and help buttons to bind to 17 the applet documentation if necessary. 18 </p><p> 19 Images which are part of the applet documentation should be in 20 PNG format and should reside in the same directory as the SGML 21 document file in CVS(gnome-applets/APPLETNAME/help/C). 22 </p><p> 23 Applets which are not part of the gnome-applets package must 24 package their documentation with the particular applet 25 package. They should use the same applet template as other 26 applets. However, the <tt><xref></tt> links to 27 the introductory chapter of the <i>GNOME 28 Applets</i> book must be removed (as the 1.x 29 GNOME Help Browser does not allow 30 you to create links between separate documents) and replaced 31 with suitable text. Note that since this document is not part 32 of the <i>GNOME Applets</i> book, you must 33 remember to add <tt><legalnotice></tt> and 34 <tt><copyright></tt> sections. 35 </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2940608"></a>Developer Information</h3><p> 36 This section is for developers. Documentation authors 37 generally do not need to know this material. 38 </p></div><p> 39 Applets should have About and 40 Manual menu items, typically as the first 41 and second top-most items in the menu respectively. This 42 section describes how the developer creates these menu items 43 and links them to the documentation. 44 </p><p> 45 To add an applet's manual to its applet menu, use: 46<pre class="programlisting"> 47/* add an item to the applet menu */ 48applet_widget_register_callback(APPLET_WIDGET(applet), "manual", 49_("Manual"), &open_manual, NULL); 50</pre> 51 Here the second argument is an arbitrary name for the 52 callback, the third argument is the label which will appear 53 when the user right clicks on the applet, and the fourth 54 argument is the callback function. 55 </p><p> 56 You will need to write a simple callback function to open the 57 help browser to the appropriate document. This is done using 58 the <tt>gnome_help_file_find_file</tt> function, 59 as described in <a href="indexs08.html" title="Application Help Buttons">the section called “Application Help Buttons”</a>. 60 </p><p> 61 You will also want to add an About menu 62 item to the applet's menu. This is a 63 stock menu item and is done: 64<pre class="programlisting"> 65applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about", 66 GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about, 67 NULL); 68</pre> 69 </p><p> 70 More information can be found at <a href="http://developer.gnome.org/doc/tutorials/applet/index.html" target="_top">Writing 71 GNOME panel applets using the GTK+/GTK-- widget set</a>. 72 </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a href="indexs08.html">Prev</a>�</td><td width="20%" align="center"><a href="index.html">Home</a></td><td width="40%" align="right">�<a href="indexs10.html">Next</a></td></tr><tr><td width="40%" align="left">Application Help Buttons�</td><td width="20%" align="center"><a href="index.html">Up</a></td><td width="40%" align="right">�Writing Context Sensitive Help (coming in GNOME-2.0)</td></tr></table></div></body></html> 73