Terminology Sections - commoncriteria/pp-template GitHub Wiki

Updated 29 January 2024

Terminology Sections

The XML includes a terminology section under the <tech-terms> tag. From this one element are generated sections for both Common Criteria Terms and Technical Terms. The CC Terms section is auto-generated from predefined terms. The contents of the Technology Terms section is supplied by the XML document Author.

  <tech-terms>
    <term full="Administrator">Administrators perform management activities on the VS. These management functions do not 
	include administration of software running within Guest VMs, such as the Guest OS. Administrators need not be human 
	as in the case of embedded or headless VMs. Administrators are often nothing more than software entities that 
	operate within the VM.</term>
    <term abbr="AES" full="Advanced Encryption Standard"/>
    <term full="Virtual Machine Manager" abbr="VMM">A VMM is a collection of software components responsible for enabling VMs to
        function as expected by the software executing within them. Generally, the VMM consists of a Hypervisor, Service 
	VMs, and other components of the VS, such as virtual devices, binary translation systems, and physical device
	drivers. It manages concurrent execution of all VMs and virtualizes platform resources as needed.</term>
  </tech-terms>

As shown above, the <term> element can take two attributes, full and abbr. The value of full is the term being defined. The value of abbr is the abbreviation for the term, if any. The contents of the <term> element is the definition for the term. If there is an abbr attribute, the term and abbreviation will appear in the Acronyms appendix, which is generally the second-to-last appendix in the document. If the <term> element has no contents (only full and abbr attributes), then the term will appear in the Acronyms appendix, but not in the terms section of the generated document.

Where acronyms appear within the text of the generated HTML PP document, they appear in the final document as links to the definition.

If there are boilerplate CC Terms that you do not want to appear in your document you can suppress them using the <suppress> tag at the beginning of the terms list. For example,

  <tech-terms>
     <suppress>Distributed TOE</suppress>
     <term> ....
        .
        .
  </tech-terms>
⚠️ **GitHub.com Fallback** ⚠️