Bundle metadata: Difference between revisions

From OLPC
Jump to navigation Jump to search
(stub)
(+draft)
Line 1: Line 1:
We need to update the metadata used for OLPC bundles. Currently a slightly different set of data is gathered for [[activity bundles]], [[sample library.info file|library bundles]], and specfiles for rpms that are included in latest builds.
We need to update the metadata used for OLPC bundles. Currently a slightly different set of data is gathered for [[activity bundles]], [[sample library.info file|library bundles]], and specfiles for rpms that are included in latest builds.


Below is an early draft of a suggested set of fields for a unified .info file that can be use for all [[bundles]] (including generic bundles of a few files put together in order to share them). Depending on the context, some of these fields will not be used or useful.
== in info file ==

Please add to the [[talk:bundle metadata|discussion]], add or remove suggested fields, or alter the lines drawn between required files in a config directory and required fields in the .info file itself. For instance, changlog data that is kept directly within .spec files is here relegated to a required changelog.


== suggested unified info file ==
:blue : current field, same meaning
:purple : current field, some change in meaning; or name change to make it clearer
:green : current field for one of the .info/.spec formats we use
:orange : new desired field; either replacing existing but unused field or adding new information

* <font color=blue>name</font> - string
* <font color=blue>name</font> - string
* <font color=blue>long_name</font> - or better "pretty_name", for display (could be shorter than <tt>name</tt>
* <font color=blue>long_name</font> - or better "pretty_name", for display (could be shorter than <tt>name</tt>
* <font color=red>version</font> - int.int
* <font color=orange>version</font> - int.int
* <font color=red>sugar_version</font> - int.int
* <font color=orange>sugar_version</font> - int.int
* <font color=purple>bundle_id</font> (change name for clarity, standard style?)
* <font color=purple>bundle_id</font> (change name for clarity, standard style?)
* <font color=purple>icon</font> - filename (change name for clarity; add path?)
* <font color=purple>icon</font> - filename (change name for clarity; add path?)

Revision as of 19:42, 26 January 2008

We need to update the metadata used for OLPC bundles. Currently a slightly different set of data is gathered for activity bundles, library bundles, and specfiles for rpms that are included in latest builds.

Below is an early draft of a suggested set of fields for a unified .info file that can be use for all bundles (including generic bundles of a few files put together in order to share them). Depending on the context, some of these fields will not be used or useful.

Please add to the discussion, add or remove suggested fields, or alter the lines drawn between required files in a config directory and required fields in the .info file itself. For instance, changlog data that is kept directly within .spec files is here relegated to a required changelog.


suggested unified info file

blue : current field, same meaning
purple : current field, some change in meaning; or name change to make it clearer
green : current field for one of the .info/.spec formats we use
orange : new desired field; either replacing existing but unused field or adding new information
  • name - string
  • long_name - or better "pretty_name", for display (could be shorter than name
  • version - int.int
  • sugar_version - int.int
  • bundle_id (change name for clarity, standard style?)
  • icon - filename (change name for clarity; add path?)
  • exec - shell invocation (change name for clarity?)
  • mime_types - semicolon? separated list of strings
  • locale - comma? separated list of strings
  • category - string
  • author - string (creator?)
  • maintainer - string, rfc822 email header
  • license - fedora license fields
  • last_update - date
  • url - url (or 'project url')

files

acknowldgements - required

changelog - required

    • person/author
    • merge information : specific versions of projects being branched/borrowed from
    • date/time

bib_info

    • name/title/attrib/filename &c. for each leaf in a collection (use existing bibliiographic info standard)

manifest

tags

There was debate about how to handle this. A section in bib_info, including file sections for the collection as a whole or named subcollections? A separate file with a set of all relevant tags for the whole bundle, one per line? An entry in the .info file?