Moved the notification components into a table.

This commit is contained in:
Christian Hammond 2004-09-01 07:51:10 +00:00
parent 4188fb54d3
commit b9dd64dce4
2 changed files with 129 additions and 141 deletions

View File

@ -1,3 +1,8 @@
Wed Sep 01 00:50:51 PDT 2004 Christian Hammond <chipx86@gnupdate.org>
* notification-spec.xml:
- Moved the notification components into a table.
Wed Sep 01 00:38:46 PDT 2004 Christian Hammond <chipx86@gnupdate.org> Wed Sep 01 00:38:46 PDT 2004 Christian Hammond <chipx86@gnupdate.org>
* notification-spec.xml: * notification-spec.xml:

View File

@ -105,147 +105,130 @@
<para> <para>
A notification has the following components: A notification has the following components:
</para> </para>
<variablelist> <table>
<varlistentry> <title>Notification Components</title>
<term>Application Name</term> <tgroup cols="2">
<listitem> <thead>
<para> <row>
Application name: This is the optional name of the application sending <entry>Component</entry>
the notification. This should be the application's formal name, rather <entry>Description</entry>
than some sort of ID. </row>
</para> </thead>
</listitem> <tbody valign="top">
</varlistentry> <row>
<varlistentry> <entry>Application Name</entry>
<term>Application Icon</term> <entry>
<listitem> Application name: This is the optional name of the application sending
<para> the notification. This should be the application's formal name, rather
An optional byte array containing the application's icon. than some sort of ID.
This should be in PNG or GIF formats. </entry>
</para> </row>
</listitem> <row>
</varlistentry> <entry>Application Icon</entry>
<varlistentry> <entry>
<term>Application ID</term> An optional byte array containing the application's icon.
<listitem> This should be in PNG or GIF formats.
<para> </entry>
An optional byte array containing the application's icon. </row>
This should be in PNG or GIF formats. <row>
</para> <entry>Application ID</entry>
</listitem> <entry>
</varlistentry> An optional byte array containing the application's icon.
<varlistentry> This should be in PNG or GIF formats.
<term>Replaces ID</term> </entry>
<listitem> </row>
<para> <row>
An optional ID of an existing notification that this <entry>Replaces ID</entry>
notification is intended to replace. <entry>
</para> An optional ID of an existing notification that this
</listitem> notification is intended to replace.
</varlistentry> </entry>
<varlistentry> </row>
<term>Notification Type ID</term> <row>
<listitem> <entry>Notification Type ID</entry>
<para> <entry>
An optional ID representing the notification type. See An optional ID representing the notification type. See
<xref linkend="notification-types"/>. <xref linkend="notification-types"/>.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Urgency Level</entry>
<term>Urgency Level</term> <entry>
<listitem> The urgency of the notification. See <xref linkend="urgency-levels"/>.
<para> </entry>
The urgency of the notification. See <xref linkend="urgency-levels"/>. </row>
</para> <row>
</listitem> <entry>Summary</entry>
</varlistentry> <entry>
<varlistentry> This is a single line overview of the notification. For instance,
<term>Summary</term> "You have mail" or "A friend has come online". It should generally
<listitem> not be longer than 40 characters, though this is not a requirement,
<para> and server implementations should word wrap if necessary. The summary
This is a single line overview of the notification. For instance, must be encoded using UTF-8.
"You have mail" or "A friend has come online". It should generally </entry>
not be longer than 40 characters, though this is not a requirement, </row>
and server implementations should word wrap if necessary. The summary <row>
must be encoded using UTF-8. <entry>Body</entry>
</para> <entry>
</listitem> <para>
</varlistentry> This is a multi-line body of text. Each line is a paragraph, server
<varlistentry> implementations are free to word wrap them as they see fit.
<term>Body</term> </para>
<listitem> <para>
<para> The text may contain simple markup as specified in
This is a multi-line body of text. Each line is a paragraph, server <xref linkend="markup"/>. It must be encoded using UTF-8.
implementations are free to word wrap them as they see fit. </para>
</para> <para>
<para> If the body is omitted just the summary is displayed.
The text may contain simple markup as specified in </para>
<xref linkend="markup"/>. It must be encoded using UTF-8. </entry>
</para> </row>
<para> <row>
If the body is omitted just the summary is displayed. <entry>Images</entry>
</para> <entry>See <xref linkend="icons-sounds"/>.</entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Sounds</entry>
<term>Images</term> <entry>See <xref linkend="icons-sounds"/>.</entry>
<listitem> </row>
<para> <row>
See <xref linkend="icons-sounds"/>. <entry>Actions</entry>
</para> <entry>
</listitem> The actions send a request message back to the notification client
</varlistentry> when invoked. This functionality may not be implemented by the
<varlistentry> notification server, conforming clients should check if it is available
<term>Sounds</term> before using it (see the GetCapabilities message in
<listitem> <xref linkend="protocol"/>. An implementation is free to ignore any
<para> requested by the client. As an example one possible rendering of
See <xref linkend="icons-sounds"/>. actions would be as buttons in the notification popup.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Hints</entry>
<term>Actions</term> <entry>See <xref linkend="hints"/>.</entry>
<listitem> </row>
<para> <row>
The actions send a request message back to the notification client <entry>Expiration Time</entry>
when invoked. This functionality may not be implemented by the <entry>
notification server, conforming clients should check if it is available <para>
before using it (see the GetCapabilities message in The timestamp in seconds since the epoch that the notification should
<xref linkend="protocol"/>. An implementation is free to ignore any close. For example, if one wishes to have an expiration of 5 seconds
requested by the client. As an example one possible rendering of from now, they must grab the current timestamp and add 5 seconds to it.
actions would be as buttons in the notification popup. </para>
</para> <para>
</listitem> If zero, the notification's expiration time is dependent on the
</varlistentry> notification server's settings, and may vary for the type of
<varlistentry> notification.
<term>Hints</term> </para>
<listitem> <para>
<para> The expiration time should be respected by implementations, but this is
See <xref linkend="hints"/>. not required (this is for compatibility with KNotify).
</para> </para>
</listitem> </entry>
</varlistentry> </row>
<varlistentry> </tbody>
<term>Expiration Time</term> </tgroup>
<listitem> </table>
<para>
The timestamp in seconds since the epoch that the notification should
close. For example, if one wishes to have an expiration of 5 seconds
from now, they must grab the current timestamp and add 5 seconds to it.
</para>
<para>
If zero, the notification's expiration time is dependent on the
notification server's settings, and may vary for the type of
notification.
</para>
<para>
The expiration time should be respected by implementations, but this is
not required (this is for compatibility with KNotify).
</para>
</listitem>
</varlistentry>
</variablelist>
<para> <para>
Each notification displayed is allocated a unique ID by the server. Each notification displayed is allocated a unique ID by the server.