Difference between revisions of "Filling Out the Bundle Class"

From The SBN Wiki
Jump to navigation Jump to search
(Update for Release 1.0)
 
(One intermediate revision by the same user not shown)
Line 16: Line 16:
 
* Supplemental
 
* Supplemental
  
Use the ''Supplemental'' value if your bundle doesn't contain any observational data at all.  So, for example, a bundle comprising all the documentation produced by a mission may many document collections, but no data collections.  Such a bundle would have a ''<bundle_type>'' of ''Supplemental''.
+
Use the ''Supplemental'' value if your bundle doesn't contain any observational data at all.  So, for example, a bundle comprising all the documentation produced by a mission may have many document collections, but no data collections.  Such a bundle would have a ''<bundle_type>'' of ''Supplemental''.
  
 
== <description> ==
 
== <description> ==
Line 22: Line 22:
 
''OPTIONAL''
 
''OPTIONAL''
  
This attribute provides contains free-form text.  Use it to include any explanatory comments you'd care to make about the bundle and its contents, but note that the description displayed to users in search interfaces is in the ''<Citation_Information>'' class, and any detailed information about the bundle content and organization should be in the file described by the ''<File_Area_Text>'' class.  That doesn't leave a lot to be said here.
+
This attribute contains free-form text.  Use it to include any explanatory comments you'd care to make about the bundle and its contents, but note that the description displayed to users in search interfaces is the one in the ''<Citation_Information>'' class, not this one, and any detailed information about the bundle content and organization should be in the file described indicated by the ''<File_Area_Text>'' class.  That doesn't usually leave a lot to be said here.

Latest revision as of 13:33, 29 April 2015

The <Bundle> class contains only two attributes - a type and a description field.

For additional explanation, see the PDS4 Standards Reference, or contact your PDS node consultant.

Following are the attributes you'll find in the Bundle class, in label order.

Note that in the PDS4 master schema, all classes have capitalized names; attributes never do.

<bundle_type>

REQUIRED

This must be one of these two standard values:

  • Archive
  • Supplemental

Use the Supplemental value if your bundle doesn't contain any observational data at all. So, for example, a bundle comprising all the documentation produced by a mission may have many document collections, but no data collections. Such a bundle would have a <bundle_type> of Supplemental.

<description>

OPTIONAL

This attribute contains free-form text. Use it to include any explanatory comments you'd care to make about the bundle and its contents, but note that the description displayed to users in search interfaces is the one in the <Citation_Information> class, not this one, and any detailed information about the bundle content and organization should be in the file described indicated by the <File_Area_Text> class. That doesn't usually leave a lot to be said here.