sugarlabs/sugar-toolkit-gtk3
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

sugar3/bundle - activity metadata standard

Browse Source 
* encourage "url" for either home page or user documentation,

* give examples for categorisation tags, define format,

* make "website" an alias for "url",

* make "category" and "categories" aliases for "tags".

* add the aliases to deprecated list; valid for use, but not encouraged.

Deprecates https://wiki.sugarlabs.org/go/Development_Team/Almanac/Activity_Bundles#.info_file_format

Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com>
Signed-off-by: James Cameron <quozl@laptop.org>
Reviewed-by: Rahul Bothra <f2016015@pilani.bits-pilani.ac.in>
Reviewed-by: Yash Agrawal <yagrawal900@gmail.com>
This commit is contained in:
Vipul Gupta (@vipulgupta2048) 2018-05-30 16:31:58 +05:30 committed by James Cameron
parent 58224cb15d
commit 47563e678f
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/sugar3/bundle/__init__.py
View File

@ -21,7 +21,7 @@ Activity Metadata
================= =================
Your `activity/activity.info` file must have these metadata keys after Your `activity/activity.info` file must have these metadata keys after
an `[Activity]` header: an `[Activity]` header on the first line:
* `name` - the name of the activity, shown by Sugar in the list of * `name` - the name of the activity, shown by Sugar in the list of
installed activities, e.g. Browse, installed activities, e.g. Browse,
@ -46,29 +46,38 @@ an `[Activity]` header:
Optional metadata keys are; Optional metadata keys are;
* `summary` - a short summary of the activity that may be displayed in the List or Home Views, * `summary` - a short summary of the activity that may be displayed in
the List or Home Views,
* `mime_types` - list of MIME types supported by the activity, * `mime_types` - list of MIME types supported by the activity,
separated by semicolons. Your `read_file` method must be able to read separated by semicolons. Your `read_file` method must be able to read
files of these MIME types. Used to offer your activity when opening a files of these MIME types. Used to offer your activity when opening a
downloaded file or a journal object. downloaded file or a journal object.
* `url` - link to the home page for the activity, * `url` - link to a home page or user documentation on
https://help.sugarlabs.org/,
* `repository` - link to repository for activity code, for use by git clone, * `repository` - link to repository for activity code, for use by git clone,
* `single_instance` - if yes, only a single instance of an activity * `single_instance` - if yes, only a single instance of an activity
should be started, and if another instance is requested the existing should be started at any one time, and if another instance is requested
instance shown, the existing instance shown,
* `max_participants` - maximum number of participants for sharing an activity, * `max_participants` - maximum participants for sharing an activity,
* `tags` - more context into which to place an activity, * `tags` - a semicolon or whitespace delimited list of keywords that
describe the activity. Suggested keywords are Programming,
Robotics, Internet, Science, Maths, Language, Geography, Documents,
Music, Media, Art, Teacher, or System,
* `show_launcher` - if set to "no", the activity is not shown in list view, * `show_launcher` - if set to "no", the activity is not shown in list view,
Deprecated metadata keys are; Deprecated metadata keys are;
* `category` or `categories` - aliases for `tags`,
* `website` - alias for `url`,
* `update_url` - the updater no longer uses this. * `update_url` - the updater no longer uses this.
.. _SPDX License Identifier: http://spdx.org/licenses/ .. _SPDX License Identifier: http://spdx.org/licenses/
@ -103,7 +112,6 @@ Example `activity.info`
----------------------- -----------------------
.. code-block:: ini .. code-block:: ini
:emphasize-lines: 10-12,20-21
[Activity] [Activity]
name = Browse name = Browse
@ -115,6 +123,10 @@ Example `activity.info`
summary = Surf the world! summary = Surf the world!
license = GPL-3.0+ license = GPL-3.0+
repository = https://github.com/sugarlabs/browse-activity.git
url = https://help.sugarlabs.org/en/browse.html
tags = Utilities;Web
metadata_license = CC0-1.0 metadata_license = CC0-1.0
description: description:
<p>Surf the world! Here you can do research, watch educational videos, take online courses, find books, connect with friends and more. Browse is powered by the WebKit2 rendering engine with the Faster Than Light javascript interpreter - allowing you to view the full beauty of the web.</p> <p>Surf the world! Here you can do research, watch educational videos, take online courses, find books, connect with friends and more. Browse is powered by the WebKit2 rendering engine with the Faster Than Light javascript interpreter - allowing you to view the full beauty of the web.</p>
@ -124,7 +136,5 @@ Example `activity.info`
<li>Bookmark pages with collaborators in real time - great for researching as a group or teachers showing pages to their class</li> <li>Bookmark pages with collaborators in real time - great for researching as a group or teachers showing pages to their class</li>
<li>Comment on your bookmarked pages - a great tool for making curated collections</li> <li>Comment on your bookmarked pages - a great tool for making curated collections</li>
</ul> </ul>
url = https://github.com/sugarlabs/browse-activity
screenshots = https://people.sugarlabs.org/sam/activity-ss/browse-1-1.png https://people.sugarlabs.org/sam/activity-ss/browse-1-2.png screenshots = https://people.sugarlabs.org/sam/activity-ss/browse-1-1.png https://people.sugarlabs.org/sam/activity-ss/browse-1-2.png
''' '''