References - commoncriteria/pp-template GitHub Wiki

23 January 2024

References create hyperlinks from some text in the document to the place where the thing referenced is defined. The NIAP XML framework has a very rich referencing capability.

SFRs

If the name of an SFR appears anywhere in the document, a reference is automatically created to the definition of the SFR. If you refer to an SFR in another document that has the same name as an SFR in your document, you must turn off cross-referencing for that term in order to prevent the framework from creating a link to the wrong SFR.

    <no-link>FCS_CKM.2</no-link>

Acronyms

If an acronym that is defined in the Terms section of the document appears anywhere in the document, the framework creates a hyperlink to the definition in the Acronyms Appendix.

Appendixes, Sections, Tables, Figures, and Bibliography Entries

To refer to any of these things, simply use the <xref> tag with the to attribute set to the id of the Section, Appendix, Table, Figure, or Bibliography Entry. For example, to refer to the Use Cases Appendix of a PP, you might use:

     <xref to="apndx-use"/>

If the Appendix is defined

     <appendix id="apndx-use" title="Use Case Templates">

then the reference should resemble "Appendix - E - Use Case Templates" with a hyperlink to the Appendix.

For any of these constructs, the framework will generate text that makes sense for the thing being referenced.

Auto-generated Audit Tables

To references any of the five auto-generated audit tables, you have to do things a little differently since you don't have an id for these tables in your document. Use

   <xref g="tableID"/>

where table id is as foll0ws for teach of the pre-defined audit tables:

t-audit-mandatory
t-audit-optional
t-audit-objective
t-audit-impl-dep
t-audit-sel-based

Auto-generated Appendixes

If the Appendix you want to refer to is auto-generated, such as the Optional SFRs appendix or the Selection-based SFRs appendix, you use the same construct:

   <xref g="apndxID"/>

where "apndxID" is one of the following:

optional-reqs - for Appendix A.1: Strictly Optional Requirements
objective-reqs - for Appendix A.2: Objective Requirements
feat-based-reqs - for Appendix A.3: Implementation-dependent Requirements
sel-based-reqs - for Appendix B: Selection-based Requirements

Auto-generated Bibliography Entries

To reference the pre-defined Bibliography entries for the CC and CEM, use

   <xref g="CC"/> or <xref g="CEM"/>