diff --git a/docs/protocol-extensions.rst b/docs/protocol-extensions.rst index 7e51b9019..66d280878 100644 --- a/docs/protocol-extensions.rst +++ b/docs/protocol-extensions.rst @@ -250,12 +250,13 @@ The escape code has the form:: 99 ; metadata ; payload -Here ```` is :code:`]` and ```` is :code:``. The -metadata is a section of colon separated :code:`key=value` pairs. Every key -must be a single character from the set :code:`[a-zA-Z]` and every value must -be a character from the set :code:`a-zA-Z0-9-_/\+.,(){}[]*&^%$#@!`~`. The -payload must be interpreted based on the metadata section. The two semi-colons -*must* always be present even when no metadata is present. +Here ```` is :code:`]` and ```` is +:code:``. The metadata is a section of colon separated +:code:`key=value` pairs. Every key must be a single character from the set +:code:`[a-zA-Z]` and every value must be a word consisting of characters from +the set :code:`a-zA-Z0-9-_/\+.,(){}[]*&^%$#@!`~`. The payload must be +interpreted based on the metadata section. The two semi-colons *must* always be +present even when no metadata is present. Before going into details, lets see how one can display a simple, single line notification from a shell script:: @@ -297,7 +298,7 @@ was activated. This is controlled by the ``a`` key which takes a comma separated set of values, ``report`` and ``focus``. The value ``focus`` means focus the window from which the notification was issued and is the default. ``report`` means send an escape code back to the application. The format of the -escape code is:: +returned escape code is:: 99 ; i=identifier ; @@ -322,7 +323,7 @@ to display it based on what it does understand. allow displaying custom icons on a notification, at all, it was decided to leave it out of the spec for the time being. - Similarly, features such a scheduled notifications could be added in future + Similarly, features such as scheduled notifications could be added in future revisions.