added some stuff about the pseudo mime types used for finer control of the

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

        * evolution-plugin-manual.xml: added some stuff about the pseudo
        mime types used for finer control of the formatter.

svn path=/trunk/; revision=29383
This commit is contained in:
Not Zed
2005-05-19 06:07:05 +00:00
committed by Michael Zucci
parent 16eefad885
commit e8bb290b21
2 changed files with 49 additions and 4 deletions

View File

@ -1,3 +1,8 @@
2005-05-19 Not Zed <NotZed@Ximian.com>
* evolution-plugin-manual.xml: added some stuff about the pseudo
mime types used for finer control of the formatter.
2005-05-13 Not Zed <NotZed@Ximian.com>
* evolution-plugin-manual.xml: added some info on the menu tag for

View File

@ -1735,12 +1735,15 @@
<orderedlist>
<listitem>
<simpara>Outputs pre-amble information. e.g. Flag-For-Followup
status.</simpara>
status. The pre-amble renderer is chosen using the pseudo
mime-type <constant>x-evolution/message/prefix</constant>, and can be
overridden or added to by plugging in to that type.</simpara>
</listitem>
<listitem>
<simpara>Invokes <methodname>format_message</methodname> to begin the message
formatting. <methodname>format_message</methodname> displays the message header, then
looks up the content object.</simpara>
<simpara>Looks up a handler for the pseudo mime-type
<constant>x-evolution/message/rfc822</constant> and invokes it
to begin message formatting. The default handler displays the
message headers and then formats the message contents.
</listitem>
<listitem>
<simpara>Using the mime-type of the content object (whether
@ -2329,6 +2332,43 @@
<interfacename>com.novell.evolution.mail.format:1.0</interfacename>.
</para>
<para>
The mail formatter allows the rendering of attachments to be
overridden based on the mime-type of the attachment. There are
additional pseudo-mime-types which can be hooked on to to override
some basic functions. These types are invalid mime-types so cannot
occur in received messages.
</para>
<informaltable>
<tgroup cols="2">
<colspec colnum="1" colname="field" colwidth="1*"/>
<colspec colnum="2" colname="value" colwidth="4*"/>
<tbody valign="top">
<row>
<entry><constant>x-evolution/message/prefix</constant></entry>
<entry>If it exists, this handler will be called before any
other content is output. This can be used to display global
message-information, such as follow-up details. Normally
this handler should chain its call to the parent handler once
it is finished.</entry>
</row>
<row>
<entry><constant>x-evolution/message/rfc822</entry>
<entry>This handler is called to output messages, including
attached messages. The default handler will output the
user-desired message headers and then render the message
content. It also does some processing to do with secured
message validation contexts. As this is not a simple
handler, generally this hook point should only be used to
supplement the prefix output where it is desirable to operate
on attached messages.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect2>
<title>Base Formatter</title>