From ae39f7001e5603010afc02de29787ade6d48ef14 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Fri, 22 Mar 2013 16:34:34 -0500 Subject: port indicator-session to GMenu/cmake. Code coverage increased from 0% to 95.4%. --- README | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) (limited to 'README') diff --git a/README b/README index e69de29..8834cc2 100644 --- a/README +++ b/README @@ -0,0 +1,47 @@ +Indicator-Session is the the session menu indicator for Unity. +Its behavior and features are listed at https://wiki.ubuntu.com/SystemMenu. + +For instructions on building and running built-in tests, see the INSTALL file. + + +Notes for Client Renderers +-------------------------- + +Indicator-Session has two custom types: the Guest menuitem and User menuitems. +Referencing the spec at ,https://wiki.ubuntu.com/SystemMenu.>, both have four +visual components: (1) an Active Session Mark and the user's (2) icon, +(3) name, and (4) Logged In Mark. + +== User menuitems can be recognized by their "indicator.switch-to-user" action. + Their four visual components are determined by: + + 1. You can test for the Action Session Mark by checking the action's state. + The state is a dicionary whose "active-user" key yields the current + session's owner's username. If it matches the username in this menuitem's + "target" attribute, show the Active Session Mark. + + 2. The icon is stored in the menuitem's "icon" attribute. If none is set, + the client should use a fallback icon such as "avatar-default." + + 3. The name is stored in the menuitem's "label" attribute. + + 4. You can test for the Logged In Mark by checking the action's state. + The state is a dictionary whose "logged-in-users" key will give + an array of usernames. If the array contains the username in this + menuitem's "target" attribute, show the Logged In Mark. + +== Guest menuitems can be recognized by their "indicator.switch-to-guest" action. + Its four visual components is determined by: + + 1. You can test for the Active Session Mark by checking the action's state. + The state is a dictionary whose "is-active" key yields a boolean. + If the booelan is true, show the Active Session Mark. + + 2. The guest user should use a fallback icon such as "avatar-default." + + 3. The name ("Guest") is stored in the menuitem's "label" attribute. + + 4. You can test for the Logged In Mark by checking the action's state. + The state is a dictionary whose "is-logged-in" key yields a boolean. + If the boolean is true, show the Logged In Mark. + -- cgit v1.2.3 From 2d7bf142998a28e1970c61bf63d6435eb4d4ac1e Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Fri, 22 Mar 2013 16:53:58 -0500 Subject: copyediting: grammar --- README | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README') diff --git a/README b/README index 8834cc2..420541e 100644 --- a/README +++ b/README @@ -7,10 +7,10 @@ For instructions on building and running built-in tests, see the INSTALL file. Notes for Client Renderers -------------------------- -Indicator-Session has two custom types: the Guest menuitem and User menuitems. -Referencing the spec at ,https://wiki.ubuntu.com/SystemMenu.>, both have four -visual components: (1) an Active Session Mark and the user's (2) icon, -(3) name, and (4) Logged In Mark. +Indicator-Session has two custom menuitems: the Guest and User switchers. +As per the https://wiki.ubuntu.com/SystemMenu specification, both need four +visual components: (1) an Active Session Mark, the user's (2) icon, (3) name, +and (4) a Logged In Mark. == User menuitems can be recognized by their "indicator.switch-to-user" action. Their four visual components are determined by: @@ -30,8 +30,8 @@ visual components: (1) an Active Session Mark and the user's (2) icon, an array of usernames. If the array contains the username in this menuitem's "target" attribute, show the Logged In Mark. -== Guest menuitems can be recognized by their "indicator.switch-to-guest" action. - Its four visual components is determined by: +== The Guest switcher can be recognized by its "indicator.switch-to-guest" + action. Its four visual components are determined by: 1. You can test for the Active Session Mark by checking the action's state. The state is a dictionary whose "is-active" key yields a boolean. -- cgit v1.2.3 From 2babf3e334649031a4e8fff308358f6974ceb155 Mon Sep 17 00:00:00 2001 From: Lars Uebernickel Date: Thu, 23 May 2013 18:48:56 -0400 Subject: Set x-canonical-type for user and guest menu items --- README | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 420541e..29a135f 100644 --- a/README +++ b/README @@ -12,7 +12,7 @@ As per the https://wiki.ubuntu.com/SystemMenu specification, both need four visual components: (1) an Active Session Mark, the user's (2) icon, (3) name, and (4) a Logged In Mark. -== User menuitems can be recognized by their "indicator.switch-to-user" action. +== User menuitems have "x-canonical-type" set to "indicator.user-menu-item" Their four visual components are determined by: 1. You can test for the Action Session Mark by checking the action's state. @@ -30,7 +30,7 @@ and (4) a Logged In Mark. an array of usernames. If the array contains the username in this menuitem's "target" attribute, show the Logged In Mark. -== The Guest switcher can be recognized by its "indicator.switch-to-guest" +== The Guest switcher has "x-canonical-type" set to "indicator.guest-menu-item" action. Its four visual components are determined by: 1. You can test for the Active Session Mark by checking the action's state. -- cgit v1.2.3 From 4fc1900d906c3c2228279c2e00754a687a38e0d0 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Sun, 23 Jun 2013 18:25:10 -0500 Subject: copyediting: fix typo --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 29a135f..addf3bb 100644 --- a/README +++ b/README @@ -35,7 +35,7 @@ and (4) a Logged In Mark. 1. You can test for the Active Session Mark by checking the action's state. The state is a dictionary whose "is-active" key yields a boolean. - If the booelan is true, show the Active Session Mark. + If the boolean is true, show the Active Session Mark. 2. The guest user should use a fallback icon such as "avatar-default." -- cgit v1.2.3