Author CalConnect documents with Metanorma

Document attributes

Note

Below are listed only document attributes that are unique to Metanorma’s processing of CSD documents.

For common document attributes, see Document attributes reference in general Metanorma author’s documentation. That page describes attributes that apply to all Metanorma flavors, not just CSD.

For an introduction to AsciiDoc document attributes and how Metanorma uses them, see the corresponding topic.

:docnumber:

CalConnect document number, as allocated by TCC.

:status:

The status of the document. Synonym: :docstage:. Can be one of:

  • proposal

  • working-draft

  • committee-draft

  • draft-standard

  • final-draft

  • published

  • withdrawn

:doctype:

The type of the document. Can be one of:

standard

Standard (no suffix on identifier; e.g. CC 1)

directive

Directive (suffix DIR, e.g. CC/DIR 1)

guide

Guide (suffix Guide)

specification

Specification (suffix S)

report

Report (suffix R)

administrative

Administrative (suffix A)

amendment

Amendment (suffix Amd)

technical corrigendum

Technical Corrigendum (suffix Cor)

advisory

Advisory (suffix Adv)

:technical-committee:

The name of the relevant CSD technical committee

:technical-committee-type:

The type of the relevant CSD technical committee (mandatory): technical, provisional

:technical-committee_2:

The name of a second relevant CSD technical committee; other committees are added as _3, _4…​

:technical-committee-type_2:

The type of a second relevant CSD technical committee; other committees are added as _3, _4…​

Markup

Terms and Definitions

Note
This section supplements The “Terms and Definitions” section in general Metanorma documentation.

This must be clause 3.

[[tda]]                      <= anchor if you want it
[source=ISO8601-1]           <= allows inheriting terms and definitions from
another document
== Terms, definitions, symbols and abbreviations   <= can combine T&D and S&A

=== Terms and definitions    <= the real T&D clause

[[term-explicit]]            <= anchor if you want it
==== explicit form           <= term item

date and time representation that uses designator symbols to delimit
time scale components

Term entries within a Terms & Definitions section

The structure is strict. The following illustrates the complete structure of a term entry.

In the term source ([.source]), all content after the reference and the “comma” is about “modifications” to the original definition.

[[paddy]]                  <= anchor
=== paddy                  <= term
alt:[paddy rice]           <= alternative term
alt:[rough rice]           <= second alternative
deprecated:[cargo rice]    <= deprecated term
domain:[rice]              <= domain

rice retaining its husk after threshing  <= definition

[example]              <= example
Foreign seeds, husks, bran, sand, dust.

NOTE: The starch of waxy rice consists almost entirely of amylopectin. <= note

[.source]
<<ISO7301,section 3.2>>, The term "cargo rice" is shown as deprecated, <= source
and Note 1 to entry is not included here.

Annexes

Annexes have to be placed before the bibliography.

[[AnnexA]]
[appendix,subtype=informative]
== Example date and time expressions, and representations
...