Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| dido:03-dido-te:99-annexes:annex-b-references:start [2026/08/07 08:06] – [Contents] nick_dido | dido:03-dido-te:99-annexes:annex-b-references:start [2026/08/23 16:57] (current) – nick_dido | ||
|---|---|---|---|
| Line 3: | Line 3: | ||
| [[dido: | [[dido: | ||
| - | Annex B contains | + | Annex B identifies |
| - | Each reference | + | Each DIDO-TE-specific |
| - | DIDO-TE-specific references use identifiers in the form: | + | DIDO-TE-specific references use identifiers in the form '' |
| - | * [DTE1] | + | Individual reference pages are leaf pages and use namespaces in the form: |
| - | * [DTE2] | + | |
| - | * [DTE3] | + | |
| - | The corresponding namespaces use only the stable numeric identifier rather than the document title. | + | < |
| + | dte-NNN | ||
| + | </ | ||
| - | Examples include: | + | The reference |
| - | + | ||
| - | * '' | + | |
| - | * '' | + | |
| - | * '' | + | |
| - | + | ||
| - | The descriptive document title appears in the reference-page heading and in the References list. | + | |
| ===== References ===== | ===== References ===== | ||
| - | <todo>Identify and create the DIDO-TE reference pages.</ | + | {{indexmenu>dido:03-dido-te: |
| ===== Citation Use ===== | ===== Citation Use ===== | ||
| - | DIDO-TE pages cite a reference by linking | + | Citations use the stable |
| - | For example, a requirement '' | + | For example: |
| - | [[dido: | + | <code dokuwiki> |
| + | [[dido: | ||
| + | </ | ||
| - | When a citation refers to a specific location within a source, the citation identifies the applicable section, clause, page, figure, table, or requirement following the reference link. | + | For model-based references, cite [[dido: |
| - | ===== References ===== | + | A model citation may identify: |
| - | * [[dido: | + | * a package; |
| - | * [[dido: | + | * a diagram; |
| - | * [[dido: | + | * a model element; |
| + | * a datatype; | ||
| + | * an attribute; | ||
| + | * an association; | ||
| + | * a relationship; | ||
| + | * a multiplicity; | ||
| + | * another identifiable model construct. | ||
| - | {{indexmenu> | + | For example: |
| + | |||
| + | <code dokuwiki> | ||
| + | [[dido: | ||
| + | </ | ||
| + | |||
| + | A more precise model citation may include the model path: | ||
| + | |||
| + | <code dokuwiki> | ||
| + | [[dido: | ||
| + | </ | ||
| + | |||
| + | Where a DIDO-TE Information Model page documents a relationship, | ||
| + | |||
| + | DIDO-TE architectural interpretations, | ||
| ---- | ---- | ||
| Line 49: | Line 65: | ||
| ===== Notes for Editors ===== | ===== Notes for Editors ===== | ||
| - | Maintain | + | Assign |
| - | Assign | + | Maintain |
| - | Use namespaces in the form: | + | Do not reuse or renumber an assigned reference identifier. |
| - | * '' | + | Use the reference page as the canonical citation target. |
| - | * '' | + | |
| - | * '' | + | |
| - | Do not include | + | Identify |
| - | Use page headings in the form: | + | For model citations, use [DTE4] as the canonical source reference and identify the applicable package, diagram, model element, datatype, attribute, association, |
| - | * '' | + | Do not represent a DIDO-TE refinement or extension as though it were present in [DTE4]. Distinguish source-model content from DIDO-TE architectural interpretation. |
| - | * '' | + | |
| - | * '' | + | |
| - | Use the reference page as the canonical citation target rather than repeating the complete citation throughout | + | Preserve source-model names, spellings, relationships, |
| - | When a new revision supersedes a referenced document, update the applicable reference page with the new version, revision, date, status, and supersession relationship. | + | Preserve historical references when existing requirements, evidence, reports, or externally published documents cite an earlier |
| - | Preserve historical references when existing requirements, Evidence, reports, or externally published documents cite an earlier revision. | + | When a referenced source is superseded, record the supersession relationship on the applicable reference page. |
| - | Do not renumber or rename reference | + | Do not rename |
| ---- | ---- | ||