From 767605b9d4a172c24784ed87f76297f66858bc3a Mon Sep 17 00:00:00 2001
From: Alexander Stein <alexander.stein@nist.gov>
Date: Tue, 11 Oct 2022 12:52:45 -0400
Subject: [PATCH] Add possible Schematron documentation checks

This is the product of the meeting and spike where we pair-programmed
and came up with example Schematron rules for tentative editorial
standards that can be used for reviews of models and embedded docs as
part of usnistgov/OSCAL#801.

Co-authored-by: Chris Compton <chris.compton@nist.gov>
Co-authored-by: Rene Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
---
 src/utils/schematron/oscal-documentation.sch | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 src/utils/schematron/oscal-documentation.sch

diff --git a/src/utils/schematron/oscal-documentation.sch b/src/utils/schematron/oscal-documentation.sch
new file mode 100644
index 0000000000..70ab1ecfa0
--- /dev/null
+++ b/src/utils/schematron/oscal-documentation.sch
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt2"
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+    xmlns:m="http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+    xmlns:nm="http://csrc.nist.gov/ns/metaschema"
+    xmlns:sqf="http://www.schematron-quickfix.com/validator/process"
+    xmlns:oscal="http://csrc.nist.gov/ns/oscal/1.0">
+
+    <sch:ns uri="http://csrc.nist.gov/ns/oscal/metaschema/1.0" prefix="m"/>
+    <sch:ns uri="http://csrc.nist.gov/ns/metaschema" prefix="nm"/>
+    
+    <sch:pattern>
+        <sch:rule context="m:description">
+            <sch:assert role="error" test="ends-with(.,'.')" id="description-ends-with-dot">Description should end with a period.</sch:assert>
+            <sch:assert role="error" test="string-length(.) gt 6" id="description-long-enough">Description is too short.</sch:assert>
+        </sch:rule>
+    </sch:pattern>
+</sch:schema>
\ No newline at end of file