Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleModel Documentation

Class: ReferenceDocument

The ReferenceDocument class is used to identify the documents that are referenced within the reporting event. Each reference document has a name and location, and is assigned an id value.

Excerpt Include
ARSP:ER Diagram: ReferenceDocument
ARSP:ER Diagram: ReferenceDocument

The ARS ReferenceDocument class corresponds with the Define-XML def:leaf element that is referenced in the ARM for Define-XML specification:

ARS ReferenceDocument AttributesCorresponding Define-XML def:leaf Attribute/Element

id

ID attribute
locationxlink:href attribute
namedef:title element

Reference documents may contain either documentation (such as specifications for analyses or representations of outputs) or programming code.

Example

Include Page
referenceDocuments
referenceDocuments

Once an identifier value has been assigned for a reference document, the references to the document as a whole, or to specific parts of the document, may be made using the DocumentReference class:

  • One or more documentation document references may be defined in the documentRefs attribute of the AnalysisMethod, Analysis, or Output classes.

Pagenav