Changes between Version 227 and Version 228 of CMDI 1.2/Specification


Ignore:
Timestamp:
08/15/16 08:18:02 (8 years ago)
Author:
Twan Goosen
Comment:

CMD instance section

Legend:

Unmodified
Added
Removed
Modified

  • CMDI 1.2/Specification

    v227 v228  
    191191|| `xs` || `http://www.w3.org/2001/XMLSchema` || XML Schema || prefixed ||
    192192
     193'''Note''': the inclusion of the major version number (i.e. 1) in the clarin.eu namespaces, but not the minor version number reflects the approach that across minor versions within a major version of the CMDI specification, the namespace is kept constant for compatibility reasons.
     194
    193195----
    194196= Structure of CMDI files =
    … …  
    198200}}}
    199201
    200 '''{TODO}:''' finish and embed UML diagram ([https://drive.google.com/file/d/0B6mqjTCSImiVdFJYV2kwMVJDcTg/view?usp=sharing working version], [https://drive.google.com/file/d/0B6mqjTCSImiVMDVCdUQyck1mS1k/view?usp=sharing=sharing PDF snapshot])
     202'''{TODO}:''' finish and embed UML diagram ([https://drive.google.com/file/d/0B6mqjTCSImiVdFJYV2kwMVJDcTg/view?usp=sharing working version], [https://drive.google.com/file/d/0B6mqjTCSImiVQXRlNnltOXB2Ums/view?usp=sharing PDF snapshot])
    201203
    202204''(Caption): The structure of a CMDI file (CMD instance). Colour scheme: Green boxes represent elements that are potentially present in all CMDI files (the CMD instance envelope). Blue boxes represent  elements defined by the CMD profile (the CMD instance payload). The diagram is meant for overview and illustration; full details to be found in the tables below.''
    … …  
    213215|| || `<cmd:Resources>` || `xs:complexType` || 1 || Includes 3 lists containing information about resource proxies and their interrelations. ||
    214216|| || `<cmd:IsPartOfList>` || `xs:complexType` || 0 or 1 || A list of `<cmd:IsPartOf>` elements, each referencing a larger external resource of which the described resource (as a whole) forms a part. ||
    215 || || `<cmd:Components>` || `xs:complexType` || 1 || This element corresponds to – and is in turn structured according to - the `<cmdp:{CMDProfile}>` applied. Here the descriptive metadata of the resource are found. ||
     217|| || `<cmd:Components>` || `xs:complexType` || 1 || This element contains the profile specific section of the CMDI file. Here the descriptive metadata of the resource are found. ||
    216218
    217219The 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.
    … …  
    308310==== Resource types ====
    309311 * '''Resource'''
    310    * A resource that is described in the present CMDI 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.
    311313 * '''Metadata'''
    312    * A metadata resource, i.e. another CMDI instance, that is subordinate to the present CMDI instance.
     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`.
    313315 * '''!SearchPage'''
    314316   * Resource that is a web page that allows the described resource to be queried by an end-user.
    … …  
    360362        </cmd:ResourceProxy>
    361363        <cmd:ResourceProxy id="c_0000000001">
    362             <cmd:ResourceType mimetype="text/xml">Metadata</cmd:ResourceType>
     364            <cmd:ResourceType mimetype="application/x-cmdi+xml">Metadata</cmd:ResourceType>
    363365            <cmd:ResourceRef>https://clarin.phonetik.uni-muenchen.de/BASRepository/Public/Corpora/ZIPTEL/0001.1.cmdi.xml</cmd:ResourceRef>
    364366        </cmd:ResourceProxy>
    … …  
    384386#!xml
    385387<cmd:ResourceRelation>
    386    <cmd:RelationType>is front of</cmd:RelationType>
     388   <cmd:RelationType>duplicates</cmd:RelationType>
    387389   <cmd:Resource ref="_395">
    388390   <cmd:Resource ref="_394"/>
    … …  
    392394=== Example 5 A maximally specified relation between resource files ===
    393395
    394 This example shows a semantic rich specification of a relationship between two resources, i.e., relation type and roles are annotated with concept references from various semantic registries.
     396This example shows a semantically rich specification of a relationship between two resources, i.e., relation type and roles are annotated with concept references from various semantic registries.
    395397
    396398{{{
    397399#!xml
    398400<cmd:ResourceRelation>
    399    <cmd:RelationType ConceptLink="http://www.w3.org/ns/oa#describing">describing</RelationType>
    400    <cmd:Resource ref="rp1">
     401    <cmd:RelationType ConceptLink="http://www.w3.org/ns/oa#describing">describing</RelationType>
     402    <cmd:Resource ref="rp1">
    401403       <cmd:Role ConceptLink="http://hdl.handle.net/11459/CCR_C-6024_88c0ac12-c24b-dd5a-d183-07e6dae25c52">source</cmd:Role>
    402404   </cmd:Resource>
    403    <cmd:Resource ConceptLink="http://hdl.handle.net/11459/CCR_C-..." ref="rp2">
    404        {TODO} Add a target concept to the CCR to get a handle
    405        <cmd:Role>target</cmd:Role>
     405   <cmd:Resource ref="rp2">
     406       <cmd:Role ConceptLink="http://hdl.handle.net/11459/CCR_C-">target</cmd:Role> <!--TODO: register in the CCR -->
    406407   </cmd:Resource>
    407408</cmd:ResourceRelation>
    … …  
    418419 * The inverse of the !IsPartOf `MAY` be indicated by a resource proxy with resource type Metadata in the instance that describes the composite.
    419420
    420 === Example t The !IsPartOf List ===
     421=== Example 6 The !IsPartOf List ===
    421422{{{
    422423#!xml
    … …  
    428429This section of the CMDI file forms what may be referred to as descriptive metadata about the described resource.
    429430
    430 '''{TODO}:''' couple of lines that describe the nature of the components section, i.e. it has a partially fixed structure and the rest is determined by the profile definition. Replacing: "Both  content and structure are completely defined by the CMD Profile  referenced by the XML element `<cmd:MdProfile>` in `<cmd:Header>`."
    431 
    432 If these parts are present they `MUST` appear in this order:
     431The 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:
    433432
    434433||||||||= Name =||= Value type =||= Occurrences =||= Description =||
    435434||||||||`<cmd:Components>` || `xs:complexType` || || Container for the CMD instance payload. ||
    436 || ||||||`<cmdp:{CMDProfile}>` || `xs:complexType` || 1 || The XML element housing all the metadata about the described resource, complying with the CMD profile schema identified in the `<cmd:MdProfile>` element in the CMD instance header. ||
     435|| ||||||`<cmdp:{RootComponent}>` || `xs:complexType` || 1 || The XML element housing all the metadata about the described resource, complying with the CMD profile schema identified in the `<cmd:MdProfile>` element in the CMD instance header. ||
    437436|| || |||| `@cmd:ref` || `xs:IDREF` || 0 or 1 || Reference to a `<cmd:ResourceProxy>` with id=ref, to which this substructure specifically applies. ||
    438437|| || |||| `@{CMDAttribute}*` || As specified in the CMD profile || As specified in the CMD profile || Custom attribute, defined as an allowed or mandatory child in a component specification. ||
    … …  
    462461                <cmdp:Description xml:lang="en">A web-application with which an end user can have historical Dutch text tokenized, lemmatized and part-of-speech tagged, using the most appropriate resources (such as lexica) for the text in question.</cmdp:Description>
    463462            </cmdp:Description>
    464             <cmdp:Description xml:lang="nl">Een web applicatie waarmee een eindgebruiker teksten in oud nederlands kan laten tokeniseren, lemmatiseren en ontleden, gerbuik makend van de resources (zoals lexica) die het beste bij die tekst passen.</cmdp:Description>
     463            <cmdp:Description xml:lang="nl">Een webapplicatie waarmee een eindgebruiker teksten in oud nederlands kan laten tokeniseren, lemmatiseren en ontleden, gebruikmakend van de resources (zoals lexica) die het beste bij die tekst passen.</cmdp:Description>
    465464        </cmdp:GeneralInfo>
    466465        ...