summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--data/examples/interface_definition_sample.xml11
-rw-r--r--data/schemata/interface_definition.rnc16
-rw-r--r--data/schemata/interface_definition.rng28
3 files changed, 31 insertions, 24 deletions
diff --git a/data/examples/interface_definition_sample.xml b/data/examples/interface_definition_sample.xml
index fe22e17..8b48c20 100644
--- a/data/examples/interface_definition_sample.xml
+++ b/data/examples/interface_definition_sample.xml
@@ -4,7 +4,7 @@
<children>
<tagNode name="user">
<properties>
- <helpString>User name</helpString>
+ <help>User name</help>
<constraint>
<regex>[a-z][a-zA-Z0-9]+</regex>
<errorMessage>User name must start with a letter and consist of letters and digits</errorMessage>
@@ -13,15 +13,18 @@
<children>
<leafNode name="full-name">
<properties>
- <helpString>User full name</helpString>
+ <help>User full name</help>
</properties>
</leafNode>
</children>
</tagNode>
<leafNode name="hostname">
<properties>
- <helpString>System hostname</helpString>
- <valueHelpString>text</valueHelpString>
+ <help>System hostname</help>
+ <valueHelp>
+ <format>text</format>
+ <description>System hostname (alphanumeric, must start with a letter)</description>
+ </valueHelp>
</properties>
</leafNode>
</children>
diff --git a/data/schemata/interface_definition.rnc b/data/schemata/interface_definition.rnc
index d28d06d..a0d6bc1 100644
--- a/data/schemata/interface_definition.rnc
+++ b/data/schemata/interface_definition.rnc
@@ -45,11 +45,11 @@ children = element children
# but whether they are used or not is implementation-defined
properties = element properties
{
- helpString?,
+ help?,
constraint?,
# These are meaningful only for leaf nodes
- valueHelpString?,
+ valueHelp?,
(multi | valueless)?
}
@@ -149,15 +149,15 @@ valueless = element valueless
empty
}
-# helpString tag contains brief description of the purpose of the node
-# Must have description= attribute
-helpString = element helpString
+# help tags contains brief description of the purpose of the node
+help = element help
{
text
}
-# valueHelpString tags contain information about acceptable value format
-valueHelpString = element valueHelpString
+# valueHelp tags contain information about acceptable value format
+valueHelp = element valueHelp
{
- text
+ element format { text } &
+ element description { text }
}
diff --git a/data/schemata/interface_definition.rng b/data/schemata/interface_definition.rng
index bc55542..7766716 100644
--- a/data/schemata/interface_definition.rng
+++ b/data/schemata/interface_definition.rng
@@ -63,14 +63,14 @@
<define name="properties">
<element name="properties">
<optional>
- <ref name="helpString"/>
+ <ref name="help"/>
</optional>
<optional>
<ref name="constraint"/>
</optional>
<optional>
<!-- These are meaningful only for leaf nodes -->
- <ref name="valueHelpString"/>
+ <ref name="valueHelp"/>
</optional>
<optional>
<choice>
@@ -212,19 +212,23 @@
<empty/>
</element>
</define>
- <!--
- helpString tag contains brief description of the purpose of the node
- Must have description= attribute
- -->
- <define name="helpString">
- <element name="helpString">
+ <!-- help tags contains brief description of the purpose of the node -->
+ <define name="help">
+ <element name="help">
<text/>
</element>
</define>
- <!-- valueHelpString tags contain information about acceptable value format -->
- <define name="valueHelpString">
- <element name="valueHelpString">
- <text/>
+ <!-- valueHelp tags contain information about acceptable value format -->
+ <define name="valueHelp">
+ <element name="valueHelp">
+ <interleave>
+ <element name="format">
+ <text/>
+ </element>
+ <element name="description">
+ <text/>
+ </element>
+ </interleave>
</element>
</define>
</grammar>