Integrating support for a table of contents, which is used on all lon…

…g pages. (usnistgov#905) Resolves usnistgov#872.
ohsh6o · Apr 21, 2021 · d264c2d · d264c2d
1 parent 1d101eb
commit d264c2d
Show file tree

Hide file tree

Showing 52 changed files with 149 additions and 67 deletions.
diff --git a/.gitignore b/.gitignore
@@ -37,13 +37,8 @@ target/
 /.runbuild
 # Generated by scripts
 .metaschema-cache
-# generated by /build/ci-cd/generate-content-converters.sh and /build/ci-cd/generate-schema.sh
-#/xml
-#/json
 # generated by /build/metaschema/unit-testing/run-tests.sh
 /metaschema/unit-testing
-# generated by /build/ci-cd/copy-and-convert-content.sh
-/content
 # generated by /build/ci-cd/generate-model-documentation.sh
 /docs/layouts/partials/generated
 # generated by Hugo
@@ -53,13 +48,11 @@ target/
 /docs/node_modules
 # generated by /build/ci-cd/generate-specification-documentation.sh
 /docs/content/documentation/processing/profile-resolution.html
-# but allow markdown files
-!/content/**/*.md
-!/xml/*.md
-!/xml/**/*.md
-!/json/*.md
-!/json/**/*.md
+
 
 #
 node_modules/
+
+# Files build by CI/CD
 /docs/content/documentation/specification/processing/profile-resolution.html
+/docs/scratch-dir
diff --git a/docs/assets/scss/hugo-uswds-theme.scss b/docs/assets/scss/hugo-uswds-theme.scss
@@ -1,5 +1,7 @@
+/*
 $theme-site-max-width: 'widescreen';
 $theme-grid-container-max-width: 'widescreen';
 $theme-banner-max-width: 'widescreen';
 $theme-header-max-width: 'widescreen';
 $theme-text-measure: 'none';
+*/
diff --git a/docs/content/contact/_index.md b/docs/content/contact/_index.md
@@ -10,6 +10,8 @@ menu:
     name: Contact Us
     url: /contact/
     weight: 50
+toc:
+  enabled: true
 aliases:
 - /contribute/contact/
 ---

diff --git a/docs/content/contribute/_index.md b/docs/content/contribute/_index.md
@@ -11,11 +11,13 @@ menu:
     name: Get involved
     url: /contribute/
     weight: 10
+toc:
+  enabled: true
 ---
 
 We are excited that you want to contribute to the OSCAL project. We are striving to provide a collaborative environment for professionals to contribute to the project's goals and objectives. A primary focus of this project is to improve security assessment efficiency, accuracy, and consistency on the basis of real-world experience with the technology used in this space. The language we develop must be well-defined, with easy to use formats.
 
-# Contributing
+## Contributing
 
 We use GitHub as a collaboration platform for the development of the OSCAL models. Within the OSCAL GitHub repository you will find:
 

diff --git a/docs/content/contribute/dev-lunch/_index.md b/docs/content/contribute/dev-lunch/_index.md
@@ -4,9 +4,9 @@ description: The NIST OSCAL team hosts a bi-weekly web conference to discuss OSC
 layout: devlunch
 aliases:
 - /contribute/devlunch/
-sidenav:
-  toc:
-    headingselectors: "h3,h4"
+toc:
+  enabled: true
+  headingselectors: "h3,h4"
 weight: 10
 ---
 

diff --git a/docs/content/contribute/model-review/_index.md b/docs/content/contribute/model-review/_index.md
@@ -2,10 +2,9 @@
 title: OSCAL Model Review
 description: The NIST OSCAL team hosts a bi-weekly web conference to discuss OSCAL model issues.
 layout: devlunch
-sidenav:
-  toc:
-    headingselectors: "h3,h4"
-    includeHtml: true
+toc:
+  headingselectors: "h3,h4"
+  includeHtml: true
 weight: 20
 ---
 

diff --git a/docs/content/contribute/roadmap.md b/docs/content/contribute/roadmap.md
@@ -2,6 +2,8 @@
 title: OSCAL Development Roadmap
 description: Information on the OSCAL development roadmap, which is taking place over a series of milestones.
 weight: 5
+toc:
+  enabled: true
 aliases:
   - /learnmore/roadmap/
 ---

diff --git a/docs/content/documentation/concepts/_index.md b/docs/content/documentation/concepts/_index.md
@@ -5,9 +5,10 @@ description: Reviews the control- and assessment-related concepts used within OS
 weight: 10
 sidenav:
     title: Concepts Used in OSCAL
-    toc:
-        headingselectors: h2,h3,h4,h5
-        collapsedepth: 4
+toc:
+    enabled: true
+    headingselectors: h2,h3,h4,h5
+    collapsedepth: 4
 aliases:
  - /learnmore/concepts/
  - /learnmore/concepts/control/

diff --git a/docs/content/documentation/relations-to-other.md b/docs/content/documentation/relations-to-other.md
@@ -2,6 +2,8 @@
 title: Relations to Other Documentary Encoding Standards
 description: Explanation of how OSCAL relates to various documentary standards.
 weight: 100
+toc:
+  enabled: true
 aliases:
   - /docs/relations/
 ---

diff --git a/docs/content/documentation/schema/_index.md b/docs/content/documentation/schema/_index.md
@@ -2,12 +2,14 @@
 title: Layers and Models Reference
 description: Provides details on the layers, models, and formats that comprise OSCAL. Concepts for each layer and model are discussed, and the semantics of each model and associated formats are defined.
 weight: 50
-aliases:
-  - /docs/model/ssp/
-  - /learnmore/architecture/
+toc:
+  enabled: true
 sidenav:
   activerenderdepth: 1
   inactiverenderdepth: 1
+aliases:
+  - /docs/model/ssp/
+  - /learnmore/architecture/
 ---
 
 The OSCAL architecture is organized in a stack of *layers*. Each lower layer in the stack provides information structures that are referenced and used by each higher layer. Each layer is composed of one or more *models*, which represent a information structure supporting a specific operational purpose. Each model in OSCAL is intended to build on the information provided by the model(s) in the lower layers.

diff --git a/docs/content/documentation/schema/assessment-layer/assessment-plan/_index.md b/docs/content/documentation/schema/assessment-layer/assessment-plan/_index.md
@@ -3,6 +3,8 @@ title: Assessment Plan Model
 heading: "OSCAL Assessment Layer: Assessment Plan Model"
 description: XML and JSON format documentation for the OSCAL Assessment Plan model, which is part of the OSCAL Assessment layer. These formats model the planning of a periodic or continuous assessment.
 weight: 60
+toc:
+  enabled: true
 aliases:
   - /documentation/schema/assessment-plan/
 ---

diff --git a/docs/content/documentation/schema/assessment-layer/assessment-plan/json-schema.md b/docs/content/documentation/schema/assessment-layer/assessment-plan/json-schema.md
@@ -5,8 +5,9 @@ description: Object-level definitions of the OSCAL Assessment Plan model JSON fo
 weight: 20
 sidenav:
   title: JSON Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/assessment-plan/json-schema/
 ---

diff --git a/docs/content/documentation/schema/assessment-layer/assessment-plan/xml-schema.md b/docs/content/documentation/schema/assessment-layer/assessment-plan/xml-schema.md
@@ -5,8 +5,9 @@ description: Element-level definitions of the OSCAL Assessment Plan model XML fo
 weight: 60
 sidenav:
   title: XML Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/assessment-plan/xml-schema/
 ---

diff --git a/...tent/documentation/schema/assessment-results-layer/assessment-results/_index.md b/...tent/documentation/schema/assessment-results-layer/assessment-results/_index.md
@@ -3,6 +3,8 @@ title: Assessment Results Model
 heading: "OSCAL Assessment Layer: Assessment Results Model"
 description: XML and JSON format documentation for the OSCAL Assessment Results model, which is part of the OSCAL Assessment Results layer. These formats model the findings of a periodic or continuous assessment.
 weight: 65
+toc:
+  enabled: true
 aliases:
   - /documentation/schema/assessment-results/
 ---

diff --git a/...documentation/schema/assessment-results-layer/assessment-results/json-schema.md b/...documentation/schema/assessment-results-layer/assessment-results/json-schema.md
@@ -5,8 +5,9 @@ description: Object-level definitions of the OSCAL Assessment Results model JSON
 weight: 20
 sidenav:
   title: JSON Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/assessment-results/json-schema/
 ---

diff --git a/.../documentation/schema/assessment-results-layer/assessment-results/xml-schema.md b/.../documentation/schema/assessment-results-layer/assessment-results/xml-schema.md
@@ -5,8 +5,9 @@ description: Element-level definitions of the OSCAL Assessment Results model XML
 weight: 60
 sidenav:
   title: XML Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/assessment-results/xml-schema/
 ---

diff --git a/docs/content/documentation/schema/assessment-results-layer/poam/_index.md b/docs/content/documentation/schema/assessment-results-layer/poam/_index.md
@@ -3,6 +3,8 @@ title: Plan of Action and Milestones (POA&M) Model
 heading: "OSCAL Assessment Results Layer: Plan of Action and Milestones (POA&M) Model"
 description: XML and JSON format documentation for the OSCAL Plan of Action and Milestones (POA&M) model, which is part of the OSCAL Assessment Results layer. These formats model the findings of a periodic or continuous assessment.
 weight: 70
+toc:
+  enabled: true
 aliases:
   - /documentation/schema/poam/
 ---

diff --git a/docs/content/documentation/schema/assessment-results-layer/poam/json-schema.md b/docs/content/documentation/schema/assessment-results-layer/poam/json-schema.md
@@ -5,8 +5,9 @@ description: Object-level definitions of the OSCAL Plan of Action and Milestones
 weight: 20
 sidenav:
   title: JSON Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/poam/json-schema/
 ---

diff --git a/docs/content/documentation/schema/assessment-results-layer/poam/xml-schema.md b/docs/content/documentation/schema/assessment-results-layer/poam/xml-schema.md
@@ -5,8 +5,9 @@ description: Element-level definitions of the OSCAL Plan of Action and Milestone
 weight: 60
 sidenav:
   title: XML Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/poam/xml-schema/
 ---

diff --git a/docs/content/documentation/schema/catalog-layer/_index.md b/docs/content/documentation/schema/catalog-layer/_index.md
@@ -6,6 +6,8 @@ weight: 70
 sidenav:
     activerenderdepth: 2
     inactiverenderdepth: 2
+toc:
+  enabled: true
 ---
 
 The OSCAL catalog layer provides a structured catalog model for representing a **catalog** of **controls**.

diff --git a/docs/content/documentation/schema/catalog-layer/catalog/_index.md b/docs/content/documentation/schema/catalog-layer/catalog/_index.md
@@ -3,6 +3,8 @@ title: Catalog Model
 heading: "OSCAL Catalog Layer: Catalog Model"
 description: XML and JSON format documentation for the OSCAL Catalog model, which models a [control catalog](/documentation/schema/catalog-layer/#catalog).
 weight: 30
+toc:
+  enabled: true
 aliases:
   - /docs/model/catalog/
   - /documentation/schema/catalog/

diff --git a/docs/content/documentation/schema/catalog-layer/catalog/json-schema.md b/docs/content/documentation/schema/catalog-layer/catalog/json-schema.md
@@ -7,8 +7,9 @@ aliases:
 weight: 20
 sidenav:
   title: JSON Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/catalog/json-schema/
 ---

diff --git a/docs/content/documentation/schema/catalog-layer/catalog/xml-schema.md b/docs/content/documentation/schema/catalog-layer/catalog/xml-schema.md
@@ -7,8 +7,9 @@ aliases:
 weight: 60
 sidenav:
   title: XML Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/catalog/xml-schema/
 ---

diff --git a/docs/content/documentation/schema/datatypes.md b/docs/content/documentation/schema/datatypes.md
@@ -3,6 +3,8 @@ title: OSCAL Data Types
 heading: Data Types Used in OSCAL
 description: A description of the data types used in the OSCAL formats.
 weight: 20
+toc:
+  enabled: true
 aliases:
   - /docs/schemas/datatypes/
   - /documentation/schema/datatypes/

diff --git a/docs/content/documentation/schema/implementation-layer/component/_index.md b/docs/content/documentation/schema/implementation-layer/component/_index.md
@@ -3,6 +3,8 @@ title: Component Definition Model
 heading: "OSCAL Implementation Layer: Component Definition Model"
 description: XML and JSON format documentation for the OSCAL Component Definition model, which is part of the OSCAL implementation layer in the OSCAL [Layers and Models Reference](/documentation/schema/). These formats model a description of the controls that are supported in a given implementation of a hardware, software, service, policy, process, procedure, or compliance artifact (e.g., FIPS 140-2 validation).
 weight: 50
+toc:
+  enabled: true
 aliases:
   - /docs/model/component/
   - /documentation/schema/component/

diff --git a/docs/content/documentation/schema/implementation-layer/component/json-schema.md b/docs/content/documentation/schema/implementation-layer/component/json-schema.md
@@ -7,8 +7,9 @@ aliases:
 weight: 20
 sidenav:
   title: JSON Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/component/json-schema/
 ---

diff --git a/docs/content/documentation/schema/implementation-layer/component/xml-schema.md b/docs/content/documentation/schema/implementation-layer/component/xml-schema.md
@@ -7,8 +7,9 @@ aliases:
 weight: 60
 sidenav:
   title: XML Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/component/xml-schema/
 ---

diff --git a/docs/content/documentation/schema/implementation-layer/ssp/_index.md b/docs/content/documentation/schema/implementation-layer/ssp/_index.md
@@ -3,6 +3,8 @@ title: System Security Plan Model (SSP)
 heading: "OSCAL Implementation Layer: System Security Plan (SSP) Model"
 description: XML and JSON format documentation for the OSCAL System Security Plan (SSP) model, which is part of the OSCAL implementation layer in the OSCAL [Layers and Models Reference](/documentation/schema/). These formats model the control implementation of an information system.
 weight: 55
+toc:
+  enabled: true
 aliases:
   - /documentation/schema/ssp/
 ---

diff --git a/docs/content/documentation/schema/implementation-layer/ssp/json-schema.md b/docs/content/documentation/schema/implementation-layer/ssp/json-schema.md
@@ -7,8 +7,9 @@ aliases:
 weight: 20
 sidenav:
   title: JSON Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/ssp/json-schema/
 ---

diff --git a/docs/content/documentation/schema/implementation-layer/ssp/xml-schema.md b/docs/content/documentation/schema/implementation-layer/ssp/xml-schema.md
@@ -7,8 +7,9 @@ aliases:
 weight: 60
 sidenav:
   title: XML Format Reference
-  toc:
-    headingselectors: "h2.toc1, h3.toc2"
+toc:
+  enabled: true
+  headingselectors: "h2.toc1, h3.toc2"
 aliases:
   - /documentation/schema/ssp/xml-schema/
 ---

diff --git a/docs/content/documentation/schema/implementation-layer/validation-modeling.md b/docs/content/documentation/schema/implementation-layer/validation-modeling.md
@@ -3,6 +3,8 @@ title: Representing Test Validation Information
 heading: "Representing Test Validation Information for Components"
 description: Discussed how test validation information (e.g., ) can be represented for an OSCAL [component](/documentation/schema/implementation-layer/component/).
 weight: 50
+toc:
+  enabled: true
 sidenav:
     activerenderdepth: 2
     inactiverenderdepth: 2

diff --git a/docs/content/documentation/schema/overview.md b/docs/content/documentation/schema/overview.md
@@ -3,6 +3,8 @@ title: OSCAL Model Overview
 heading: Introduction to the OSCAL Models
 description: Reviews OSCAL modeling concepts, and discusses the supported OSCAL formats and related validation mechanisms.
 weight: 10
+toc:
+  enabled: true
 sidenav:
     title: OSCAL Model Overview
 aliases:

diff --git a/docs/content/documentation/schema/profile-layer/_index.md b/docs/content/documentation/schema/profile-layer/_index.md
@@ -3,6 +3,8 @@ title: Profile Layer
 heading: "OSCAL Profile Layer"
 description: Provides the OSCAL [profile model](/documentation/schema/profile-layer/profile/), which represents a [profile](/learnmore/concepts/profile/), also known as a *baseline* or *overlay*.
 weight: 60
+toc:
+  enabled: true
 sidenav:
     activerenderdepth: 2
     inactiverenderdepth: 2

diff --git a/docs/content/documentation/schema/profile-layer/profile/_index.md b/docs/content/documentation/schema/profile-layer/profile/_index.md
@@ -3,6 +3,8 @@ title: Profile Model
 heading: "OSCAL Profile Layer: Profile Model"
 description: XML and JSON format documentation for the OSCAL [Profile model](.), which is the sole model in the OSCAL [Profile](../) layer. These formats model a [profile](/documentation/schema/profile-layer/#profile).
 weight: 40
+toc:
+  enabled: true
 aliases:
   - /docs/model/profile/
   - /documentation/schema/profile/