User:Alsroot/trash/Object Bundles: Difference between revisions

Line 32:

=== METADATA file ===

Object bundle could be installed to Journal in two forms:

* files from bundle will be unpacked and installing as separate files, bundle itself will be removed(similar to .xoj)<br>''METADATA'' should not contain ''[Composite]'' section

* bundles will be installed as composite object i.e. as a directory of packaged to bundle files<br>''METADATA'' should contain ''[Composite]'' section

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.

''[Metadata]'' section is mandatory. It describes Datastore metadata fields of final entry in Journal.

==== [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;"

Line 44:

Line 50:

|-

| ''journal_file''

| ~~optional~~

| mandatory

| if exists, this file will be unpacked while uploading bundle to Journal and current section defines its metadata<br>otherwise defines metadata for bundle itself and bundle will be stored as is in Journal

|-

Line 57:

Line 63:

|}

METADATA file could have several ''[Manifest]'' sections, in that case they ~~would~~ be parted by different suffixes e.g. ''[Manifest2]'', ''[Manifest.additional]'' etc. Multi-object bundles could be utilized in >0.86 for collections of objects or actions.

METADATA file could have several ''[Manifest]'' sections, in that case they should be parted by different suffixes e.g. ''[Manifest2]'', ''[Manifest.additional]'' etc. Multi-object bundles could be utilized in >0.86 for collections of objects or actions.

=== MANIFEST file ===

@@ Line 32: / Line 32: @@
 === METADATA file ===
+Object bundle could be installed to Journal in two forms:
+* files from bundle will be unpacked and installing as separate files, bundle itself will be removed(similar to .xoj)<br>''METADATA'' should not contain ''[Composite]'' section
+* bundles will be installed as composite object i.e. as a directory of packaged to bundle files<br>''METADATA'' should contain ''[Composite]'' section
 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.
-''[Metadata]'' section is mandatory. It describes Datastore metadata fields of final entry in Journal.
+==== [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;"
@@ Line 44: / Line 50: @@
 |-
 | ''journal_file''
-| optional
+| mandatory
 | if exists, this file will be unpacked while uploading bundle to Journal and current section defines its metadata<br>otherwise defines metadata for bundle itself and bundle will be stored as is in Journal
 |-
@@ Line 57: / Line 63: @@
 |}
-METADATA file could have several ''[Manifest]'' sections, in that case they would be parted by different suffixes e.g. ''[Manifest2]'', ''[Manifest.additional]'' etc. Multi-object bundles could be utilized in >0.86 for collections of objects or actions.
+METADATA file could have several ''[Manifest]'' sections, in that case they should be parted by different suffixes e.g. ''[Manifest2]'', ''[Manifest.additional]'' etc. Multi-object bundles could be utilized in >0.86 for collections of objects or actions.
 === MANIFEST file ===