[gnome-panel] doc: Add guidelines for context menu



commit 28db2934bbc71fb16853078401d43821a46f9ed1
Author: Vincent Untz <vuntz gnome org>
Date:   Thu Feb 24 18:39:11 2011 +0100

    doc: Add guidelines for context menu

 doc/reference/panel-applet/panel-applet-docs.sgml |   32 +++++++++++++++++++++
 1 files changed, 32 insertions(+), 0 deletions(-)
---
diff --git a/doc/reference/panel-applet/panel-applet-docs.sgml b/doc/reference/panel-applet/panel-applet-docs.sgml
index cd96ee0..20b85a2 100644
--- a/doc/reference/panel-applet/panel-applet-docs.sgml
+++ b/doc/reference/panel-applet/panel-applet-docs.sgml
@@ -248,6 +248,38 @@ PANEL_APPLET_OUT_PROCESS_FACTORY ("HelloWorldFactory",
      The Panel Applet library uses <type>GtkAction</type> to define menu items appearing in the context menu of the applet.
     </para>
 
+    <sect2 id="getting-started.context-menu.content">
+     <title>Guidelines for Context Menu</title>
+
+     <para>
+      To help guarantee consistency in the interaction with applets, there are some guidelines that are recommended to follow:
+     </para>
+
+     <itemizedlist>
+      <listitem>
+       <para>
+        Do not make the context menu too long: if you have more than five or six menu items, then it might be worth investing efforts on rethinking what is important in the menu.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        For the menu item that will enable the user to configure the applet, use "Preferences" for the label, and try to avoid "Configure", "Configuration", "Settings", etc.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        Avoid putting a "Help" menu item. The user will usually explicitly add the applet, so it is expected that he knows what the applet is about. Putting a "Help" menu item in the context menu is therefore too prominent. It might make sense to add a "Help" button in the Preferences dialog, though.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        If you agree, avoid putting a "About" menu item. To the user, applets are not different applications but elements of one global application, the panel. Of course, this means that credits for working on the applet are not visible to the user.
+       </para>
+      </listitem>
+     </itemizedlist>
+
+    </sect2>
+
     <sect2 id="getting-started.context-menu.setup">
      <title>Setting Up the Menu</title>
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]