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.

Sign up for GitHub

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

new XProc for docs generation; cleanup and renaming #46

Merged
merged 9 commits into from
Aug 10, 2023
Merged

new XProc for docs generation; cleanup and renaming #46

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6c2c036
new XProc for docs generation; cleanup and renaming
wendellpiez Jul 13, 2023
e3ee2bd
Correcting top-level identifiers on XProcs; more cleanup
wendellpiez Jul 13, 2023
63a206a
Restoring old readme (pls update)
wendellpiez Jul 14, 2023
c180ef0
Removing duplicate readme
wendellpiez Jul 14, 2023
9a3a746
Updated Makefile and an initial comment
wendellpiez Jul 27, 2023
4e3d5fb
Further improvements to scripts and 'make' logic; cleanup
wendellpiez Jul 27, 2023
b5b41d6
Switched up order of arguments in docs generation invocation, to matc…
wendellpiez Jul 27, 2023
d42fa8b
Correcting readme
wendellpiez Jul 28, 2023
25a9fa5
Added test site generator script; added to `make`; corrected broken R…
wendellpiez Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 114 additions & 0 deletions src/document/METASCHEMA-DOCS-DIVS-write.xpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
<?xml version="1.0" encoding="UTF-8"?>
<p:declare-step xmlns:p="http://www.w3.org/ns/xproc" xmlns:c="http://www.w3.org/ns/xproc-step"
version="1.0" xmlns:metaschema="http://csrc.nist.gov/ns/metaschema/1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" type="metaschema:METASCHEMA-DOCS-DIVS-write"
name="METASCHEMA-DOCS-DIVS-write">

<!-- Purpose: Emit XML and JSON-oriented metaschema documentation FILE FRAGMENTS (`div` elements) -->
<!-- Input: A valid and correct OSCAL Metaschema instance linked to its modules (also valid and correct) -->
<!-- Input: options 'path' and 'metaschema-id' must be set, to populate a/@href in crosslinks -->
<!-- Output: Writes outputs to designated subdirectory; exposes no ports -->

<!-- NIST/ITL Metaschema github.com/usnistgov/metaschema https://pages.nist.gov/metaschema/ -->

<!-- &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& -->
<!-- Ports -->

<p:input port="METASCHEMA" primary="true"/>

<p:input port="parameters" kind="parameter"/>

<!--<p:option name="metaschema-id" select="'oscal'"/>-->

<p:option name="output-path" required="true"/>
<p:option name="metaschema-id" required="true"/>

<p:option name="json-outline-filename" select="$metaschema-id || '-json-outline.html'"/>
<p:option name="json-reference-filename" select="$metaschema-id || '-json-reference.html'"/>
<p:option name="json-index-filename" select="$metaschema-id || '-json-index.html'"/>
<p:option name="json-definitions-filename" select="$metaschema-id || '-json-definitions.html'"/>
<p:option name="xml-outline-filename" select="$metaschema-id || '-xml-outline.html'"/>
<p:option name="xml-reference-filename" select="$metaschema-id || '-xml-reference.html'"/>
<p:option name="xml-index-filename" select="$metaschema-id || '-xml-index.html'"/>
<p:option name="xml-definitions-filename" select="$metaschema-id || '-xml-definitions.html'"/>

<!-- &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& -->
<!-- Import (subpipeline) -->

<p:import href="METASCHEMA-DOCS-TRACE.xpl"/>

<p:variable name="xml-outline-uri" select="resolve-uri($xml-outline-filename, $output-path)"/>
<p:variable name="xml-reference-uri" select="resolve-uri($xml-reference-filename, $output-path)"/>
<p:variable name="xml-index-uri" select="resolve-uri($xml-index-filename, $output-path)"/>
<p:variable name="xml-definitions-uri" select="resolve-uri($xml-definitions-filename, $output-path)"/>
<p:variable name="json-outline-uri" select="resolve-uri($json-outline-filename, $output-path)"/>
<p:variable name="json-reference-uri" select="resolve-uri($json-reference-filename, $output-path)"/>
<p:variable name="json-index-uri" select="resolve-uri($json-index-filename, $output-path)"/>
<p:variable name="json-definitions-uri" select="resolve-uri($json-definitions-filename,$output-path)"/>

<!-- * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * -->

<!-- Implicit source is on the METASCHEMA input port -->

<metaschema:metaschema-docs-trace name="DOCS-PIPELINE">
<!--<p:with-option name="output-path" select="$output-path"/>-->
<p:with-option name="metaschema-id" select="$metaschema-id"/>
</metaschema:metaschema-docs-trace>

<p:store method="html" version="5.0">
<p:with-option name="href" select="$json-outline-uri"/>
<p:input port="source">
<p:pipe step="DOCS-PIPELINE" port="JSON-object-map-div"/>
</p:input>
</p:store>

<p:store method="html" version="5.0">
<p:with-option name="href" select="$json-reference-uri"/>
<p:input port="source">
<p:pipe step="DOCS-PIPELINE" port="JSON-object-reference-div"/>
</p:input>
</p:store>

<p:store method="html" version="5.0">
<p:with-option name="href" select="$json-index-uri"/>
<p:input port="source">
<p:pipe step="DOCS-PIPELINE" port="JSON-object-index-div"/>
</p:input>
</p:store>

<p:store method="html" version="5.0">
<p:with-option name="href" select="$json-definitions-uri"/>
<p:input port="source">
<p:pipe step="DOCS-PIPELINE" port="JSON-definitions-div"/>
</p:input>
</p:store>

<p:store method="html" version="5.0">
<p:with-option name="href" select="$xml-outline-uri"/>
<p:input port="source">
<p:pipe step="DOCS-PIPELINE" port="XML-element-map-div"/>
</p:input>
</p:store>

<p:store method="html" version="5.0">
<p:with-option name="href" select="$xml-reference-uri"/>
<p:input port="source">
<p:pipe step="DOCS-PIPELINE" port="XML-element-reference-div"/>
</p:input>
</p:store>

<p:store method="html" version="5.0">
<p:with-option name="href" select="$xml-index-uri"/>
<p:input port="source">
<p:pipe step="DOCS-PIPELINE" port="XML-element-index-div"/>
</p:input>
</p:store>

<p:store method="html" version="5.0">
<p:with-option name="href" select="$xml-definitions-uri"/>
<p:input port="source">
<p:pipe step="DOCS-PIPELINE" port="XML-definitions-div"/>
</p:input>
</p:store>

</p:declare-step>
89 changes: 89 additions & 0 deletions src/document/METASCHEMA-DOCS-DIVS.xpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<?xml version="1.0" encoding="UTF-8"?>
<p:declare-step xmlns:p="http://www.w3.org/ns/xproc" xmlns:c="http://www.w3.org/ns/xproc-step"
version="1.0" xmlns:metaschema="http://csrc.nist.gov/ns/metaschema/1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" type="metaschema:METASCHEMA-DOCS-DIVS"
name="METASCHEMA-DOCS-DIVS">

<!-- Purpose: Emit XML and JSON-oriented metaschema documentation FILE FRAGMENTS (`div` elements) -->
<!-- Input: A valid and correct OSCAL Metaschema instance linked to its modules (also valid and correct) -->
<!-- Input: options 'path' and 'metaschema-id' must be set, to populate a/@href in crosslinks -->
<!-- Output: exposes outputs on named ports -->

<!-- NIST/ITL Metaschema github.com/usnistgov/metaschema https://pages.nist.gov/metaschema/ -->

<!-- &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& -->
<!-- Ports -->

<p:input port="METASCHEMA" primary="true"/>

<p:input port="parameters" kind="parameter"/>

<!--<p:option name="metaschema-id" select="'oscal'"/>-->

<!--<p:option name="output-path" required="true"/>-->
<p:option name="metaschema-id" required="true"/>

<!--<p:option name="json-outline-filename" select="$metaschema-id || '-json-outline.html'"/>
<p:option name="json-reference-filename" select="$metaschema-id || '-json-reference.html'"/>
<p:option name="json-index-filename" select="$metaschema-id || '-json-index.html'"/>
<p:option name="json-definitions-filename" select="$metaschema-id || '-json-definitions.html'"/>
<p:option name="xml-outline-filename" select="$metaschema-id || '-xml-outline.html'"/>
<p:option name="xml-reference-filename" select="$metaschema-id || '-xml-reference.html'"/>
<p:option name="xml-index-filename" select="$metaschema-id || '-xml-index.html'"/>
<p:option name="xml-definitions-filename" select="$metaschema-id || '-xml-definitions.html'"/>-->

<p:serialization port="JSON-object-map-div" indent="true" method="html" version="5.0"/>
<p:output port="JSON-object-map-div" primary="false">
<p:pipe step="DOCS-PIPELINE" port="JSON-object-index-div"/>
</p:output>

<p:serialization port="JSON-object-reference-div" indent="true" method="html" version="5.0"/>
<p:output port="JSON-object-reference-div" primary="false">
<p:pipe step="DOCS-PIPELINE" port="JSON-object-reference-div"/>
</p:output>

<p:serialization port="JSON-object-index-div" indent="true" method="html" version="5.0"/>
<p:output port="JSON-object-index-div" primary="false">
<p:pipe step="DOCS-PIPELINE" port="JSON-object-map-div"/>
</p:output>

<p:serialization port="JSON-definitions-div" indent="true" method="html" version="5.0"/>
<p:output port="JSON-definitions-div" primary="false">
<p:pipe step="DOCS-PIPELINE" port="JSON-definitions-div"/>
</p:output>

<p:serialization port="XML-element-map-div" indent="true" method="html" version="5.0"/>
<p:output port="XML-element-map-div" primary="false">
<p:pipe step="DOCS-PIPELINE" port="XML-element-index-div"/>
</p:output>

<p:serialization port="XML-element-reference-div" indent="true" method="html" version="5.0"/>
<p:output port="XML-element-reference-div" primary="false">
<p:pipe step="DOCS-PIPELINE" port="XML-element-reference-div"/>
</p:output>

<p:serialization port="XML-element-index-div" indent="true" method="html" version="5.0"/>
<p:output port="XML-element-index-div" primary="false">
<p:pipe step="DOCS-PIPELINE" port="XML-element-map-div"/>
</p:output>

<p:serialization port="XML-definitions-div" indent="true" method="html" version="5.0"/>
<p:output port="XML-definitions-div" primary="false">
<p:pipe step="DOCS-PIPELINE" port="XML-definitions-div"/>
</p:output>

<!-- &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& &&& -->
<!-- Import (subpipeline) -->

<p:import href="METASCHEMA-DOCS-TRACE.xpl"/>

<!-- * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * -->

<!-- Implicit source is on the METASCHEMA input port -->

<metaschema:metaschema-docs-trace name="DOCS-PIPELINE">
<!--<p:with-option name="output-path" select="$output-path"/>-->
<p:with-option name="metaschema-id" select="$metaschema-id"/>
</metaschema:metaschema-docs-trace>

</p:declare-step>
4 changes: 2 additions & 2 deletions src/document/METASCHEMA-HTML-DOCS.xpl → ...cument/METASCHEMA-DOCS-TESTSITE-write.xpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<p:declare-step xmlns:p="http://www.w3.org/ns/xproc" xmlns:c="http://www.w3.org/ns/xproc-step"
version="1.0" xmlns:metaschema="http://csrc.nist.gov/ns/metaschema/1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" type="metaschema:METASCHEMA-HTML-DOCS"
name="METASCHEMA-HTML-DOCS">
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" type="metaschema:METASCHEMA-DOCS-TESTSITE-write"
name="METASCHEMA-DOCS-TESTSITE-write">

<!-- Purpose: Emit XML and JSON-oriented metaschema documentation -->
<!-- Input: A valid and correct OSCAL Metaschema instance linked to its modules (also valid and correct) -->
Expand Down
42 changes: 41 additions & 1 deletion src/document/METASCHEMA-DOCS-TRACE.xpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,46 +63,86 @@
<p:pipe port="result" step="make-json-object-tree"/>
</p:output>

<p:serialization port="JSON-object-map-div" indent="true"/>
<p:output port="JSON-object-map-div" primary="false">
<p:pipe port="result" step="make-json-model-map"/>
</p:output>

<p:serialization port="JSON-object-map-html" indent="true"/>
<p:output port="JSON-object-map-html" primary="false">
<p:pipe port="result" step="style-json-model-map"/>
</p:output>

<p:serialization port="JSON-object-reference-div" indent="true"/>
<p:output port="JSON-object-reference-div" primary="false">
<p:pipe port="result" step="render-json-object-reference"/>
</p:output>

<p:serialization port="JSON-object-reference-html" indent="true"/>
<p:output port="JSON-object-reference-html" primary="false">
<p:pipe port="result" step="style-json-object-reference"/>
</p:output>

<p:serialization port="JSON-object-index-div" indent="true"/>
<p:output port="JSON-object-index-div" primary="false">
<p:pipe port="result" step="render-json-object-index"/>
</p:output>

<p:serialization port="JSON-object-index-html" indent="true"/>
<p:output port="JSON-object-index-html" primary="false">
<p:pipe port="result" step="style-json-object-index"/>
</p:output>

<p:serialization port="JSON-definitions-div" indent="true"/>
<p:output port="JSON-definitions-div" primary="false">
<p:pipe port="result" step="render-json-definitions"/>
</p:output>

<p:serialization port="JSON-definitions-html" indent="true"/>
<p:output port="JSON-definitions-html" primary="false">
<p:pipe port="result" step="style-json-definitions"/>
</p:output>

<p:serialization port="XML-element-tree-xml" indent="true"/>
<p:output port="XML-element-tree-xml" primary="false">
<p:pipe port="result" step="make-xml-element-tree"/>
</p:output>

<p:serialization port="XML-element-map-div" indent="true"/>
<p:output port="XML-element-map-div" primary="false">
<p:pipe port="result" step="make-xml-model-map"/>
</p:output>

<p:serialization port="XML-element-map-html" indent="true"/>
<p:output port="XML-element-map-html" primary="false">
<p:pipe port="result" step="style-xml-model-map"/>
</p:output>

<p:serialization port="XML-element-reference-div" indent="true"/>
<p:output port="XML-element-reference-div" primary="false">
<p:pipe port="result" step="render-xml-element-reference"/>
</p:output>

<p:serialization port="XML-element-reference-html" indent="true"/>
<p:output port="XML-element-reference-html" primary="false">
<p:pipe port="result" step="style-xml-element-reference"/>
</p:output>

<p:serialization port="XML-element-index-div" indent="true"/>
<p:output port="XML-element-index-div" primary="false">
<p:pipe port="result" step="render-xml-element-index"/>
</p:output>

<p:serialization port="XML-element-index-html" indent="true"/>
<p:output port="XML-element-index-html" primary="false">
<p:pipe port="result" step="style-xml-element-index"/>
</p:output>

<p:serialization port="XML-definitions-div" indent="true"/>
<p:output port="XML-definitions-div" primary="false">
<p:pipe port="result" step="render-xml-definitions"/>
</p:output>

<p:serialization port="XML-definitions-html" indent="true"/>
<p:output port="XML-definitions-html" primary="false">
<p:pipe port="result" step="style-xml-definitions"/>
Expand Down
26 changes: 12 additions & 14 deletions src/document/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,20 @@ output_folder:=$(abspath test_output)
test: smoke-test ## Run all tests

.PHONY: smoke-test
smoke-test: smoke-test-hugo smoke-test-standalone ## Run all smoke-tests
smoke-test: smoke-test-hugo smoke-test-testsite ## Run all smoke-tests

.PHONY: smoke-test-hugo
smoke-test-hugo: ## Test verifies that 'write-hugo-metaschema-docs.xpl' runs without error
$(call EXEC_CALABASH,-i source=$(test_metaschema) output-path=file://$(output_folder)/smoke/hugo/ write-hugo-metaschema-docs.xpl)
smoke-test-hugo: ## Test verifies that 'METASCHEMA-DOCS-DIVS-write.xpl' runs without error
$(call EXEC_CALABASH,-iMETASCHEMA=$(test_metaschema) METASCHEMA-DOCS-DIVS-write.xpl output-path=file://$(output_folder)/smoke/hugo/ metaschema-id=models_metaschema)

.PHONY: smoke-test-standalone
smoke-test-standalone: ## Test verifies that make-metaschema-standalone-docs.xpl runs without error
$(call EXEC_CALABASH,-i source=$(test_metaschema) \
output-path=file://$(output_folder)/smoke/standalone/ \
-o INT_0_echo-input=/dev/null \
-o INT_1_composed=/dev/null \
-o INT_2_abstract-model-map=/dev/null \
-o INT_3_unfolded-instance-map=/dev/null \
-o INT_4_marked-instance-map=/dev/null \
make-metaschema-standalone-docs.xpl)
.PHONY: smoke-test-testsite
smoke-test-testsite: ## Test verifies that METASCHEMA-DOCS-TESTSITE-write.xpl runs without error
./mvn-schemadocs-testsite-xpl.sh "$(test_metaschema)" test_output/smoke/testsite models_metaschema

# $(call EXEC_CALABASH,-iMETASCHEMA=$(test_metaschema) \
# METASCHEMA-DOCS-TESTSITE-write.xpl \
# output-path=file://$(output_folder)/smoke/testsite/ \
# metaschema-id=models_metaschema)

clean: ## Remove test output
rm -fr $(smoke-test_output)
rm -fr $(output_folder)
Loading