[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]
Subject: SingleItemSubmission1 DTD
RegRep folks, Earlier this week I proposed to the other implementors in RegRep that we focus on the simplest case first, i.e. how does a Submitting Organization (SO) submit the metadata for a single XSGML-entity to a Registration Authority for registration. I volunteered to produce a simple Submission DTD for that purpose. First lets make a distinction among terms: An XSGML-entity is an item to be registered, a <data-element> is metadata about the XSGML-entity to be registered, and an <xsgml-entity-reference> is a pointer to the actual XSGML-entity instance. A Registry will maintain the metadata about an XSGML-entity, including a reference to its instance (which may or may not be at the same location) and a Repository will maintain the instance itself. A Registry/Repository will do both. My first proposal is for a "vanilla" submission that is completely self contained. That is, the XSGML-entity to be registered does not have any Associations with other XSGML-entities and has no Related Data instances. Attached is a text file, SingleItemSubmission1, for that DTD, along with an identical file having a "dtd" file extension appropriate for various XML tools to parse and present. The DTD is complete with 20+ "Semantic Rules" identifying the purpose of each XML element and any semantic restrictions on its values. I'd appreciate any comments on either the DTD itself or its Semantic Rules. It is not a complete subset of DTD's currently specified because it singles out <xsgml-entity-reference> for special attention, adds the concept of <local-reference-name>, and adds two new attributes for <contact>s. While the rest of you contemplate "SingleItemSubmission1", I'll work on an extension, call it SingleItemSubmission2 that supports both Associations and Related Data. Then, if those two items make sense, we can consider the more difficult task of deciding definitions for and relationships among data element dictionaries, containers, packages, etc. -- Len G.
<!-- OASIS SingleItemSubmission1 DTD
Version 1.0
12 April 2000
Len Gallagher - OASIS RegRep member
The purpose of SingleItemSubmission1 is to provide a simple
format for a Submitting Organization to submit a single
XSGML-entity to a Registration Authority for the purpose of
registration of that element in a Registry/Repository. This
submission form does not provide for Associations or for
Related Data, nor does it provide for any submission purpose
other than to register the submitted item.
-->
<!ELEMENT SingleItemSubmission1
(
submitting-organization,
simple-contact+,
registration-authority,
xsgml-entity-reference,
local-reference-name,
data-element
)
>
<!ELEMENT submitting-organization (urn-reference)>
<!ELEMENT simple-contact
(
contact-name,
contact-role*,
contact-telephone*,
contact-email
)
>
<!ATTLIST simple-contact
availability (
private
| public
| protected ) #IMPLIED
role-category (
administrative
| technical
| all-issues ) #IMPLIED
>
<!ELEMENT contact-name (short-clear-text)>
<!ELEMENT contact-role (comment-text)>
<!ELEMENT contact-telephone (short-clear-text)>
<!ELEMENT contact-email (short-clear-text)>
<!ELEMENT registration-authority (urn-reference)>
<!ELEMENT xsgml-entity-reference (ftp-reference)>
<!ELEMENT local-reference-name (short-connected-name)>
<!ELEMENT data-element
(
representation-label,
version?,
definition-text,
name-context+,
classification*
)
>
<!ELEMENT representation-label EMPTY>
<!ATTLIST representation-label
representation-type (
xml-dtd
| sgml-dtd
| xml-schema
| xdr-schema
| sox-schema
| rdf-schema
| sgml-element
| xml-element
| sgml-attribute
| xml-attribute
| sgml-enumerated-attribute-set
| xml-enumerated-attribute-set
| sgml-enumerated-attribute-value
| xml-enumerated-attribute-value
| sgml-parameter-entity
| xml-parameter-entity
| character-entity-set) #REQUIRED
>
<!ELEMENT version (short-clear-text)>
<!ELEMENT definition-text (human-readable-text)>
<!ELEMENT name-context (
name-context-label,
designation-name+)>
<!ELEMENT name-context-label EMPTY>
<!ATTLIST name-context-label
defined-label (
entity-supplied-name
| fpi
| urn ) #REQUIRED
>
<!ELEMENT designation-name (uri-reference)>
<!ELEMENT classification
(
classification-scheme-identifier-reference,
classification-scheme-item-value-reference
)
>
<!ELEMENT classification-scheme-identifier-reference (urn-reference)>
<!ELEMENT classification-scheme-item-value-reference (uri-reference)>
<!ELEMENT urn-reference (#PCDATA)>
<!ELEMENT ftp-reference (#PCDATA)>
<!ELEMENT uri-reference (#PCDATA)>
<!ELEMENT short-connected-name (#PCDATA)>
<!ELEMENT short-clear-text (#PCDATA)>
<!ELEMENT comment-text (#PCDATA)>
<!ELEMENT human-readable-text (#PCDATA)>
<!-- SEMANTIC RULES for <SingleItemSubmission1>
1) The <submitting-organization> is a URN that uniquely identifies a
Submitting Organization (SO). The SO is previously known to the
Registration Authority (RA) and they each know of a unique URN for
the other.
2) The <simple-contact> identifies a person or office associated with the
SO able to speak to technical or administrative questions about the
submitted item.
3) If the <availability> attribute of a <simple-contact> is:
Case:
a) "private", then the RA will not reveal the <simple-contact> to
any other organization.
b) "protected", then the RA may reveal the <simple-contact> to other
legitimate registration authorities.
[Note: legitimate left purposely undefined for now]
c) "public", then the RA may reveal the <simple-contact> to any user
of the registry maintained by the RA.
d) not present, then "public" is assumed.
4) If the <role-category> attribute of a <simple-contact> is:
Case:
a) "administrative", the the <simple-contact> is prepared to address
administrative questions related to the submitted item.
b) "technical", then the <simple-contact> is prepared to address
technical questions related to the submitted item.
c) "all-issues", then the <simple-contact> is prepared to address
all isuues related to the submitted item.
d) not present, then "all-issues" is assumed.
3) A <contact-name> identifies the name to ask for when contacting
the <simple-contact>.
4) The <contact-role> is a comment that explains in natural language the
relationship of the <simple-contact> to the item submitted for registration.
It may explain further the <role-category> of the contact.
5) The <contact-telephone> is a single international telephone number,
possibly with an extension, that is the best number to use when trying to
contact a person who can speak to issues involving the submitted item.
6) The <contact-email> is a global email address that is the best address
to use when trying to contact someone who can respond to issues involving
the submitted item.
7) The <registration-authority> is a URN that uniquely identifies the RA
to which the item referenced by the <xsgml-entity-reference> is submitted
for registration.
8) The <xsgml-entity-reference> is an FTP URL that locates the item
submitted for registration. If the RA is also a repository for the item,
then the RA will download the item and store it in the repository.
9) The <local-reference-name> is a name that can be used to reference the
submitted item in a locally scoped name space. If the submitted item is a
single data element or a single DTD, then this name will often be equal to
the name of the referenced XML element; however, this is not required. The
intent is that the RA use this name as the basis of constructing an
RA-specific URN that will uniquely identify this item in a global context.
[NOTE: Later, when submission packages are supported, this name can be used
to reference other items in the same submission.]
10) The <representation-label> identifies the representation type of the
item submitted for registration. If the the RA is also a repository for
that item, then the RA verifies that the item is of the identified type.
11) The <version>, if present, is an SO-specific string for identifying
the version of the submitted item. The format of <version> is not specified
herein.
12) The <definition-text> is a natural language description of the item
submitted for registration.
13) A <name-context> defines one or more names of the item submitted for
registration.
Case:
a) If the <defined-label> attribute is "entity-supplied-name", then
each <designation-name> associated with that label is an arbitrary
<uri-reference>.
b) If the <defined-label> attribute is "urn", then the <uri-reference>
of each <designation-name> associated with that label is a URN that
uniquely identifies the item submitted for registration.
c) If the <defined-label> attribute is "fpi", then ???? ...
[NOTE: What is an "fpi"?]
14) The <classification-scheme-identifier-reference> is a URN that
uniquely identifies a classification scheme registered in a Registry
maintained by the RA.
15) The <classification-scheme-item-value-reference> is a value defined
by the referenced classification scheme.
16) A <urn-reference> is a Uniform Resource Name (URN) as specified by
IETF RFC 1241.
(See http://www.ietf.cnri.reston.va.us/rfc/rfc2141.txt?number=2141)
17) An <ftp-reference> is a File Transfer Protocol (FTP) Uniform Resource
Locator (URL) as specified by IETF. The default user name is "anonymous".
(See ftp://ftp.isi.edu/in-notes/rfc1738.txt)
18) A <uri-reference> is a Uniform Resource Identifier (URI) as specified
by ???. (See http://???)
19) A <short-connected-name> element consists entirely of visible characters
from the implied character set. The presence of non-visible characters is
an error. The length of a <short-connected-name> element is less than or
equal to 50 characters.
20) A <short-clear-text> element consists entirely of visible characters
from the implied character set, together with optional use of blank spaces.
Other non-visible characters may be ignored by the RA. The length of a
<short-clear-text> element is less than or equal to 50 characters.
21) A <comment-text> element consists entirely of visible characters from
the implied character set, together with optional use of blank spaces, tabs,
and return characters. Other non-visible characters may be ignored by the
RA. The length of a <comment-text> element is less than or equal to 500
characters.
22) A <human-readable-text> element consists entirely of visible characters
from the implied character set, together with optional use of blank spaces,
tabs, and return characters. Other non-visible characters may be ignored by
the RA. The length of a <human-readable-text> element is less than or equal
to some RA-specified limit greater than or equal to 50,000 characters.
-->
<!-- OASIS SingleItemSubmission1 DTD
Version 1.0
12 April 2000
Len Gallagher - OASIS RegRep member
The purpose of SingleItemSubmission1 is to provide a simple
format for a Submitting Organization to submit a single
XSGML-entity to a Registration Authority for the purpose of
registration of that element in a Registry/Repository. This
submission form does not provide for Associations or for
Related Data, nor does it provide for any submission purpose
other than to register the submitted item.
-->
<!ELEMENT SingleItemSubmission1
(
submitting-organization,
simple-contact+,
registration-authority,
xsgml-entity-reference,
local-reference-name,
data-element
)
>
<!ELEMENT submitting-organization (urn-reference)>
<!ELEMENT simple-contact
(
contact-name,
contact-role*,
contact-telephone*,
contact-email
)
>
<!ATTLIST simple-contact
availability (
private
| public
| protected ) #IMPLIED
role-category (
administrative
| technical
| all-issues ) #IMPLIED
>
<!ELEMENT contact-name (short-clear-text)>
<!ELEMENT contact-role (comment-text)>
<!ELEMENT contact-telephone (short-clear-text)>
<!ELEMENT contact-email (short-clear-text)>
<!ELEMENT registration-authority (urn-reference)>
<!ELEMENT xsgml-entity-reference (ftp-reference)>
<!ELEMENT local-reference-name (short-connected-name)>
<!ELEMENT data-element
(
representation-label,
version?,
definition-text,
name-context+,
classification*
)
>
<!ELEMENT representation-label EMPTY>
<!ATTLIST representation-label
representation-type (
xml-dtd
| sgml-dtd
| xml-schema
| xdr-schema
| sox-schema
| rdf-schema
| sgml-element
| xml-element
| sgml-attribute
| xml-attribute
| sgml-enumerated-attribute-set
| xml-enumerated-attribute-set
| sgml-enumerated-attribute-value
| xml-enumerated-attribute-value
| sgml-parameter-entity
| xml-parameter-entity
| character-entity-set) #REQUIRED
>
<!ELEMENT version (short-clear-text)>
<!ELEMENT definition-text (human-readable-text)>
<!ELEMENT name-context (
name-context-label,
designation-name+)>
<!ELEMENT name-context-label EMPTY>
<!ATTLIST name-context-label
defined-label (
entity-supplied-name
| fpi
| urn ) #REQUIRED
>
<!ELEMENT designation-name (uri-reference)>
<!ELEMENT classification
(
classification-scheme-identifier-reference,
classification-scheme-item-value-reference
)
>
<!ELEMENT classification-scheme-identifier-reference (urn-reference)>
<!ELEMENT classification-scheme-item-value-reference (uri-reference)>
<!ELEMENT urn-reference (#PCDATA)>
<!ELEMENT ftp-reference (#PCDATA)>
<!ELEMENT uri-reference (#PCDATA)>
<!ELEMENT short-connected-name (#PCDATA)>
<!ELEMENT short-clear-text (#PCDATA)>
<!ELEMENT comment-text (#PCDATA)>
<!ELEMENT human-readable-text (#PCDATA)>
<!-- SEMANTIC RULES for <SingleItemSubmission1>
1) The <submitting-organization> is a URN that uniquely identifies a
Submitting Organization (SO). The SO is previously known to the
Registration Authority (RA) and they each know of a unique URN for
the other.
2) The <simple-contact> identifies a person or office associated with the
SO able to speak to technical or administrative questions about the
submitted item.
3) If the <availability> attribute of a <simple-contact> is:
Case:
a) "private", then the RA will not reveal the <simple-contact> to
any other organization.
b) "protected", then the RA may reveal the <simple-contact> to other
legitimate registration authorities.
[Note: legitimate left purposely undefined for now]
c) "public", then the RA may reveal the <simple-contact> to any user
of the registry maintained by the RA.
d) not present, then "public" is assumed.
4) If the <role-category> attribute of a <simple-contact> is:
Case:
a) "administrative", the the <simple-contact> is prepared to address
administrative questions related to the submitted item.
b) "technical", then the <simple-contact> is prepared to address
technical questions related to the submitted item.
c) "all-issues", then the <simple-contact> is prepared to address
all isuues related to the submitted item.
d) not present, then "all-issues" is assumed.
3) A <contact-name> identifies the name to ask for when contacting
the <simple-contact>.
4) The <contact-role> is a comment that explains in natural language the
relationship of the <simple-contact> to the item submitted for registration.
It may explain further the <role-category> of the contact.
5) The <contact-telephone> is a single international telephone number,
possibly with an extension, that is the best number to use when trying to
contact a person who can speak to issues involving the submitted item.
6) The <contact-email> is a global email address that is the best address
to use when trying to contact someone who can respond to issues involving
the submitted item.
7) The <registration-authority> is a URN that uniquely identifies the RA
to which the item referenced by the <xsgml-entity-reference> is submitted
for registration.
8) The <xsgml-entity-reference> is an FTP URL that locates the item
submitted for registration. If the RA is also a repository for the item,
then the RA will download the item and store it in the repository.
9) The <local-reference-name> is a name that can be used to reference the
submitted item in a locally scoped name space. If the submitted item is a
single data element or a single DTD, then this name will often be equal to
the name of the referenced XML element; however, this is not required. The
intent is that the RA use this name as the basis of constructing an
RA-specific URN that will uniquely identify this item in a global context.
[NOTE: Later, when submission packages are supported, this name can be used
to reference other items in the same submission.]
10) The <representation-label> identifies the representation type of the
item submitted for registration. If the the RA is also a repository for
that item, then the RA verifies that the item is of the identified type.
11) The <version>, if present, is an SO-specific string for identifying
the version of the submitted item. The format of <version> is not specified
herein.
12) The <definition-text> is a natural language description of the item
submitted for registration.
13) A <name-context> defines one or more names of the item submitted for
registration.
Case:
a) If the <defined-label> attribute is "entity-supplied-name", then
each <designation-name> associated with that label is an arbitrary
<uri-reference>.
b) If the <defined-label> attribute is "urn", then the <uri-reference>
of each <designation-name> associated with that label is a URN that
uniquely identifies the item submitted for registration.
c) If the <defined-label> attribute is "fpi", then ???? ...
[NOTE: What is an "fpi"?]
14) The <classification-scheme-identifier-reference> is a URN that
uniquely identifies a classification scheme registered in a Registry
maintained by the RA.
15) The <classification-scheme-item-value-reference> is a value defined
by the referenced classification scheme.
16) A <urn-reference> is a Uniform Resource Name (URN) as specified by
IETF RFC 1241.
(See http://www.ietf.cnri.reston.va.us/rfc/rfc2141.txt?number=2141)
17) An <ftp-reference> is a File Transfer Protocol (FTP) Uniform Resource
Locator (URL) as specified by IETF. The default user name is "anonymous".
(See ftp://ftp.isi.edu/in-notes/rfc1738.txt)
18) A <uri-reference> is a Uniform Resource Identifier (URI) as specified
by ???. (See http://???)
19) A <short-connected-name> element consists entirely of visible characters
from the implied character set. The presence of non-visible characters is
an error. The length of a <short-connected-name> element is less than or
equal to 50 characters.
20) A <short-clear-text> element consists entirely of visible characters
from the implied character set, together with optional use of blank spaces.
Other non-visible characters may be ignored by the RA. The length of a
<short-clear-text> element is less than or equal to 50 characters.
21) A <comment-text> element consists entirely of visible characters from
the implied character set, together with optional use of blank spaces, tabs,
and return characters. Other non-visible characters may be ignored by the
RA. The length of a <comment-text> element is less than or equal to 500
characters.
22) A <human-readable-text> element consists entirely of visible characters
from the implied character set, together with optional use of blank spaces,
tabs, and return characters. Other non-visible characters may be ignored by
the RA. The length of a <human-readable-text> element is less than or equal
to some RA-specified limit greater than or equal to 50,000 characters.
-->
************************************************************** Len Gallagher LGallagher@nist.gov NIST Work: 301-975-3251 Bldg 820 Room 562 Home: 301-424-1928 Gaithersburg, MD 20899-8970 USA Fax: 301-948-6213 **************************************************************
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]
Powered by eList eXpress LLC