Display deprecation notice in generated documentation #115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wendellpiez
approved these changes
Mar 25, 2024
There was a problem hiding this comment.
The only suggestions I have are syntax sugar - nice work here, @nikitawootten-nist.
| @@ -152,6 +153,7 @@ | |||
| </div> | |||
| <xsl:where-populated> | |||
| <div class="body"> | |||
| <xsl:apply-templates select="$definition/@deprecated"/> | |||
There was a problem hiding this comment.
Nice! adding to the default traversal by selecting and processing the attribute.
| @@ -65,7 +65,7 @@ | |||
| <div class="model-entry definition { tokenize($me/@_metaschema-json-id,'/')[2] }"> | |||
| <xsl:variable name="header-class" expand-text="true">{ if (exists(parent::map)) then | |||
| 'definition' else 'instance' }-header</xsl:variable> | |||
| <div class="{ $header-class }"> | |||
| <div class="{ $header-class }{ if (exists($me/@deprecated)) then ' deprecated-header' else '' }"> | |||
There was a problem hiding this comment.
In addition to tightening the path I might put this expression into the $header-class variable, as it already templates this ... no biggie, certainly.
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Committer Notes
Display deprecation in generated documentation.
Include an example of a deprecated definition in the "everything" test metaschema
Display deprecation in reference documentation
.deprecated-headerclass is applied to item headers, which could be used for additional styling in the futureDisplay deprecation in definition documentation
.deprecated-headerclass is applied to item headers, which could be used for additional styling in the futureDisplay deprecation in outline documentation
.OM-name-deprecatedclass is applied to outline links, which is styled in the example CSS as strike-through text.Test the implementation on the OSCAL-Reference
Note that I decided displaying deprecation notices in the index documentation, as the index does not show any other details.
All Submissions:
Changes to Core Features: