OS Builder/Add additional Activities: Difference between revisions

From OLPC
Jump to navigation Jump to search
(rework)
Line 1: Line 1:
Look into the sugar_activity_group and sugar_activities_extra modules.
You can add additional activities using the {{code|sugar_activity_group}} and {{code|sugar_activities_extra}} modules.

An ''Activity Group'' page is a list of activities and download URLs.
The page must use the Sugar [http://wiki.sugarlabs.org/go/Activity_Team/Activity_Microformat activity microformat].
The page does not need to be on the OLPC Wiki; it can be on your own web server or school server.

The ''Software Update'' feature will check the ''Activity Group'' page for updated activities.


=sugar_activity_group=
=sugar_activity_group=


If your activities are published online and can being fetched from public URLs, and you can manage a "Sugar Activity Group page" the best option is to use sugar_activity_group. This works both for the builder and for later updates.
If your activities are published online or can being fetched by the laptops, ''and'' you can manage a ''Activity Group'' page, then use {{code|sugar_activity_group}}. This works both for the builder and the ''Software Update'' feature, so you can deliver updates during a deployment.


Define a 'base URL' -- for example, http://wiki.laptop.org/go/Activities/YourDeployment . Add the module to the modules list and a new section:
Define a ''base URL'' -- for example,

<nowiki>http://wiki.laptop.org/go/Activities/YourDeployment</nowiki>

Add the module to the modules list and a new section:


[sugar_activity_group]
[sugar_activity_group]
url=http://wiki.laptop.org/go/Activities/YourDeployment
url=<nowiki>http://wiki.laptop.org/go/Activities/YourDeployment</nowiki>


The system will actually request a url adding the OS version number, so it will try, in order
The builder will request a URL by adding the operating system version number, so it will try, in order:


http://wiki.laptop.org/go/Activities/YourDeployment/10.1.3
<nowiki>http://wiki.laptop.org/go/Activities/YourDeployment/13.2.7</nowiki>
http://wiki.laptop.org/go/Activities/YourDeployment/10.1
<nowiki>http://wiki.laptop.org/go/Activities/YourDeployment/13.2</nowiki>
http://wiki.laptop.org/go/Activities/YourDeployment/10
<nowiki>http://wiki.laptop.org/go/Activities/YourDeployment/13</nowiki>
http://wiki.laptop.org/go/Activities/YourDeployment
<nowiki>http://wiki.laptop.org/go/Activities/YourDeployment</nowiki>


For best control over activity versions, create an ''Activity Group'' page with the full operating system version number, for example:
For best control over activity versioning, create a page for this specific version http://wiki.laptop.org/go/Activities/YourDeployment/10.1.3 . The page uses the[http://wiki.sugarlabs.org/go/Activity_Team/Activity_Microformat activity microformat] -- the easiest way is to start copying the contents of http://wiki.laptop.org/go/Activities/G1G1/10.1.3 or http://wiki.laptop.org/go/Activities/G1G1Lite/10.1.3
<nowiki>http://wiki.laptop.org/go/Activities/YourDeployment/13.2.7</nowiki>

An easy way is to start by copying the contents of [[Activities/13.2.7]].

Using your own ''Activity Group'' page will hide updates from the OLPC ''Activity Group'', so be sure to keep your page up to date.


=sugar_activities_extra=
=sugar_activities_extra=


If your activities and content are not published, or you prefer to avoid maintaining a "Sugar Activity Group page", you can use sugar_activities_extra.
If your activities and content are not published, or you prefer to avoid maintaining a Sugar ''Activity Group'' page, you can use {{code|sugar_activities_extra}}.


However, this method does not support Sugar's ''Software Update'' feature, so you cannot update activities automatically during deployment.
For just place them in a directory next to your INI file, and use the sugar_activities_extra module.


For activities with a URL, add:
* Add sugar_activities_extra to the modules list
* For activities with a URL, just add a
[sugar_activities_extra]
[sugar_activities_extra]
url_1=http://foo.com/MyActivity-1.xo
url_1=<nowiki>http://activities.example.edu/MyActivity-1.xo</nowiki>
url_2=http://foo.com/MyContent-3.xol
url_2=<nowiki>http://activities.example.edu/MyContent-3.xol</nowiki>

* For activities from your disk, create a directory <code>activities</code>, and add instead
For activities from your disk, put them in a <code>activities</code>, and add:
[sugar_activities_extra]
[sugar_activities_extra]
local_dir=%(oob_config_dir)s/activities
local_dir=%(oob_config_dir)s/activities

Revision as of 22:06, 2 October 2016

You can add additional activities using the sugar_activity_group and sugar_activities_extra modules.

An Activity Group page is a list of activities and download URLs. The page must use the Sugar activity microformat. The page does not need to be on the OLPC Wiki; it can be on your own web server or school server.

The Software Update feature will check the Activity Group page for updated activities.

sugar_activity_group

If your activities are published online or can being fetched by the laptops, and you can manage a Activity Group page, then use sugar_activity_group. This works both for the builder and the Software Update feature, so you can deliver updates during a deployment.

Define a base URL -- for example,

 http://wiki.laptop.org/go/Activities/YourDeployment

Add the module to the modules list and a new section:

 [sugar_activity_group]
 url=http://wiki.laptop.org/go/Activities/YourDeployment

The builder will request a URL by adding the operating system version number, so it will try, in order:

 http://wiki.laptop.org/go/Activities/YourDeployment/13.2.7
 http://wiki.laptop.org/go/Activities/YourDeployment/13.2
 http://wiki.laptop.org/go/Activities/YourDeployment/13
 http://wiki.laptop.org/go/Activities/YourDeployment

For best control over activity versions, create an Activity Group page with the full operating system version number, for example:

 http://wiki.laptop.org/go/Activities/YourDeployment/13.2.7

An easy way is to start by copying the contents of Activities/13.2.7.

Using your own Activity Group page will hide updates from the OLPC Activity Group, so be sure to keep your page up to date.

sugar_activities_extra

If your activities and content are not published, or you prefer to avoid maintaining a Sugar Activity Group page, you can use sugar_activities_extra.

However, this method does not support Sugar's Software Update feature, so you cannot update activities automatically during deployment.

For activities with a URL, add:

 [sugar_activities_extra]
 url_1=http://activities.example.edu/MyActivity-1.xo
 url_2=http://activities.example.edu/MyContent-3.xol

For activities from your disk, put them in a activities, and add:

 [sugar_activities_extra]
 local_dir=%(oob_config_dir)s/activities