Development Team/Almanac/Activity Bundles: Difference between revisions

Line 58: Line 58:
  activity_version = 1
  activity_version = 1
  host_version = 1
  host_version = 1
  service_name = com.redhat.Sugar.BrowserActivity
  bundle_id = com.redhat.Sugar.BrowserActivity
  icon = activity-web
  icon = activity-web
  class = browseractivity.BrowserActivity
  class = browseractivity.BrowserActivity
Line 77: Line 77:
: Each activity.info file must have a "host_version" key.  The version is a single positive integer.  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.)
: Each activity.info file must have a "host_version" key.  The version is a single positive integer.  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.)


  service_name = com.redhat.Sugar.BrowserActivity
  bundle_id = com.redhat.Sugar.BrowserActivity
: 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".
: This is the activity bundle identifier.  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
  icon = activity-web
Line 84: Line 84:


  exec = sugar-activity webactivity.WebActivity
  exec = sugar-activity webactivity.WebActivity
: The exec key specifies the executable which [[Sugar]] runs to start the activity instances. Environment variables given on the exec line are expanded. It should support the following arguments:
: The exec key specifies the executable which [[Sugar]] runs to start the activity instances. Environment variables given on the exec line are expanded. Executable files should be placed into the bin/ directory in the bundle. It should support the following arguments:


; -b, --bundle-id  : Identifier of the activity bundle
; -a, --activity-id : Identifier of the activity instance.
; -a, --activity-id : Identifier of the activity instance.
; -o, --object-id  : Identifier of the associated datastore object.
; -o, --object-id  : Identifier of the associated datastore object.
; -u, --uri        : URI to load.
; -u, --uri        : URI to load.
Python activities should generally use the generic sugar-activity executable.


  mime_types = application/pdf;image/tiff
  mime_types = application/pdf;image/tiff