Skip to content

Commit

Permalink
Update catalog-xml.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kscarf1 authored Mar 5, 2018
1 parent 67b12b8 commit 351257e
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions docs/prose/catalog-xml.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Each OSCAL catalog is defined by a <catalog> element. A <catalog> element
Catalogs may use <section> elements for catalog partitioning. A <section> element may contain the following:
* <title> (mandatory)
* <prose> (mandatory)
* <section> or <group> (zero or more of each)
* <references> (zero or more)
* <section> or [<group>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-group-element) (zero or more of each)
* [<references>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-references-element) (zero or more)
* @id
* <optionalClass>

Expand All @@ -37,15 +37,15 @@ Catalogs may use <group> elements to reference related controls or control gr

A <group> element may contain the following:
* <title> (optional)
* <control-components> (mandatory)
* <group> or <control> (one or more total)
* <references> (zero or more)
* [<control-components>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#control-components-element) (mandatory)
* [<group>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-group-element) or [<control>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#control-element) (one or more total)
* [<references>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-references-element) (zero or more)
* @id
* <optionalClass>

### <control-components> element
A <control-components> element may contain the following:
* <prop>, <anyKindofPart>, <link>, and/or <param> elements (zero or more of each)
* [<prop>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#prop-element), [<anyKindofPart>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#part-element), [<link>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#link-element), and/or [<param>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#param-element) elements (zero or more of each)

### <framework> and <worksheet> elements
TBD: figure out where this slots in
Expand All @@ -54,24 +54,24 @@ The *<framework> element* is used to define a formal framework. OSCAL also of

Both <framework> and <worksheet> elements may contain the following:
* <title>
* <declarations> (zero or more)
* <section>, <category>, and/or <component> definitions (zero or more of each)
* <references> (zero or more)
* [<declarations>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-declarations-element) (zero or more)
* [<section>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-section-element), [<category>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#category-element), and/or [<component>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#component-element) definitions (zero or more of each)
* [<references>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-references-element) (zero or more)
* @id
* <optionalClass>

#### <category> element
A <category> element specifies a group of related controls or a group of groups of such controls. A <category> element may contain the following:
* <title> (optional)
* <prop>, <link>, and/or <prose> elements (zero or more of each)
* <category> or <component> elements (one or more total)
* [<prop>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#prop-element), [<link>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#link-element), and/or <prose> elements (zero or more of each)
* [<category>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#category-element) or [<component>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#component-element) element (one or more total)
* @id
* <optionalClass>

#### <component> element
A <framework> element or <worksheet> element may contain *<component>* elements. A component references one or more controls. This provides a way to organize the contents of a framework. A <component> element may contain the following:
A [<framework> or <worksheet>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#framework-and-worksheet-elements) element may contain *<component>* elements. A component references one or more controls. This provides a way to organize the contents of a framework. A <component> element may contain the following:
* <title> (optional)
* <param>, <prop>, <link>, <prose>, and/or <part> elements (zero or more of each)
* [<param>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#param-element), [<prop>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#prop-element), [<link>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#link-element), <prose>, and/or [<anyKindofPart>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#part-element) elements (zero or more of each)
* <component> elements (zero or more)
* @id
* <optionalClass>
Expand All @@ -91,7 +91,7 @@ A <param> element is a parameter setting to be propagated to points of insert
##### <part> element
A <part> element is a partition, piece, or section of a control, subcontrol, component, or part. A <part> element may contain the following:
* <title> (optional)
* <prose> and/or <control-components> elements (zero or more of each)
* <prose> and/or [<control-components>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#control-components-element) (zero or more of each)
* @id
* <optionalClass>

Expand All @@ -102,16 +102,16 @@ A <prop> element is a value with a name. It is attributed to the containing c
## <control> element
Each security or privacy control within the catalog is defined by a <control> element. A <control> element may contain the following:
* <title> (optional)
* <control-components> and/or <subcontrol> elements (zero or more of each)
* <references> (zero or more)
* [<control-components>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#control-components-element) and/or [<subcontrol>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#subcontrol-element) elements (zero or more of each)
* [<references>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-references-element) (zero or more)
* @id
* <optionalClass>

## <subcontrol> element
An OSCAL <subcontrol> element is very similar to an OSCAL <control> element in its composition. A <subcontrol> element may contain the following:
* <title> (optional)
* <control-components> element (mandatory)
* <references> (zero or more)
* [<control-components>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#control-components-element) element (mandatory)
* [<references>](https://github.com/usnistgov/OSCAL/blob/docs/docs/prose/catalog-xml.md#the-references-element) (zero or more)
* @id
* <optionalClass>

Expand Down

0 comments on commit 351257e

Please sign in to comment.