Features/Sugar Bundles: Difference between revisions

Line 41: Line 41:
* Journal entries with ''activity_id'', launch poper activity to open this object
* Journal entries with ''activity_id'', launch poper activity to open this object
* activities, launch it with newly created object
* activities, launch it with newly created object
=== Specification ===
Object bundle should have METADATA file in the top directory of .xo bundle.
This file is in [http://docs.python.org/library/configparser.html INI] format which describes how to setup bundle.
METADATA file can have one or several sections(depends on installation method) that describe metadata fields of final entry(ies) in Journal.
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Field
! Flags
! Notes
|-
| ''entry''
| mandatory
| defines access point to within bundle (e.g. index.html for library bundles)
|-
| ''mime_type''
| mandatory
| define MIME type for final Journal entry
|-
| ''uid''
| ignored
|-
| ''*''
| optional
| any [[Features/Plain_Query_Format#System_terms|system]], [[Features/Plain_Query_Format#Users_predefined_terms|users predefined]] and arbitrary Datastore field
|-
|}
Any field in ''METADATA'' file can have ''_file'' suffix, in that case content of this field(substring w/o ''_file'' suffix) will be fetched from file inside of the bundle.


== Benefit to Sugar ==
== Benefit to Sugar ==