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

Model map enhancement: links to local definitions #94

Closed
3 tasks
wendellpiez opened this issue Dec 9, 2020 · 1 comment
Closed
3 tasks

Model map enhancement: links to local definitions #94

wendellpiez opened this issue Dec 9, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@wendellpiez
Copy link
Collaborator

User Story:

As currently deployed, the model maps (XML and JSON) contain links from the respective models into appropriate documentation, but only for global definitions, not for assemblies or fields declared locally, or for flags in general.

This is because targets do not appear one for one in the maps or docs. A given local declaration will appear in a a map (and in the schema docs) as many times as it appears within the context of use of its globally defined ancestor, which could be many multiples (e.g., children of part).

An appropriate ID assignment can however be made deterministically using XSLT, for example with a tunnel parameter to trace the invocation context of (the appearance of) a local definition though the template stack from top to bottom.

Goals:

Extend the production of model maps (XML and JSON) so that links work from any/all represented structures into analogous positions in the documentation, including from structures defined locally in their respective Metaschemas, not only globally.

Dependencies:

None, although other Issues also address model maps and could be bundled: usnistgov/metaschema-xslt#36 usnistgov/metaschema-xslt#30.

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated. Changes to the 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.
@aj-stein-nist
Copy link
Collaborator

This work was completed with previous PRs in other sprints. Outstanding higher-level work around this issue can continue to be tracked in usnistgov/metaschema-xslt#17.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants