Improvements to converter readme docs#1027
Merged
david-waltermire merged 2 commits intousnistgov:mainfrom Oct 7, 2021
Merged
Conversation
… conversion pathways
ohsh6o
suggested changes
Sep 28, 2021
Contributor
ohsh6o
left a comment
ohsh6o
left a comment
There was a problem hiding this comment.
Some minor feedback around typos and Saxon version specifications.
| @@ -71,7 +71,24 @@ The following example uses **Saxon HE** to convert an OSCAL catalog XML file to | |||
| ``` | |||
| java -jar "saxon9he.jar" -xsl:"oscal_catalog_xml-to-json-converter.xsl" -s:"oscal-catalog.xml" -o:"oscal-catalog.json" json-indent=yes | |||
Contributor
There was a problem hiding this comment.
Perhaps change to "saxon10he.jar" or something analogous as Saxon 9.x is now deprecated.
Contributor
There was a problem hiding this comment.
@wendellpiez Can you add an issue for upgrading to Saxon 10? Can you reference in that issue that these docs need to be updated?
| Paths\names of these files need to be provided based on the location of the files on your computer: | ||
|
|
||
| The Saxon JAR file is named ```saxon9he.jar```. The catalog converter is specified as ```-xsl:"oscal_catalog_xml-to-json-converter.xsl"```, the source catalog XML file is specified as ```-s:"oscal-catalog.xml"```, and the destination catalog JSON file is specified as ```-o:"oscal-catalog.json"```. Paths\names of these files need to be provided based on the location of the files on your computer. | ||
| * The Saxon JAR file is named ```saxon9he.jar```. |
xml/README.md
Outdated
| The Saxon JAR file is named ```saxon9he.jar```. The catalog converter is specified as ```-xsl:"oscal_catalog_json-to-xml-converter.xsl"```, the source catalog JSON file is specified as ```json-file="oscal-catalog.json"```, and the destination catalog XML file is specified as ```-o:"oscal-catalog.xml"```. Paths\names of these files need to be provided based on the location of the files on your computer. | ||
| `-it` indicates the initial template (XSLT entry point) should be 'make-xml'. | ||
|
|
||
| Paths\names given to other settingsneed to be provided based on the location of the files on your computer: |
Contributor
There was a problem hiding this comment.
Suggested change
| Paths\names given to other settingsneed to be provided based on the location of the files on your computer: | |
| Paths\names given to other settings need to be provided based on the location of the files on your computer: |
xml/README.md
Outdated
|
|
||
| Paths\names given to other settingsneed to be provided based on the location of the files on your computer: | ||
|
|
||
| * The Saxon JAR file is named ```saxon9he.jar```. |
ohsh6o
approved these changes
Oct 1, 2021
Contributor
There was a problem hiding this comment.
Per discussion with @wendellpiez, I will surface Saxon 9.x versus Saxon 10.x compatibilities elsewhere. The typos and stylistic changes I recommended are now obsolete and have been fixed. I am happy with the improved docs!
david-waltermire
suggested changes
Oct 5, 2021
| @@ -71,7 +71,24 @@ The following example uses **Saxon HE** to convert an OSCAL catalog XML file to | |||
| ``` | |||
| java -jar "saxon9he.jar" -xsl:"oscal_catalog_xml-to-json-converter.xsl" -s:"oscal-catalog.xml" -o:"oscal-catalog.json" json-indent=yes | |||
Contributor
There was a problem hiding this comment.
@wendellpiez Can you add an issue for upgrading to Saxon 10? Can you reference in that issue that these docs need to be updated?
3 tasks
8 tasks
galtm
pushed a commit
to galtm/OSCAL
that referenced
this pull request
Jan 15, 2022
* Improvements to readme docs for both XML-to-JSON and JSON-to-XML XSLT conversion pathways
galtm
pushed a commit
to galtm/OSCAL
that referenced
this pull request
Jan 16, 2022
* Improvements to readme docs for both XML-to-JSON and JSON-to-XML XSLT conversion pathways
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This corrects docs errors reported in #1020.
Potential errors in SSP conversion remain to be determined but will be addressed in usnistgov/metaschema#174.
Committer Notes
There are several ways to run the converters in debug as well as regular configuration. In addition to correcting a manifest error (as reported), the docs now describe these configurations.
All Submissions:
Changes to Core Features:
n/a