From 8b3b58503dca17206fd530fc4828fdd51faa08a3 Mon Sep 17 00:00:00 2001
From: Not Zed <NotZed@Ximian.com>
Date: Fri, 13 May 2005 10:07:34 +0000
Subject: added some info on the menu tag for popup menus.

2005-05-13  Not Zed  <NotZed@Ximian.com>

        * evolution-plugin-manual.xml: added some info on the menu tag for
        popup menus.

svn path=/trunk/; revision=29350
---
 doc/devel/ChangeLog                   |  5 +++++
 doc/devel/evolution-plugin-manual.xml | 37 +++++++++++++++++++++++++++++++++--
 2 files changed, 40 insertions(+), 2 deletions(-)

(limited to 'doc/devel')

diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog
index 0b137d8036..562faf8216 100644
--- a/doc/devel/ChangeLog
+++ b/doc/devel/ChangeLog
@@ -1,3 +1,8 @@
+2005-05-13  Not Zed  <NotZed@Ximian.com>
+
+	* evolution-plugin-manual.xml: added some info on the menu tag for
+	popup menus.
+
 2004-11-18  Not Zed  <NotZed@Ximian.com>
 
 	* evolution-plugin-manual.xml: define load-on-startup parameter.
diff --git a/doc/devel/evolution-plugin-manual.xml b/doc/devel/evolution-plugin-manual.xml
index 2feb047482..aad93ef0f3 100644
--- a/doc/devel/evolution-plugin-manual.xml
+++ b/doc/devel/evolution-plugin-manual.xml
@@ -821,7 +821,7 @@
 	  <programlisting>
 	    <![CDATA[
 <hook class="com.ximian.evolution.mail.popup:1.0">
- <menu id="menuid" target="targettype">
+ <menu id="menuid" target="targettype" factory="function spec"? >
   <item
    type="item | toggle | radio | image | submenu | bar"
    active ?
@@ -835,8 +835,41 @@
 </hook>]]></programlisting>
 	  <!-- this is all too bloody verbose, is there a better way? -->
 	  <para>
-	    <emphasis>Need to define menu tag</emphasis>
+	    <emphasis>Menu Tag</emphasis>
 	  </para>
+	  <variablelist>
+	    <varlistentry>
+	      <term><parameter>id</parameter></term>
+	      <listitem>
+		<simpara>
+		  The id of the menu to which these items should be added.
+		</simpara>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><parameter>target</parameter></term>
+	      <listitem>
+		<simpara>
+		  The target expected.  There will normally only be one target
+		  type defined for any given menu, however some menu's may
+		  supply multiple targets depending on context.
+		</simpara>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><parameter>factory</parameter></term>
+	      <listitem>
+		<simpara>
+		  If present, then a plugin-specific function specification of
+		  the the function to invoke when the the menu is being
+		  created.  This function will normally call
+		  e_popup_add_items() to add custom menu items.  It is used to
+		  provide more control than the visible and enable masks
+		  provide.  The plugin argument is the popup target.
+		</simpara>
+	      </listitem>
+	    </varlistentry>
+	  </variablelist>
 	  <variablelist>
 	    <varlistentry>
 	      <term><parameter>type</parameter></term>
-- 
cgit