This site may be down for up to an hour for network maintenance during the period
21 January 2022 22:30 UTC - 22 January 2022 00:30 UTC.

Difference between revisions of "Filling Out the Reference List Classes"

From The SBN Wiki
Jump to navigation Jump to search
(Safety Save)
(: Safety Save)
Line 27: Line 27:
  
 
Either a logical ID (LID) reference or a LID reference with an additional version ID (VID) must be provided (but not both).  If ''<lid_reference>'' is used, the value must match the ''<logical_identifier>'' value of some other PDS4 product in the registry (this will be checked when the product is officially registered).  Similarly, when a ''<lidvid_reference>'' is used, the value has the format '''''logical_identifier::version_identifier''''', and there must be a product with the given ''<logical_identifier>'' '''and''' ''<version_identifier>'' values.
 
Either a logical ID (LID) reference or a LID reference with an additional version ID (VID) must be provided (but not both).  If ''<lid_reference>'' is used, the value must match the ''<logical_identifier>'' value of some other PDS4 product in the registry (this will be checked when the product is officially registered).  Similarly, when a ''<lidvid_reference>'' is used, the value has the format '''''logical_identifier::version_identifier''''', and there must be a product with the given ''<logical_identifier>'' '''and''' ''<version_identifier>'' values.
 +
 +
=== <reference_type> ===
 +
 +
''REQUIRED''
 +
 +
This must be one of the standard values defined for this context.  We keep a list of these on [[Questions#.3CInternal_Reference.3E.2F.3Creference_type.3E|the Questions page]].  This list is likely to grow - if you need a new value, let your PDS contact person know.
 +
 +
=== <comment> ===
 +
 +
''OPTIONAL''
 +
 +
This is a place to put a bit of text as needed to explain why you're referencing the product mentioned above.  Formatting is preserved.

Revision as of 18:38, 28 November 2012

The '<Reference_List> class provides a list of internal (i.e., to other PDS4 products) and external citations relevant to the product. The internal references in this class provide the primary method for making associations like:

  • Raw data to calibrated data
  • Calibrated data to the calibration observation(s) used
  • Data to documentation on calibration or observing conditions
  • and so on.

The <Reference_List> class is itself optional. When it is included, all internal references (if any) are listed first; external references (if any) are listed second. You may include as many of each type of reference as you like.

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

Following are the attributes and subclasses you'll find in <Reference_List>, in label order.

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

<Internal_Reference>

OPTIONAL

This class provides a direct reference to the logical identifier of another product somewhere in the PDS4 registry. A specific version can be referenced, if appropriate.

The <Internal_Reference> format is the same wherever it appears.

<lid_reference> or <lidvid_reference>

REQUIRED

Either a logical ID (LID) reference or a LID reference with an additional version ID (VID) must be provided (but not both). If <lid_reference> is used, the value must match the <logical_identifier> value of some other PDS4 product in the registry (this will be checked when the product is officially registered). Similarly, when a <lidvid_reference> is used, the value has the format logical_identifier::version_identifier, and there must be a product with the given <logical_identifier> and <version_identifier> values.

<reference_type>

REQUIRED

This must be one of the standard values defined for this context. We keep a list of these on the Questions page. This list is likely to grow - if you need a new value, let your PDS contact person know.

<comment>

OPTIONAL

This is a place to put a bit of text as needed to explain why you're referencing the product mentioned above. Formatting is preserved.