Difference between revisions of "Report token"
(→Symbols, Abbreviations, and Acronyms) |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | A [[report | + | 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, | 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. | |
| − | |||
| − | understand them, | ||
| − | |||
| − | in | ||
| − | |||
| + | :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. | |
| − | |||
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.
