Development Team/Almanac/Activity Bundles: Difference between revisions

← Older edit Newer edit →

@@ Line 28: / Line 28: @@
   [Activity]
   name = Web
+ name[en_US] = Web
   name[de] = Web
-  version = 1
+  activity_version = 1
+ sugar_version = 1
   id = com.redhat.Sugar.BrowserActivity
   icon = activity-web
@@ Line 40: / Line 42: @@
   [Activity]
-: All .info files must begin with [Activity], and only that, on the first line of the file
+: The activity.info file must begin with [Activity], and only that, on the first line of the file
   name = Web
-: This is the name is displayed in Sugar referring to the activity.  A 'name' key without a bracketed language code is assumed to be US English.  All .info files must have this key.
+: 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.
+ name[en_US] = Web
   name[de] = Web
-: This is a localized name for the activity.  The language codes between the brackets are ISO language codes (fixme: need specific ISO standard).
+: These keys are localized names for the activity.  The language codes between the brackets are ISO language codes (fixme: need specific ISO standard).
-  version = 1
+  activity_version = 1
-: Each activity must have a version key.  The version is a single positive integer, and may only contain the characters 1 through 9.  Larger versions are considered "newer".
+: Each activity.info file must have a "activity_version" key.  The version is a single positive integer, and may only contain the characters 1 through 9.  Larger versions are considered "newer".
+ host_version = 1
+: 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
@@ Line 65: / Line 71: @@
   show_launcher = yes
-: This key is optional.  If specified, it indicates that the activity should show in the [[Sugar]] panel launcher, represented by the activity's icon.  If specified, the 'icon' key must also be specified.
+: 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.