1,285
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − + − − + − + − + − + − *[[Activity_pack]], (a collection of Activity Bundles) Line 22:
Line 20: − + Line 30:
Line 28: − + + + + + + + − + − + − + − activity/ + − activity.info + − activity-web.svg − contents − contents.sig − mimetypes.xml − permissions.info (optional; '''not a stable API''') − + − + + + + + + + + + + + + + + − + − .info files follow a key/value pair format, similar to the [http://www.freedesktop.org/wiki/Specifications/desktop-entry-spec fd.o desktop entry spec], but not conforming to it. An example is shown here:+ − [Activity]+ − name = Web − activity_version = 1 − host_version = 1 − bundle_id = com.redhat.Sugar.BrowserActivity − icon = activity-web − exec = sugar-activity browseractivity.BrowserActivity -s − mime_types = application/pdf;image/tiff − update_url = http://host.net/bundles/FooBar − A more detailed explanation of the valid properties follows:+ − [Activity] + − + − name = Web+ − : 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.+ − − − − − host_version = 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.) − + − + − + − + − icon = activity-web + − + − exec = sugar-activity webactivity.WebActivity + + + + Line 104:
Line 105: − + − mime_types = application/pdf;image/tiff + − + − show_launcher = yes + − + − update_url = ... + + − + + − + − There are properties anticipated to be used by future Sugar versions. In general, Sugar will ignore unknown properties, and use defaults for missing properties. − − tags = ... − : List of tags to categorize this activity. Not yet implemented, see [http://dev.laptop.org/ticket/6634 #6634]. − − == Activity Name Localization/Translation == Line 138:
Line 135: − + + Line 149:
Line 147: − + − + Line 163:
Line 161: − − Make sure to add your shell script and any native libraries to the MANIFEST before you package your bundle. You can also accomplish the same thing by throwing all your libraries in the root folder of the bundle, like the [[Map_(activity)|Map activity]] does, but if you have more than a few libraries to include it can get quite cluttered. − − + Line 177:
Line 172: − + + + + + + + + + + + + + + + + − + − + Line 190:
Line 200: − + − * [[Activity tutorial]] − + +
Development Team/Almanac/Activity Bundles (view source)
Revision as of 18:16, 3 June 2018
, 18:16, 3 June 2018.info file format, deprecate some parts, refer to specification in git
{{Developers}}
<noinclude>{{GoogleTrans-en}}</noinclude>{{Developers}}{{TOCright}}
{{Translations}}
== Introduction ==
== Introduction ==
[[Activities]] in the [[Sugar]] environment are packaged into a self-contained '''"bundles"'''. Each bundle contains all the resources and executable code (other than system-provided base libraries) which the activity needs to execute. Any resources or executable code that is not provided by the base system must be packaged within the bundle. Activity bundles are the end result of, and use a different directory structure than, [[Creating_an_activity|activity development]]
[[Activities]] in the [[Sugar]] environment are packaged into a self-contained '''"bundles"'''. Each bundle contains all the resources and executable code (other than system-provided base libraries) which the activity needs to execute. Any resources or executable code that is not provided by the base system must be packaged within the bundle. Activity bundles are the end result of, and use a different directory structure than, [[olpc:Creating_an_activity|activity development]]
; See also
; See also
*[[OLPC Bitfrost]] in general and its section on [[OLPC Bitfrost#Software installation|software installation]]
* [[olpc:OLPC Bitfrost]] in general and its section on [[olpc:OLPC Bitfrost#Software installation|software installation]]
*[[OLPC Human Interface Guidelines/Activities|HIG-Activities]] and its section on [[OLPC Human Interface Guidelines/Activities/Activity Bundles|activity bundles]]
* [[Human_Interface_Guidelines/Activities|HIG-Activities]] and its section on [[Human_Interface_Guidelines/Activities/Activity Bundles|activity bundles]]
*'''[[Creating_an_Activity|Creating an Activity bundle]]
* [[olpc:Creating an activity]]
== Rationale ==
== Rationale ==
Currently Sugar on jhbuild looks for bundles in the "activities" subfolders of XDG_DATA_DIRS. Right now this is /usr/share/activities and the usr/share/activities subfolder of the jhbuild build folder.
Currently Sugar on jhbuild looks for bundles in the "activities" subfolders of XDG_DATA_DIRS. Right now this is /usr/share/activities and the usr/share/activities subfolder of the jhbuild build folder.
Sugar will automatically generate and remove the .service files necessary to launch the activity through [[D-BUS]] service activation when the activity is installed or removed.
Sugar will automatically generate and remove the .service files necessary to launch the activity through [[olpc:D-BUS]] service activation when the activity is installed or removed.
Activities should also NEVER store local state or preferences in the activity bundle itself. These should always be stored in an activity-specific directory in the user's sugar profile, available through the SUGAR_PROFILE environment variable.
Activities should also NEVER store local state or preferences in the activity bundle itself. These should always be stored in an activity-specific directory in the user's sugar profile, available through the SUGAR_PROFILE environment variable.
profile_path = sugar.env.get_profile_path()
profile_path = sugar.env.get_profile_path()
== Bundle Structure ==
== Bundle structure ==
The activity bundle is a directory, with a name ending in ".activity". Each activity bundle must, in a subdirectory called 'activity', contain a file named "activity.info", and following a special format. For example:
The activity bundle is a directory, with a name ending in ".activity". Each activity bundle must, in a subdirectory called 'activity', contain a file named "activity.info", and following a special format. For example:
Web.activity/
Web.activity/
activity/
activity.info (activity info file)
activity-web.svg (icon for activity as specified in activity.info)
mimetypes.xml (map documents to MIME types)
text-plain.svg (icons for documents, e.g. "text-plain.svg" for "text/plain")
text-html.svg
bin/
bin/
web-activity
web-activity (launcher script or activity executable)
locale/
locale/
de_DE/
de_DE/
activity.linfo
activity.linfo (localized info 1)
zh_CN/
zh_CN/
activity.linfo
activity.linfo (localized info 2)
lib/
mylib.so (native library)
icons/
icons/
; activity
;activity
All metadata about the activity is organized in this subdirectory. The <code>contents</code> and <code>contents.sig</code> are manifest and credential files for the entire bundle contents (excepting the <code>contents</code> and <code>contents.sig</code> files themselves), as described by the [[Manifest Specification]]. The optional <code>mimetypes.xml</code> file is a [http://freedesktop.org/wiki/Specifications/shared-mime-info-spec freedesktop.org MIME type file] describing how to recognize the MIME types defined by the activity.
All metadata about the activity is organized in this subdirectory. The <code>contents</code> and <code>contents.sig</code> are manifest and credential files for the entire bundle contents (excepting the <code>contents</code> and <code>contents.sig</code> files themselves), as described by the [[olpc:Contents manifest specification]]; these files are not supported by current versions of Sugar. The optional <code>mimetypes.xml</code> file is a [http://freedesktop.org/wiki/Specifications/shared-mime-info-spec freedesktop.org MIME type file] describing how to recognize the MIME types defined by the activity. SVG icons for those MIME types can be put in this directory as well.
;bin
Contains executables, is added to the PATH environment variable.
;lib
See [[#Bundling native libraries]] below.
;locale
See [[#Activity name localization/translation]] below.
; icons
; icons
Contains the icons used by the activity. When using the sugar.activity python package the path is automatically added to the default [http://www.pygtk.org/docs/pygtk/class-gtkicontheme.html gtk icon theme].
Contains the icons used by the activity. When using the sugar.activity python package the path is automatically added to the default [http://www.pygtk.org/docs/pygtk/class-gtkicontheme.html gtk icon theme].
== .info File Format ==
== .info file format ==
See [https://github.com/sugarlabs/sugar-toolkit-gtk3/blob/master/src/sugar3/bundle/__init__.py sugar3/bundle] for the latest bundle metadata specification.
This section below deprecated, but has some useful historical information that goes beyond what the specification needs.
Some additional comments on the key;
name
: The activity.info file must begin with [Activity], and only that, on the first line of the file
: A 'name' key without a bracketed language code is the "en_US" localized name of the activity.
activity_version
: An activity should not use the value in source code, as it may be changed by developers and packagers.
activity_version = 1
: Each activity.info file must have a "activity_version" key. The version is a single positive integer. Larger versions are considered "newer". The value assigned to this key should be considered '''opaque''' to the activity; the only requirement of the activity is that it must be larger for new activity builds.
bundle_id = com.redhat.Sugar.BrowserActivity
bundle_id
: This is the activity bundle identifier. It is required. The name should conform to the [http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names D-Bus spec] - in particular, hyphens are not allowed (although this wasn't enforced in earlier builds, see [http://dev.laptop.org/ticket/6226 Trac 6226]). It is recommended that [http://en.wikipedia.org/wiki/Java_package#Package_naming_conventions Java package naming conventions] are used when chosing bundle identifiers, to ensure uniqueness. Briefly, your name should begin with the reversed domain name of an organization you belong to.
: The name should conform to the [http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names D-Bus spec] - in particular, hyphens are not allowed. It is recommended that [http://en.wikipedia.org/wiki/Java_package#Package_naming_conventions Java package naming conventions] are used when choosing bundle identifiers, to ensure uniqueness. Briefly, your name should begin with the reversed domain name of an organization you belong to.
: The reversed domain name part is supposed to be rooted in some actual DNS-rooted namespace. You don't need to own this domain; you just need to have a reasonable claim on some ''unique'' name at that domain. There are several ways to derive one:
: The reversed domain name part is supposed to be rooted in some actual DNS-rooted namespace. You don't need to own this domain; you just need to have a reasonable claim on some ''unique'' name at that domain. There are several ways to derive one:
:* If your email address is ''yourname''@''somemailhost''.com, then you could use ''com.somemailhost.yourname''.''YourActivity''.
:* If your email address is ''yourname''@''somemailhost''.com, then you could use ''com.somemailhost.yourname''.''YourActivity''.
:* You could set up a web page on a free hosting service with information about your activity, and use a name derived from its URL. For example, if you create a page at http://www.geocities.com/xotumusica for your activity, then com.geocities.www.xotumusica is a reasonable bundle_id.
:* You could set up a web page on a free hosting service with information about your activity, and use a name derived from its URL. For example, if you create a page at http://www.geocities.com/xotumusica for your activity, then com.geocities.www.xotumusica is a reasonable bundle_id.
:* If nothing else is available, even org.laptop.wiki.''YourActivityPageTitle'' is probably a reasonable bundle_id, provided that you create the [[YourActivityPageTitle]] page. Remember, bundle_ids should be unique, so you should double check that the [[YourActivityPageTitle]] page doesn't already exist (and then create it) before using this as your bundle_id.
:* If nothing else is available, even org.sugarlabs.wiki.''Your Activity Page Title'' is probably a reasonable bundle_id, provided that you create the 'Your Activity Page Title' page. Remember, bundle_ids should be unique, so you should double check that the 'Your Activity Page Title' page doesn't already exist (and then create it) before using this as your bundle_id.
: In the Python bindings, the bundle_id is also used as the activity's default service type when the activity is shared on the network. To determine this type, the distinct 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".
: In the Python bindings, the bundle_id is also used as the activity's default service type when the activity is shared on the network. To determine this type, the distinct 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 "_WebActivity_laptop_org".
license
: It points to the activity's icon. The icon is looked up in the activity bundle's 'activity' directory (the same directory the activity.info file is in). It cannot contain a path. When searching for the icon in the activity bundle's 'activity' directory, only a file with the icon name and the extension '.svg' will be looked for.
: This field names the licenses used for the activity bundle (the "binary" .xo file). For multiple licenses, separate them with semicolons ";". Otherwise, the value should conform to the same guidelines as the [http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License:_field <code>License:</code> field] of an RPM package; consult the [http://fedoraproject.org/wiki/Packaging/LicensingGuidelines Fedora Licensing Guidelines] for more information. A 'license' field naming an entry or entries in the "Good Licenses" table at [http://fedoraproject.org/wiki/Licensing Fedora's Licensing list] is required for any activities distributed by Sugar Labs.
icon
: The icon is looked up in the activity bundle's 'activity' directory (the same directory the activity.info file is in). It cannot contain a path. When searching for the icon in the activity bundle's 'activity' directory, only a file with the icon name and the extension '.svg' will be looked for.
exec
: 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:
: 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:
; -u, --uri : URI to load.
; -u, --uri : URI to load.
Python activities should generally use the generic sugar-activity executable. Other activities need to adhere to the [[Low-level Activity API]].
Python activities should generally use the generic sugar-activity executable. Other activities need to adhere to the [[olpc:Low-level Activity API]].
tags
: List of mime types supported by the activity, separated by semi colons. It's used when opening a file from the web or to present to the user a list of activities which can open a certain journal object.
: Tags give more context in which to place the activity. This is used to allow users to find activities more easily in the journal, the home view, [http://activities.sugarlabs.org http://activities.sugarlabs.org], etc.
single_instance
: 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.
: Added to flag activities that use resources that cannot be shared, such as a camera.
max_participants
: Setting max_participants in activity.py is possible, but deprecated.
: URL to retrieve update information; implemented in [http://dev.laptop.org/ticket/4951 #4951]. The software update control panel will attempt to look for information about the latest version of the activity by fetching the given url with first the core OS build number, then the release number, then the release major version number appended, then finally as-is. (For example, if your update URL tag has the value 'http://host.net/bundles/FooBar' and you are currently running release 8.1.1 (core OS 708), the following URLs will be tried, in this order: http://host.net/bundles/FooBar/708, http://host.net/bundles/FooBar/8.1.1, http://host.net/bundles/FooBar/8.1, http://host.net/bundles/FooBar .) The contents of the URLs should be in the [[activity microformat]]. If no update_url is specified, http://wiki.laptop.org/go/Activities will be used. See [[Software update]] for more information.
repository
: The URL of the master git repository for the activity, for use by {{code|git clone}}. Since activities are not all hosted in a single repository, it is important to include a link so that users can readily find the activity. Some git hosting services allow the URL to be used by web browser as well as {{code|git clone}}.
===Future Properties===
== Localization/translation of the activity name and tags ==
Localized data lives in the locale directory. Each language stores its localized keys in a <u>separate</u> directory named for the language's ISO code. Localized keys from the 'activity.info' file are stored in the 'activity.linfo' files in that directory. For example, German-localized German (as opposed to Swiss-localized German) language translations are stored in the 'de_DE/activity.linfo' file:
Localized data lives in the locale directory. Each language stores its localized keys in a <u>separate</u> directory named for the language's ISO code. Localized keys from the 'activity.info' file are stored in the 'activity.linfo' files in that directory. For example, German-localized German (as opposed to Swiss-localized German) language translations are stored in the 'de_DE/activity.linfo' file:
activity.linfo
activity.linfo
At this time, only translations for the 'name' key from the 'activity.info' file is supported. A localized 'de_DE/activity.linfo' file would look like:
At this time, only translations for the 'name' and 'tags' keys from the 'activity.info' file is supported. A localized 'de_DE/activity.linfo' file would look like:
[Activity]
[Activity]
name = Web
name = Web
tags = erforschung;web
Keys in the languague-specific '.linfo' files selectively override keys from the 'activity.info' file; if a key is not present in the '.linfo' file the value from the 'activity.info' file is used instead.
Keys in the languague-specific '.linfo' files selectively override keys from the 'activity.info' file; if a key is not present in the '.linfo' file the value from the 'activity.info' file is used instead.
Activity bundles should be packaged as zip files with the ".xo" extension. The mime type in the journal is "application/vnd.olpc-sugar".
Activity bundles should be packaged as zip files with the ".xo" extension. The mime type in the journal is "application/vnd.olpc-sugar".
== Bundling Native Libraries ==
== Bundling native libraries ==
Sometimes you need to include a native library or two with your activity. The strategy that [[Develop]] and [[Model]] use is specifying a shell script for the executable in the .info file:
Sometimes you need to include a native library or two with your activity. The strategy that [[olpc:Develop]] and [[olpc:Model]] use is specifying a shell script for the executable in the .info file:
exec = ./model_startup.sh
exec = ./model_startup.sh
sugar-activity model_app.ModelActivity
sugar-activity model_app.ModelActivity
== activity/permissions.info ==
== activity/permissions.info ==
'''Note: the API described in this section is NOT STABLE and will probably change in future releases; perhaps drastically.'''
'''Note: the API described in this section is DEPRECATED.'''
Bitfrost describes a variety of security-related settings which activity authors can specify about their activity. At the option of the activity author, these settings can be described in a file called 'permissions.info' which can be placed alongside 'activity.info' in the 'activity' directory of the bundle.
Bitfrost describes a variety of security-related settings which activity authors can specify about their activity. At the option of the activity author, these settings can be described in a file called 'permissions.info' which can be placed alongside 'activity.info' in the 'activity' directory of the bundle.
constant-uid
constant-uid
into the permissions.info file will result in your activity being launched with the same uid each time it is run. (This is option is mainly used by activities based on the xulrunner codebase.)
into the permissions.info file will result in your activity being launched with the same uid each time it is run. (Usually each activity gets a constant gid, but each instance launched of the activity gets a unique uid. Activities based on the xulrunner codebase, however, tend to set restrictive group permissions on local files, so this option avoids this problem at the cost of less isolation between activity instances.)
As of rainbow-0.7.22, the line:
use-serial
will add the activity UIDs to the 'uucp' group, so that the activity can access /dev/ttyUSB* devices. (See <trac>8434</trac>.)
Other options which may be specified include:
lim_nofile 20
lim_fsize 10e6
lim_nproc 8
lim_mem 190e6
which will limit the number of file descriptors, the maximum writable file size, the number of processes, and the maximum size of the activity's address space, respectively. (See <tt>[http://linux.die.net/man/2/setrlimit man 2 setrlimit]</tt> for details.)
== Other Technologies Comparison ==
== Other technologies comparison ==
Activity bundles are similar to OS X bundles or [[Java JAR files]]; a simple mechanism to encapsulate everything you need in a single directory that can be moved around independently.
Activity bundles are similar to OS X bundles or Java JAR files; a simple mechanism to encapsulate everything you need in a single directory that can be moved around independently.
It differs from autopackage, it's not a package management system. There's no central database, no scripts get run on install/uninstall. There also is no special file format.
It differs from autopackage, it's not a package management system. There's no central database, no scripts get run on install/uninstall. There also is no special file format.
== See also ==
== See also ==
* [[Bundle]] for a generic introduction to bundles
* [[olpc:Activity tutorial]]
[[Category:API]]
[[Category:API]]
[[Category:Sugar]]
[[Category:Sugar]]
[[Category:Developers]]
[[Category:Developer]]
[[Category:Software development]]
[[Category:Software development]]
[[Category:File formats]]
[[Category:File formats]]
[[Category:Activity installation]]