Project

General

Profile

Actions
Copy link

Bug #2128

open

Request addition of optional "exampleEntry" element under <attribute>

Added by Matthew Brooke almost 19 years ago.

Status:
New
Priority:
Normal
Assignee:
Matt Jones
Category:
eml - general bugs
Target version:
Unspecified
Start date:
06/16/2005
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
2128

Description

This is a request for the addition of an "exampleValue" element (or other
appropriate name) under the <attribute> subtree.

The element would be optional, and unbounded (cardinality zero to infinity). Its
primary use would be for data-entry software to show the user an example of what
should be entered in a given field. The entry would contain an example of a
properly-formatted, valid entry for the attribute in question

Proposed location is:

...immediately after the existing entry:
/eml:eml/dataset/dataTable/attributeList/attribute/measurementScale

...and immediately before the existing entry:
/eml:eml/dataset/dataTable/attributeList/attribute/missingValueCode

the xpath would be:
/eml:eml/dataset/dataTable/attributeList/attribute/exampleValue

Here is a suggested addition to the eml-attribute.xsd schema:

==================================

<xs:element name="exampleValue" type="xs:string" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Example Value</doc:tooltip>
<doc:summary>An example of a properly-formatted,
valid entry for this attribute</doc:summary>
<doc:description>An example of a properly-formatted,
valid entry for this attribute, which could be accessed and used by
data-entry software to show the user an example of what should be
entered in a given field.</doc:description>
<doc:example>depends on measurementScale for this attribute; e.g. for
a datetime format of hh:mm, the example value could be: 11:05</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>

==================================

Here is a suggested EML snippet showing its usage (where "<...>" denotes that
non-relevant elements have been omitted for clarity):

<...>
<attribute>
<...>
<measurementScale>
<...datetime info here...>
</measurementScale>

&lt;exampleValue&gt;11:05&lt;/exampleValue&gt;
    &lt;exampleValue&gt;01:21&lt;/exampleValue&gt;
    &lt;exampleValue&gt;23:00&lt;/exampleValue&gt;
<...>
  &lt;/attribute&gt;
<...>
Actions
Copy link

Also available in: Atom PDF