jcarr
/
libnotify
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/ChangeLog
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:

167
docs/notification-spec.xml
View File

@ -105,76 +105,71 @@
<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>
<entry>Component</entry>
<entry>Description</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry>Application Name</entry>
<entry>
Application name: This is the optional name of the application sending Application name: This is the optional name of the application sending
the notification. This should be the application's formal name, rather the notification. This should be the application's formal name, rather
than some sort of ID. than some sort of ID.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Application Icon</entry>
<term>Application Icon</term> <entry>
<listitem>
<para>
An optional byte array containing the application's icon. An optional byte array containing the application's icon.
This should be in PNG or GIF formats. This should be in PNG or GIF formats.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Application ID</entry>
<term>Application ID</term> <entry>
<listitem>
<para>
An optional byte array containing the application's icon. An optional byte array containing the application's icon.
This should be in PNG or GIF formats. This should be in PNG or GIF formats.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Replaces ID</entry>
<term>Replaces ID</term> <entry>
<listitem>
<para>
An optional ID of an existing notification that this An optional ID of an existing notification that this
notification is intended to replace. notification is intended to replace.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Notification Type ID</entry>
<term>Notification Type ID</term> <entry>
<listitem>
<para>
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>
<para>
The urgency of the notification. See <xref linkend="urgency-levels"/>. The urgency of the notification. See <xref linkend="urgency-levels"/>.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Summary</entry>
<term>Summary</term> <entry>
<listitem>
<para>
This is a single line overview of the notification. For instance, This is a single line overview of the notification. For instance,
"You have mail" or "A friend has come online". It should generally "You have mail" or "A friend has come online". It should generally
not be longer than 40 characters, though this is not a requirement, not be longer than 40 characters, though this is not a requirement,
and server implementations should word wrap if necessary. The summary and server implementations should word wrap if necessary. The summary
must be encoded using UTF-8. must be encoded using UTF-8.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Body</entry>
<term>Body</term> <entry>
<listitem>
<para> <para>
This is a multi-line body of text. Each line is a paragraph, server This is a multi-line body of text. Each line is a paragraph, server
implementations are free to word wrap them as they see fit. implementations are free to word wrap them as they see fit.
@ -186,28 +181,19 @@
<para> <para>
If the body is omitted just the summary is displayed. If the body is omitted just the summary is displayed.
</para> </para>
</listitem> </entry>
</varlistentry> </row>
<varlistentry> <row>
<term>Images</term> <entry>Images</entry>
<listitem> <entry>See <xref linkend="icons-sounds"/>.</entry>
<para> </row>
See <xref linkend="icons-sounds"/>. <row>
</para> <entry>Sounds</entry>
</listitem> <entry>See <xref linkend="icons-sounds"/>.</entry>
</varlistentry> </row>
<varlistentry> <row>
<term>Sounds</term> <entry>Actions</entry>
<listitem> <entry>
<para>
See <xref linkend="icons-sounds"/>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Actions</term>
<listitem>
<para>
The actions send a request message back to the notification client The actions send a request message back to the notification client
when invoked. This functionality may not be implemented by the when invoked. This functionality may not be implemented by the
notification server, conforming clients should check if it is available notification server, conforming clients should check if it is available
@ -215,20 +201,15 @@
<xref linkend="protocol"/>. An implementation is free to ignore any <xref linkend="protocol"/>. An implementation is free to ignore any
requested by the client. As an example one possible rendering of requested by the client. As an example one possible rendering of
actions would be as buttons in the notification popup. actions would be as buttons in the notification popup.
</para> </entry>
</listitem> </row>
</varlistentry> <row>
<varlistentry> <entry>Hints</entry>
<term>Hints</term> <entry>See <xref linkend="hints"/>.</entry>
<listitem> </row>
<para> <row>
See <xref linkend="hints"/>. <entry>Expiration Time</entry>
</para> <entry>
</listitem>
</varlistentry>
<varlistentry>
<term>Expiration Time</term>
<listitem>
<para> <para>
The timestamp in seconds since the epoch that the notification should The timestamp in seconds since the epoch that the notification should
close. For example, if one wishes to have an expiration of 5 seconds close. For example, if one wishes to have an expiration of 5 seconds
@ -243,9 +224,11 @@
The expiration time should be respected by implementations, but this is The expiration time should be respected by implementations, but this is
not required (this is for compatibility with KNotify). not required (this is for compatibility with KNotify).
</para> </para>
</listitem> </entry>
</varlistentry> </row>
</variablelist> </tbody>
</tgroup>
</table>
<para> <para>
Each notification displayed is allocated a unique ID by the server. Each notification displayed is allocated a unique ID by the server.