Changes

Jump to navigation Jump to search
Line 25: Line 25:  
This feature is a first approach to unified format for all types of bundles(in 0.86 it will support only Journal entries and new library bundles).
 
This feature is a first approach to unified format for all types of bundles(in 0.86 it will support only Journal entries and new library bundles).
   −
==== Bundle files hierarchy ====
+
=== Bundle files hierarchy ===
    
* ''MANIFEST'' EOL-terminalted list of files inside bundle
 
* ''MANIFEST'' EOL-terminalted list of files inside bundle
 
* ''METADATA'' file in [http://docs.python.org/library/configparser.html INI] format which describes bundle
 
* ''METADATA'' file in [http://docs.python.org/library/configparser.html INI] format which describes bundle
   −
==== METADATA file ====
+
=== METADATA file ===
    
METADATA files consists of several sections:
 
METADATA files consists of several sections:
* ''[Metadata]'' required<br>describes Datastore metadata fields of final entry in Journal<br>each field in this section is equal to proper Datastore field<br>should contain at least ''mime_type'' field
+
* ''[Metadata]''
 
* ...
 
* ...
    
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 bundle.
 
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 bundle.
 +
 +
==== [Metadata] section ====
 +
 +
This section is mandatory. It describes Datastore metadata fields of final entry in Journal.
 +
 +
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
 +
|-style="background:#787878; color: white;"
 +
! Field
 +
! Flags
 +
! Notes
 +
|-
 +
| mime_type
 +
| mandatory
 +
|
 +
|-
 +
| *
 +
| optional
 +
| any Datastore field, predefined or user defined
 +
|-
 +
|}
 +
 +
 +
<br>each field in this section is equal to proper Datastore field<br>should contain at least ''mime_type'' field
    
== Benefit to Sugar ==
 
== Benefit to Sugar ==

Navigation menu