Update annotations/documentation

DIGGSml · Feb 10, 2025 · 1537fa1 · 1537fa1
1 parent 7b13319
commit 1537fa1
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 12 deletions.
diff --git a/Kernel.xsd b/Kernel.xsd
@@ -5328,7 +5328,8 @@ subsidiary portion of the overall observed zone or sample.This property would be
 
 Either a classificationCode value or lithDescription value must be present in the Lithology object. 
 
-The codespace attribute is mandatory and shall be a URL to an xml dictionary that conforms to the Dictionary_diggs.xsd schema and that defines the terms used in the classification system within diggs:Definition elements. The value of classificationCode should be equivalent to the gml:name property of the associated diggs:Definition, for example: <classificationCode codespace="https://diggsml.org/def/codes/DIGGS/0.1/astmD2488.xml">Well-graded sand with gravel</classificationCode> An example diggs:Definition element within the dictionary would look as follows:
+The codespace attribute is mandatory and should be a URL to an xml dictionary that conforms to the Dictionary_diggs.xsd schema and that defines the terms used in the classification system within diggs:Definition elements. The value of classificationCode should be equivalent to the gml:name property of the associated diggs:Definition, for example: <![CDATA[
+    <classificationCode codespace="https://diggsml.org/def/codes/DIGGS/0.1/astmD2488.xml">Well-graded sand with gravel</classificationCode>]]> An example diggs:Definition element within the dictionary would look as follows:<![CDATA[
 
         <diggs:Definition gml:id="SWg">
             <gml:description>SW with ≥ 15% gravel</gml:description>
@@ -5342,7 +5343,7 @@ The codespace attribute is mandatory and shall be a URL to an xml dictionary tha
                     <diggs:sourceElementXpath>//diggs:Lithology/diggs:classificationCode</diggs:sourceElementXpath>
                 </diggs:Occurrence>
             </diggs:occurrences>
-        </diggs:Definition>
+        </diggs:Definition>]]>
 
 The Geo-Institute has developed online dictionaries for ASTM D2487, ASTM D2488, AASHTO and USDA classification systems that may referenced in instance documents that use those classifications.
 
@@ -5497,7 +5498,8 @@ Classification systems that do not have an online dictionary may be used, but th
 
 Either a classificationCode value or lithDescription value must be present in the Lithology object. 
 
-The codespace attribute is mandatory and shall be a URL to an xml dictionary that conforms to the Dictionary_diggs.xsd schema and that defines the terms used in the classification system within diggs:Definition elements. The value of classificationCode should be equivalent to the gml:name property of the associated diggs:Definition, for example: <classificationCode codespace="https://diggsml.org/def/codes/DIGGS/0.1/astmD2488.xml">Well-graded sand with gravel</classificationCode> An example diggs:Definition element within the dictionary would look as follows:
+The codespace attribute is mandatory and should be a URL to an xml dictionary that conforms to the Dictionary_diggs.xsd schema and that defines the terms used in the classification system within diggs:Definition elements. The value of classificationCode should be equivalent to the gml:name property of the associated diggs:Definition, for example: <![CDATA[
+    <classificationCode codespace="https://diggsml.org/def/codes/DIGGS/0.1/astmD2488.xml">Well-graded sand with gravel</classificationCode>]]> An example diggs:Definition element within the dictionary would look as follows:<![CDATA[
 
         <diggs:Definition gml:id="SWg">
             <gml:description>SW with ≥ 15% gravel</gml:description>
@@ -5511,7 +5513,7 @@ The codespace attribute is mandatory and shall be a URL to an xml dictionary tha
                     <diggs:sourceElementXpath>//diggs:Lithology/diggs:classificationCode</diggs:sourceElementXpath>
                 </diggs:Occurrence>
             </diggs:occurrences>
-        </diggs:Definition>
+        </diggs:Definition>]]>
 
 The Geo-Institute has developed online dictionaries for ASTM D2487, ASTM D2488, AASHTO and USDA classification systems that may referenced in instance documents that use those classifications.
 

diff --git a/Piling.xsd b/Piling.xsd
@@ -277,9 +277,9 @@
                         <annotation>
                             <documentation>A code or name identifying the pile size (typically
                                 diameter and weight/unit length) along with other shape parameters
-                                as applicable. Intended to come from a controlled list of terms,
+                                as applicable. Intended to come from a controlled list of terms,<![CDATA[
                                 Example: <pileSizeDesignation codeSpace="ASTM A6 H-Piling">HP 200 x
-                                    64</pileSizeDesignation></documentation>
+                                    64</pileSizeDesignation>]]></documentation>
                         </annotation>
                     </element>
                     <element minOccurs="0" ref="diggs:weldType">
@@ -330,9 +330,9 @@
                         <annotation>
                             <documentation>A code or name identifying the pile size (typically
                                 diameter and weight/unit length) along with other shape parameters
-                                as applicable. Intended to come from a controlled list of terms,
+                                as applicable. Intended to come from a controlled list of terms,<![CDATA[
                                 Example: <pileSizeDesignation codeSpace="ASTM A6 H-Piling">HP 200 x
-                                    64</pileSizeDesignation></documentation>
+                                    64</pileSizeDesignation>]]></documentation>
                         </annotation>
                     </element>
                     <element minOccurs="0" name="wallThickness" type="eml:LengthMeasureExt">
@@ -390,9 +390,9 @@
                         <annotation>
                             <documentation>A code or name identifying the pile size (typically
                                 diameter and weight/unit length) along with other shape parameters
-                                as applicable. Intended to come from a controlled list of terms,
+                                as applicable. Intended to come from a controlled list of terms,<![CDATA[
                                 Example: <pileSizeDesignation codeSpace="ASTM A6 H-Piling">HP 200 x
-                                    64</pileSizeDesignation></documentation>
+                                    64</pileSizeDesignation>]]></documentation>
                         </annotation>
                     </element>
                     <element minOccurs="0" name="shape" type="diggs:PileShapeEnumExtType">
@@ -498,9 +498,9 @@
                         <annotation>
                             <documentation>A code or name identifying the pile size (typically
                                 diameter and weight/unit length) along with other shape parameters
-                                as applicable. Intended to come from a controlled list of terms,
+                                as applicable. Intended to come from a controlled list of terms,<![CDATA[
                                 Example: <pileSizeDesignation codeSpace="ASTM A6 H-Piling">HP 200 x
-                                    64</pileSizeDesignation></documentation>
+                                    64</pileSizeDesignation>]]></documentation>
                         </annotation>
                     </element>
                     <element minOccurs="0" name="timberType" type="gml:CodeType">