aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Uebernickel <lars.uebernickel@canonical.com>2013-06-28 14:36:28 -0400
committerLars Uebernickel <lars.uebernickel@canonical.com>2013-06-28 14:36:28 -0400
commit90904091b7258ec6a3d02f50e4113acbb1c8214e (patch)
tree29acb0f759f1a835d785d034aae2d96df8f5f89a
parente744e385675fb948ffd888668c22ea93c706e1fa (diff)
downloadlibayatana-indicator-90904091b7258ec6a3d02f50e4113acbb1c8214e.tar.gz
libayatana-indicator-90904091b7258ec6a3d02f50e4113acbb1c8214e.tar.bz2
libayatana-indicator-90904091b7258ec6a3d02f50e4113acbb1c8214e.zip
README: include information about the new Position key in indicator files
-rw-r--r--README13
1 files changed, 10 insertions, 3 deletions
diff --git a/README b/README
index 1ea62ef..b51e110 100644
--- a/README
+++ b/README
@@ -6,14 +6,21 @@ files in `/usr/share/unity/indicators`. These files have to have the same
name as the well-known D-Bus name that the corresponding service owns.
An indicator file is a normal key file (like desktop files). It must have
-an `[Indicator Service]` section, that contains the service's name
-(`Name`) and optionally the object path at which its action group is found
-(`ObjectPath`). For example:
+an `[Indicator Service]` section, that must contain the service's name (`Name`)
+and the object path at which its action group is found (`ObjectPath`). For
+example:
[Indicator Service]
Name=indicator-example
ObjectPath=/com/canonical/indicator/example
+It should also contain a hint to where the indicator should appear in the panel:
+
+ Position=70
+
+The smaller the position, the further to the right (or left when RTL is
+enabled) the indicator appears.
+
An indicator can only export one action group, but a menu for each profile
("desktop", "greeter", "phone") supports. There must be a section for each
of those profiles, containing the object path on which the menu is