search

niemopen / niem-naming-design-rules

NIEM Naming and Design Rules Specification
Other
4 stars 2 forks source link

Review NDR definitions #18

Open cdmgtri opened 1 year ago

cdmgtri commented 1 year ago

Migrated from NIEM/NIEM-NDR#102

Update some of the definitions so they are shorter and don't embed what should be constraint or interpretation rules. Make sure they explain what the concept is.

Current

[Definition: reference schema document]

A reference schema document is a schema document that is intended to provide the authoritative definitions of broadly reusable schema components. It is a conformance target of this specification. A reference schema document MUST conform to all rules of this specification that apply to this conformance target. An XML document with a conformance target identifier of http://reference.niem.gov/niem/specification/naming-and-design-rules/5.0/#ReferenceSchemaDocument MUST be a conformant reference schema document.

Proposed

[Definition: reference schema document]

A reference schema document is a schema document that is intended to provide the authoritative definitions of broadly reusable schema components.

Move the part about a document with a REF target identifier being a conformant reference schema document to an interpretation rule if that's needed.

Current

[Definition: data definition]

The data definition of a schema component is the content of the first occurrence of the element xs:documentation that is an immediate child of an occurrence of an element xs:annotation that is an immediate child of the element that defines the component.

Proposed

Say what it is, not where to find it. Doesn't apply to other formats besides NIEM XML anyway.

Current

[Definition: RoleOf element]

A RoleOf element is an element declaration that

  • is defined by a reference schema document or an extension schema document, and
  • has a {name} that begins with RoleOf.

A RoleOf element represents a base type for a role type.