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

Removing placeholder elements for 'prose' #495

Closed
4 of 5 tasks
wendellpiez opened this issue Sep 26, 2019 · 1 comment
Closed
4 of 5 tasks

Removing placeholder elements for 'prose' #495

wendellpiez opened this issue Sep 26, 2019 · 1 comment

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented Sep 26, 2019

User Story:

Now we have metaschema syntax for controlling the appearance of wrapped or unwrapped groups, specifically field[@as-type='markup-multiline'], there are a couple of metaschema constructs we can remove, namely (at least) the fields 'prose', 'note' and any similar.

This will simplify the schemas and make them more intelligible. We can do this anyplace that markup-multline fields appear alone, without siblings of other types.

Goals:

Remove placeholder constructs such as 'prose' or 'note' from appearing in schema documentation by making them implicit; we do this by making their parents into markup-multiline fields (no longer assemblies) with 'in-xml' set to 'WITH-WRAPPER` (or the equivalent).

Dependencies:

Double check to see that this can be done without actually affecting the resulting models in XML and JSON

Acceptance Criteria

  • Verify that placeholder dummies have been removed by showing them missing from schema documentation
  • Verify that all documents expected to be valid, remain valid against schemas (XSD and JSON)
  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@david-waltermire
Copy link
Contributor

This was addressed in PR #492.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants