Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sprint22 Metaschema enhancements #450

Closed
wants to merge 75 commits into from

Conversation

wendellpiez
Copy link
Contributor

@wendellpiez wendellpiez commented Jun 27, 2019

Committer Notes

Testing PR. Will rewrite these committer notes to reflect Issues addressed, now (at least): #437, #442, #448, #435, with more to come.

Note: the draft SSP Metaschema, which needs to be updated to the new model, is not validated in this build against its XSD or Schematron.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions]

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them? See issues
  • Have you written new tests for your core changes, as applicable? Yes
  • Have you included examples of how to use your new feature(s)? Yes, and tbd

@wendellpiez wendellpiez changed the title Sprint22 metaschema Sprint22 Metaschema enhancements Jun 27, 2019
@@ -85,15 +92,15 @@ Nonetheless and with this in mind, understanding the mechanism by which the Meta

Terminology note: "metaschema" is a common noun and there are many metaschema technologies (indeed almost any mature XML tag set has one), with different purposes, feature sets and capabilities. "Metaschema" (capitalized) is our peculiar homegrown metaschema technology and application.

## The Overall Approach
## The Approach

A reduced, lightweight modeling language with certain specially-enforced constraints can be sketched such that multiple schemas constraining disparate formats, such as XML and JSON, can be produced from a single metaschema instance (a document written in Metaschema) deterministically, and thus designed and coordinated in parallel.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wendellpiez should we maybe be more specific on the use of XML for crafting the metaschemas themselves rather than alluding to any sort of new language which is what the sentence "a reduced, lightweight modeling language ..." kind of does? I know we don't want to detract from the design principles we've built, which themselves are new in this domain, but don't necessarily want to confuse folks when it comes to the syntax of the metaschemas.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anweiss good point. We could say "A reduced, lightweight XML-based modeling language" -- would that do the trick? I am not sure this is the place to explain the rationale(s) for the XML basis of the Metaschema itself. Or is it? We could also write a couple of sentences on that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think simply adding "XML-based" will do the trick here. A better place to explain the rationale behind certain decisions such as the use of XML for the metaschema, etc might be in an FAQ of sorts, no?

wendellpiez and others added 25 commits July 18, 2019 14:56
…ulting XSD per usnistgov#448; some updates to markdown documentation
Co-Authored-By: Andrew Weiss <anweiss@github.com>
Co-Authored-By: Andrew Weiss <anweiss@github.com>
Disabled @group-as checks in metaschema-check.sch. These need to be updated to support the new features.
… metaschema update XSLT - will break the build for now
@@ -0,0 +1,352 @@

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file was used to define the work needed for this PR. I don't think this needs to be added to the repo as a standalone Markdown file. We should pull from this to build out metaschema documentation and examples instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the file to a safe place, no longer in the rep

<xsl:strip-space elements="*"/>

<xsl:preserve-space elements="documentation"/>
<!--Converts file:/C:/Users/wap1/Documents/OSCAL/build/metaschema/xml/oscal-datatypes.xsd in JSON Schema notation-->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why this path is in here. This needs to be cleaned up.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stray comment now cleaned up.

@david-waltermire
Copy link
Contributor

Closing this in favor of PR #464, where this branch is being integrated.

@wendellpiez wendellpiez deleted the sprint22-metaschema branch October 2, 2019 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants