From 8c23e382711a447dd12117b14d715bccd0012797 Mon Sep 17 00:00:00 2001
From: Michael Zucci <zucchi@src.gnome.org>
Date: Fri, 22 Oct 2004 09:15:49 +0000
Subject: 	some doc updates

svn path=/trunk/; revision=27693
---
 doc/devel/evolution-plugin-manual.xml | 62 ++++++++++++++++-------------------
 1 file changed, 29 insertions(+), 33 deletions(-)

(limited to 'doc/devel')

diff --git a/doc/devel/evolution-plugin-manual.xml b/doc/devel/evolution-plugin-manual.xml
index a8f01ac954..dbac234ca4 100644
--- a/doc/devel/evolution-plugin-manual.xml
+++ b/doc/devel/evolution-plugin-manual.xml
@@ -16,6 +16,8 @@
 <!ENTITY em-popup-reference SYSTEM "em-popup.xml">
 <!ENTITY em-format-reference SYSTEM "em-format.xml">
 
+<!ENTITY em-events SYSTEM "em-events.xml">
+
 ]>
 <?xml-stylesheet href="sdocbook.css" type="text/css"?>
 
@@ -1482,14 +1484,37 @@
 	    <![CDATA[
 <hook class="com.ximian.evolution.mail.events:1.0">
  <event
-   type="pass | sink"
-   priority="signed integer"
+   target="target name"
    id="event name"
+   type="pass | sink" ?
+   priority="signed integer" ?
    enable="target mask" ?
    handle="function spec"/> *
- </event> *
 </hook>]]></programlisting>
 	  <variablelist>
+	    <varlistentry>
+	      <term><parameter>target</parameter></term>
+	      <listitem>
+		<simpara>
+		  The target type of the event listener.  This will normally
+		  match in a 1:1 relationship to the event
+		  <parameter>id</parameter> itself.
+		</simpara>
+	      </listitem>
+	    </varlistentry>
+	    <varlistentry>
+	      <term><parameter>id</parameter></term>
+	      <listitem>
+		<simpara>
+		  The name of the event to listen to.  By convention the names
+		  will be of the form
+		  <constant>target.event</constant>.
+		  e.g. <constant>folder.changed</constant>, or
+		  <constant>message.read</constant>, etc.  Although they are
+		  just simple case-sensitive strings.
+		</simpara>
+	      </listitem>
+	    </varlistentry>
 	    <varlistentry>
 	      <term><parameter>type</parameter></term>
 	      <listitem>
@@ -1510,14 +1535,6 @@
 		</simpara>
 	      </listitem>
 	    </varlistentry>
-	    <varlistentry>
-	      <term><parameter>id</parameter></term>
-	      <listitem>
-		<simpara>
-		  The name of the event to listen to.
-		</simpara>
-	      </listitem>
-	    </varlistentry>
 	    <varlistentry>
 	      <term><parameter>enable</parameter></term>
 	      <listitem>
@@ -2576,28 +2593,7 @@
 	  <interfacename>com.ximian.evolution.mail.events:1.0</interfacename>.
 	</para>
 
-	<sect2>
-	  <title>Folder Changed Event</title>
-	  <informaltable>
-	    <tgroup cols="2">
-	      <colspec colnum="1" colname="field" colwidth="1*"/>
-	      <colspec colnum="2" colname="value" colwidth="4*"/>
-	      <tbody valign="top">
-		<row>
-		  <entry>Name</entry>
-		  <entry><constant>folder.changed</constant></entry>
-		</row>
-		<row>
-		  <entry>Target</entry>
-		  <entry>
-		    <link
-		      linkend="mail-hooks-event-EMEventTargetFolder">EMEventTargetFolder</link>
-		  </entry>
-		</row>
-	      </tbody>
-	    </tgroup>
-	  </informaltable>
-	</sect2>
+	&em-events;
 
 	<sect2>
 	  <title>Mail Event Targets</title>
-- 
cgit v1.2.3