summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Hammond <chipx86@chipx86.com>2006-01-26 07:45:24 +0000
committerChristian Hammond <chipx86@chipx86.com>2006-01-26 07:45:24 +0000
commit47cde24c15b40e9791fc78c4905a6bb471e45130 (patch)
treecab19439d755906a93cc5bbf9a0246c3958ec7db
parent2aabd35c7211ebe64285e492ec4d4101fddbf4bb (diff)
downloadlibnotify-47cde24c15b40e9791fc78c4905a6bb471e45130.tar.gz
Fixed to actually be valid docbook.
-rw-r--r--docs/ChangeLog5
-rw-r--r--docs/notification-spec.xml98
2 files changed, 57 insertions, 46 deletions
diff --git a/docs/ChangeLog b/docs/ChangeLog
index ee0b0d2..7a73bcd 100644
--- a/docs/ChangeLog
+++ b/docs/ChangeLog
@@ -1,3 +1,8 @@
+Wed Jan 25 23:45:11 PST 2006 Christian Hammond <chipx86@chipx86.com>
+
+ * notification-spec.xml:
+ - Fixed to actually be valid docbook.
+
Mon Jan 23 01:18:23 PST 2006 Christian Hammond <chipx86@chipx86.com>
* notification-spec.xml:
diff --git a/docs/notification-spec.xml b/docs/notification-spec.xml
index 5246973..e1297db 100644
--- a/docs/notification-spec.xml
+++ b/docs/notification-spec.xml
@@ -220,54 +220,60 @@
<row>
<entry>Actions</entry>
<entry>
- The actions send a request message back to the notification client
- when invoked. This functionality may not be implemented by the
- notification server, conforming clients should check if it is available
- before using it (see the GetCapabilities message in
- <xref linkend="protocol"/>). An implementation is free to ignore any
- requested by the client. As an example one possible rendering of
- actions would be as buttons in the notification popup.
- </entry>
- <entry>
- Actions are sent over as a list of pairs. Each even element in the
- list (starting at index 0) represents the identifier for the action.
- Each odd element in the list is the localized string that will be
- displayed to the user.
+ <para>
+ The actions send a request message back to the notification client
+ when invoked. This functionality may not be implemented by the
+ notification server, conforming clients should check if it is available
+ before using it (see the GetCapabilities message in
+ <xref linkend="protocol"/>). An implementation is free to ignore any
+ requested by the client. As an example one possible rendering of
+ actions would be as buttons in the notification popup.
+ </para>
+ <para>
+ Actions are sent over as a list of pairs. Each even element in the
+ list (starting at index 0) represents the identifier for the action.
+ Each odd element in the list is the localized string that will be
+ displayed to the user.
+ </para>
+ <para>
+ The default action (usually invoked my clicking the notification)
+ should have a key named <literal>"default"</literal>. The name can
+ be anything, though implementations are free not to display it.
+ </para>
</entry>
- <entry>
- The default action (usually invoked my clicking the notification)
- should have a key named <literal>"default"</literal>. The name can
- be anything, though implementations are free not to display it.
- <entry>
</row>
<row>
<entry>Hints</entry>
- <entry><para>See <xref linkend="hints"/>.</para></entry>
-
- <para>
- Beyond the core protocol is the hints table. A couple of core
- elements have been moved to hints mostly because in a huge number
- of cases their default values would be sufficent. The elements moved
- to hints are:
- </para>
- <segmentedlist>
- <seglistitem>
- <seg>Category ID</seg>
- <seg>An optional ID representing the type of notification (the name
- has been changed from Notification Type ID in pervious versions).
- See <xref linkend="categories"/>.</seg>
- </seglistitem>
- <seglistitem>
- <seg>Urgency Level</seg>
- <seg>The urgency of the notification. See
- <xref linkend="urgency-levels"/>. (Defaults to 1 - Normal)</seg>
- </seglistitem>
- <seglistitem>
- <seg>Icon Data</seg>
- <seg>Instead of overloading the icon field we now have an icon_data
- field that is used when icon is blank.</seg>
- </seglistitem>
- </segmentedlist>
+ <entry>
+ <para>See <xref linkend="hints"/>.</para>
+ <para>
+ Beyond the core protocol is the hints table. A couple of core
+ elements have been moved to hints mostly because in a huge number
+ of cases their default values would be sufficent. The elements moved
+ to hints are:
+ </para>
+ <segmentedlist>
+ <title>Elements Moved to Hints</title>
+ <segtitle>Element</segtitle>
+ <segtitle>Description</segtitle>
+ <seglistitem>
+ <seg>Category ID</seg>
+ <seg>An optional ID representing the type of notification (the name
+ has been changed from Notification Type ID in pervious versions).
+ See <xref linkend="categories"/>.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>Urgency Level</seg>
+ <seg>The urgency of the notification. See
+ <xref linkend="urgency-levels"/>. (Defaults to 1 - Normal)</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>Icon Data</seg>
+ <seg>Instead of overloading the icon field we now have an icon_data
+ field that is used when icon is blank.</seg>
+ </seglistitem>
+ </segmentedlist>
+ </entry>
</row>
<row>
<entry>Expiration Timeout</entry>
@@ -720,8 +726,8 @@
</entry>
</row>
<row>
- <entry><literal>"desktop-entry"></literal></entry>b
- <entry>Application Desktop ID</entry>
+ <entry><literal>"desktop-entry"></literal></entry>
+ <entry>string</entry>
<entry>
This specifies the name of the desktop filename representing the
calling program. This should be the same as the prefix used for the