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

OSCAL element maps for schema documentation #337

Closed
wendellpiez opened this issue Apr 4, 2019 · 1 comment
Closed

OSCAL element maps for schema documentation #337

wendellpiez opened this issue Apr 4, 2019 · 1 comment
Assignees
Labels
Scope: Website Issues targeted at the OSCAL project website. User Story

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented Apr 4, 2019

User Story:

As an OSCAL user and developer, I need to understand the content models of the various elements (objects) in OSCAL. An XSLT now in a dev branch can produce an element map from a metaschema, showing a map of element containment.

Maps can be created from the root of a metaschema or from any element. Mini-maps per element could be used on the element's page.

Here's a screen shot of a smaller element map, rooted at part:

image

Goals:

  1. Consider and determine whether and how element maps can be used in the schema documentation.
  2. Produce a JSON version.

Dependencies:

Stable schema documentation as described in #314.

Where CSS is involved and perhaps Javascript (maybe we wish the maps to expand/collapse as well as link), we need to determine how to integrate with Jekyll/USWDS in a way that is robust across upgrades.

Acceptance Criteria

  1. Element maps are integrated according to our determination
  2. A JSON version has been produced, or another Issue has been created for this work item
@wendellpiez wendellpiez changed the title OSCAL element maps for schema documentation OSCAL *element maps* for schema documentation Apr 5, 2019
@wendellpiez wendellpiez changed the title OSCAL *element maps* for schema documentation OSCAL element maps for schema documentation Apr 5, 2019
@david-waltermire david-waltermire added this to the OSCAL 1.0 M2 milestone May 8, 2019
@david-waltermire david-waltermire added the Scope: Website Issues targeted at the OSCAL project website. label May 9, 2019
@david-waltermire
Copy link
Contributor

Closing this in favor of issue #439.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: Website Issues targeted at the OSCAL project website. User Story
Projects
None yet
Development

No branches or pull requests

2 participants