Changes between Version 233 and Version 234 of CMDI 1.2/Specification


Ignore:
Timestamp:
10/04/16 09:06:55 (8 years ago)
Author:
Twan Goosen
Comment:

CMDI instance section

Legend:

Unmodified
Added
Removed
Modified

  • CMDI 1.2/Specification

    v233 v234  
    204204----
    205205
    206 A CMDI file contains the actual metadata of one specific resource (hereafter referred to as the ''described resource''),  and might also be referred to as a ''CMD record'' or ''CMD instance''. All CMDI files have the same structure at the top level. At a lower level, parts of its structure  are defined by the CMD profile upon which it is based.
     206A CMDI file contains the actual metadata of one specific resource (hereafter referred to as the ''described resource''),  and might also be referred to as a ''CMD record'' or ''CMD instance''. All CMDI files have the same structure at the top level (the ''CMD instance envelope''). At a lower level, parts of its structure  are defined by the CMD profile upon which it is based (the ''CMD instance payload'').
    207207
    208208== The main structure ==
    … …  
    211211||||= Name =||= Value type =||= Occurrences =||= Description =||
    212212|||| `<cmd:CMD>` || `xs:complexType` || || The root element of the CMDI file. ||
    213 || || `@CMDVersion` || `xs:String` ("1.2") || 1 || Denotes the CMDI version on which this CMDI file is based. ||
     213|| || `@CMDVersion` || `xs:string` ("1.2") || 1 || Denotes the CMDI version on which this CMDI file is based. ||
    214214|| || `<cmd:Header>` || `xs:complexType` || 1 || Encapsulates core administrative data about the CMDI file. ||
    215215|| || `<cmd:Resources>` || `xs:complexType` || 1 || Includes 3 lists containing information about resource proxies and their interrelations. ||
    … …  
    219219The first three elements (`<cmd:Header>`, `<cmd:Resources>` and `<cmd:IsPartOfList>`) constitute the ''CMD instance envelope'' and reside in the `cmd` namespace. The ''CMD instance payload'' is contained in the `<cmd:Components>` element, which (profile specific) substructure  exists in the profile-specific namespace (prefix `cmdp`), possibly adorned with attributes in the `cmd`  namespace.
    220220
    221 In addition to this,  foreign attributes (XML attributes of other namespaces than those defined in the [#typography_namespaces Typographic and XML Namespace conventions]) `MAY` occur anywhere in `<cmd:Header>`, `<cmd:Resources>` and `<cmd:IsPartOfList>` elements and on the `<cmd:Components>` element (but not on any of its children). These foreign namespaces SHOULD be ignored by tools unrelated to the party associated with the namespace and therefore MAY be removed during processing. The foreign namespace MUST be representative of the party that introduces the extension. Therefore, the namespace `SHOULD NOT` start with `http://www.clarin.eu`, `http://clarin.eu`, etc. unless the foreign namespace is introduced by the owner of the domain ''clarin.eu''.
     221In addition to this,  foreign attributes (XML attributes of other namespaces than those defined in the [#typography_namespaces Typographic and XML Namespace conventions]) `MAY` occur anywhere in `<cmd:Header>`, `<cmd:Resources>` and `<cmd:IsPartOfList>` elements and on the `<cmd:Components>` element (but not on any of its children). These foreign namespaces `SHOULD` be ignored by tools unrelated to the party associated with the namespace and therefore `MAY` be removed during processing. The foreign namespace `MUST` be representative of the party that introduces the extension. Therefore, the namespace `SHOULD NOT` start with `http://www.clarin.eu`, `http://clarin.eu`, etc. unless the foreign namespace is introduced by the owner of the domain ''clarin.eu''.
    222222
    223223A detailed specification of the above mentioned parts of a CMD instance is given in the next four sections.
    … …  
    259259}}}
    260260== The `<Header>` element ==
    261 The header of a CMDI instance mainly contains administrative information about the metadata, that is metadata about the CMDI file itself. The included elements MUST follow the structure and order described in this table:
     261The header of a CMDI instance mainly contains administrative information about the metadata, that is metadata about the CMDI instance itself. The included elements MUST follow the structure and order described in this table:
    262262
    263263||||= Name =||= Value type =||= Occurrences =||= Description =||
    … …  
    310310==== Resource types ====
    311311 * '''Resource'''
    312    * A resource that is described in the present CMD instance, e.g. a text document, media file or tool.
     312   * A resource that is described in the present CMD instance, e.g., a text document, media file or tool.
    313313 * '''Metadata'''
    314    * A metadata resource, i.e. another CMD instance, that is subordinate to the present CMD instance. The media type of this metadata resource `SHOULD` be `application/x-cmdi+xml`.
     314   * A metadata resource, i.e., another CMD instance, that is subordinate to the present CMD instance. The media type of this metadata resource `SHOULD` be `application/x-cmdi+xml`.
    315315 * '''!SearchPage'''
    316316   * Resource that is a web page that allows the described resource to be queried by an end-user.
    … …  
    318318   * A resource that is a web service that allows the described resource to be queried by means of dedicated software.
    319319 * '''!LandingPage'''
    320    * A resources that is a web page that provides the original context of the described resource, e.g. a "deep link" into a repository system.
     320   * A resources that is a web page that provides the original context of the described resource, e.g., a "deep link" into a repository system.
    321321
    322322=== The list of journal files ===
    … …  
    404404   </cmd:Resource>
    405405   <cmd:Resource ref="rp2">
    406        <cmd:Role ConceptLink="http://hdl.handle.net/11459/CCR_C-">target</cmd:Role> <!--TODO: register in the CCR -->
     406       <cmd:Role ConceptLink="http://hdl.handle.net/11459/CCR_C_c4e689ff-3724-10f7-8eb5-aee00b313f5f">target</cmd:Role>
    407407   </cmd:Resource>
    408408</cmd:ResourceRelation>
    … …  
    420420
    421421=== Example 6 The !IsPartOf List ===
     422This example shows an IsPartOf referring to another CMD instance, which describes the collection this instance is a part of.
     423
    422424{{{
    423425#!xml
    … …  
    426428</cmd:IsPartOfList>
    427429}}}
     430
    428431== The components ==
    429432This section of the CMDI file forms what may be referred to as descriptive metadata about the described resource.
    430433
    431 The CMD Profile referenced by the XML element `<cmd:MdProfile>` in `<cmd:Header>` defines what XML elements and XML attributes are mandatory or optional in this section. Some attributes `MAY` appear universally in XML elements contained in any CMD instance payload section regardless of the profile, but rather depending on the corresponding level in the matching CMD Profile, i.e. whether the XML element is reflecting a CMD Component or CMD element. The next table describes the mandatory structure and order of this section as a function of the definition of a specific CMD Profile:
     434The CMD Profile referenced by the XML element `<cmd:MdProfile>` in `<cmd:Header>` defines what XML elements and XML attributes are mandatory or optional in this section. Some attributes `MAY` appear universally in XML elements contained in any CMD instance payload section regardless of the profile, but rather depending on the corresponding level in the matching CMD Profile, i.e., whether the XML element is reflecting a CMD Component or CMD element. The next table describes the mandatory structure and order of this section as a function of the definition of a specific CMD Profile:
    432435
    433436||||||||= Name =||= Value type =||= Occurrences =||= Description =||