-
Notifications
You must be signed in to change notification settings - Fork 19
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
XML and JSON Schema docs pages - reorganize page architecture #128
Labels
enhancement
New feature or request
Comments
12 tasks
usnistgov/OSCAL#872 is also about this. |
wendellpiez
added a commit
to wendellpiez/metaschema
that referenced
this issue
Jun 1, 2021
david-waltermire
pushed a commit
that referenced
this issue
Jun 2, 2021
* Addressing several small display and linking glitches in docs generation * Docs generation revamp Reworked reference and other pages to sketch - #128 and others
8 tasks
david-waltermire
added a commit
that referenced
this issue
Jun 6, 2021
* Rework of docs focusing on JSON docs and model pipeline * Improvements to composition toolchain * Fixed a few small bugs in the metaschema-check. Improved performance of the compose pruning using an accumulator. * Moved edge-case samples into testing directory * Made shadowing warning a warning * Initial commit of an Oxygen Metaschema framework. * Creation of new compose schematron unit tests. * Cross-linking XML and JSON syntax pages and other improvements to links * Now building XML and JSON indexes to reference pages, with links to steps * Reconfigured docs pipeline (XSLT entry points); adding new files including pipeline steps * Migrating schema generation tools to new/improved composition pipeline * Addressing usnistgov/OSCAL#902 thanks for finding this bug * Enhancements to JSON Schema definition (with better performance too) * Adding support for json-base-uri as a metaschema property * Updated JSON schema $id; factoring out common docs XSLT * Fixing IDs in JSON schema per issue usnistgov/OSCAL#933. * Addressing datatype validation issues: whitespace collapsing; non-empty values; ncname-workalike in JSON Schema - see usnistgov/OSCAL#911 usnistgov/OSCAL#805 also #33 #67 #68 * Improvements to XSD production; fully aligning 'token' datatype across XSD and JSON Schema implementations. * Updating bidirectional XML/JSON converter generators (#143) * Committing a version that handles test data correctly (so far) from rebuilt metaschema composition addressing #51 #53 #76 * Now displaying constraints in documentation at point of definition; * Docs generation revamp Reworked reference and other pages to sketch - #128 and others Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
User Story:
Currently both the XML and JSON Schema docs pages have an organization reflecting that of the (composed) metaschema for the model, not for the expressed model itself (XML or JSON).
This leads to much weirdness such as a JSON user not being able to look up a 'task' object because it is not called 'task' (it is an anonymous object member of an array called ('actions' - who knew?), or much confusion around
part
(or is itparts
?) since there are at least two kinds of parts (so far) that sometimes appear in the same model.Instead of following the metaschema source (whose organization means nothing to the user), the XML page should be indexed and laid out by element, and the JSON page should be indexed and laid out by name and/or grouping name, whichever appears. This means listing things by their appearance (names in use including applicable
use-name
) and then sublisting by the apparent contexts in which those names are used for different things.Such an organization would also make a clean linking target from the model maps pages, enabling us to resolve Issues usnistgov/metaschema-xslt#36, #94 and usnistgov/metaschema-xslt#15.
Goals:
Redesign page layout of both XML and JSON Schema docs for usability, navigability and readability. See usnistgov/metaschema-xslt#15, but focus first on page organization and ToC/findability.
Dependencies:
Work in progress is available on the grouping logic as it would apply to the JSON Schema documentation. It already shows promising results.
Acceptance Criteria
{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}
The text was updated successfully, but these errors were encountered: