diff --git a/build/metaschema/lib/metaschema-check.sch b/build/metaschema/lib/metaschema-check.sch index 03d38726f5..f24ae14e2d 100644 --- a/build/metaschema/lib/metaschema-check.sch +++ b/build/metaschema/lib/metaschema-check.sch @@ -114,7 +114,7 @@ --> - + @@ -130,6 +130,10 @@ Unexpected namespace: examples should use namespace '' + + + Empty paragraph (is likely to distort rendition) + diff --git a/build/metaschema/lib/metaschema-common-html.xsl b/build/metaschema/lib/metaschema-common-html.xsl index e034062dac..06ba81be21 100644 --- a/build/metaschema/lib/metaschema-common-html.xsl +++ b/build/metaschema/lib/metaschema-common-html.xsl @@ -12,13 +12,17 @@ - : - +
+ + +
-
- +
+ + +
@@ -60,7 +64,7 @@ -
+
diff --git a/build/metaschema/lib/metaschema-compose.xsl b/build/metaschema/lib/metaschema-compose.xsl index aeb703c6bb..b05d910211 100644 --- a/build/metaschema/lib/metaschema-compose.xsl +++ b/build/metaschema/lib/metaschema-compose.xsl @@ -166,10 +166,10 @@ + - @@ -202,8 +202,7 @@ - string - + diff --git a/build/metaschema/lib/metaschema-jsondocs-jekyll-uswds.xsl b/build/metaschema/lib/metaschema-jsondocs-jekyll-uswds.xsl index 140571c0d2..d6e8c73bb8 100644 --- a/build/metaschema/lib/metaschema-jsondocs-jekyll-uswds.xsl +++ b/build/metaschema/lib/metaschema-jsondocs-jekyll-uswds.xsl @@ -379,6 +379,24 @@ + + + + + +
Remarks
+
+ +
+ + +

+ JSON + + +

+
+ diff --git a/build/metaschema/lib/metaschema-xmldocs-jekyll-uswds.xsl b/build/metaschema/lib/metaschema-xmldocs-jekyll-uswds.xsl index 5d20679274..0bead1752e 100644 --- a/build/metaschema/lib/metaschema-xmldocs-jekyll-uswds.xsl +++ b/build/metaschema/lib/metaschema-xmldocs-jekyll-uswds.xsl @@ -103,6 +103,7 @@ select="@name"/> attribute +

This attribute appears on: @@ -133,14 +134,7 @@ element - - -

Supports inline encoding

- - -

Appears as a sequence of markup elements (paragraphs, lists etc.)

-
- + @@ -161,14 +155,11 @@
-

The {@name} element { $modal } have { $noun }:

+

The {@name} element { $modal } have { $noun }:

-
@@ -204,7 +195,6 @@ -
@@ -224,15 +214,14 @@
  • - - + attribute - - (optional) + (optional) + @@ -245,9 +234,6 @@ (required) - @@ -255,12 +241,16 @@

    The element has the following contents (in order):

      - +
    + +
  • Any element (in a foreign namespace)
  • +
    +
  • - + - +
    Remarks
    + +

    + XML + + +

    +
    + @@ -413,15 +411,31 @@ + +

    An attribute

    +
    + + +

    An element

    +
    + + + + + + + , type + + + string + + - attribute - element (with text contents) - element (with mixed text and element contents) - prose content: paragraphs, lists etc. - element (with element contents) - ANY - + , with text contents + , with mixed text and (inline prose) element contents + , as prose content: paragraphs, lists etc. + , with its element contents Matching diff --git a/docs/content/documentation/relations.md b/docs/content/documentation/relations.md index 781dbfb58f..8bc49c9efe 100644 --- a/docs/content/documentation/relations.md +++ b/docs/content/documentation/relations.md @@ -1,5 +1,5 @@ --- -title: Relations to Industry Standards +title: Relations to Documentary Encoding Standards description: Relations permalink: /docs/relations/ layout: post @@ -10,7 +10,9 @@ sticky_sidenav: true Professionals working in the security domain are already familiar with numerous standards, specifications, guidelines and regulatory frameworks that define and describe practice in the systems security arena: NIST SP800-53, ISO 27001/2, FedRAMP, FISMA/FIPS, HIPAA and others. OSCAL's models are designed to capture the full range of these. -However, there are other standard forms of document represention that might also be useful in certain contexts. Since OSCAL attempts not to replace any of these, but to complement them, developers of OSCAL-based systems may wish to be aware of them and of opportunities to take advantage of OSCAL in working with them. +However, OSCAL is not the only text encoding technology available, and it is not always the most suitable, depending on the task at hand. Designed specifically to support operations related to security automation and assessment support, OSCAL may not be as optimal as other (standards-based, non-proprietary) formats for other applications including, notably, full text transcription, search and retrieval, or publication workflows. (OSCAL data may be shared among partners, even over networks including the Internet; but it is not necessarily suitable for publishing as such.) + +More importantly, since OSCAL shares its technical foundations with other documentary encoding standards that serve other horizontal or neighboring vertical domains, it is important to recognize a *high degree of compatibility* with other XML-based formats. Investing in OSCAL and OSCAL-related tooling is a way of developing capability that applies to these other formats as well; likewise investing in these can have beneficial side effects related to OSCAL and related technologies. ## How OSCAL relates to other document encoding formats