Metadata object - jhhl/AUMI-Together GitHub Wiki

Metadata object

Most AUMIT persisted objects have a Metadata object (structure, really) embedded in it.

This guarantees that the object can be maintained and navigated using common APIs.

  • version : the version of metadata object / the version of the enclosing object. While these could be in "dotted" format, I find simple numbers, as a devolved version of that, work fine.
  • name : the internal name of the object
  • uinames : an internationalized dictionary of names for the UI to display for the object. e.g.:
{
'default' : 'Piano',
'en-GB' : 'Her Majesty's Piano',
'en-CA' : 'The Piano, eh',
'en' : 'Piano',
'de' : 'Klavier'
}
  • icon : either
    • a simple UNICODE string
  • author : responsible party (parties) for this object
  • description : an internationalized dictionary of descriptions. e.g.:
{
'default' : '60 key piano from C4 to C6',
'de' : ' Klavier mit 60 Noten'
}
  • credits : copyright and required IP licensing info
  • tags : a list of tag strings, which are NOT internationalized. This may use my parameterized tag feature.
  • created : creation date
  • modified : latest modified date (of either object or metadata)
  • source: source URL to update this object with
  • signature: signature of the data
  • comment: any other information that might be internal, like source code management levels,