Changes between Version 9 and Version 10 of ComponentRegistryAndEditor/FrontEndSpec

Timestamp:

11/14/14 14:56:31 (10 years ago)

Author:

Twan Goosen

Comment:

Editor (incomplete)

ComponentRegistryAndEditor/FrontEndSpec

@@ -120 +120 @@
 * Concept link (optional; see below for details on search)
 
-XML example: 
+For XML examples, see Elements and Components.
+
+=== Elements ===
+
+Components can have any number of child elements defined
+
+Elements have the following properties:
+* Name (mandatory; must be a valid XML attribute name)
+* Type (mandatory; see below for details on selection)
+* !DisplayPriority (mandatory - each component must have at least one child element with a value > 0)
+* !MinOccurrences (mandatory, should be an integer >= 0)
+* !MaxOccurrences (mandatory, should be an integer >= !MinOccurrences or 'unbounded')
+* Concept link (optional; see below for details on search)
+* Documentation (optional)
+* Multilingual (optional boolean)
+
+Elements can have any number of attributes as children
+
+XML example of an optional (0:1) 'string' type element with one attribute
 {{{#!xml
-<AttributeList>
+<CMD_Element name="myElement" ValueScheme="string" CardinalityMin="0" CardinalityMax="1" DisplayPriority="1" Multilingual="false">
+      <AttributeList>
+        <Attribute>
+          <Name>elementAttribute</Name>
+          <Type>string</Type>
+        </Attribute>
+      </AttributeList>
+</CMD_Element>
+}}}
+
+=== Components ===
+
+Components can have any number of child components defined. These can either be references to other components with an ID of their own, or inline components that constitute a level of hierarchy but cannot be reused outside the context in which they are defined.
+
+==== Linking in existing components ====
+Existing components from the public, private or group spaces can be chosen for inclusion as a reference.
+
+TODO: XML example
+
+==== Inline components ====
+
+Inline components have the following properties:
+
+
+Inline components can have any number of attributes and elements as children
+
+XML example of a 1:N component with an element and an attribute as children
+{{{#!xml
+<CMD_Component name="DiscAn_TextCorpus" CardinalityMin="1" CardinalityMax="unbounded">
+    <AttributeList>
       <Attribute>
-        <Name>firstAttribute</Name>
+        <Name>componentAttribute</Name>
         <ConceptLink>http://www.isocat.org/datcat/DC-3870</ConceptLink>
         <Type>string</Type>
       </Attribute>
-      <Attribute>
-        <Name>secondAttribute</Name>
-        <ConceptLink>http://www.isocat.org/datcat/DC-3870</ConceptLink>
-        <Type>boolean</Type>
-      </Attribute>
-</AttributeList>
+    </AttributeList>
+    <CMD_Element name="childElement" ValueScheme="string" CardinalityMin="1" CardinalityMax="1" DisplayPriority="1" Multilingual="false">
+    ...
 }}}
 
-=== Elements ===
-
-Components can have any number of child elements defined
-
-Elements have the following properties:
-
-TODO: XML example
-
-=== Components ===
-
-Components can have any number of child components defined. These can either be references to other components with an ID of their own, or inline components that constitute a level of hierarchy but cannot be reused outside the context in which they are defined.
-
-==== Linking in existing components ====
-Existing components from the public, private or group spaces can be chosen for inclusion as a reference.
-
-TODO: XML example
-
-==== Inline components ====
-
-Inline components have the following properties:
-*
-
-TODO: XML example
 
 === Type selection ===