Development Team/Almanac/Activity Bundles: Difference between revisions

Line 32:

[Activity]

~~name = Web~~

name[en_US] = Web

~~name[de] = Web~~

activity_version = 1

host_version = 1

Line 49:

Line 47:

name = Web

: This is the name is displayed in Sugar referring to the activity. A 'name' key without a bracketed language code ~~MUST match~~ the name of the activity ~~bundle directory, minus the ".activity" ending~~. The activity.info file must have this key.

: This is the name is displayed in Sugar referring to the activity. A 'name' key without a bracketed language code is the "en_US" localized name of the activity. The activity.info file must have this key.

~~name[en_US] = Web~~

~~name[de] = Web~~

~~: These keys are localized names for the activity. The language codes between the brackets are ISO language codes (fixme: need specific ISO standard)~~.

activity_version = 1

Line 61:

Line 55:

: Each activity.info file must have a "host_version" key. The version is a single positive integer, and may only contain the characters 1 through 9. This specifies the version of the Sugar environment which the activity is compatible with. (fixme: need to specify sugar versions somewhere. Obviously we start with 1.)

id = com.redhat.Sugar.BrowserActivity

service = com.redhat.Sugar.BrowserActivity

: This is the activity's dbus service name. It is required.

: This is the activity's dbus service name. It is required. It is also used as the activity's default service type when the activity is shared on the network. To determine this type, the distince parts (separated by the '.' character) are reversed, any '.' is replaced by a '_' character, and the type is prefixed by a '_' character. So in this example, the default service type would be "_BrowserActivity_Sugar_redhat_com".

icon = activity-web

: This key is optional. It points to the activity's icon. The icon is first searched for in the activity bundle's root directory, and if not found, is looked up in the current GTK icon theme. It cannot contain a path.

~~python_module~~ = BrowserActivity.BrowserActivity

exec = sugar-activity-factory com.redhat.Sugar.BrowserActivity BrowserActivity.BrowserActivity

~~exec = super-duper-web-browser~~

: The exec key are used when [[Sugar]] installs the activity. It specifies the executable which [[Sugar]] runs to start the activity's factory service. A factory service spawns instances of the actual activity. A factory service for Python-based activities is provided with [[Sugar]].

: The ~~python_module and~~ exec ~~keys~~ are used when [[Sugar]] installs the activity. ~~The python_module key should point~~ to the activity ~~class in a python module; i.e. if running python from the root activity directory, one should be able to~~ '~~import <contents of python_module value>' successfully~~. ~~If the activity is not written in Python, then the exec key should contain the executable of the activity's~~ factory ~~to run when launching an instance~~ of the activity. ~~(fixme: python_module is somewhat redundant; it should get folded into exec)~~

~~default_type = _web_olpc._udp~~

~~: Each activity must have a default type. This must follow the mDNS specification for serivce types and must be globally unique. This key is required. It is used as the~~ service ~~type~~ for ~~the mDNS service when the activity~~ is ~~shared~~.

show_launcher = yes

: This key is optional. If not present, or if present with a value of "yes", the activity is shown with its icon in the [[Sugar]] panel launcher and a valid 'icon' key/value pair is required. If specified with a value of "no", the activity is not shown in the [[Sugar]] panel launcher, and the 'icon' key is not required.

@@ Line 32: / Line 32: @@
   [Activity]
- name = Web
   name[en_US] = Web
- name[de] = Web
   activity_version = 1
   host_version = 1
@@ Line 49: / Line 47: @@
   name = Web
-: This is the name is displayed in Sugar referring to the activity.  A 'name' key without a bracketed language code MUST match the name of the activity bundle directory, minus the ".activity" ending.  The activity.info file must have this key.
+: This is the name is displayed in Sugar referring to the activity.  A 'name' key without a bracketed language code is the "en_US" localized name of the activity.  The activity.info file must have this key.
- name[en_US] = Web
- name[de] = Web
-: These keys are localized names for the activity.  The language codes between the brackets are ISO language codes (fixme: need specific ISO standard).
   activity_version = 1
@@ Line 61: / Line 55: @@
 : Each activity.info file must have a "host_version" key.  The version is a single positive integer, and may only contain the characters 1 through 9.  This specifies the version of the Sugar environment which the activity is compatible with.  (fixme: need to specify sugar versions somewhere.  Obviously we start with 1.)
-  id = com.redhat.Sugar.BrowserActivity
+  service = com.redhat.Sugar.BrowserActivity
-: This is the activity's dbus service name.  It is required.
+: This is the activity's dbus service name.  It is required.  It is also used as the activity's default service type when the activity is shared on the network.  To determine this type, the distince parts (separated by the '.' character) are reversed, any '.' is replaced by a '_' character, and the type is prefixed by a '_' character.  So in this example, the default service type would be "_BrowserActivity_Sugar_redhat_com".
   icon = activity-web
 : This key is optional.  It points to the activity's icon.  The icon is first searched for in the activity bundle's root directory, and if not found, is looked up in the current GTK icon theme.  It cannot contain a path.
-  python_module = BrowserActivity.BrowserActivity
+  exec = sugar-activity-factory com.redhat.Sugar.BrowserActivity BrowserActivity.BrowserActivity
- exec = super-duper-web-browser
+: The exec key are used when [[Sugar]] installs the activity.  It specifies the executable which [[Sugar]] runs to start the activity's factory service.  A factory service spawns instances of the actual activity.  A factory service for Python-based activities is provided with [[Sugar]].
-: The python_module and exec keys are used when [[Sugar]] installs the activity.  The python_module key should point to the activity class in a python module; i.e. if running python from the root activity directory, one should be able to 'import <contents of python_module value>' successfully.  If the activity is not written in Python, then the exec key should contain the executable of the activity's factory to run when launching an instance of the activity.  (fixme: python_module is somewhat redundant; it should get folded into exec)
- default_type = _web_olpc._udp
-: Each activity must have a default type.  This must follow the mDNS specification for serivce types and must be globally unique.  This key is required.  It is used as the service type for the mDNS service when the activity is shared.
   show_launcher = yes
 : This key is optional.  If not present, or if present with a value of "yes", the activity is shown with its icon in the [[Sugar]] panel launcher and a valid 'icon' key/value pair is required.  If specified with a value of "no", the activity is not shown in the [[Sugar]] panel launcher, and the 'icon' key is not required.