Model Map enhancement: keys to reading

[wendellpiez]

User Story:

It would potentially be helpful to users of the Model maps to have "keys" or references explaining how to read their notations of the (respectively) XML and JSON data objects.

Potentially these could be created dynamically from a Metaschema "self-describing model", or by pasting the results of map production and then editing by hand, integrating either into the pipeline (XSLT) that produces them or into the Markdown host page.

Either approach has advantages for ease of production, graceful results, and maintainability. They could also be combined by a specialized filter made just to produce the HTML block, that would add/substitute the explanatory language into the HTML produced by pushing a generic model through the display filter.

Goals:

• Add to each of the JSON and XML model maps, a brief section explaining how to read it
• Ensure that this remains part of the production and can be kept up to date, ideally without further intervention (unless the metaschema model itself changes).

Dependencies:

Stable map production, so, #14.

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]

Note this could be addressed in the Hugo templates that are the basis for generating these pages, something like a collapse feature.