mlhim-specs-dev team mailing list archive
-
mlhim-specs-dev team
-
Mailing list archive
-
Message #00168
[Branch ~mlhim-specs-dev/mlhim-specs/main] Rev 130: Working on Element documentation strings. Completed entity.xsd Bug #771266
------------------------------------------------------------
revno: 130
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Sat 2011-04-30 18:13:16 -0500
message:
Working on Element documentation strings. Completed entity.xsd Bug #771266
modified:
schemas/entity.xsd
--
lp:mlhim-specs
https://code.launchpad.net/~mlhim-specs-dev/mlhim-specs/main
Your team MLHIM Specifications Developers is subscribed to branch lp:mlhim-specs.
To unsubscribe from this branch go to https://code.launchpad.net/~mlhim-specs-dev/mlhim-specs/main/+edit-subscription
=== modified file 'schemas/entity.xsd'
--- schemas/entity.xsd 2011-04-30 21:22:48 +0000
+++ schemas/entity.xsd 2011-04-30 23:13:16 +0000
@@ -13,15 +13,15 @@
<xs:sequence>
<xs:element name="details" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The details are a structural segment that may be used to create machine processable capabilities. For example in a workflow or authentication service. </xs:documentation></xs:annotation>
</xs:element>
<xs:element name="description" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A human readable description for this role.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="is_primary" maxOccurs="1" minOccurs="0" type="xs:boolean">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A binary attribute indicating if this is the primary role in the list of roles.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -41,15 +41,15 @@
<xs:sequence>
<xs:element name="details" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The details are a structural segment that may be used to create machine processable capabilities. For example in a GIS it may contain longitude/latitude/altitude information. </xs:documentation></xs:annotation>
</xs:element>
<xs:element name="description" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A human readable description for this location.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="is_primary" maxOccurs="1" minOccurs="0" type="xs:boolean">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A binary attribute indicating if this is the primary location in the list of locations.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -68,7 +68,7 @@
<xs:sequence>
<xs:element name="targets" maxOccurs="unbounded" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The List of target UUIDs. Relationships can only be established between instances. </xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -86,27 +86,27 @@
<xs:sequence>
<xs:element name="valid_time_begin" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>If present this must be a valid datetime string including timezone</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="valid_time_end" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>If present this must be a valid datetime string including timezone</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="ev" maxOccurs="1" minOccurs="0" type="mlhim2:ExceptionalValue">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The exceptional value. Often referred to as Null Flavour. </xs:documentation></xs:annotation>
</xs:element>
<xs:element name="identifiers" maxOccurs="unbounded" minOccurs="0" type="mlhim2:DvIdentifier">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A List of identifiers used to relate this entity to the real world.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="roles" maxOccurs="unbounded" minOccurs="0" type="mlhim2:Role">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A List of roles that this entity may participate. </xs:documentation></xs:annotation>
</xs:element>
<xs:element name="locations" maxOccurs="unbounded" minOccurs="0" type="mlhim2:Location">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A list of locations for this entity. </xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -124,7 +124,7 @@
<xs:sequence>
<xs:element name="details" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>structural details about the device</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -142,7 +142,7 @@
<xs:sequence>
<xs:element name="details" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>structural details about the organization</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -160,7 +160,7 @@
<xs:sequence>
<xs:element name="members" maxOccurs="1" minOccurs="0" type="mlhim2:Party">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A Set of Partys composing the Group.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -178,7 +178,7 @@
<xs:sequence>
<xs:element name="details" maxOccurs="1" minOccurs="1" type="mlhim2:ItemStructure">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>structural details about the person</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -196,7 +196,7 @@
<xs:sequence>
<xs:element name="details" maxOccurs="1" minOccurs="1" type="mlhim2:ItemStructure">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>structural details about the non-human</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
