Changes between Version 7 and Version 8 of CmdiClavasIntegration

Timestamp:

05/22/13 15:38:58 (11 years ago)

Author:

twagoo

Comment:

schema examples + updated other examples

CmdiClavasIntegration

@@ -68 +68 @@
 * !ValueScheme has to be string. For this we add a schematron rule to the general component schema.
 * Vocabulary URI (can be URL or URN) gets specified in Vocabulary attribute
-* Value field optionally specified, either as a parameter on the URI or as a separate attribute (TODO: DECIDE). It would be nice if we could pass the 'label' selection on to the API so that a pre-selection can happen server side (making the processing of the response more uniform)
+* Value property field optionally specified (default=prefLabel), either as a parameter on the URI or as a separate attribute VocabValueProperty (second example). TODO: DECIDE
+ * Use case is language vocabulary that provides versions of ISO-639 per item
+ *  It would be nice if we could pass the 'label' selection on to the API so that a pre-selection can happen server side, returning it in a specially marked element or attribute (making the processing of the response more uniform)
 
 Example:
@@ -93 +95 @@
     ValueScheme="string"
     Vocabulary="http://openskos.org/institutions"
-    VocabularyLabel="name"
+    VocabValueProperty="name"
 />
 }}}
@@ -109 +111 @@
     <ValueScheme>
       <enumeration>
-         <item AppInfo="Dutch" VocabItem="http://cdb.iso.org/lg/CDB-00138580-001">dut</item>
-         <item AppInfo="French" VocabItem="http://cdb.iso.org/lg/CDB-00138512-001">fra</item>
+         <item VocabItem="http://cdb.iso.org/lg/CDB-00138580-001">Dutch</item>
+         <item VocabItem="http://cdb.iso.org/lg/CDB-00138512-001">French</item>
       </enumeration>
     </ValueScheme>
@@ -116 +118 @@
 }}}
 
+Text content comes from the selected label. VocabItem has the URI for each item in the vocabulary. There probably is no need for AppInfo (separate display label). Notice that there currently is no way to represent multilingual vocabularies, so the language will have to be specified in the vocabulary URI with a fallback to the default language of the vocabulary.
+
 ==== Specifying vocabularies in CMDI profile XSD's ====
 
-The values of the vocabulary related attributes could go straight into the generated profile XSD, pretty much like the "datcat"-attributes and read like that from the schema by client applications. We can put them 
+The values of the vocabulary related attributes could go straight into the generated profile XSD, pretty much like the "datcat"-attributes and read like that from the schema by client applications. 
+
+===== Open vocabularies =====
+
+Example, assuming the solution with separate attributes for vocabulary id and label specifiers:
+
+{{{
+#!xml
+<xs:element 
+  name="Institute"  
+  ann:displaypriority="1"
+  dcr:datcat="http://www.isocat.org/datcat/DC-3785" 
+  cmd:Vocabulary="http://openskos.org/institutions" 
+  cmd:VocabValueProperty="name">
+  <xs:complexType>
+    <xs:simpleContent>
+      <xs:extension base="xs:string">
+        <xs:attribute ref="xml:lang"/>
+      </xs:extension>
+    </xs:simpleContent>
+  </xs:complexType>
+</xs:element>
+}}}
+
+===== Closed vocabularies =====
+
+Example:
+
+{{{
+#!xml
+<xs:simpleType 
+  name="simpletype-iso-639-3-code-clarin.eu.cr1.c_123456789" 
+  cmd:Vocabulary="http://openskos.org/api/languages?label=iso-639-3">
+  <xs:restriction base="xs:string">
+    <xs:enumeration value="Dutch" cmd:VocabItem="http://cdb.iso.org/lg/CDB-00138512-001" />
+    <xs:enumeration value="French" cmd:VocabItem="http://cdb.iso.org/lg/CDB-00138512-001" />
+  </xs:restriction>
+</xs:simpleType>
+}}}
 
 === CLAVAS vocabulary sources ===
 
 Vocabularies from ISOCat will be provided to OpenSKOS (the exact details as to how this is going to be done still have to be worked out), Arbil and ComponentRegistry will query these vocabularies through OpenSKOS.
-
-== Open issues ==
-
-* PID's for vocabularies (yes please) and vocabulary items (maybe... possibly use part identifiers)
-* ...
-
-== Roadmap ==
-
-Implementation can be divided into at least two phases:
-
-=== Phase 1 ===
-
-Target milestone: late december 2012
-
-* Adapt the CMDI schema to allow vocabularies to be referenced from elements. In this phase only support ''open vocabularies'' and values coming from ''prefLabel'' 
-* Create a CMDI profile that references vocabularies
-* Implement a client in Arbil that consumes the OpenSKOS API for specific vocabularies (initially we skip caching, e.g. online availability only)
-* Create UI component(s) in Arbil that make use of these calls to present the vocabulary items to the user
-* Extend reading of profile specification and reading/writing of CMDI instances to support vocabulary references
-
-=== Phase 2  ===
-
-Target milestone: ?
-
-* Allow closed vocabularies
-* Vocabulary caching in Arbil
-* ...to be further specified...