Changes between Version 95 and Version 96 of CMDI 1.2/Specification


Ignore:
Timestamp:
01/19/16 14:31:30 (8 years ago)
Author:
Twan Goosen
Comment:

Updated Structure of CMDI files

Legend:

Unmodified
Added
Removed
Modified

  • CMDI 1.2/Specification

    v95 v96  
    146146
    147147=== Typographic and XML Namespace conventions ===
     148[=#typography_namespaces]
    148149The following typographic conventions for XML fragments will be used throughout this specification:
    149150 * `<prefix:Element>` \\ An XML element with the Generic Identifier ''Element'' that is bound to an XML namespace denoted by the prefix ''prefix''.
    … …  
    189190  * `<ResourceRelationList>,` containing a list of `<ResourceRelation>` elements, each representing a relationship between 2 resource files (as listed in the `<ResourceProxyList>`)
    190191* The `<IsPartOfList>` element, containing a list of `<IsPartOf>` elements, each referencing a larger external resource of which the described resource (as a whole) forms a part
    191 * The `<Components>` element, containing one subelement corresponding to – and in turn structured according to - the CMD profile applied. Here the "real" metadata of the reosurce are to be found.
    192 
    193 The first three elements (`<Header>`, `<Resources>`and `<IsPartOfList>`) constitute the ''CMD instance envelope''and reside in the `cmd` namespace. The ''CMD instance payload'' contains the `<Components>`element, which (profile specific) substructure  exists in the profile-specific namespace (prefix `cmdp`) or cues-for-tools namespace (`cue`). 
    194 
    195 A detailed specification of the above mentioned parts of a CMD instance is given in the next four sections. In addition to this,  foreign attributes (XML attributes of other namespaces than those defined in the [Typographic and XML Namespace conventions])  `MAY` occur anywhere in `<Header>`, `<Resources>`and `<IsPartOfList>`elements and on the `<Components>` element (but not on any of its children).
     192* The `<Components>` element, containing one subelement corresponding to – and in turn structured according to - the CMD profile applied. Here the descriptive metadata of the resource are found.
     193
     194The first three elements (`<Header>`, `<Resources>`and `<IsPartOfList>`) constitute the ''CMD instance envelope''and reside in the `cmd` namespace. The ''CMD instance payload'' contains the `<Components>`element, which (profile specific) substructure  exists in the profile-specific namespace (prefix `cmdp`), possibly adorned with attributes in the cmd  namespace.
     195
     196A detailed specification of the above mentioned parts of a CMD instance is given in the next four sections. 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 `<Header>`, `<Resources>`and `<IsPartOfList>`elements and on the `<Components>` element (but not on any of its children).
    196197
    197198=== Examples ===
    … …  
    251252
    252253||||=Name=||=Value type=||=Occurrences=||=Description=||
    253 ||||`<Header>`||`xs:complexType`||1||Encapsulates core admistrative data about the CMDI file||
     254||||`<Header>`||`xs:complexType`||1||Encapsulates core administrative data about the CMDI file||
    254255||  ||`<MdCreator>`||`xs:string`||0 to unbounded||Denotes the creator of this metadata file||
    255256||  ||`<MdCreationDate>`||`xs:date`||0 or 1||The date this metadata file was created||
    256257||  ||`<MdSelfLink>`||`xs:anyURI`||0 or 1||A reference to this metadata file in its home repository, in the form of a PID (preferred) or a URL||
    257258||  ||`<MdProfile>`||`xs:anyURI`||1||The CMDI profile  upon which this metadata file is based, given by its identifier in the Component Registry, e.g. clarin.eu:cr1:p_1407745711925||
    258 ||  ||`<MdCollectionDisplayName>`||`xs:string`||0 or 1||The collection to which the described resource belongs, given as a human-readable name. In VLO this name will be assigned to the Collection facet.||
     259||  ||`<MdCollectionDisplayName>`||`xs:string`||0 or 1||The collection to which the described resource belongs, given as a human-readable name. Exploitation tools can use this name to present metadata collections.||
    259260 
    260261=== Examples ===
    … …  
    284285|| ||||||`<ResourceProxy>` ||`xs:complexType`||0 to unbounded||Represents a file which is a part of or closely related to the described resource||
    285286|| || ||||`@id`||`xs:ID`||1||Local identifier for the parent `<ResourceProxy>`, unique within this CMDI file||
    286 || || ||||`<ResourceType>` ||Value from controlled set (`cmd:Resourcetype_simple`): `Resource`,`Metadata`,`LandingPage`,`SearchService`,`SearchPage`||1||The type of the file represented by this `<ResourceProxy>`||
     287|| || ||||`<ResourceType>` ||`xs:string` ("Resource", "Metadata", "LandingPage", "SearchService", "SearchPage")||1||The type of the file represented by this `<ResourceProxy>`||
    287288|| || || ||`@mimeType`||`xs:string`||0 or 1||The media type of the file||
    288 || || ||||`<ResourceRef>`||`xs:anyURI`||1||A reference to  the file represented by this `<ResourceProxy>`, in the form of a Clarin compliant PID or a regular URL||
     289|| || ||||`<ResourceRef>`||`xs:anyURI`||1||A reference to the file represented by this `<ResourceProxy>`, in the form of a CLARIN-compliant PID or a regular URL||
    289290
    290291
    … …  
    295296||||||`<JournalFileProxyList>` ||`xs:complexType`||1||Contains a list of journal file proxies (see below)||
    296297|| ||||`<JournalFileProxy>` ||`xs:complexType`||0 to unbounded||Represents a file containing provenance information about the described resource||
    297 || || ||`<JournalFileRef>`||`xs:anyURI`||1||A reference to  the file represented by this `<JournalFileProxy>`, in the form of a Clarin compliant PID or a regular URL||
     298|| || ||`<JournalFileRef>`||`xs:anyURI`||1||A reference to  the file represented by this `<JournalFileProxy>`, in the form of a CLARIN-compliant PID or a regular URL||
    298299
    299300===     The list of relations between resource files ===
    … …  
    301302
    302303||||||||||=Name=||=Value type=||=Occurrences=||=Description=||
    303 ||||||||||`<ResourceRelationList>`||`xs:complexType`||1||A representation of a relation between 2 resource proxies listed in `<ResourceProxyList>`||
     304||||||||||`<ResourceRelationList>`||`xs:complexType`||1||Contains a list of journal file proxies (see below)||
    304305|| ||||||||`<ResourceRelation>`||`xs:complexType`||0 to unbounded||A representation of a relation between 2 resource proxies listed in `<ResourceProxyList>`||
    305306|| || ||||||`<RelationType>`||`xs:string`||1||The type of the relation represented by its parent `<ResourceRelation>`||
    306 || || || ||||`@ConceptLink`||`xs:anyURI`||0 or 1||A reference to some concept registry (Clarin Concept Registry by default), indicating the semantics of `<RelationType>`||
     307|| || || ||||`@ConceptLink`||`xs:anyURI`||0 or 1||A reference to some concept registry (CLARIN Concept Registry by default), indicating the semantics of `<RelationType>`||
    307308|| || ||||||`<Resource>`||`xs:complexType`||2||References one of the resource proxies participating in the relationship||
    308309|| || || ||||`@ref`||`xs:IDREF`||1||A reference to the `<ResourceProxy>` with id=ref (the `<ResourceProxy>` represented by its parent `<Resource>` element)||
    309310|| || || ||||`<Role>`||`xs:string`||0 or 1||Indicates the role its parent Resource plays in the relationship||
    310 || || || || ||`@ConceptLink`||`xs:anyURI`||0 or 1||A reference to some concept registry (Clarin Concept Registry by default), indicating the semantics of `<RelationType>`||
     311|| || || || ||`@ConceptLink`||`xs:anyURI`||0 or 1||A reference to some concept registry (CLARIN Concept Registry by default), indicating the semantics of `<Role>`||
    311312
    312313
    … …  
    316317||||=Name=||=Value type=||=Occurrences=||=Description=||
    317318||||`<IsPartOfList>` ||`xs:complexType`||0 or 1||Contains a list of `<IsPartOf>`(see below)||
    318 || ||`<IsPartOf>` ||`xs:anyURI`||0 to unbounded||A reference to an external resource of which the described resource is a part, in the form of a Clarin compliant PID or a regular URL||
     319|| ||`<IsPartOf>` ||`xs:anyURI`||0 to unbounded||A reference to an external resource of which the described resource is a part, in the form of a CLARIN-compliant PID or a regular URL||
    319320
    320321=== Examples ===
    … …  
    339340
    340341==      The components ==
    341 This part of the CMDI file forms what may be referred to as «real» metadata about the described resource.  Both  content and structure are completely defined by the CMD Profile  referenced by the XML element`<MdProfile>` in `<Header>`.
     342This part of the CMDI file forms what may be referred to as descriptive metadata about the described resource.  Both  content and structure are completely defined by the CMD Profile  referenced by the XML element`<MdProfile>` in `<Header>`.
    342343
    343344||||||||=Name=||=Value type=||=Occurrences=||=Description=||
    344345||||||||`<Components>` ||`xs:complexType`||1||Contains 1 occurrence of an XML element named according to selected CMD profile||
    345346|| ||||||`<{CMDProfile}>` ||`xs:complexType`||1||The XML element housing all the metadata about the described resource, complying with the {CMDProfile} schema ||
     347|| || ||||`@cmd:ref`||xs:IDREF||0 or 1||Reference to a `<ResourceProxy>` with id=ref, to which this substructure specifically applies||
     348|| || ||||`@{CMDAttribute}`||Subset of XSD datatypes||As specified||Custom attribute, defined as an allowed or mandatory child in a component specification||
    346349|| || ||||`<{CMDElement}>`||Subset of XSD datatypes||0 to unbounded||Atomic piece of information about the described resource||
    347350|| || || ||`@xml:lang`||`xs:string`||0 or 1||Indicates the language of the {CMDElement} content, by a 2 letter language tag from ISO 639||
    348 || || || ||`@ConceptLink`||`xs:anyURI`||0 or 1||Reference to a concept in an external vocabulary. Used in case the value {CMDElement} is selected from a controlled vocabulary||
     351|| || || ||`@cmd:ref`||xs:IDREF||0 or 1||Reference to a `<ResourceProxy>` with id=ref, to which this substructure specifically applies||
     352|| || || ||`@cmd:ValueConceptLink`||`xs:anyURI`||0 or 1||Reference to a concept in an external vocabulary. Used in case the value {CMDElement} is selected from a controlled vocabulary||
     353|| || || ||`@{CMDAttribute}`||Subset of XSD datatypes||As specified||Custom attribute, defined as an allowed or mandatory child in a component specification||
    349354|| || ||||`<{CMDComponent}>`||`xs:complexType`||0 to unbounded||A chunk of information about the described resource, recursively composed of CMD Elements and other CMD Components|| 
    350 || || || ||`@ComponentId`||`xs:anyURI`||0 or 1||Reference to the specification of {{CMDComponent} in Component Registry. If not present, {CMDComponent} is defined locally within its parent CMD component ||
     355|| || || ||`@cmd:ComponentId`||`xs:anyURI`||0 or 1||Reference to the specification of {CMDComponent} in Component Registry. If not present, {CMDComponent} is defined locally within its parent CMD component ||
     356|| || || ||`@cmd:ref`||xs:IDREF||0 or 1||Reference to a `<ResourceProxy>` with id=ref, to which this substructure specifically applies||
     357|| || || ||`@{CMDAttribute}`||Subset of XSD datatypes||As specified||Custom attribute, defined as an allowed or mandatory child in a component specification||
    351358
    352359=       The CMDI Component Specification Language (CCSL)=