Difference between revisions of "Common properties of Named Data"
Jump to navigation
Jump to search
Petr.Bures (talk | contribs) |
Petr.Bures (talk | contribs) m |
||
| Line 4: | Line 4: | ||
!XML | !XML | ||
!Description | !Description | ||
!Presence | |||
!Default | |||
|- | |- | ||
|GUID | |GUID | ||
|<sup>[[Legend of XML elements|[A]]]</sup> STRING <code>ID</code> or <code>GUID</code> | |<sup>[[Legend of XML elements|[A]]]</sup> STRING <code>ID</code> or <code>GUID</code> | ||
|Unique GUID of the named data element, is written to the <code>ID</code> attribute, if an alternative text identifier is used in the <code>ID</code>, optionally specified in the <code>GUID</code> attribute | |Unique GUID of the named data element, is written to the <code>ID</code> attribute, if an alternative text identifier is used in the <code>ID</code>, optionally specified in the <code>GUID</code> attribute | ||
|required | |||
| | |||
|- | |- | ||
|Name | |Name | ||
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Name</code> | |<sup>[[Legend of XML elements|[E]]]</sup> <code>Name</code> | ||
|Element name, can be translated into multiple languages (see [[Multilingual text]]) | |Element name, can be translated into multiple languages (see [[Multilingual text]]) | ||
|required | |||
| | |||
|- | |- | ||
|Comment | |Comment | ||
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Comment</code> | |<sup>[[Legend of XML elements|[E]]]</sup> <code>Comment</code> | ||
|Optional comment, can be translated into multiple languages (see [[Multilingual text]]) | |Optional comment, can be translated into multiple languages (see [[Multilingual text]]) | ||
|optional | |||
|empty | |||
|- | |- | ||
|Item type | |Item type | ||
|<sup>[[Legend of XML elements|[A]]]</sup> ENUM <code>ItemType</code> | |<sup>[[Legend of XML elements|[A]]]</sup> ENUM <code>ItemType</code> | ||
|Item type {<sup>[[Legend of XML elements|[V]]]</sup> <code>[[Text string (Named Data Type)|String]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Number (Named Data Type)|Double]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Enumeration (Named Data Type)|Enum]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Set (Named Data Type)|Set]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Enumeration or Set Element (Named Data Type)|EnumItem]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Date and Time (Named Data Type)|DateTime]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Table (Named Data Type)|Table]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Group (Named Data Type)|Group]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Hatch and Color (Named Data Type)|SoilPattern]]</code>} | |Item type {<sup>[[Legend of XML elements|[V]]]</sup> <code>[[Text string (Named Data Type)|String]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Number (Named Data Type)|Double]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Enumeration (Named Data Type)|Enum]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Set (Named Data Type)|Set]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Enumeration or Set Element (Named Data Type)|EnumItem]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Date and Time (Named Data Type)|DateTime]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Table (Named Data Type)|Table]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Group (Named Data Type)|Group]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Hatch and Color (Named Data Type)|SoilPattern]]</code>} | ||
|required | |||
| | |||
|- | |- | ||
|Settings | |Settings | ||
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Settings</code> | |<sup>[[Legend of XML elements|[E]]]</sup> <code>Settings</code> | ||
|Different for each element type | |Different for each element type | ||
|required | |||
| | |||
|- | |- | ||
| Identifier | | Identifier | ||
| <sup>[[Legend of XML elements|[A]]]</sup> STRING <code>Ident</code> | | <sup>[[Legend of XML elements|[A]]]</sup> STRING <code>Ident</code> | ||
|The optional identifier, used especially for libraries that have it prescribed, can then be reflected in the [[Mapping]] | |The optional identifier, used especially for libraries that have it prescribed, can then be reflected in the [[Mapping]] | ||
|optional | |||
|empty | |||
|} | |} | ||
'''Example of Template XML''' | '''Example of Template XML''' | ||
Revision as of 09:13, 27 March 2022
Template XML definition
| Property | XML | Description | Presence | Default |
|---|---|---|---|---|
| GUID | [A] STRING ID or GUID
|
Unique GUID of the named data element, is written to the ID attribute, if an alternative text identifier is used in the ID, optionally specified in the GUID attribute
|
required | |
| Name | [E] Name
|
Element name, can be translated into multiple languages (see Multilingual text) | required | |
| Comment | [E] Comment
|
Optional comment, can be translated into multiple languages (see Multilingual text) | optional | empty |
| Item type | [A] ENUM ItemType
|
Item type {[V] String, [V] Double, [V] Enum, [V] Set, [V] EnumItem, [V] DateTime, [V] Table, [V] Group, [V] SoilPattern}
|
required | |
| Settings | [E] Settings
|
Different for each element type | required | |
| Identifier | [A] STRING Ident
|
The optional identifier, used especially for libraries that have it prescribed, can then be reflected in the Mapping | optional | empty |
Example of Template XML
<Item ID="{F12017FC-9AF4-4866-9FC2-BE7CF40B1A67}" ItemType="String">
<Name>
<Item Lang="CS" Text="Název zkoušky" />
<Item Lang="EN" Text="Test name" />
</Name>
<Comment>
<Item Lang="CS" Text="General / Fixed" />
</Comment>
<Settings Ident="ID123" />
</Item>
Data XML definition
| Property | XML | Description |
|---|---|---|
| Identifier | [A] STRING ID
|
ID can be either a GUID or a unique text identifier corresponding to ID / GUID attribute of Template Item
|
Example of Data XML
<Item ID="{B1DC392E-0C1A-4016-8B77-1CD25D89DC65}" StrValue="Pokus obsah" />