Difference between revisions of "Report token"

From CNM Wiki
Jump to: navigation, search
(List)
(Symbols, Abbreviations, and Acronyms)
 
Line 8: Line 8:
 
:If there are numerous symbols, abbreviations, and acronyms in a report (more than five that are not readily recognized as standard in the field), or if there is a chance that readers will not understand them, a report requires a list of all symbols, abbreviations, and acronyms with an explanation of each. The list of symbols, abbreviations, and acronyms begins on a new page in print publications. (See also 6.9, Symbols, Abbreviations, and Acronyms.) Some organizations may include this section as part of the front matter to ensure that the reader is quickly aware of its existence.
 
:If there are numerous symbols, abbreviations, and acronyms in a report (more than five that are not readily recognized as standard in the field), or if there is a chance that readers will not understand them, a report requires a list of all symbols, abbreviations, and acronyms with an explanation of each. The list of symbols, abbreviations, and acronyms begins on a new page in print publications. (See also 6.9, Symbols, Abbreviations, and Acronyms.) Some organizations may include this section as part of the front matter to ensure that the reader is quickly aware of its existence.
  
===Symbols, Abbreviations, and Acronyms===
+
==Applicable rules==
6.9.1 General
+
According to the [[ANSI/NISO Scientific and Technical Reports]] standard,
 +
:Spell out symbols, abbreviations, and acronyms at their first use in the text to ensure that readers understand them. However, do not define standard mathematical notation, chemical symbols (unless needed for clarification; see: 6.6), and known abbreviations of measurement unless the potential exists for misinterpretation. Write out an acronym the first time it is used in the text, and include it in a list of symbols, abbreviations, and acronyms. Use symbols that are standard in the discipline of the report.
  
Spell out symbols, abbreviations, and acronyms at their first use in the text to ensure that
+
:If no standard has been established for a concept, consult related scientific or technical literature for a symbol in general use. When they occur in lists, present symbols, abbreviations, and acronyms in descending order, as follows:
readers understand them. However, do not define standard mathematical notation, chemical
+
:*Numbers
symbols (unless needed for clarification; see: 6.6), and known abbreviations of measurement
+
:*Roman (English) alphabet capital letters
unless the potential exists for misinterpretation. Write out an acronym the first time it is used
+
:*Roman (English) alphabet lowercase letters
in the text, and include it in a list of symbols, abbreviations, and acronyms. Use symbols that
+
:*Greek alphabet capital letters
are standard in the discipline of the report. Appendix A, Selected Annotated Bibliography,
+
:*Greek alphabet lowercase letters
 +
:*Subscripts
 +
:*Superscripts
 +
:*Special notes
  
A.6, Standards and Symbols, includes standards for symbols used in many disciplines. If no
+
:If a symbol, abbreviation, or acronym has more than one definition, separate the explanations by a semicolon and explain each definition at its first use in the report.
standard has been established for a concept, consult related scientific or technical literature
 
for a symbol in general use. When they occur in lists, present symbols, abbreviations, and
 
acronyms in descending order, as follows:  
 
 
 
• Numbers
 
 
 
• Roman (English) alphabet capital letters
 
 
 
• Roman (English) alphabet lowercase letters
 
 
 
• Greek alphabet capital letters
 
 
 
• Greek alphabet lowercase letters
 
 
 
• Subscripts
 
 
 
• Superscripts
 
 
 
• Special notes
 
 
 
If a symbol, abbreviation, or acronym has more than one definition, separate the explanations  
 
by a semicolon and explain each definition at its first use in the report.
 
 
 
 
 
6.9.2 Print-Specific
 
 
 
Display symbols, abbreviations, and acronyms and their definitions in two columns with the
 
abbreviations and acronyms listed in alpha-numeric order and aligned with the left margin.
 
Begin each entry on a new line, followed in the second column by its definition. Leave
 
adequate space between the longest symbol, abbreviation, or acronym and its definition and
 
align the rest of the entries in the list(s) accordingly.
 

Latest revision as of 14:34, 16 November 2020

A report token (hereinafter, the Token) is a symbol, abbreviation, or acronym that a report or another document utilizes.


List

A list or lists of the Tokens is a conditional part of report's back or, rarely, but possibly, front matter; it is included if symbols, abbreviations, or acronyms appear in any other component of the report. When the List is included, it functions as a part of document's structural metadata.

The ANSI/NISO Scientific and Technical Reports standard details,

If there are numerous symbols, abbreviations, and acronyms in a report (more than five that are not readily recognized as standard in the field), or if there is a chance that readers will not understand them, a report requires a list of all symbols, abbreviations, and acronyms with an explanation of each. The list of symbols, abbreviations, and acronyms begins on a new page in print publications. (See also 6.9, Symbols, Abbreviations, and Acronyms.) Some organizations may include this section as part of the front matter to ensure that the reader is quickly aware of its existence.

Applicable rules

According to the ANSI/NISO Scientific and Technical Reports standard,

Spell out symbols, abbreviations, and acronyms at their first use in the text to ensure that readers understand them. However, do not define standard mathematical notation, chemical symbols (unless needed for clarification; see: 6.6), and known abbreviations of measurement unless the potential exists for misinterpretation. Write out an acronym the first time it is used in the text, and include it in a list of symbols, abbreviations, and acronyms. Use symbols that are standard in the discipline of the report.
If no standard has been established for a concept, consult related scientific or technical literature for a symbol in general use. When they occur in lists, present symbols, abbreviations, and acronyms in descending order, as follows:
  • Numbers
  • Roman (English) alphabet capital letters
  • Roman (English) alphabet lowercase letters
  • Greek alphabet capital letters
  • Greek alphabet lowercase letters
  • Subscripts
  • Superscripts
  • Special notes
If a symbol, abbreviation, or acronym has more than one definition, separate the explanations by a semicolon and explain each definition at its first use in the report.