Changes between Version 213 and Version 214 of CMDI 1.2/Specification


Ignore:
Timestamp:
06/27/16 09:58:20 (8 years ago)
Author:
Twan Goosen
Comment:

TODOs

Legend:

Unmodified
Added
Removed
Modified

  • CMDI 1.2/Specification

    v213 v214  
    4444
    4545=== Glossary ===
    46 {{{#!comment
    47 TODO: Grouping of items (3 or 4 groups of semantically related terms, alphabetic order within groups)
    48 }}}
     46'''{TODO}:''' consistent upper/lower case
    4947
    5048==== General ====
    … …  
    6462 * '''language tag'''
    6563   * A textual code “used to help identify languages, whether spoken, written, signed, or otherwise signaled, for the purpose of communication.  This includes constructed and artificial languages but excludes languages not intended primarily for human communication, such as programming languages.” ([#REF_BCP_47 IETF BCP 47])
     64 * '''media type'''
     65  * '''{TODO}'''
    6666 * '''metadata'''
    6767   * A __resource__ that is a description of another resource, usually given as a set of properties in the form of attribute-value pairs. This description may contain information about the resource, aspects or parts of the resource and/or artefacts and actors connected to the resource.
    … …  
    100100   * The component based metadata model described in the present specification.
    101101 * '''CMD profile''', profile definition, profile
    102    * A __CMD component__ that is used to describe a class of __resources__, providing the complete structure for an __instance payload__. It is never included in other __CMD components__.
     102   * A __CMD component__ that is used to describe a class of __resources__, providing the complete structure for an __instance payload__. It is never included in other __CMD components__. '''{TODO}:'''  reconsider relation between profile and component
    103103 * '''CMD profile schema'''
    104104   * A schema definition by which the correctness of a __CMD instance__ with respect to the __CMD profile__ it pertains to can be evaluated. May be expressed as __XML Schema__ but also in other XML schema languages.
    … …  
    204204|| `xs`   || `http://www.w3.org/2001/XMLSchema`                 || XML Schema            || prefixed ||
    205205
    206 {{{#!comment
    207 TODO: Add payload, envelope namespace and namespace for specification
    208 }}}
    209 
    210 {{{#!comment
    211 TODO: Decide whether we want to have the following intro subsections
    212 == CMDI Component Metadata Model ==
    213 == CMDI Component and Profile Specification Level ==
    214 }}}
     206'''{TODO}:''' Add payload, envelope namespace and namespace for specification
    215207
    216208----
    … …  
    222214}}}
    223215
    224 {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])}
    225 {TODO: add caption to diagram, make clear that it serves to illustrate the document structure but that the full constraints are in the table}
     216'''{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])
     217'''{TODO}:''' add caption to diagram, make clear that it serves to illustrate the document structure but that the full constraints are in the table
    226218
    227219(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.
    … …  
    400392
    401393=== Example 4 !ResourceRelation List ===
     394'''{TODO}:''' caption; should mention that what is demonstrated here is that concepts are optional, and that concepts from various sources can be used
    402395
    403396{{{
    … …  
    443436This section of the CMDI file forms what may be referred to as descriptive metadata about the described resource.
    444437
    445 {{{#!comment
    446 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.
     438
     439'''{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.
    447440Replacing: "Both  content and structure are completely defined by the CMD Profile  referenced by the XML element `<cmd:MdProfile>` in `<cmd:Header>`."
    448 }}}
    449441
    450442If these parts are present they `MUST` appear in this order: