NIEM NDR version 5.0

See this version at https://niem.github.io/NIEM-NDR/v5.0.

• Integrated source and publication repositories. Moved all published artifacts to /publish directory.
• Installed build system using GNU autoconf/configure, using Makefile.in.
• Added run script "run.in" for easy execution of common targets, without cluttering up the Makefile.
• Issue #95: Fixed error "used to by" in section 10.4.
• Issue #82: Remove metadata from structures:AugmentationType.
• Issue #86: Added documentation to components in the structures namespace.
• Issue #88: Update utility schemas for NIEM 5.0beta1.
  • structures: Added sequenceID. Removed structures:metadata attribute from structures:AugmentationType. Added xml:lang. Added documentation.
  • appinfo: Added xml:lang. Revised documentation of attribute appinfo:deprecated.
• Issue #94: Updated structures, appinfo, and schema examples, and NIEM schemas for validation, to NIEM 5.0 draft versions.
  • Updated example XSD NIEM subset to entire NIEM 5.0rc1 tree.
  • Updated structures & appinfo schemas to UTF-8.
• Issue #81: Add text and rules supporting attribute structures:sequenceID.
  • Added new interpretation rule defining order of properties when structures:sequenceID is used.
  • Added text in Section 5.3 clarifying that NIEM expresses order of properties of an object via structures:sequenceID.
• Issue #90.: Changed type of @Structures:sequenceID to positive integer.
• Issue #89: Updated NIEM version to 5.0.
• Issue #87: Required attribute xml:lang on component names and xs:documentation.
• Issue #83: Added RDF entailment for use of structures:metadata.
  • Stood up a section for schema components mapping to RDF.
• Issue #84: Added RDF entailment for @Structures:relationshipMetadata.
  • Added description of properties being put into named graphs using structures:relationshipMetadata.
  • Added introduction of RDF datasets.
  • Described NIEM data as being triples that can be assigned to named graphs as needed.
  • Introduced N-Quads via text from its standard; added reference to N-Quads specification.
  • Expanded the section on elements as simple properties to cover cases with and without structures:relationshipMetadata.
  • Added RDF/N-Quad definition of attributes as simple properties.
  • Redefined RDF for elements and attributes applied via an augmentation type. Removed the separate sections for elements and attributes. Added new section for both elements and attributes, which defers to the sections for elements and attributes as simple properties.
  • Updated text & example in section 12 "instance metadata" section.
  • Broke out section on RDF mappings of instances to type information.
• Issue #43: Renamed table 10-2 to "Property representation terms".
• Issue #58: The term "linked data" now links to the W3C landing page for Linked Data.
• Issue #79: Added new rule 5-1, which defines the interpretation of XML data as defined by RDF mappings.
• Issue #72: Removed use of in rules.
• Issue #91: Clarify that properties are unordered in §5.
• Issue #92: Added principle of "optional and over-inclusive". Added to the section defining the "reference schema document" conformance target
• Issue #93: Revised definition of Representation Term "Date".
  • Revised to "A continuous or recurring period of time, of a duration greater than or equal to a day."
• Issue #76: Corrected name of RDF.
• Issue #75: Added new MUST rule that requires a component with a name ending in 'SimpleType' be a simple type definition, and with a name ending in 'Type' be a complex type definition.
• Issue #74: Fixed missing "an" in definition of conformant instance XML document.
• Issue #80: Added representation term "Representation" to table "Property representation terms".
• Issue #71: Revised section heading that repeated "id" instead of using "ref".
• Issue #70: Fix whitespace/blank lines in 5.6.2. RDF Literals
• Issue #96: Updated text to avoid preferring the term "MPD" for a message specification.
• Updated front matter for final release.

NIEM Naming and Design Rules, version 5.0rc1

Updates since v5.0beta1:

• Issue #96: Updated text to avoid preferring the term "MPD" for a message specification.
• Updated front matter for final release.

NIEM Naming and Design Rules, version 5.0beta1

See this version at https://niem.github.io/NIEM-NDR/v5.0beta1/

Integrated source and publication repositories. Moved all published artifacts to /publish directory.

Installed build system using GNU autoconf/configure, using Makefile.in.

Added run script "run.in" for easy execution of common targets, without cluttering up the Makefile.

Tracked issues:

• Issue #95: Fixed error "used to by" in section 10.4.

• Issue #82: Remove metadata from structures:AugmentationType.

• Issue #86: Added documentation to components in the structures namespace.

• Issue #88: Update utility schemas for NIEM 5.0beta1.

  • structures: Added sequenceID. Removed structures:metadata attribute from structures:AugmentationType. Added xml:lang. Added documentation.
  • appinfo: Added xml:lang. Revised documentation of attribute appinfo:deprecated.

• Issue #94: Updated structures, appinfo, and schema examples, and NIEM schemas for validation, to NIEM 5.0 draft versions.

  • Updated example XSD NIEM subset to entire NIEM 5.0rc1 tree.
  • Updated structures & appinfo schemas to UTF-8.

• Issue #81: Add text and rules supporting attribute structures:sequenceID.

  • Added new interpretation rule defining order of properties when structures:sequenceID is used.
  • Added text in Section 5.3 clarifying that NIEM expresses order of properties of an object via structures:sequenceID.

• Issue #90.: Changed type of @structures:sequenceID to positive integer.

• Issue #89: Updated NIEM version to 5.0.

• Issue #87: Required attribute xml:lang on component names and xs:documentation.

• Issue #83: Added RDF entailment for use of structures:metadata.

  • Stood up a section for schema components mapping to RDF.

• Issue #84: Added RDF entailment for @structures:relationshipMetadata.

  • Added description of properties being put into named graphs using structures:relationshipMetadata.
  • Added introduction of RDF datasets.
  • Described NIEM data as being triples that can be assigned to named graphs as needed.
  • Introduced N-Quads via text from its standard; added reference to N-Quads specification.
  • Expanded the section on elements as simple properties to cover cases with and without structures:relationshipMetadata.
  • Added RDF/N-Quad definition of attributes as simple properties.
  • Redefined RDF for elements and attributes applied via an augmentation type. Removed the separate sections for elements and attributes. Added new section for both elements and attributes, which defers to the sections for elements and attributes as simple properties.
  • Updated text & example in section 12 "instance metadata" section.
  • Broke out section on RDF mappings of instances to type information.

• Issue #43: Renamed table 10-2 to "Property representation terms".

• Issue #58: The term "linked data" now links to the W3C landing page for Linked Data.

• Issue #79: Added new rule 5-1, which defines the interpretation of XML data as defined by RDF mappings.

• Issue #72: Removed use of in rules.

• Issue #91: Clarify that properties are unordered in §5.

• Issue #92: Added principle of "optional and over-inclusive". Added to the section defining the "reference schema document" conformance target

• Issue #93: Revised definition of Representation Term "Date".

  • Revised to "A continuous or recurring period of time, of a duration greater than or equal to a day."

• Issue #76: Corrected name of RDF.

• Issue #75: Added new MUST rule that requires a component with a name ending in 'SimpleType' be a simple type definition, and with a name ending in 'Type' be a complex type definition.

• Issue #74: Fixed missing "an" in definition of conformant instance XML document.

• Issue #80: Added representation term "Representation" to table "Property representation terms".

• Issue #71: Revised section heading that repeated "id" instead of using "ref".

• Issue #70: Fix whitespace/blank lines in 5.6.2. RDF Literals

NIEM NDR v4.0

view the HTML version

NIEM Naming and Design Rules v4.0rc1

• view the HTML version
• view the commit log for the release

NIEM NDR v4.0beta2

View the draft NDR document

NIEM NDR 4.0beta2.

Included reference to code lists spec as an option for building code types, code simple types.

Fixed typo in rule 10-17.

Added crossref from code type to code simple type.

Added schematron for component name allowed characters.

Expanded rule 10-47 from "hyphen" to "punctuation" to include underscore, hyphen, and period.

Added schematron for rule 10-50 and fixed omission of proxy types from the rule.

Removed old rule 11-2, 11-5, 11-13, as they are now covered by rule 10-50.

Added reference to code lists spec v1.0.

eliminated stray 3.0 references

Pointed to github repo for updates and errata, and comment submission.

Added spelling to Makefile. Stood up initial words file.

Revised non-word "birthdate" to OED word "birth-date"

Stood up and verified spell checking

Addressed @fixed and @default:

Updated 6.2.2. from "Disallow content modification with XML processors" to
"Prohibit XML parsing from constructing values", clarifying that XML documents
aren't modified; it's data passed through a parser. Updated principle 5.

Updated Section 8.4 from "Ensure schema processing does not alter processed
data" to "Ensure XML parsing does not construct values"" Added description of
infoset augmentation by XML Schema validating parsers. Got away from language
that sounds like XML files are modified by parsers.

Updated rule #no-at-fixed to allow required attribute uses.

Prohibited @fixed on simple type facets in reference schemas.

Broke up Rule 11-29. "Standard opening phrase for element" and Rule
11-30. "Standard opening phrase for complex type" into component-specific rules.

Updated instance rules on ID/REF and URIs.

Removed references to the local terminology namespace.

Updated NDR to include correct structures and appinfo schemas.

Overhauled section 12 & rules about ids, refs, and uris, consistently with NTAC
decisions.

Removed terminology of "content element" and "reference element".

Removed language about "pointing" and instead mapped ids and refs to
uris.

Added new section on "the meaning of NIEM data". Added table mapping XML data to
NIEM meaning of that data. Added new diagram for a simple XML instance.

Added toplevel section on identifiers and references, and put id/ref as
subsection on local identifiers and references.

Indicated that objects can be merged.

Added new section on uniform identifiers in niem data.

Added new rules defining uri as URI-reference, and id and ref as mapped to uri.

Added section on compare-and-contrast of ref-to-id and URIs.

Added rule ensuring only one of (id, ref, uri) appears on an instance.

Udpated structures.xsd to include @Structures:uri.

Fixed: NCCT Issue 959 - 10.4 Augmentations - Revise problems with extensions

Fixed: NCCT Issue 960 - 10.4 Augmentation - Clarify augmentation type

Addressed Issue 961 - 10.4 Augmentation - Expand definition of "augmentation" to include direct elements.

Fixed: NCCT Issue 962 - Figure 10-12: "An augmentation that is not an
augmentable type" is incomplete. No change, fixed in previous draft.

Addressed NNCT Issue 963 - Figures 10-12 and 10-13 An Augmentation that is not
an augmentation type. Provided supporting text.

Addressed NCCT Issue 863 - NDR [Rule 10-49] (Names use common abbreviations)
Violation. OK in current release. Revised that rule to be SHOULD in
alignment with relaxation of naming rules to SHOULD.

Addressed NCCT Issue 864 - NDR [Rule 11-31] (Standard opening phrase for
element) Violation. No change; fixed in 4.0.

Addressed NCCT Issue 866 - Duplicate terms in LocalTerminology. No change. Not in 4.0.

Fixed NCCT Issue 939 - NDR rule 10-69 applies only to REF, should apply to
REF,EXT. Revised as requested.

Addressed NCCT Issue 935 - typo in section 5.3. No change. Fixed in previous version.

Updated date & version of doc.