Typical sections in IEEE
General
The easiest way to ensure that you are following the document structure that IEEE demands, is to use a Metanorma template.
If you author a document type that doesn't have a template, check a sample document for better understanding how to structure that document.
Typically, an IEEE SA document contains the following content order:
include::author/ieee/topics/markup.adoc[tag=preliminary-ieee]
Terms and definitions
The terms and definitions is used to define important terms and cite them throughout the standard.
Learn how to enter terms and definitions.
References
The references section contains normative references, it is considered a “bibliography” section.
Learn how to Entering bibliographic references.
Content sections
After the sections above, any number of content sections can be added.
Annex sections
General
Annex sections are declared by prepending the [appendix] tag above the section declaration. Annexes can be added as necessary.
An annex can either be normative or informative. By default an annex is marked informative.
In order to declare a normative annex, use the obligation attribute in the following manner: [appendix,obligation=normative]
// Without declaration, an annex is informative.
[appendix]
== Informative annex title
...
// A normative annex.
[appendix,obligation=normative]
== Normative annex title
...
// A informative annex with explicit declaration
[appendix,obligation=informative]
== Informative annex title
...Annex clauses are placed after all content sections, right before the bibliography section.
Glossary
IEEE SA documents support an extra definitions section that represents informative terms, as a "Glossary" section in the annex.
It can be encoded as follows:
[appendix]
== Glossary
=== My term
My definition
...The usage and syntax of this section is identical to that of terms. Please refer to the terms and definitions syntax on how to write out the terms in the Glossary.