Metanorma: Aequitate Verum

Metanorma IEEE SA document attributes

Note

Document attributes listed below are unique to the processing of IEEE SA documents in Metanorma.

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 IEEE SA.

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

Document information

docnumber

In IEEE SA terms: the designation number for the document. Do not include the initial "P".

Example 1. Example for IEEE SA docnumber
:docnumber: 2830
draft

The draft number. Use together with :docstage: draft. Do not include the initial "D".

Example 2. Example for IEEE SA docstage
:docstage: draft
:draft: 2
edition

The edition number of the document. In case that a document is a draft, the edition number indicates the intended edition number.

Example 3. Example for IEEE SA edition
:edition: 1
amendment-number

(only when docsubtype is set to amendment) The number of the amendment.

corrigendum-number

(only when docsubtype is set to corrigendum) The number of the corrigendum.

isbn-pdf

The ISBN of the PDF document in ISBN-13 format.

Example 4. Example for IEEE SA isbn-pdf
:isbn-pdf: 978-1-5044-7724-6
isbn-print

The ISBN of the print document in ISBN-13 format.

Example 5. Example for IEEE SA isbn-print
:isbn-print: 978-1-5044-7725-3
stdid-pdf

The final standard identifier of the PDF document.

Example 6. Example for IEEE SA stdid-pdf
:stdid-pdf: STD24807
stdid-print

The final standard identifier of the print document.

Example 7. Example for IEEE SA stdid-print
:stdid-print: STDPD24807
doctype

Document type. Definitions of the document type are found on the IEEE SA Style Manual.

Choices:

standard

This document is a Standard (default)

recommended-practice

This document is a Recommended Practice

guide

This document is a Guide

docsubtype

Document subtype. Choices:

document

Document is new or a revision (default)

amendment

Document is an amendment

corrigendum

Document is an corrigendum

erratum

Document is an erratum

trial-use

Document published for a limited period of time. Can apply to any of the document types. (Default value: false.)

Note
A Trial-Use standard is only described in the text of the introduction, it is not prominently displayed nor is it fielded data.
Note
Please see Operations Manual, 5.7 Trial-Use standards for more details.
docstatus

Status of document.

Allowed values are:

developing

Document is under development.

active

Document is active.

inactive

Document is inactive.

If not supplied, the value is developing if draft is supplied, else active.

issued-date

The date on which the document was approved. Like all dates in Metanorma, this must be supplied in YYYY-MM-DD format.

Example 8. Example for IEEE SA issued-date
:issued-date: 2021-06-16
issued-date

The date on which the document draft was circulated.

feedback-ended-date

(conditional). Only when trial-use is set to true. Specific to trial-use documents: the final date at which comments about the document will be accepted.

obsoleted-date
  • When trial-use is set to false: the date on which the document will become inactive

  • When trial-use is set to true: the date on which the document will expire.

    Note
    A trial-use document is effective for not more than three years (Operations Manual, 5.7 Trial-Use standards).
:keywords

Comma-delimited list of keywords associated with the document.

Example 9. Example for IEEE SA keywords (IEEE Std 2830™-2021)
:keywords: data fusion, IEEE 2830™, shared machine learning, SML, trusted execution environment, TEE
:doctitle:

Document title.

Do not include the words "Draft {Guide/Standard/Recommended Practice} for", these words are supplied automatically by Metanorma.

Note
:doctitle: can be set using the first line of the AsciiDoc markup, prefaced by `= ` instead of setting the document attribute.

Document relationships

:merges:

This document incorporates the document(s) with the nominated identifiers (semicolon-delimited).

:updates:

This document is an update of the document(s) with the nominated identifiers (semicolon-delimited).

Document contributors

General

There are multiple types of contributors to an IEEE SA document, and the document displays full provenance of where the document was developed, balloted and eventually approved.

The basic information of these groups are entered as document attributes, including:

  • the working group

  • the balloting group

  • the standards board, at the time of publishing the document.

Members of these groups are entered in the Participants clause.

Society

An IEEE SA document is sponsored by or developed by an IEEE society. This IEEE society is prominently displayed on the cover page.

Note
This is mandatory information.
society

The IEEE society responsible for the document. Do not include the "IEEE" prefix.

Example 10. Example for IEEE SA society
:society: Computer Society

Committee

An IEEE SA document is developed within a working group under an IEEE SA committee. This IEEE SA committee is prominently displayed on the cover page.

Note
This is mandatory information.
committee

The committee responsible for the document.

Example 11. Example for IEEE SA committee
:committee: C/AISC - Artificial Intelligence Standards Committee
:committee: Standards Activities Board

Working group

An IEEE SA document is developed by a working group.

Note
This is mandatory information.

An IEEE SA working group can be one of two modes (more details at process):

  • Entity-based: members are IEEE SA member organizations

  • Individual-based: members are individual contributors

    working-group

    The working group responsible for the document.

    Example 12. Example for IEEE SA working-group
    :working-group: Spatial Web Working Group

Members of the working group are to be listed in the Participants clause.

Balloting group

The balloting group, or balloting committee, is the group that recommends the document for approval as a standard by the IEEE SA Standardization board.

The balloting group is composed of voting members of the working group, or the committee that the working group belongs to.

balloting-group

The Standards Association balloting group responsible for the document.

balloting-group-type

The type of the Standards Association balloting group responsible for the document, individual or entity (default: individual).

Members of the balloting group are to be listed in the Participants clause.

Standardization board

The IEEE Standardization Board at the time of document publication is rendered in the document preface.

Members of the IEEE SA Standardization Board (SASB) are to be listed in the Participants clause.

Visual appearance

:hierarchical-object-numbering:

If set, do not number tables and figures consecutively throughout the body of the document, but restart numbering with each clause (hierarchically).

Use in complex documents, with multiple tables or figures, that need to be tracked against clauses for ease of lookup (so Figure 6-3, Figure 6-4, instead of Figure 21, Figure 22.)