Difference between revisions of "ANSI/NISO Scientific and Technical Reports"

From CNM Wiki
Jump to: navigation, search
(→‎Front Matter)
 
(94 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
'''Scientific and Technical Reports: Preparation, Presentation, and Preservation''' (hereinafter, the ''Standard'') is the ANSI/NISO Z39.18-2005 (R2010) American national standard that is developed by the [[National Information Standards Organization]] and approved in 2005 and reaffirmed by 2010 by the [[American National Standards Institute]].
+
'''Scientific and Technical Reports: Preparation, Presentation, and Preservation''' (alternatively known as [[ANSI/NISO Z39.18]]; hereinafter, the ''Standard'') is the [[ANSI/NISO Z39.18-2005 (R2010)]] American national standard that is developed by the [[National Information Standards Organization]] and approved in 2005 and reaffirmed by 2010 by the [[American National Standards Institute]].
  
  
Line 13: Line 13:
 
:*Appendix A -- '''Selected Annotated Bibliography'''
 
:*Appendix A -- '''Selected Annotated Bibliography'''
 
:*Appendix B -- '''Glossary'''
 
:*Appendix B -- '''Glossary'''
−
:*Appendix C -- '''Dublin Core Data Elements'''
+
:*Appendix C -- '''[[Dublin Core Data Elements]]'''
 
:*Appendix D -- '''Formats for Organizing a Scientific or Technical Report'''
 
:*Appendix D -- '''Formats for Organizing a Scientific or Technical Report'''
 
:*Appendix E -- '''Report Documentation Page, Standard Form (SF)'''  
 
:*Appendix E -- '''Report Documentation Page, Standard Form (SF)'''  
Line 26: Line 26:
 
:The ''Standard'' will guide individuals and organizations in preparing reports. It is generally couched in terms of the traditional printed report because that medium is the most concrete and common example for readers to consider and visualize. However, the ''Standard'' is expressed in such a way that adapting to other means of publication (for example, electronic formats on the Web) is recognized.  
 
:The ''Standard'' will guide individuals and organizations in preparing reports. It is generally couched in terms of the traditional printed report because that medium is the most concrete and common example for readers to consider and visualize. However, the ''Standard'' is expressed in such a way that adapting to other means of publication (for example, electronic formats on the Web) is recognized.  
  
−
:Although the ''Standard'' necessarily has to consider means of distribution, facilitate methods of literature control, and accommodate methods of accessibility, it is not a standard for cataloging, describing, or preserving publications. Those roles are fulfilled by other standards, such as those associated with using MARC 21 records, Dublin Core, and evolving standards for persistent identification.
+
:Although the ''Standard'' necessarily has to consider means of distribution, facilitate methods of literature control, and accommodate methods of accessibility, it is not a standard for cataloging, describing, or preserving publications. Those roles are fulfilled by other standards, such as those associated with using MARC 21 records, [[Dublin Core]], and evolving standards for persistent identification.
  
 
===Audience===
 
===Audience===
Line 36: Line 36:
 
==Key Concepts==
 
==Key Concepts==
 
===Metadata===
 
===Metadata===
−
:The ''Standard'' advocates provision for the capture of appropriate metadata in report preparation. Metadata refer to information about information or, equivalently, data about data. In current practice, the term has come to mean structured information that feeds into automated processes, and this definition is currently the most useful way to think about metadata. This definition further applies whether the publication that the metadata describes is in print or electronic form. In publishing, metadata can be classified according to a variety of specific functions, such as technical metadata for technical processes, rights metadata for rights resolution, preservation metadata for digital archiving, and descriptive metadata (metadata that characterizes the content itself).  
+
:The ''Standard'' advocates provision for the capture of appropriate metadata in report preparation. Metadata refer to information about information or, equivalently, data about data. In current practice, the term has come to mean structured information that feeds into automated processes, and this definition is currently the most useful way to think about metadata. This definition further applies whether the publication that the metadata describes is in print or electronic form. In publishing, metadata can be classified according to a variety of specific functions, such as technical metadata for technical processes, rights metadata for rights resolution, preservation metadata for digital archiving, and [[descriptive metadata]] (metadata that characterizes the [[report content|content]] itself).  
  
 
===Persistence===
 
===Persistence===
−
:The ''Standard'' addresses the need for persistence in links that are incorporated in reports. A key component of the digital information infrastructure is a mechanism for addressing and locating digital objects on a network or in an archival system. The current addressing structure for the World Wide Web is based on the Uniform Resource Locator (URL). While the URL provides direct, efficient access, URL-only naming fails whenever the resources are moved or reorganized. The lack of persistence leads to "404" (file not found) errors, inhibiting access to information and causing problems when archiving material for long-term preservation and permanent access. These links should also be documented for accessibility in print format.  
+
:The ''Standard'' addresses the need for persistence in links that are incorporated in reports. A key component of the digital information infrastructure is a mechanism for addressing and locating digital objects on a network or in an archival system. The current addressing structure for the [[World Wide Web]] is based on the [[Uniform Resource Locator]] ([[URL]]). While the URL provides direct, efficient access, URL-only naming fails whenever the resources are moved or reorganized. The lack of persistence leads to "404" (file not found) errors, inhibiting access to information and causing problems when archiving material for long-term preservation and permanent access. These links should also be documented for accessibility in print format.  
  
 
===Interoperability===
 
===Interoperability===
Line 60: Line 60:
 
::The XML document contains the report with its metadata. Elements in an XML document should comply with the DTD provided (see Appendix F), which validates the document.  
 
::The XML document contains the report with its metadata. Elements in an XML document should comply with the DTD provided (see Appendix F), which validates the document.  
 
:;XSL (Style Sheet)  
 
:;XSL (Style Sheet)  
−
::The XSL (extensible Style Sheet) provides a mechanism for presenting data available in an XML document. It provides formatting information and ordering of presentation (not always the same order as in the XML document) and can generate extra metadata, such as a table of contents, list of figures, etc. Multiple XSL sheets can be used for the same document to accommodate the needs of various communities: Web publication of reports, printed reports, etc.
+
::The XSL (extensible Style Sheet) provides a mechanism for presenting data available in an XML document. It provides formatting information and ordering of presentation (not always the same order as in the XML document) and can generate extra metadata, such as a [[table of contents]], [[content aid|list of figures]], etc. Multiple XSL sheets can be used for the same document to accommodate the needs of various communities: Web publication of reports, printed reports, etc.
  
 
===Presentation===
 
===Presentation===
−
:The ''Standard'' is cognizant of and reflects the requirements and limitations of different methods of publication. The concept of publication (literally, to make known to the public) changed drastically in the 1960s when computers were applied to the typesetting process. Suddenly, machine-readable electronic records were being produced along with traditional print. The subsequent development of new media, recording devices, codes of expression, and means of transmission made these electronic records eminently usable. Scientific, business, military, and government communities found these new media to be a convenient and economical means for distributing and storing information, including reports. As a result, we now see diverse ways of publishing data and information, from printed pages to CDs to analog and digital tapes to files accessible over the World Wide Web.  
+
:The ''Standard'' is cognizant of and reflects the requirements and limitations of different methods of publication. The concept of publication (literally, to make known to the public) changed drastically in the 1960s when computers were applied to the typesetting process. Suddenly, machine-readable electronic records were being produced along with traditional print. The subsequent development of new media, recording devices, codes of expression, and means of transmission made these electronic records eminently usable. Scientific, business, military, and government communities found these new media to be a convenient and economical means for distributing and storing information, including reports. As a result, we now see diverse ways of publishing data and information, from printed pages to files accessible over the [[World Wide Web]].  
  
 
:The prescriptions of the ''Standard'' are flexible enough to be adapted to a great variety of publication methods, both extant and yet to be discovered. However, it also recognizes that many users of a report find a printed version more convenient, portable, or permanent. Therefore, the ''Standard'' states that electronic publications be formatted so that standardized, usable print copies can be produced from any medium through common or specialized software. The ''Standard'' suggests producing reports that can be converted from medium to medium and format to format to allow ease of use and future migration.
 
:The prescriptions of the ''Standard'' are flexible enough to be adapted to a great variety of publication methods, both extant and yet to be discovered. However, it also recognizes that many users of a report find a printed version more convenient, portable, or permanent. Therefore, the ''Standard'' states that electronic publications be formatted so that standardized, usable print copies can be produced from any medium through common or specialized software. The ''Standard'' suggests producing reports that can be converted from medium to medium and format to format to allow ease of use and future migration.
Line 78: Line 78:
  
 
===Maintenance and Preservation===
 
===Maintenance and Preservation===
−
:The ''Standard'' advocates adopting practices that ensure long-term preservation of reports. Compilers and publishers of scientific and technical reports can and should take action to ensure their efforts will be appreciated for as long as the reports have value to users. This requirement means that reports should be prepared using techniques and materials that enable discovery and usability over the long term. Continuing discovery is assured by associating a report with clear, distinct, and unchanging identifying information (descriptive metadata). Continuing usability is assured by adopting an easily navigated and navigable structure, including maintenance of internal and external links, and by using publishing techniques that withstand the test of time. Time-tested publishing techniques involve the appropriate choice of publishing medium, such as acid-free paper or polyester-based silver gelatin film. However, publishing increasingly involves producing digital products that can be migrated and shared across media, platforms, applications, and organizations. At the time the Committee developed the ''Standard'', the most promising method for assuring continuing migration is employment of an XML DTD to encode electronic reports when produced.  
+
:The ''Standard'' advocates adopting practices that ensure long-term preservation of reports. Compilers and publishers of scientific and technical reports can and should take action to ensure their efforts will be appreciated for as long as the reports have value to users. This requirement means that reports should be prepared using techniques and materials that enable discovery and usability over the long term. Continuing discovery is assured by associating a report with clear, distinct, and unchanging identifying information ([[descriptive metadata]]). Continuing usability is assured by adopting an easily navigated and navigable structure, including maintenance of internal and external links, and by using publishing techniques that withstand the test of time. Time-tested publishing techniques involve the appropriate choice of publishing medium, such as acid-free paper or polyester-based silver gelatin film. However, publishing increasingly involves producing digital products that can be migrated and shared across media, platforms, applications, and organizations. At the time the Committee developed the ''Standard'', the most promising method for assuring continuing migration is employment of an XML DTD to encode electronic reports when produced.  
  
 
:Many complex, electronic scientific and technical reports are used to produce multimedia publications and presentations. In such cases, it is particularly important to use presentation standards and practices that not only enable the widest possible access at the time of report creation, but also ensure continuous availability of content and structure despite changes in the delivery environment. In cases of multimedia reports, it is desirable to preserve the original presentation media as well as the original content. When this preservation cannot be achieved, it is most important to preserve the content so that the original source material is preserved.
 
:Many complex, electronic scientific and technical reports are used to produce multimedia publications and presentations. In such cases, it is particularly important to use presentation standards and practices that not only enable the widest possible access at the time of report creation, but also ensure continuous availability of content and structure despite changes in the delivery environment. In cases of multimedia reports, it is desirable to preserve the original presentation media as well as the original content. When this preservation cannot be achieved, it is most important to preserve the content so that the original source material is preserved.
Line 93: Line 93:
  
 
:;Descriptive Metadata  
 
:;Descriptive Metadata  
−
::Descriptive metadata, such as cataloging information prepared following standards such as Dublin Core or MARC 21, convey information that helps the user find a report and distinguish it from other similar ones. Descriptive metadata are commonly used for resource discovery, such as author/title/subject searching, or grouping like objects for browsing. Such metadata include the title and creator (author), as well as any keywords or subject references.  
+
::[[Descriptive metadata]], such as cataloging information prepared following standards such as [[Dublin Core]] or MARC 21, convey information that helps the user find a report and distinguish it from other similar ones. [[Descriptive metadata]] are commonly used for resource discovery, such as author/title/subject searching, or grouping like objects for browsing. Such metadata include the title and creator (author), as well as any keywords or subject references.  
 
:;Structural Metadata  
 
:;Structural Metadata  
−
::Structural metadata explain the relationship between parts of multipart objects and enhance internal navigation. Such metadata include a table of contents or list of figures and tables.  
+
::[[Structural metadata]] explain the relationship between parts of multipart objects and enhance internal navigation. Such metadata include a [[table of contents]] or [[content aid|list of figures and tables]].  
 
:;Administrative Metadata  
 
:;Administrative Metadata  
−
::Administrative metadata support maintaining and archiving reports and ensure their long-term availability. Administrative metadata are needed for migration of data from one format to another and contain rights information used for access control. Such metadata include type and version of software used in preparing the report and rights-management requirements.
+
::[[Administrative metadata]] support maintaining and archiving reports and ensure their long-term availability. [[Administrative metadata]] are needed for migration of data from one format to another and contain rights information used for access control. Such metadata include type and version of software used in preparing the report and rights-management requirements.
  
 
===Components===
 
===Components===
 
:The author/creator of a scientific or technical report must keep all metadata requirements in mind throughout report creation and should prepare the components to enable ready recognition of key descriptive, structural, and administrative information about the report.  
 
:The author/creator of a scientific or technical report must keep all metadata requirements in mind throughout report creation and should prepare the components to enable ready recognition of key descriptive, structural, and administrative information about the report.  
  
−
:Table 1 presents the ''Standard'' components of scientific and technical reports in the traditional order of presentation. In reports organized in this manner, the listed components from cover through acknowledgments are commonly referred to as front matter, the components from summary through references are referred to as the body or text matter, and components from appendices through distribution list are referred to as back matter.  
+
:Table 1 presents the ''Standard'' components of scientific and technical reports in the traditional order of presentation. In reports organized in this manner, the listed components from cover through acknowledgments are commonly referred to as front matter, the components from summary through references are referred to as the body or text matter, and components from appendices through [[distribution metadata|distribution list]] are referred to as back matter.  
  
 
:In the Inclusion Status column, the table indicates which components are required by the ''Standard'', which are optional, and which are conditional. Finally, in the column headed Function, the table indicates the primary role served by the information conveyed in each component.  
 
:In the Inclusion Status column, the table indicates which components are required by the ''Standard'', which are optional, and which are conditional. Finally, in the column headed Function, the table indicates the primary role served by the information conveyed in each component.  
Line 112: Line 112:
 
|-
 
|-
 
!rowspan="11"|Front Matter
 
!rowspan="11"|Front Matter
−
|Cover||Optional||Descriptive metadata  
+
|[[Report cover|Cover]]||Optional||[[Descriptive metadata]]
 
|-
 
|-
−
|Title Section||Required||Descriptive metadata, such as Dublin Core elements: Identifier, Title, Creator, Publisher, Contributor, Date, and Language  
+
|[[Discovery metadata|Title Section]]||Required||[[Descriptive metadata]], such as [[Dublin Core]] elements: Identifier, Title, Creator, Publisher, Contributor, Date, and Language  
 
|-
 
|-
−
|Notice Section||Conditional (include when needed to specify intellectual property rights or state restrictions on access or use)||Administrative metadata, such as the Dublin Core elements: Rights Management and Format  
+
|[[distribution metadata|Notice Section]]||Conditional (include when needed to specify intellectual property rights or state restrictions on access or use)||[[Administrative metadata]], such as the [[Dublin Core]] elements: Rights Management and Format  
 
|-
 
|-
−
|Format Information Section||Conditional (include when the original is created in digital format)||Administrative metadata, such as Dublin Core element: Format  
+
|[[Report format|Format Information Section]]||Conditional (include when the original is created in digital format)||[[Administrative metadata]], such as [[Dublin Core]] element: Format  
 
|-
 
|-
−
|Report Documentation Section||Conditional (include in reports prepared for federal governmental agencies)||style="text-align:left;"|
+
|[[Discovery metadata|Report Documentation Section]]||Conditional (include in reports prepared for federal governmental agencies)||style="text-align:left;"|
−
*Descriptive metadata, such as the Dublin Core elements: Title, Creator, and Publisher
+
*[[Descriptive metadata]], such as the [[Dublin Core]] elements: Title, Creator, and Publisher
−
*Source of administrative metadata, such as the Dublin Core element: Rights Management  
+
*Source of [[administrative metadata]], such as the [[Dublin Core]] element: Rights Management  
 
|-
 
|-
−
|Abstract Section||Required||Descriptive metadata, such as the Dublin Core elements: Description, Subject, and Coverage  
+
|[[Document abstract|Abstract Section]]||Required||[[Descriptive metadata]], such as the [[Dublin Core]] elements: Description, Subject, and Coverage  
 
|-
 
|-
−
|Contents Section||Required||Structural metadata
+
|[[Table of contents|Contents Section]]||Required||[[Structural metadata]]
 
|-
 
|-
−
|List of Figures and Tables||Conditional (include when there are more than 5 figures and/or tables)||Structural metadata  
+
|[[Content aid|List of Figures and Tables]]||Conditional (include when there are more than 5 figures and/or tables)||[[Structural metadata]]
 
|-
 
|-
−
|Foreword||Conditional (include when background and context is needed)||Descriptive metadata  
+
|[[Foreword]]||Conditional (include when background and context is needed)||[[Descriptive metadata]]
 
|-
 
|-
−
|Preface||Conditional (include when background and context is needed)||Descriptive metadata  
+
|[[Preface]]||Conditional (include when background and context is needed)||[[Descriptive metadata]]
 
|-
 
|-
−
|Acknowledgments||Conditional (include when significant)||Content  
+
|[[Report acknowledgment|Acknowledgments]]||Conditional (include when significant)||[[report content|Content]]
 
|-
 
|-
 
!rowspan="7"|Body or Text Matter
 
!rowspan="7"|Body or Text Matter
−
|Summary||Required||Content  
+
|[[Document summary|Summary]]||Required||[[report content|Content]]
 
|-
 
|-
−
|Introduction||Required||Content  
+
|[[Report stage-setting section|Introduction]]||Required||[[report content|Content]]
 
|-
 
|-
−
|Methods, Assumptions, and Procedures||Required||Content  
+
|[[Report undertaking section|Methods, Assumptions, and Procedures]]||Required||[[report content|Content]]
 
|-
 
|-
−
|Results and Discussion||Required||Content  
+
|[[report finding|Results and Discussion]]||Required||[[report content|Content]]
 
|-
 
|-
−
|Conclusions||Required||Content  
+
|[[Report interpretation|Conclusions]]||Required||[[report content|Content]]
 
|-
 
|-
−
|Recommendations||Conditional (include when purpose of report is to suggest a course of action)||Content  
+
|[[report recommendation|Recommendations]]||Conditional (include when purpose of report is to suggest a course of action)||[[report content|Content]]
 
|-
 
|-
−
|References||Conditional (use if references are provided)||Structural metadata, such as the Dublin Core element: Relation  
+
|[[document reference|References]]||Conditional (use if references are provided)||[[Structural metadata]], such as the [[Dublin Core]] element: Relation  
 
|-
 
|-
 
!rowspan="6"|Back Matter
 
!rowspan="6"|Back Matter
−
|Appendices||Conditional (include when needed to supplement Results and Discussion)||Structural metadata  
+
|[[document appendix|Appendices]]||Conditional (include when needed to supplement Results and Discussion)||[[Structural metadata]]
 
|-
 
|-
−
|Bibliography||Conditional (include when needed to amplify references)||Structural metadata
+
|[[document bibliography|Bibliography]]||Conditional (include when needed to amplify references)||[[Structural metadata]]
 
|-
 
|-
−
|List of Symbols, Abbreviations, and Acronyms||Conditional (include if symbols, abbreviations, or acronyms appear in any other component of the report; this section might appear as part of the front matter)||Structural metadata  
+
|[[Report token|List of Symbols, Abbreviations, and Acronyms]]||Conditional (include if symbols, abbreviations, or acronyms appear in any other component of the report; this section might appear as part of the front matter)||[[Structural metadata]]
 
|-
 
|-
−
|Glossary||Conditional (include if report incorporates terms unfamiliar to the intended audience)||Structural metadata  
+
|[[document glossary|Glossary]]||Conditional (include if report incorporates terms unfamiliar to the intended audience)||[[Structural metadata]]
 
|-
 
|-
−
|Index||Conditional (include when needed to ensure that a user locates all references to a concept)||Structural metadata  
+
|[[document index|Index]]||Conditional (include when needed to ensure that a user locates all references to a concept)||[[Structural metadata]]
 
|-
 
|-
−
|Distribution List||Conditional (include when needed to control access)||Administrative metadata, such as the Dublin Core element: Rights Management
+
|[[distribution metadata|Distribution List]]||Conditional (include when needed to control access)||[[Administrative metadata]], such as the [[Dublin Core]] element: Rights Management
 
|}
 
|}
  
Line 176: Line 176:
 
:*background about, or a context for, reports; and  
 
:*background about, or a context for, reports; and  
 
:*lists for finding specific chapters, headings, figures, and tables.  
 
:*lists for finding specific chapters, headings, figures, and tables.  
−
:It also provides information needed for cataloging in bibliographic databases and digital libraries. A discussion of the purpose and scope of each element of front matter follows and suggests best practices for the location of such information.
+
:Front matter also provides information needed for cataloging in bibliographic databases and digital libraries. The ''Standard'' further discusses (1) '''[[Report cover|cover]]''', (2) '''[[Discovery metadata|title section]]''', (3) '''[[distribution metadata|notice of distribution and access restrictions]]''', (4) '''[[report format|format information]]''', (5) '''[[Discovery metadata|report documentation page]]''', (6) '''[[document abstract|abstract]]''', (7) '''[[table of contents|contents]]''', (8) '''[[content aid|list(s) of figures and tables]]''', (9) '''[[foreword]]''', (10) '''[[preface]]''', and (11) '''[[report acknowledgment|acknowledgments]]''' in details.
−
 
 
−
:;Cover
 
−
::Although considered an optional component, a cover provides physical protection for a print report and displays major metadata elements for resource discovery. Electronic versions of reports, especially in PDF, often include a cover to replicate the look of the print version. A cover identifies the report number, title, author(s), and any distribution limitations. If classified or proprietary information appears in a report, a notice on the cover indicates that such material is included. The best practices for including data elements of a report cover are as follows:
 
−
::*Report number (can also be on the back cover, or on both)
 
−
::*Report title and subtitle, if used (should be the same on the cover, title page, and report documentation page)
 
−
::*Title and numbering of series, if the report is issued in a series (can also be on the back cover, or both)
 
−
::*Author, principal investigator, editor, and/or compiler
 
−
::*Publisher (the organization that assumes responsibility for publication, which may or may not be the same as the sponsoring organization)
 
−
::*Date of publication (optional; can defer to the title page or to the copyright page)
 
−
::*Distribution limitations
 
−
::*Sponsoring organization of published research
 
−
::*A bar code or other indication of the International Standard Book Number (ISBN) or International Standard Serial Number (ISSN) and the price (optional). This information is usually included on the back cover of the report as well and may facilitate managing inventory.
 
−
::*Technical requirements (for example, video, audio, digital)
 
−
::*Subject
 
−
::Legal or policy considerations of the sponsoring organization may require using additional data elements.
 
−
 
 
−
:;Title Section
 
−
::The required title section indicates the subject and content of the report and provides information needed for description and bibliographic control of, and access to, a report.
 
−
::These data are critical to discover, acquire, store, and provide access to information resources. If the performing and sponsoring organizations are different entities, the title section clearly identifies the different responsibilities (that is, performance and sponsorship). The information in the cover and title section must be consistent; if an optional Report Documentation Page is used, its bibliographic data must also be consistent with the information in the cover and title section. The recommended data elements of a title section are as follows:
 
−
::*'''Report number'''. Each report requires a report number unique within the organization that appears in a consistent location for each document in a series. A report number is composed of an alphanumeric report code (2-16 characters) and, if desired, a numeric sequential group (1-14 digits indicating the year and sequence of report issuance). Different sponsoring and performing organizations usually assign separate report numbers; so a report may have multiple numbers. These numbers should appear together in a prominent location in the front matter. ANSI/NISO Z39.23-1997 (R2002), Standard Technical Report Number (STRN) Format and Creation, provides guidance on establishing and using standard scientific and technical report numbers.
 
−
::*Report title and subtitle, if used (should be the same on the cover, title page, and report documentation page)
 
−
::*Title and numbering of series, if the report is issued in a series
 
−
::*Author, principal investigator, editor, and/or compiler, with the primary creator listed first, per standard library cataloging practice
 
−
::*Performing organization (author/creator affiliation)
 
−
::*Publication data, including place of publication, publisher (which may or may not be the same as the sponsoring organization), and date (may also defer to the copyright page)
 
−
::*Type of report and period covered, where applicable (conditional)
 
−
::*Contract or grant number, where applicable (may defer to the copyright page)
 
−
::*Sponsoring or issuing organization (if different than the performing organization)
 
−
::*Subject descriptors (e.g., keywords)
 
−
 
 
−
 
 
−
5.1.2.2 Title and Subtitle
 
−
 
 
−
The title is especially important in abstracting, cataloging, indexing, and referencing a report
 
−
and for informing potential readers of the content. A subtitle may be added to further define
 
−
the contents. The words of the title and subtitle define and limit the topic of the report and
 
−
appear on the cover, title section, and optional Report Documentation Page, using exactly the
 
−
same wording. In creating the title of a report, a creator using best practices:
 
−
 
 
−
• selects words that distinguish the report from any other on the same general topic rather
 
−
than writing, “Report on...”
 
−
 
 
−
• uses a distinctive subtitle for clarity if the report is one in a series or a supplement to
 
−
previously published work (information about the period covered—for example, month,
 
−
quarter, or year—may be included in the subtitle of reports in series); and
 
−
 
 
−
• spells out abbreviations and acronyms.
 
−
 
 
−
When a report consists of more than one volume (or binding), the title is repeated in a
 
−
separate title section, and each separate volume is identified by an Arabic number and a
 
−
volume title or subtitle.
 
−
 
 
−
Example:
 
−
 
 
−
Interstellar and Interplanetary Dust
 
−
Volume 2: Supernova Isotopic Enrichments
 
−
 
 
−
 
 
−
5.1.2.3 Author(s) / Creator(s)
 
−
 
 
−
The author/creator of a report is reserved for the person or persons responsible for
 
−
originating the scientific or technical information or the text of the report and who can
 
−
effectively defend the content of the report to a peer group. The primary author/creator is
 
−
always identified first. Identifying an editor is justified when the editor has applied subject
 
−
matter expertise in preparing the report.
 
−
 
 
−
An author’s/creator’s name appears on the cover (see 5.1.1) and title section (see 5.1.2) and,
 
−
if used, the Report Documentation Page in identical form. The preferred order is first name,
 
−
middle name or initial, surname. Academic degrees are not given. However, authors/creators
 
−
or contributors can identify themselves by their job titles in the organization (Jane R. Doe,
 
−
Cost Analyst; Jack T. Doe, Head, Research and Development Division) or by their functions
 
−
as contributors (Jane R. Doe, Principal Investigator; JackT. Doe, Compiler). If these titles are
 
−
used, they should be used consistently within an organization or series. In cases of multiple
 
−
authors/creators from different organizations, the names appear with their organizational
 
−
affiliations.
 
−
 
 
−
 
 
−
 
 
−
5.1.2.4 Performing and Sponsoring Organizations
 
−
 
 
−
The performing organization conducts research; the sponsoring organization funds research
 
−
and usually, but not always, controls report publication and distribution. The performing and
 
−
sponsoring organization may be the same. Reports that present the results of research done
 
−
under contracts or grants identify both a performing and a sponsoring organization if different.
 
−
In such cases, the name of the sponsoring organization, the performing organization (or other
 
−
responsible units), and the complete address(es) appear on the title section. If there are
 
−
multiple sponsoring organizations, each is listed and the functions of each are identified.
 
−
 
 
−
:;Notice of Distribution/Access Restrictions
 
−
 
 
−
5.1.3.1 Copyright
 
−
 
 
−
Some organizations may opt to use a traditional copyright page common within the publishing
 
−
industry. The copyright section may include the following information, if available:
 
−
 
 
−
• The complete name of the sponsoring organization, including the contract number
 
−
authorizing the research, and/or any organizations providing funding for the report  
 
−
 
 
−
• Library of Congress Cataloging-in-Publication (CIP) Data
 
−
 
 
−
• An ISBN and/or ISSN
 
−
 
 
−
• The country in which the report was produced
 
−
 
 
−
• Permission for use of proprietary information, such as photo credits
 
−
 
 
−
• The mission statement of the producer, trademark information, and any disclaimers from
 
−
the producer
 
−
 
 
−
• A copyright symbol, year, and the name of the copyright holder
 
−
 
 
−
• Authority to copy the contents or require permission from the producer prior to copying.
 
−
While federal government publications may be freely copied by the public, a request for
 
−
permission allows the publisher to track the uses of the report.
 
−
 
 
−
• The name, complete address, and phone number of the producer and how additional
 
−
copies of the report may be obtained; a Web or email address, or both, may be included.
 
−
Copyrights on reports are not always formally registered; material prepared for the U.S.
 
−
Government is usually available for public dissemination without copyright.
 
−
 
 
−
The order of appearance is not important so long as all elements appear. The recommended
 
−
location is the verso (back) of the title page. If these elements are included on the copyright
 
−
page, it is at the discretion of the publisher if they are included in other sections of the front
 
−
matter.
 
−
 
 
−
5.1.3.2 Distribution Limitations / Notices
 
−
 
 
−
When necessary to call attention to certain aspects of a report, such as its security
 
−
classification, restricted distribution, or proprietary information, appropriate notices appear on
 
−
the cover and title section. For example, a notice may alert the reader that a particular report
 
−
is:
 
−
 
 
−
 
 
−
• a presentation of preliminary findings subject to revisions, or
 
−
 
 
−
• a formal draft or a working paper intended to elicit comments and ideas.
 
−
 
 
−
If disclaimers or similar notices are needed, they appear on the inside front cover or the
 
−
optional copyright page that follows the title page of a printed report. Notices may also alert
 
−
the reader to certain legal conditions, for example, using brand or trade names in the report.
 
−
 
 
−
 
 
−
Generic terms are preferable to brand or trade names if scientific and technical accuracy can
 
−
be maintained in using them.
 
−
 
 
−
A disclaimer may or may not be appropriate for government-generated reports. It is the
 
−
responsibility of each organization to determine the appropriate notice for the reports it
 
−
produces and to coordinate these decisions with the appropriate legal counsel. Government
 
−
classified material will have specific regulations; producers should follow the regulations
 
−
applicable to their government agency.
 
−
 
 
−
 
 
−
5.1.4 Format Information
 
−
 
 
−
Reports produced in digital format should provide easily-accessible metadata describing the
 
−
programs used in producing the report. Creators of reports should also consider the original
 
−
and on-going accessibility of items requiring unique or specialized hardware or software not
 
−
normally used by their primary audience.
 
−
 
 
−
5.1.5 Report Documentation Page
 
−
 
 
−
Agencies within the federal government use a Report Documentation Page (e.g., a National
 
−
Technical Information Service bibliographic data sheet or Standard Form 298) in addition to a
 
−
title section. It is an optional component for academic and industrial reports.
 
−
 
 
−
Appendix E shows a sample Report Documentation Page containing all pertinent
 
−
bibliographic data about the report (including keywords or identifiers) necessary for librarians,
 
−
information specialists, and others concerned with information processing and handling. An
 
−
abstract of 200 words or fewer is an integral part of this section. Some federal agencies
 
−
require that reports prepared for them under contract or grant include a Report
 
−
Documentation Page and specify its location. Academic and industrial report producers that
 
−
use a report documentation page frequently place it as the final component of back matter. A
 
−
Report Documentation Page is not listed in the table of contents unless it appears as back
 
−
matter; however, it is paginated whether it appears as front or back matter. Instructions for
 
−
completing a report documentation page appear in Appendix E of the ''Standard''.
 
−
 
 
−
5.1.6 Abstract
 
−
 
 
−
An abstract, a required component, presents a concise (approximately 200 words, although
 
−
the length may vary; there may be restrictions in some automated databases) informative
 
−
statement of the purpose, scope, methods, and major findings of the report, including results,
 
−
conclusions, and recommendations. The informative abstract retains the tone and scope of
 
−
the report but omits the details. The abstract typically appears in a separate section between
 
−
the title section and table of contents, although reports that use a Report Documentation
 
−
Page include the abstract as bibliographic data entered on the form. Because abstracts are
 
−
also published by abstracting services to assist potential readers in determining if they are
 
−
interested in the report, an abstract is independent of the rest of the report. An abstract  
 
−
contains no undefined symbols, abbreviations, or acronyms and makes no reference to
 
−
references or illustrative material. ANSI/NISO Z39.14-1997 (R2002), Guidelines for Abstracts,
 
−
the ''Standard'' for preparing informative abstracts, provides examples of abstracts as well as
 
−
guidance on their presentation and style.
 
−
 
 
−
An executive summary (see 5.2.1) may be used as an alternative to an abstract and includes
 
−
information similar to an abstract, but in slightly more detail. An executive summary should
 
−
not exceed 10 pages, dependent on the length of the report.
 
−
 
 
−
5.1.7 Contents
 
−
 
 
−
The required contents section identifies the heading and location of, or link to, each major
 
−
section of the front matter (excluding the title page and the contents section itself), the
 
−
content, and the back matter. A contents section helps readers understand the organization
 
−
and scope of a report. Headings in a table of contents are worded, spelled, punctuated, and
 
−
numbered, if used, exactly as they are in the report. Creators should consider that page
 
−
 
 
−
 
 
−
numbers of digital items may not be static and alternate methods of efficient access may be
 
−
needed. Figure 6 shows a sample contents section.
 
−
 
 
−
 
 
−
Contents
 
−
 
 
−
Abstract .iii
 
−
 
 
−
Figures.vi
 
−
 
 
−
Tables.vii
 
−
 
 
−
Foreword.viii
 
−
 
 
−
Preface.ix
 
−
 
 
−
Summary.2
 
−
 
 
−
Introduction.5
 
−
 
 
−
Methods, Assumptions, and Procedures.6
 
−
 
 
−
Electrofishing.7
 
−
 
 
−
Sample Preparation.8  
 
−
 
 
−
Water Analysis.9
 
−
 
 
−
Statistics.10
 
−
 
 
−
Site Description .11
 
−
 
 
−
RM 38.11
 
−
 
 
−
RM 24.12
 
−
 
 
−
RM 19.12
 
−
 
 
−
Results and Discussion.13
 
−
 
 
−
Physical and Chemical Parameters.13
 
−
 
 
−
Fish Parameters.17
 
−
 
 
−
Species Richness .17
 
−
 
 
−
Species Diversity Indices .19
 
−
 
 
−
Weight/Length Distributions.21
 
−
 
 
−
Sampling Adequacy.23
 
−
 
 
−
Conclusions.25
 
−
 
 
−
Recommendations.27
 
−
 
 
−
References.29
 
−
 
 
−
Appendix: Weekly Fish Collection Data.31
 
−
 
 
−
Symbols, Abbreviations, and Acronyms.43
 
−
 
 
−
Glossary.45
 
−
 
 
−
 
 
−
Figure 6: Sample table of contents section
 
−
 
 
−
It is useful to include a list of subheadings in the contents section at the beginning of each
 
−
major report section that is more than 20 pages in length. Subheadings are also helpful for
 
−
understanding complex material; however, not all levels of headings need to be listed in the
 
−
contents section. First- and second-level headings may suffice. However, if any subheading
 
−
of a given level is listed in the table of contents, all subheadings of that level must be
 
−
included. (See also 6.4, Designation, for an explanation of page numbering.) Organizations
 
−
may opt for a variation in the order of the table of contents. For instance, a preface may
 
−
follow the title page to set the context of the report and precede the table on contents.
 
−
 
 
−
5.1.8 List(s) of Figures and Tables
 
−
 
 
−
If a report contains more than five figures or tables, or some combination totaling more than
 
−
five, a list of figures and/or tables is required. If a report contains fewer than five figures or
 
−
tables, a list is optional. Figures and tables in the table of contents are numbered, worded,
 
−
spelled, and punctuated exactly as they are in the report. The lists of figures and tables, titled
 
−
“Figures” and “Tables,” respectively, follow the contents section. If the table of contents fills
 
−
only half a page, the lists of figures and tables may follow the table of contents on the same
 
−
 
 
−
 
 
−
page. If lists of figures and tables are included in a report, all figures and tables are listed with
 
−
their corresponding locations. A list of figures precedes a list of tables. If a report has many
 
−
figures and few tables or few figures and many tables, they can be combined into a single list
 
−
(“Figures and Tables”) with figures preceding tables.
 
−
 
 
−
5.1.9 Foreword
 
−
 
 
−
The foreword is a conditional introductory statement that presents background material or
 
−
places in context a report that is part of a series. It is written by an authority in the field other
 
−
than the creator of the report. The name and affiliation of the creator of the foreword follow
 
−
the last paragraph. A foreword and a preface are not interchangeable, and the information in
 
−
them is not redundant. If both are included, the foreword precedes the preface.
 
−
 
 
−
5.1.10 Preface
 
−
 
 
−
A preface is a conditional introductory statement that announces the purpose and scope of
 
−
the report and acknowledges the contributions of individuals not identified as authors/creators
 
−
or editors. Sometimes a preface specifies the audience for which a report is intended; it may
 
−
also highlight the relationship of the report to a specific project or program. Material that is
 
−
necessary for understanding the report belongs in the introduction not the preface.
 
−
 
 
−
A preface is usually written by the author/creator, editor, or other party responsible for the
 
−
report. The name and affiliation do not appear at the end of the preface unless there might be
 
−
doubt about its authorship. The preface follows the lists of figures and tables and optional
 
−
foreword and begins a separate section titled “Preface.”
 
−
 
 
−
5.1.11 Acknowledgments
 
−
 
 
−
Acknowledgments of technical assistance that contributed to the content of the report are
 
−
made at an appropriate place in the preface or in the text; however, lengthy
 
−
acknowledgments are often made in a conditional section titled “Acknowledgments.” This
 
−
section follows the preface, in which case the preface does not contain acknowledgments. If
 
−
there is no preface, “Acknowledgments” follows the contents section (or list(s) of figures and
 
−
tables and foreword).
 
  
 
===Body Matter===
 
===Body Matter===
 +
:The body is the part of the report in which the creator describes methods, assumptions, and procedures, then presents and discusses the results and draws conclusions and recommends actions based on those results. The organization of a report depends on its subject matter and audience as well as its purpose. (See Appendix D for sample organizational models.) Thus, the organization of the content may vary widely and the organization of the report may be divided into sections or chapters. Information on the content follows.
  
−
The body is the part of the report in which the creator describes methods, assumptions, and
+
:The ''Standard'' further discusses (1) '''[[document summary|summary]]''', (2) '''[[Report stage-setting section|introduction]]''', (3) '''[[Report undertaking section|methods, assumptions, and procedures]]''', (4) '''[[Report finding|results and discussion]]''', (5) '''[[Report interpretation|conclusions]]''', (6) '''[[report recommendation|recommendations]]''', and (7) '''[[document reference|references]]''' in details.
−
procedures, then presents and discusses the results and draws conclusions and
 
−
recommends actions based on those results. The organization of a report depends on its
 
−
subject matter and audience as well as its purpose. (See Appendix D for sample
 
−
organizational models.) Thus, the organization of the content may vary widely and the
 
−
organization of the report may be divided into sections or chapters. Information on the
 
−
content follows.
 
−
 
 
−
5.2.1 Summary
 
−
 
 
−
A summary is a required component of a report. It clearly states the key points of the report—
 
−
including the problem under investigation, the principal results and conclusions, and a
 
−
recommended course of action for decision makers. The summary differs from the abstract
 
−
(see 5.1.6) in purpose, audience, and length. Because the summary restates key points,
 
−
material not included in the text does not appear in the summary. Introductory material
 
−
 
 
−
 
 
−
(purpose, scope, and organization), descriptive material (nature and method of investigation),
 
−
and the most important results and conclusions are summarized, with emphasis on the
 
−
findings of the research and recommendations.
 
−
 
 
−
Although a summary depends on the content in that it introduces no new information, it is
 
−
independent from the user’s point of view; therefore, all symbols, abbreviations, and
 
−
acronyms are defined, and unusual terms are explained. A summary does not contain
 
−
references or cross-references to other sections of the report.
 
−
 
 
−
If a print report exceeds 50 pages, a separate executive summary is often prepared for a
 
−
management-level audience. An Executive Summary is a non-technical presentation that
 
−
provides an adequate level of detail for decision makers needing a basic understanding of a
 
−
research problem and the major findings but who do not plan to read the report in its entirety.
 
−
Some Executive Summaries contain fiscal and political implications of the recommendations
 
−
or results; such indications are frequently not a part of the report. Some organizations may
 
−
opt to place the summary as the last component of the front matter instead of the first
 
−
component of the text.
 
−
 
 
−
5.2.2 Introduction
 
−
 
 
−
The required introduction provides readers with general information they need to understand
 
−
more detailed information in the rest of the report. It introduces the subject, purpose, scope,  
 
−
and way the author/creator plans to develop the topic. The introduction also indicates the
 
−
audience for the report: who is expected to read it and act on its recommendations or review
 
−
its findings (this information may also be included in the preface). The introduction does not,
 
−
however, include findings, conclusions, or recommendations.
 
−
 
 
−
The statement of the subject defines the topic and associated terminology and may include
 
−
the theory behind the subject, its historical background, its significance, and a review of
 
−
pertinent literature. The statement of the purpose indicates the reason for the investigation;
 
−
the statement of the scope indicates the extent and limits of the investigation. The
 
−
author/creator’s plan for developing the report usually presents a narrative outline of the
 
−
body.
 
−
 
 
−
5.2.3 Methods, Assumptions, and Procedures
 
−
 
 
−
A description of the methods, assumptions, and procedures used in an investigation is a
 
−
required component. A succinct explanation of them enables readers to evaluate the results
 
−
without referring extensively to the references. The description should be complete enough
 
−
that a knowledgeable reader could duplicate the procedures of the investigation. The system
 
−
of measurement (for example, metric or English) is identified. If the research included
 
−
apparatus, instruments, or reagents, a description of the apparatus, the design and precision
 
−
of the instruments, and the nature of the reagents are explained in this required section of
 
−
text. (See also 6.5, Units and Numbers.)  
 
−
 
 
−
5.2.4 Results and Discussion
 
−
 
 
−
A required component of the report, results and their discussion can be presented in the
 
−
same or in separate sections. The results section presents the findings based on the
 
−
methods. The discussion section indicates the degree of accuracy and the significance of the
 
−
results of the research described. Specific values used to substantiate conclusions appear in
 
−
the body. Supporting details not essential to an understanding of the results appear in an
 
−
appendix. Sometimes a section, “Presentation of Results,” includes figures and tables and
 
−
 
 
−
 
 
−
 
 
−
their captions (titles). Such figures and tables appear as close as possible following their
 
−
discussion in the text. The discussion accounts for the results but does not interpret them.
 
−
(See also 6.2, Visual and Tabular Matter.)  
 
−
 
 
−
5.2.5 Conclusions
 
−
 
 
−
The required conclusions section interprets findings that have been substantiated in the
 
−
discussion of results and discusses their implications. The section introduces no new material
 
−
other than remarks based on these findings. It includes the author’s/creator’s opinions and is
 
−
written to be read independently of the text. The section could include a summary of the
 
−
conclusions from similar studies, a conclusion based solely on the current results, or an
 
−
overall conclusion. The following examples could be appropriate titles for this section:
 
−
 
 
−
• Conclusions - if deductions independent of specific conditions of the investigation are
 
−
made
 
−
 
 
−
• Restatement of Results - if factual findings specific to the particular investigation are
 
−
given
 
−
 
 
−
• Concluding Remarks - if opinions are included in addition to findings and conclusions
 
−
 
 
−
5.2.6 Recommendations
 
−
 
 
−
The conditional recommendations section presents a course of action based on the results
 
−
and conclusions of the study. Types of studies for which recommendations are often made
 
−
include tests and experiments, field trials, specific design problems, feasibility studies, and  
 
−
market appraisals. Recommendations might include additional areas for study, alternate
 
−
design approaches, or production decisions. Specific recommendations are presented in a
 
−
numbered or bulleted list that is introduced by an informative lead-in sentence.
 
−
Recommendations may also be included within the conclusions section.
 
−
 
 
−
5.2.7 References
 
−
 
 
−
The conditional references section, if used, appears as the last section of the body and
 
−
begins on a new page in print publications. This section may also be called “Sources,”
 
−
 
 
−
“Works Cited,” or “Bibliography,” depending on the nature of the referenced materials.
 
−
 
 
−
To help readers use and assess referenced materials, all references include the following
 
−
elements: name of author(s)/creator(s), title of referenced work, and publication data or
 
−
digital-access information. If a government document is referenced, the National Technical
 
−
Information Service (NTIS) number is included, when available, to facilitate user access to
 
−
the report.
 
−
 
 
−
References are prepared according to the accepted practice of the discipline of the primary
 
−
author/creator of a report. (See also Appendix A.3, Style Manuals and Guides.) Three basic
 
−
reference forms, each with its own advantage, are commonly used for reports. The number-
 
−
identification system of citing material allows readers to locate references easily in a printed
 
−
document. For this form, references are numbered consecutively with Arabic numbers in
 
−
order of their first appearance in the text keyed to appropriate places in the text and fully
 
−
identified in the successively numbered list of references.
 
−
 
 
−
In the second form of referencing, the author-date format, authors’ names, and dates of
 
−
publication or creation are cited in the text in parentheses and keyed to an alphabetically
 
−
arranged list of references. The author-date style helps readers to associate facts and ideas
 
−
with their originators and date of origin.
 
−
 
 
−
 
 
−
 
 
−
In the third form of referencing, publications may be noted in the context of a footnote,
 
−
endnote, or referenced link within a report and the complete bibliographic reference, which
 
−
can also include the title, author/creator, publisher, date, and location of the publisher,
 
−
including specific page numbers with a document (for example, a journal article), may be
 
−
included in the back matter in a bibliography.
 
−
 
 
−
If figures and tables are obtained from referenced material, the sources are identified in
 
−
source or credit lines that are part of the figure(s) or table(s). A source or credit line contains
 
−
adequate descriptive data to enable readers to verify the location of the original figure(s) or
 
−
table(s). If the figure or table is used in its complete presentation (that is, both content and
 
−
form), “Source” would be an appropriate lead-in to the citation. If either the content or form is
 
−
modified, “Adapted from” would be appropriate lead-in wording. Such sources are not further
 
−
identified in the list of references unless an additional reference to them appears in the text of
 
−
the report. (See also 6.2, Visual and Tabular Matter.)
 
−
 
 
−
References may include information gathered from a Web page or site. Most citations of
 
−
material from Internet sources should follow rules for journal articles.
 
−
 
 
−
Example:
 
−
 
 
−
Virillio, Paul, "Speed and Information: Cyberspace Alarm!" CTHEORY,
 
−
 
 
−
URL: http://www.freedonia.com/ctheory/, September 27, 1995.
 
−
 
 
−
The URL or other path information appears instead of the volume and number cited for a
 
−
conventional journal. It is frequently useful to the reader to know the date when the material
 
−
was accessed. In such cases, “Accessed [date]” would be appropriate wording.
 
−
 
 
−
Examples:
 
−
 
 
−
Bailey, C. W., "Electronic Serials and Related Topics: A Brief Discourse,"
 
−
 
 
−
message to multiple recipients of list VPIEJ-L (VPIEJ-L@VTVM1 .BITNET), April 23, 1992.
 
−
 
 
−
Carlyle, Paul, "Do Electronic Journals Make Sense?" message distributed on Internet
 
−
by Paul Carlyle, RAND, June 1995 (e-mail carlyle@rand.org).
 
−
 
 
−
For other views on game theory, see Sadim Adan,
 
−
http://www.unkx.com/xxx.yyy, last modified September 19, 1995.
 
−
 
 
−
Accessed November 17, 1999.  
 
−
 
 
  
 
===Back Matter===
 
===Back Matter===
 +
:The back matter supplements and clarifies the body of the report (for example, appendices), makes the body easier to use (for example, glossary, lists of symbols, abbreviations and acronyms, and index), and shows where additional information can be found (for example, bibliography). Some organizations consider the reference section to be part of the back matter; if the pages following the front matter are numbered sequentially, it is immaterial to the reader if the reference or bibliography section is part of the body or the back matter.
  
−
The back matter supplements and clarifies the body of the report (for example, appendices),
+
:The ''Standard'' further discusses (1) '''[[document appendix|appendices]]''', (2) '''[[document bibliography|bibliography]]''', (3) '''[[report token|list(s) of symbols, abbreviations, and acronyms]]''', (4) '''[[document glossary|glossary]]''', (5) '''[[document index|index]]''', and (6) '''[[distribution metadata|distribution list]]''' in details.
−
makes the body easier to use (for example, glossary, lists of symbols, abbreviations and
 
−
acronyms, and index), and shows where additional information can be found (for example,
 
−
bibliography). Some organizations consider the reference section to be part of the back
 
−
matter; if the pages following the front matter are numbered sequentially, it is immaterial to
 
−
the reader if the reference or bibliography section is part of the body or the back matter.
 
−
 
 
−
5.3.1 Appendices
 
−
 
 
−
Appendices contain information that supplements, clarifies, or supports the content. These
 
−
conditional components of back matter also contain material that might otherwise interfere
 
−
with an orderly presentation of ideas in the body. Placing detailed explanations, supporting
 
−
data, or long mathematical analyses in appendices shortens the text and makes it easier to
 
−
 
 
−
 
 
−
 
 
−
 
 
−
read. However, information essential to the purpose of the report should appear in the text.
 
−
For example, in a report about a new mathematical analysis, the detailed derivation of
 
−
equations belongs in the text, while other subjects, such as those that follow, appear in
 
−
appendices:
 
−
 
 
−
• Detailed explanations and descriptions of test techniques and apparatus
 
−
 
 
−
• Content of other documents (for example, standard test procedures, laws, and
 
−
management instructions)  
 
−
 
 
−
• Extensive data in the form of figures or tables
 
−
 
 
−
• Computer listings of programs, input, and output
 
−
 
 
−
• Mathematical analyses
 
−
 
 
−
Other components of back matter (for example, bibliographies) do not appear in appendices.
 
−
 
 
−
Appendices usually follow the references or last section of the text. For print publications,
 
−
each appendix begins on a new, right-hand page and has a title that appears below the
 
−
appendix designation.
 
−
 
 
−
Example:
 
−
 
 
−
Appendix B
 
−
 
 
−
Complementary Energy Principle
 
−
 
 
−
Each appendix is referred to in the text. If the report contains more than one appendix, each
 
−
is identified with a capital letter (Appendix A, Appendix B, etc.) in the order mentioned in the
 
−
report. A single appendix is labeled, “Appendix.” Similar items may be combined to avoid
 
−
creating unnecessary appendices. For example, several sample forms can be combined in a
 
−
single appendix and labeled “Sample Forms” rather than each being identified as a separate
 
−
appendix.
 
−
 
 
−
Although figures and tables are best integrated into the text following their initial mention,
 
−
figures, tables, or other graphics of secondary importance that provide back-up data should
 
−
be combined into an appendix. In appendices, figures precede tables, with both groups
 
−
arranged in numerical sequence.
 
−
 
 
−
5.3.2 Bibliography
 
−
 
 
−
A conditional section, a bibliography lists additional sources of information not referenced in
 
−
the text. If a bibliography is included in addition to the list of references (part of the text), the
 
−
bibliography follows the appendix(es). A bibliography is unnecessary if the references in the
 
−
text constitute a complete list of sources of information. Bibliographic entries are usually
 
−
arranged alphabetically by author/creator, but any logical order may be used if it is explained
 
−
and is consistent. In print publications (or electronic reports that maintain the "page" look and
 
−
feel), the bibliography section begins on a new page and is titled, “Bibliography.”
 
−
 
 
−
5.3.3 List(s) of Symbols, Abbreviations, and Acronyms
 
−
 
 
−
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.
 
−
 
 
−
5.3.4 Glossary
 
−
 
 
−
A conditional section, the glossary is a list of terms defined and explained to facilitate a
 
−
reader’s comprehension of the report when numerous terms requiring definition are used.
 
−
 
 
−
The glossary is part of the back matter, and glossary terms may also be defined at their first
 
−
mention. Glossary terms are arranged in alphabetical order with each on a separate line
 
−
followed by its definition. The glossary section, titled “Glossary,” begins on a new page in
 
−
print publications. Some organizations may include this section as part of the front matter to
 
−
ensure that the reader is quickly aware of its existence.
 
−
 
 
−
5.3.5 Index
 
−
 
 
−
An index is an alphabetical listing of all major topics discussed in a report. An index is
 
−
optional in short reports (fewer than 50 print pages), but reports of 50 pages or more usually
 
−
contain one to help readers locate specific information. An index entry cites the page or
 
−
location where the topic can be found, affording readers quick reference on a particular topic.
 
−
An index may identify and locate information, indicate its nature and scope, identify related
 
−
entries, and clarify relationships between entries. The arrangement and level of detail of the
 
−
index are determined by the structure of the report, its target audience, and its anticipated
 
−
uses.
 
−
 
 
−
The most common type of index for a report is the subject index in which subjects are
 
−
presented alphabetically. Other types of indexes (for example, name index, number, and
 
−
code index) may also be used. They are placed before the subject index in the back matter.
 
−
 
 
−
In preparing an index, the number and kind of access points (entry locations) and the
 
−
information level of indexable matter (for example, abstract or concrete) are determined.
 
−
 
 
−
Each index entry has a heading (first element) and a locator (page, section number, or linking
 
−
information) where information about the entry is found. Terms used as report headings are
 
−
included in the index. The index contains all terms likely to be sought by the intended
 
−
audience.
 
−
 
 
−
5.3.6 Distribution List
 
−
 
 
−
If included, the distribution list follows the index (or glossary, if there is no index). The list
 
−
indicates the complete mailing address of the individuals and organizations receiving copies
 
−
of the report and the number of copies received. The Privacy Act of 1974 forbids federal
 
−
agencies from listing the names and home addresses of individuals, so in a government
 
−
report a distribution list contains business addresses only. Distribution lists provide a
 
−
permanent record of initial distribution. In the case of classified reports, restricted-distribution
 
−
reports, and reports containing proprietary data, such lists are extremely valuable as they can
 
−
be used later for communicating instructions regarding handling and classification
 
−
downgrading. A distribution list is also useful if errata are discovered and changes are issued
 
−
to correct a report. (See also 6.12, Errata.)
 
  
 
==Presentation and Display==
 
==Presentation and Display==
−
 
+
This section discusses standard methods for ensuring consistency in presentation: designing visual and tabular matter; formatting; presenting units, numbers, formulas, and equations; incorporating footnotes, endnotes, references, and bibliographic entries; preparing [[report token|lists of symbols, abbreviations, and acronyms]]; formatting glossaries and indexes; and correcting errata after publication. Within each subsection, a distinction is made between rules applicable to all reports regardless of mode of publication (e.g., paper or Web) and rules applicable to reports published in paper form.  
−
 
 
−
This section discusses standard methods for ensuring consistency in presentation: designing  
 
−
visual and tabular matter; formatting; presenting units, numbers, formulas, and equations;  
 
−
incorporating footnotes, endnotes, references, and bibliographic entries; preparing lists of  
 
−
symbols, abbreviations, and acronyms; formatting glossaries and indexes; and correcting  
 
−
errata after publication. Within each subsection, a distinction is made between rules  
 
−
applicable to all reports regardless of mode of publication (e.g., paper, CD-ROM, or Web)  
 
−
and rules applicable to reports published in paper form.  
 
−
 
 
  
 
===Subordination===  
 
===Subordination===  
 +
:;General
 +
::Indicate subordination of ideas by using headings and subheadings to divide the report into manageable sections, call attention to main topics, and signal changes in topics. Most reports require no more than five levels of headings.
  
−
6.1.1 General
+
::Consistency of presentation is important in showing subordinate relationships. Many reports use a decimal numbering system to show relationships and to simplify extensive cross-referencing. An alternate format for subordination uses a progression of fonts. Indicate headings and subheadings by bold font with initial capital letters for principal words. Indicate primary headings by using a larger font than that used for non-primary headings. Align primary and secondary headings flush with the left column of text and run in other headings with indented text.  
−
 
 
−
Indicate subordination of ideas by using headings and subheadings to divide the report into
 
−
manageable sections, call attention to main topics, and signal changes in topics. Most reports
 
−
require no more than five levels of headings.
 
−
 
 
−
Consistency of presentation is important in showing subordinate relationships. Many reports  
 
−
use a decimal numbering system to show relationships and to simplify extensive cross-  
 
−
referencing. An alternate format for subordination uses a progression of fonts. Indicate  
 
−
headings and subheadings by bold font with initial capital letters for principal words. Indicate  
 
−
primary headings by using a larger font than that used for non-primary headings. Align  
 
−
primary and secondary headings flush with the left column of text and run in other headings  
 
−
with indented text.  
 
−
 
 
−
6.1.2 Print-Specific Guidelines
 
−
 
 
−
Begin each major section on a new page.
 
−
 
 
−
6.1.3 Non-Print-Specific
 
  
−
In the digital environment, delineate sections in a way that is easy to understand and access,
+
:;Print-Specific Guidelines
−
with full links included as required.  
+
::Begin each major section on a new page.  
  
−
 
+
:;Non-Print-Specific  
−
6.2 Visual and Tabular Matter
+
::In the digital environment, delineate sections in a way that is easy to understand and access, with full links included as required.
−
6.2.1 General
 
−
 
 
−
Many of the data in reports are presented in figures and tables as well as in the text. Figures
 
−
provide visual representations in the form of graphs, line drawings, diagrams, photographs,
 
−
etc. Tables arrange large amounts of quantitative data in an ordered space. Follow these
 
−
guidelines to ensure that figures and tables are effectively integrated with the text of a report:  
 
−
 
 
−
• Mention each figure and/or table in the text.
 
−
 
 
−
• Locate each figure or table near, but never before, its first mention in the text of print
 
−
reports. Provide an interior link between the mention of a figure or table and its place in a
 
−
digital document if not on the same screen as the text.
 
−
 
 
−
• If a figure or table is central to the comprehension of the text, include it in the text. If
 
−
 
 
−
 
 
−
 
 
−
figures or tables provide only supplementary information, place them in an appendix (see
 
−
also 5.3.1). Mention any material in an appendix in the text; otherwise it lacks context.
 
−
 
 
−
• Ensure that the amount of text discussion associated with each figure or table adequately
 
−
reflects its importance to the report, the level of complexity of the information illustrated or
 
−
tabulated, and the level of knowledge of anticipated readers. Figure legends can be used
 
−
to provide further explanation.
 
−
 
 
−
• Number figures in the text with consecutive Arabic numbers (for example, Figure 1,
 
−
 
 
−
Figure 2). Number those pertaining only to appendices consecutively for each appendix
 
−
(for example, Figure A1, Figure A2, Figure B1). Number tables consecutively and
 
−
independently of figures, with Arabic numbers (for example, Table 1, Table 2,...Table 8).
 
−
 
 
−
If an appendix contains its own tables in addition to tables in the text, identify and number
 
−
the appendix tables consecutively after the text tables (for example, Table 22, Appendix
 
−
Table A1). If there is more than one appendix, begin table numbers again in each (for
 
−
example, Table A1, Table A2, Table B1, Table B2).
 
−
 
 
−
• Provide a descriptive title for figures and tables to aid in comprehension and to be used in
 
−
the front matter list of figures and tables.
 
−
 
 
−
6.2.1.1 Print-Specific Guidelines
 
−
 
 
−
Adopt vertical rather than horizontal orientation for figures and tables so they can be viewed
 
−
without turning a printed page sideways. If possible, redesign oversized figures or tables that
 
−
fold in to fit a standard 8-1/2 x 11-inch page with vertical orientation. If a figure or table cannot
 
−
be redesigned to fit on a page vertically, turn the image counterclockwise to fit the page. If a
 
−
figure or table cannot be reduced to fit a standard page, redesign it to fit two facing pages.
 
−
 
 
−
 
 
−
6.2.1.2 Non-Print-Specific  
 
−
 
 
−
If possible, format visual material so it can be viewed on a single screen at normal resolution,
 
−
taking into consideration the variations found in viewing items on the Web through different
 
−
browsers.
 
−
 
 
−
6.2.2 Figures
 
−
 
 
−
Figures (for example, graphs and charts, diagrams, photographs, schematic drawings, etc.)
 
−
play a significant role in presenting and clarifying technical ideas. (See also Appendix A.7,
 
−
Graphic Arts.) Normally, a figure should emphasize one main idea and show no more than is
 
−
necessary. Figures should have informative titles (captions) that summarize the figure and,
 
−
as needed, callouts that clearly and concisely identify each part. The figure number and title
 
−
should appear below the figure. The title describes the content without giving background
 
−
information, results, or comments about the figure. The placement and alignment of callouts
 
−
should be consistent within the report. Callouts are best placed horizontally and unboxed,
 
−
and straight lines (leaders) connect callouts to the part(s) identified in a figure. Any symbols,
 
−
abbreviations, or acronyms that appear in figures or tables but not in the text should be
 
−
explained in a key or defined in a caption. Identify footnotes to figures independently of text
 
−
footnotes using superscript, lowercase letters beginning with “a” in each figure. If using
 
−
lowercase letters leads to ambiguity, as with chemical or mathematical formulas, use a
 
−
sequence of symbols (*, t, t, §, ||, #, **, etc.). The type of figure used depends on the type of
 
−
information being presented: graphs show relationships among data; diagrams portray
 
−
relationships among components; photographs realistically depict general appearance; and
 
−
drawings emphasize essential elements and omit unnecessary details.
 
−
 
 
−
The purpose of a figure, its reproducibility, and convenience of location for report readers are
 
−
factors in preparation. Line art, original photographs, and digital image files are preferable for
 
−
 
 
−
 
 
−
 
 
−
reproduction. Color is often necessary for comprehension. If not, its use should be carefully
 
−
considered because of limited reproducibility as well as cost. Figure 7 shows an example of
 
−
color substitutes: screens, crosshatching, patterned lines or similar techniques are effective
 
−
substitutes for color.
 
−
 
 
−
 
 
−
□I WordFrame ■ WordPerfect
 
−
 
 
−
□ MakerTeX n IslandWrite
 
−
 
 
−
□ TeX □ All others
 
−
 
 
−
 
 
−
 
 
−
Software Use by Directorate
 
−
 
 
−
Figure 7: Example of graphic devices used as color substitutes
 
−
 
 
−
 
 
−
Gauge graphic techniques to viewing capabilities. Choose symbols, letters, and lines that are
 
−
legible at the lowest likely resolution used by readers. Position letters and numbers on graphs
 
−
and charts so they can be easily read from the bottom and right-hand side of the graphical
 
−
representation. When graphs represent trend curves, place tick marks along the axes to
 
−
indicate the required degree of approximation. If highly accurate readings are needed, use
 
−
grid lines (or, better, use a table). Crop and size photographs to show only significant details.
 
−
To ensure legibility, the minimum acceptable line weight for drawings is 8 points (3 mm). Do
 
−
not use graphic devices such as borders, frames, title blocks, and background tones unless
 
−
their use significantly improves clarity.
 
−
 
 
−
6.2.3 Tables
 
−
 
 
−
6.2.3.1 General
 
−
 
 
−
Tables present detailed facts or statistics concisely in row-and-column format. A formal table
 
−
has a table number and title placed above the data. The title describes the content without
 
−
giving background information, results, or comments about the table. The first principle words
 
−
of the title should reflect the content of the first column. The row head and column heads
 
−
identify the tabulated data that appear in the body or cells of the table.
 
−
 
 
−
Identify footnotes to tables independently of text footnotes using superscript, lowercase
 
−
letters beginning with “a” in each table. If using lowercase letters leads to ambiguity, as with
 
−
chemical or mathematical formulas, use a sequence of symbols (*, t, t, §, ||, #, **, etc.).
 
−
Assign footnote letters in left-to-right and top-to-bottom order; place footnotes below the
 
−
bottom line of the table. If a table or data in a table was obtained from a reference source,
 
−
 
 
−
 
 
−
 
 
−
 
 
−
include a source line that identifies the reference. (See also 5.2.7, References.) Figure 8
 
−
shows the parts of a table.
 
−
 
 
−
 
 
−
Table 3. Table Number and Title.
 
−
 
 
−
Stub Head
 
−
 
 
−
Column Head 3
 
−
 
 
−
Column Head b
 
−
 
 
−
Row Head
 
−
 
 
−
Data
 
−
 
 
−
Data
 
−
 
 
−
Data
 
−
 
 
−
 
 
−
Source Line:
 
−
 
 
−
3 Footnote to table appears here.
 
−
b Footnote to table appears here.
 
−
 
 
−
Figure 8: Nomenclature for the parts of a table
 
−
 
 
−
 
 
−
Indicate units of measurement in the table title, the column heads, or in a note. If presented in
 
−
the column heads, place units and symbols in parentheses and do not repeat them in the
 
−
columns. If data are unavailable for a particular cell, use a dash to fill the vacancy.
 
−
 
 
−
Use horizontal rules to separate a table from the title and row heading and column heads
 
−
from the body of the table. Use vertical rules to separate columns if needed to ease
 
−
reading/viewing of tabular material.
 
−
 
 
−
 
 
−
6.2.3.2 Print-Specific Guidelines
 
−
 
 
−
To enable print presentation of tables with multiple columns, it may be necessary to continue
 
−
tabular columns on successive pages. If adopting this approach, repeat the table number and
 
−
title, row head, and column head and note the continuation. Do not carry a table over unless
 
−
at least two rows or columns will be included. Do not display a row across more than one
 
−
page.
 
−
 
 
−
 
 
−
6.2.3.3 Non-Print-Specific
 
−
 
 
−
Format tables so they can be viewed on a single screen at normal resolution, taking into
 
−
consideration the variations found in viewing items on the Web through different browsers.
 
−
 
 
−
 
 
−
===Presentation Format===
 
−
 
 
−
The physical appearance of a report, both text and graphics, constitutes format. The goal of
 
−
any format is to enhance readability and comprehension by providing visual uniformity and a
 
−
consistent subordination of ideas. Decisions about report formats should be based on
 
−
principles of graphic design, keeping in mind format choices may be limited by contract
 
−
specifications, in-house requirements, or the equipment used for publication or display. (See
 
−
also Appendix A.7, Graphic Arts.)
 
−
 
 
−
 
 
−
6.3.1 General
 
−
 
 
−
6.3.1.1 Line Length
 
−
 
 
−
Ragged right margins make reading easier. Avoid excessively ragged right margins by using
 
−
a standard and a minimum line length. The minimum line length is 2 to 3 12-point characters
 
−
(8 to 13 mm) shorter than the standard line length. A line ends with the word falling nearest
 
−
the standard length, but does not exceed the standard length by more than two characters.
 
−
For example, a single column of text intended for continuous reading (as opposed to
 
−
reference material) may be presented in standard lines equivalent to 40 to 43 picas (169 to
 
−
182 mm) wide. To minimize ragged right margins, a recommended minimum line length is
 
−
equivalent to 38 picas (161 mm). If a report is presented in double-column format, the image
 
−
area includes the space necessary to separate the columns, 1 to 2 12-point characters (4 to
 
−
8 mm). A recommended minimum line length for double columns is 20 12-point characters
 
−
(85 mm) per column with 2 additional 12-point characters (8 mm) between each column, a
 
−
total of 42 12-point characters (178 mm).
 
−
 
 
−
6.3.1.2 Font Choice
 
−
 
 
−
A font size and style should be clearly legible.
 
−
 
 
−
For report text, including mathematical notations, a 10- or 12-point (4- or 5-mm) serif font is
 
−
the most comfortable font for readers. Smaller sizes can be used for non-text matter (for
 
−
example, footnotes and indexes); however, 8 points (3 mm) is the smallest acceptable size
 
−
for non-text matter.
 
−
 
 
−
The availability and appearance of specialized characters for symbols, formulas, and
 
−
equations are important considerations in selecting a font.
 
−
 
 
−
6.3.2 Print-Specific
 
−
 
 
−
6.3.2.1 Image Area
 
−
 
 
−
The space allotted on a page or screen for textual, visual, or tabular matter is the image area.
 
−
Observing a standard image area ensures the information on a page will not be lost during
 
−
printing and binding. The normal image area on U.S. standard paper that is 8-1/2 by 11
 
−
inches (216 by 279 mm) is 7-1/8 by 9-3/16 inches (182 by 233 mm) or, in type-setting
 
−
terminology, 43 by 55 picas. The image area includes headers and footers, if used, and page
 
−
numbers. For lead pages (for example, stand-alone material, such as the foreword or table of
 
−
contents, and the first page of a chapter) subtract 1 inch (25 mm) from the top of the image
 
−
area.
 
−
 
 
−
6.3.2.2 Margins
 
−
 
 
−
Margins set off the image area, which includes headers and footers. Although they are
 
−
proportional, margins are not equal on all sides. By printing convention, the top margin is the
 
−
narrowest, usually 1 inch (25 mm), and the outer margin is wider. The bottom margin is wider
 
−
than both top and outer margins. To accommodate binding, the inner or gutter margin is the
 
−
widest. The default margins for most word processing software observe these printing
 
−
conventions.
 
−
 
 
−
6.3.2.3 Paper and Ink
 
−
 
 
−
Use U.S. standard size (8-1/2 by 11 inches (216 by 279 mm)) acid-free paper to produce
 
−
paper copies of scientific and technical reports. Color, smoothness, and weight are factors in
 
−
selecting paper. Type is most easily read against an off-white, uncoated stock; however,
 
−
halftone illustrations (photographs) printed on coated paper are superior to those printed on
 
−
uncoated. To ensure legibility and reproducibility, use black ink.
 
−
 
 
−
6.3.2.4 Printing Equipment
 
−
 
 
−
A laser or laser-quality printer with a minimum 300-dpi (dots per inch) resolution produces
 
−
acceptable camera-ready copy for text and line work. If photographs or high-resolution
 
−
graphics are included electronically in a report, use a printer with 600-dpi or higher resolution
 
−
to print them.  
 
  
 
===Designation===
 
===Designation===
 +
:For ease of use and reference, delimit and uniquely identify segments of a report. For traditional paper reports, the segments are usually pages. For reports published in digital form, they may be pages, but are more likely to be paragraphs or screens.
  
−
6.4.1 General
+
:Once the segments of a report have been determined, use consecutive Arabic numbers to designate them. When reproducing appendix information from another source, retain the designation of the original source in addition to designation for inclusion in the appendix. If a report is divided into sections or chapters because of its length or scope, number the text, exclusive of front matter and back matter, sequentially from one part to the next.
−
 
 
−
For ease of use and reference, delimit and uniquely identify segments of a report. For
 
−
traditional paper reports, the segments are usually pages. For reports published in digital
 
−
form, they may be pages, but are more likely to be paragraphs or screens.
 
−
 
 
−
Once the segments of a report have been determined, use consecutive Arabic numbers to  
 
−
designate them. When reproducing appendix information from another source, retain the  
 
−
designation of the original source in addition to designation for inclusion in the appendix. If a  
 
−
report is divided into sections or chapters because of its length or scope, number the text,  
 
−
exclusive of front matter and back matter, sequentially from one part to the next.
 
−
 
 
−
6.4.2 Print-Specific
 
−
 
 
−
Place page numbers in the same place on each page (for example, bottom right) or in a
 
−
consistent place on mirror-image pages (for example, upper outer corner). Do not place
 
−
hyphens, parentheses, or other punctuation marks around page numbers.
 
−
 
 
−
Number front matter with consecutive lowercase roman numerals. Do not show page
 
−
numbers on the cover or title page, but consider the title page as page i. Begin a table of
 
−
contents on a new odd-numbered right-hand page.
 
−
 
 
−
Begin the text of each volume of a multivolume report on a new page 1.
 
−
 
 
−
The structure and nature of a report govern the optional use of headers and footers in the
 
−
text. Do not place headers and footers on lead pages, on the first page of the table of
 
−
contents, or in the preface. Use running headers to help locate information in long, complex
 
−
reports.
 
−
 
 
−
When running headers appear on right-hand pages, use the last text heading on the page as
 
−
the header. When running headers appear on left-hand pages, use the first text heading to
 
−
appear as the header. If using section titles as headings, use them as running headers
 
−
throughout the section. Running headers used for a section of notes in the back matter
 
−
should show inclusive page numbers where the relevant references are found (for example,
 
−
Notes to Pages 23-31).
 
  
 
===Units and Numbers===
 
===Units and Numbers===
−
:Present standard units of measurement clearly, concisely, and consistently in reports. The preferred standard for units is the International System of Units (SI). If another system is used, the corresponding SI units may appear in parentheses. If two systems of measurement are used, indicate the systems in the “Methods, Assumptions, and Procedures” section and in a statement at the beginning of the list of symbols, abbreviations, and acronyms. (See also [[#Methods, Assumptions, and Procedures|Methods, Assumptions, and Procedures]].)
+
:Present standard units of measurement clearly, concisely, and consistently in reports. The preferred standard for units is the International System of Units (SI). If another system is used, the corresponding SI units may appear in parentheses. If two systems of measurement are used, indicate the systems in the [[report undertaking section|"Methods, Assumptions, and Procedures" section]] and in a statement at the beginning of the [[report token|list of symbols, abbreviations, and acronyms]].
−
 
 
−
Abbreviate units used with specific numbers (for example, 3.7 m) except where a potential
 
−
exists for misinterpretation; otherwise, spell out units. For SI units derived from proper
 
−
names, show the symbols in initial capital letters (for example, Hz and N); use lowercase
 
−
letters for units that are spelled out (for example, hertz and newtons). Write SI symbols in
 
−
singular form; IEEE/ASTM SI-10-2002, American National Standard for Use of the
 
−
International System of Units (SI): The Modern Metric System, provides detailed information
 
−
on using SI symbols and units.
 
−
 
 
−
Always use Arabic numbers to express units of measurement and time in mathematical
 
−
expressions, decimals, percentages, and proportions. For other expressions, the following
 
−
apply:
 
−
 
 
−
• If a sentence contains only one number and it is greater than nine, indicate it as a
 
−
numeral; if a number is nine or less, spell it out.
 
−
 
 
−
• Always spell out a number at the beginning of a sentence.
 
−
 
 
−
• Use numerals for a group of two or more numbers if one of them is 10 or greater (for
 
−
example, a capacitor having 3 leads, 2 pairs of controls, and 12 settings).
 
−
 
 
−
• The same guidelines apply to ordinal numbers, but treat ordinals and cardinals separately
 
−
if they appear together (for example, the 5th and 14th groups, containing six and seven
 
−
items, respectively).
 
−
 
 
−
• Use Arabic numbers for all numbering systems (page and section, table, figure, and
 
−
reference numbers), except for roman-numeral pagination of front matter (for example,
 
−
page iii).
 
−
 
 
−
 
 
−
6.6 Formulas and Equations
 
−
 
 
−
Present formulas and equations in sentence form and punctuate them for clarity and
 
−
consistency; however, do not begin a sentence with a formula or equation.
 
−
 
 
−
Clarify complicated mathematical formulas and derivations by defining symbols below the
 
−
formula or derivation or as is customary in the discipline, relating equations to one another
 
−
and describing the physical reality represented by the mathematics. Chemical symbols need
 
−
not be defined unless the author/creator chooses to do so for clarification. Use marginal
 
−
notes to identify modifications of symbols (for example, prime marks) and to distinguish
 
−
between the letter “O” and “0” (zero); the letter “I” and the number “1”; the letter “x” and the
 
−
multiplication sign (x). Clearly indicate superscripts and subscripts.
 
−
 
 
−
Include brief formulas and equations as part of the text if the formula or equation fits on one
 
−
line. If a formula or equation is displayed set off from the text, center or indent it, depending
 
−
on its length. For consistent presentation and cross-referencing in a report with extensive
 
−
notation, display and number all equations. Italicize formulas and equations, whether
 
−
included as part of the text or displayed.
 
−
 
 
−
 
 
−
Enclose equation numbers in parentheses at the right-hand margin with a minimum of
 
−
1/4 inch between the last term in the equation and the equation number. Place the equation
 
−
number on the same line of a single-line equation and on the last line of a multi-line equation.
 
−
 
 
−
If a long formula or equation does not fit on a single line, break it before an operational sign
 
−
(plus, minus, times, integral, etc.) or after an expression enclosed with parentheses, brackets,
 
−
etc.
 
−
 
 
−
Use an extra line space between the lines when a formula or equation is carried over
 
−
because of its length. A number of computer software packages supporting the presentation
 
−
of equations automatically provide correct line spacing. An example of a multi-line equation
 
−
split to fit on a page is shown in Figure 9.
 
−
 
 
−
 
 
−
Jo Jo E(n ^ ) N ^ 1 '^ dl l
 
−
 
 
−
-f/.V,
 
−
 
 
−
rJF cJN;
 
−
 
 
−
 
 
−
rJF rJN/ _ c)¥ dN/ _ £ M ( d FdN/
 
−
 
 
−
0 j 0 L dll d£, X \df| dll
 
−
 
 
−
 
 
−
~ /3M dF XT \ dM dF
 
−
35*5/ '\^T 1 dr, N 7 34 «; '
 
−
 
 
−
+ K 2 (3K x - K|)MFN/+- K 2 (k|- 1)FN/
 
−
 
 
−
 
 
−
- 3K 2 K£MFN,+ k 2 k|m 3 fn /
 
−
 
 
−
 
 
−
dn d£
 
−
 
 
  
−
Figure 9: Sample multi-line equation with extra space before and after
+
:Abbreviate units used with specific numbers (for example, 3.7 m) except where a potential exists for misinterpretation; otherwise, spell out units. For SI units derived from proper names, show the symbols in initial capital letters (for example, Hz and N); use lowercase letters for units that are spelled out (for example, hertz and newtons). Write SI symbols in singular form; IEEE/ASTM SI-10-2002, American National Standard for Use of the International System of Units (SI): The Modern Metric System, provides detailed information on using SI symbols and units.
  
 +
:Always use Arabic numbers to express units of measurement and time in mathematical expressions, decimals, percentages, and proportions. For other expressions, the following apply:
 +
:*If a sentence contains only one number and it is greater than nine, indicate it as a numeral; if a number is nine or less, spell it out.
 +
:*Always spell out a number at the beginning of a sentence.
 +
:*Use numerals for a group of two or more numbers if one of them is 10 or greater (for example, a capacitor having 3 leads, 2 pairs of controls, and 12 settings).
 +
:*The same guidelines apply to ordinal numbers, but treat ordinals and cardinals separately if they appear together (for example, the 5th and 14th groups, containing six and seven items, respectively).
 +
:*Use Arabic numbers for all numbering systems (page and section, table, figure, and reference numbers), except for roman-numeral pagination of front matter (for example, page iii).
  
−
Define chemical symbols if definition enhances their comprehension. Use close spacing for  
+
===Formulas and Equations===
−
chemical symbols, numbers, or line bonds in a formula. Chemical equations may be run in or  
+
:Present formulas and equations in sentence form and punctuate them for clarity and consistency; however, do not begin a sentence with a formula or equation.  
−
displayed set off from text. Use roman (English) type rather than italics to form chemical
 
−
symbols. If displayed, they should be numbered in sequence, and the equation numbers
 
−
placed to the right of the reaction. Number chemical equations consecutively and
 
−
independently of mathematical equations.  
 
  
−
If a chemical equation is too long to fit on one line, break it after the arrow. Align the first
+
:Clarify complicated mathematical formulas and derivations by defining symbols below the formula or derivation or as is customary in the discipline, relating equations to one another and describing the physical reality represented by the mathematics. Chemical symbols need not be defined unless the author/creator chooses to do so for clarification. Use marginal notes to identify modifications of symbols (for example, prime marks) and to distinguish between the letter "O" and "0" (zero); the letter "I" and the number "1"; the letter "x" and the multiplication sign (x). Clearly indicate superscripts and subscripts.  
−
element of the runover line with the last element of the preceding line. Leave extra line
 
−
spacing between the lowest part of the first line and the highest part of the next line. An
 
−
example of a chemical equation broken after the arrow is shown in Figure 10:
 
  
 +
:Include brief formulas and equations as part of the text if the formula or equation fits on one line. If a formula or equation is displayed set off from the text, center or indent it, depending on its length. For consistent presentation and cross-referencing in a report with extensive notation, display and number all equations. Italicize formulas and equations, whether included as part of the text or displayed.
  
−
Co(NH 3 ) 6 3+ + 6H 3 Cr ^
+
:Enclose equation numbers in parentheses at the right-hand margin with a minimum of 1/4 inch between the last term in the equation and the equation number. Place the equation number on the same line of a single-line equation and on the last line of a multi-line equation.
  
 +
:If a long formula or equation does not fit on a single line, break it before an operational sign (plus, minus, times, integral, etc.) or after an expression enclosed with parentheses, brackets, etc.
  
−
Co(H 2 0) 6 3+ + 6NH 4 ^
+
:Use an extra line space between the lines when a formula or equation is carried over because of its length. A number of computer software packages supporting the presentation of equations automatically provide correct line spacing.
−
 
 
−
K — 1O 20
 
−
 
 
−
C
 
−
 
 
−
 
 
−
Figure 10: Sample chemical equation spread over two lines
 
  
 +
:Define chemical symbols if definition enhances their comprehension. Use close spacing for chemical symbols, numbers, or line bonds in a formula. Chemical equations may be run in or displayed set off from text. Use roman (English) type rather than italics to form chemical symbols. If displayed, they should be numbered in sequence, and the equation numbers placed to the right of the reaction. Number chemical equations consecutively and independently of mathematical equations.
  
 +
:If a chemical equation is too long to fit on one line, break it after the arrow. Align the first element of the runover line with the last element of the preceding line. Leave extra line spacing between the lowest part of the first line and the highest part of the next line.
  
 
===Footnotes or Endnotes===
 
===Footnotes or Endnotes===
 +
:Include footnotes or endnotes in a report only to clarify information in the text; keep them as brief as possible. To avoid preparing footnotes or endnotes, incorporate material into the text by enclosing it in parentheses or placing it in a separate paragraph.
  
−
Include footnotes or endnotes in a report only to clarify information in the text; keep them as
+
:Use superscript Arabic numbers to key notes to the portion of the text they clarify. Number notes consecutively through the text; place footnotes at the bottom of the page on which each occurs and place endnotes at the end of the section of text they clarify. If a footnote runs longer than its page margin, complete the footnote at the bottom of the subsequent page, preceding any footnote(s) for that page. If a footnote clarifies tabular information, use a superscript sequence of lowercase letters or symbols to avoid confusion with text footnotes.
−
brief as possible. To avoid preparing footnotes or endnotes, incorporate material into the text
 
−
by enclosing it in parentheses or placing it in a separate paragraph.
 
−
 
 
−
Use superscript Arabic numbers to key notes to the portion of the text they clarify. Number  
 
−
notes consecutively through the text; place footnotes at the bottom of the page on which each  
 
−
occurs and place endnotes at the end of the section of text they clarify. If a footnote runs  
 
−
longer than its page margin, complete the footnote at the bottom of the subsequent page,  
 
−
preceding any footnote(s) for that page. If a footnote clarifies tabular information, use a  
 
−
superscript sequence of lowercase letters or symbols to avoid confusion with text footnotes.
 
−
(See also 6.2.3, Tables.)
 
−
 
 
−
 
 
−
6.8 References and Bibliographic Entries
 
−
 
 
−
Indent the first line of a reference and align subsequent lines flush with the left margin. Align
 
−
entries in a bibliography flush left without paragraph indentation. If a bibliographic entry runs
 
−
longer than a single line, uniformly indent subsequent runover lines. Alternatively, maintain a
 
−
flush left placement and enter a blank line between bibliographic entries.
 
−
 
 
−
 
 
−
6.9 Symbols, Abbreviations, and Acronyms
 
−
6.9.1 General
 
−
 
 
−
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. Appendix A, Selected Annotated Bibliography,
 
−
 
 
−
A.6, Standards and Symbols, includes standards for symbols used in many disciplines. 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.
 
−
 
 
−
 
 
−
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.
 
−
 
 
−
 
 
−
===Glossary Entries===
 
−
 
 
−
Arrange glossary entries in alphabetical order and align them with the left margin. Uniformly
 
−
indent subsequent lines or maintain flush left with the left margin and enter a blank line
 
−
between glossary entries. Begin each definition with a capital letter and end it with a period.
 
−
 
 
−
 
 
−
===Index Entries===
 
−
 
 
−
6.11.1 General
 
−
 
 
−
Always use lower case unless an entry begins with a proper name; indent entries uniformly
 
−
for each level of modification. Indent runover lines deeper than the deepest subentry.
 
−
 
 
−
6.11.2 Print-Specific
 
−
 
 
−
It is customary to arrange index entries on printed pages so they appear single-spaced in a
 
−
two- or three-column format.
 
−
 
 
−
6.11.3 Non-Print-Specific
 
−
 
 
−
Best practice is to provide links between index terms and what they reference.
 
−
 
 
−
 
 
−
6.12 Errata
 
−
6.12.1 General
 
−
 
 
−
If errors severe enough to cause misunderstanding are discovered too late for correction prior
 
−
to the distribution of a report, send an errata sheet or update that identifies the report and the
 
−
error(s) to initial and subsequent recipients.
 
−
 
 
−
Identify an error in the text by line; identify an error in a formula or an equation by number
 
−
and the correction noted. The following form is used for corrections:
 
−
 
 
−
 
 
−
Page
 
−
 
 
−
Reads
 
−
 
 
−
Should Read
 
−
 
 
−
37, line 5
 
−
 
 
−
cosine of the angle
 
−
 
 
−
sine of the angle
 
−
 
 
−
Paragraph
 
−
 
 
−
Reads
 
−
 
 
−
Should Read
 
−
 
 
−
5.12, line 2
 
−
 
 
−
cosine of the angle
 
−
 
 
−
sine of the angle
 
−
 
 
−
 
 
−
 
 
−
6.12.2 Print-Specific
 
−
 
 
−
For printed reports, insert the errata sheet immediately following the cover.
 
−
 
 
−
6.12.3 Non-Print-Specific
 
−
 
 
−
When errors are corrected in a digital environment, notice of the version being accessed
 
−
should be included in the metadata.
 
−
 
 
−
 
 
−
==Appendices==
 
−
===Glossary===
 
−
:*[[Administrative metadata]]. Administrative metadata support maintaining and archiving reports and
 
−
 
 
−
ensure their long-term availability. Administrative metadata are needed
 
−
for migration of data from one format to another and contain rights
 
−
information used for access control. Such metadata include type and
 
−
version of software used in preparing the report and rights-management
 
−
requirements. See also: Rights metadata
 
−
:*[[Americans with Disabilities Public Law 101- 336, 101st Congress, enacted July 26, 1990. The ADA
 
−
 
 
−
Act (ADA) prohibits discrimination and ensures equal opportunity for persons with
 
−
 
 
−
disabilities in employment, state and local government services, public
 
−
accommodations, commercial facilities, and transportation.
 
−
 
 
−
See also: Section 508
 
−
 
 
−
:*[[Best practice Guide and documentation to describe and standardize the use of
 
−
 
 
−
processes that best support a community's needs.
 
−
 
 
−
:*[[Data element A discrete component of data or metadata.
 
−
 
 
−
Descriptive metadata Metadata that are used for the indexing, discovery, and identification of a
 
−
 
 
−
resource.
 
−
 
 
−
:*[[Digital document “Digital document definition: where the view of a document version
 
−
 
 
−
relevant for the requirements of one (of possibly multiple alternative)
 
−
applications is represented using a digital representation format, such as
 
−
a digital file.” (ISO 10303, Industrial Automation Systems and Integration)
 
−
 
 
−
:*[[Digital Object Identifier (DOI®) A DOI (Digital Object Identifier) is a persistent identifier given to a Web
 
−
 
 
−
J ' ’ file or other Internet document so that if its Internet address changes,
 
−
 
 
−
users will be redirected to its new address. The DOI is an implementation
 
−
of the CNRI Handle System®, in which the term "DOI" is used instead of
 
−
"Handle" to describe the identifiers. DOI syntax is defined in
 
−
ANSI/NISO Z39.84.
 
−
 
 
−
See also: Uniform Resource Name (URN)
 
−
 
 
−
:*[[Document-Type Definition In SGML or XML, a formal description of the components of a specific
 
−
 
 
−
(DTD) document or class of documents. DTDs provide a formal grammar used
 
−
 
 
−
for machine processing (parsing) of documents expressed in SGML or
 
−
XML. A DTD description includes: the containers or elements that make
 
−
up the document (for example, paragraphs, headings, list items, figures,
 
−
tables, etc.); the logical structure of the document (for example, chapters
 
−
containing sections, etc.); additional information associated with elements
 
−
—known as attributes (for example, identifiers, date stamps, etc.).
 
−
 
 
−
:*[[Dublin Core The Dublin Core Metadata Element Set is a set of 15 descriptive
 
−
 
 
−
semantic definitions that represents a core set of elements likely to be
 
−
useful across a broad range of disciplines. Dublin Core metadata
 
−
supplement existing methods for searching and indexing Web-based
 
−
metadata, regardless of whether the corresponding resource is an
 
−
electronic document or a "real" physical object. Described in ANSI/NISO
 
−
Z39.85.
 
−
:*[[extensible Markup Language
 
−
 
 
−
extensible Stylesheet
 
−
Language
 
−
 
 
−
Ingest
 
−
 
 
−
 
 
−
International Standard Book
 
−
Number (ISBN)
 
−
 
 
−
 
 
−
International Standard Serial
 
−
Number (ISSN)
 
−
 
 
−
 
 
−
MARC 21
 
−
 
 
−
 
 
−
Metadata
 
−
 
 
−
 
 
−
Multimedia
 
−
 
 
−
 
 
−
Open Archival Information
 
−
System (OAIS)
 
−
 
 
−
 
 
−
Definition
 
−
 
 
−
See: XML
 
−
See: XSL
 
−
 
 
−
 
 
−
The external interface that accepts information into an archive. This
 
−
process may include staging information to prepare for full acceptance,
 
−
confirmation of receipt, and validation. OAIS contains the services and
 
−
functions that accept Submission Information Packages from Producers,
 
−
prepares Archival Information Packages for storage, and ensures that
 
−
Archival Information Packages and their supporting Descriptive
 
−
Information become established. Accession (traditional archives) = Ingest
 
−
 
 
−
The International Standard Book Number (ISBN) uniquely identifies books
 
−
and book-like products published internationally. Every ISBN consists of a
 
−
set number of digits (ten prior to a revision in 2004), and whenever it is
 
−
printed it is preceded by the letters ISBN. The number is divided into four
 
−
parts of variable length, each part separated by a hyphen. Described in
 
−
ISO 2108.
 
−
 
 
−
The International Standard Serial Number (ISSN) uniquely identifies a
 
−
serial title regardless of language or country in which it is published. An
 
−
ISSN is eight digits long and always displayed this way: ISSN 1234-5679.
 
−
The first seven digits serve as the title number and the eighth is a check
 
−
digit, which provides an efficient means for discovering transcription
 
−
errors. Described in ISO 3297 and ANSI/NISO Z39.9.
 
−
 
 
−
MARC is the acronym for MAchine-Readable Cataloging. It defines a data
 
−
format that emerged from a Library of Congress led initiative begun thirty
 
−
years ago. MARC became USMARC in the 1980s and MARC 21 in the
 
−
late 1990s. It provides the mechanism by which computers exchange,
 
−
use, and interpret bibliographic information and its data elements make
 
−
up the foundation of most library catalogs used today.
 
−
 
 
−
Literally, "data about data," metadata include data associated with either
 
−
an information system or an information object for purposes of
 
−
description, administration, legal requirements, technical functionality, use
 
−
and usage, and preservation.
 
−
 
 
−
See also: Administrative metadata, Descriptive metadata. Preservation
 
−
metadata, Rights metadata, Structural metadata, Technical metadata,
 
−
 
 
−
Use metadata
 
−
 
 
−
Materials, documents, or products, such as World Wide Web pages, CD-
 
−
ROMs, or components of digital libraries, archival information systems,
 
−
and virtual museums that use any combination of text, numeric data, still
 
−
and moving images, animation, sound, and graphics.
 
−
 
 
−
The Open Archival Information System (OAIS ) reference model is a
 
−
conceptual framework for an archival system dedicated to preserving and
 
−
maintaining access to digital information over the long term. The
 
−
reference model increases awareness and understanding of concepts
 
−
relevant for archiving digital objects, especially among nonarchival
 
−
institutions; elucidate terminology and concepts for describing and
 
−
comparing data models and archival architectures; expand consensus on
 
−
the elements and processes endemic to digital information preservation
 
−
and access; and create a framework to guide the identification and
 
−
development of standards. Described in:
 
−
http://public.ccsds.org/publications/archive/650x0b1 .pdf
 
−
 
 
−
 
 
−
 
 
−
Term
 
−
 
 
−
Preservation metadata
 
−
 
 
−
Rights metadata
 
−
 
 
−
Section 508
 
−
 
 
−
 
 
−
Structural metadata
 
−
 
 
−
Style Sheets
 
−
 
 
−
Technical metadata
 
−
 
 
−
Uniform Resource Name
 
−
(URN)
 
−
 
 
−
Use metadata
 
−
 
 
−
USMARC
 
−
 
 
−
XML
 
−
 
 
−
 
 
−
Definition
 
−
 
 
−
Metadata related to the preservation management of information
 
−
resources, for example, metadata used to document, or created as a
 
−
result of, preservation processes performed on information resources.
 
−
 
 
−
A form of administrative metadata dealing with rights management
 
−
statements, including ownership statements, licenses, permissions, etc.
 
−
 
 
−
Section 508 refers to a statutory section in the Rehabilitation Act of 1973
 
−
(found at 29 U.S.C. 794d). Congress significantly strengthened section
 
−
508 in the Workforce Investment Act of 1998. Its primary purpose is to
 
−
provide access to and use of Federal executive agencies’ electronic and
 
−
information technology (EIT) by individuals with disabilities. The statutory
 
−
language of Section 508 can be found at http://www.section508.gov/ . The
 
−
Access Board http://www.access-board.gov wrote the Section 508
 
−
standards and is the U.S. federal agency responsible for developing and
 
−
enforcing accessibility requirements.
 
−
 
 
−
See also: Americans with Disabilities Act (ADA)
 
−
 
 
−
Information used to display and navigate digital resources; also includes
 
−
information on the internal organization of the digital resource. Structural
 
−
metadata might include information such as the structural divisions of a
 
−
resource (that is, chapters in a book) or sub-object relationships (such as
 
−
individual diary entries in a diary section).
 
−
 
 
−
Style sheets describe how documents are presented on screens, in print,
 
−
or perhaps how they are pronounced. By attaching style sheets to
 
−
structured documents on the Web (for example XML), authors/creators
 
−
and readers can influence the presentation of documents without
 
−
sacrificing device-independence or adding new XML tags.
 
−
 
 
−
See also: XSL
 
−
 
 
−
Metadata created for, or generated by, a computer system, relating to
 
−
how the system or its content behaves or needs to be processed.
 
−
 
 
−
Also referred to as "Universal Resource Name/Number." A unique,
 
−
location-independent identifier of a file available on the Internet. The file
 
−
remains accessible by its URN regardless of changes that might occur in
 
−
its host and directory path. For information about Internet addressing,
 
−
Described in: http://www.w3.org/Addressing/Addressing.html .
 
−
 
 
−
See also: Digital Object Identifier (DOI®)
 
−
 
 
−
Metadata, generally automatically created by the computer, that relate to
 
−
the level and type of use of an information system.
 
−
 
 
−
See: MARC 21
 
−
 
 
−
XML is extensible Markup Language, a project of the
 
−
World Wide Web Consortium (W3C): the development of the specification
 
−
is being supervised by their XML Working Group. It is designed to
 
−
improve the functionality of the Web by providing more flexible and
 
−
adaptable information identification. It is called extensible because it is
 
−
not a fixed format like HTML (a single, predefined markup language).
 
−
Instead, XML is actually a metalanguage—a language for describing
 
−
other languages—which allows customized markup languages for
 
−
limitless different types of objects. XML can do this because it's written in
 
−
SGML (ISO 8879), the international standard metalanguage for text
 
−
markup systems.
 
−
 
 
−
 
 
−
Term Definition
 
−
 
 
−
XSL XSL (extensible Stylesheet Language) is a language for expressing
 
−
 
 
−
stylesheets for XML objects. It consists of two parts: a language for
 
−
transforming XML objects, and an XML vocabulary for specifying
 
−
formatting semantics. The originality and power of XSL is more general
 
−
than just describing how XML items should be presented; it allows, as
 
−
well as describes, how these objects can be transformed into other
 
−
objects. The part of XSL dealing with document transformation is called
 
−
XSLT. The part of XSL dealing with formatting objects is called XSL-FO.
 
−
XSL and XSLT are currently working drafts of the
 
−
World Wide Web Consortium (W3C).
 
−
 
 
−
===Appendix C===
 
−
 
 
−
Dublin Core Data Elements
 
−
 
 
−
 
 
−
(This appendix is not part of ANSI/NISO Z39.18-2005, Scientific and Technical Reports - Preparation, Presentation and
 
−
Preservation. It is included for information only.)
 
−
 
 
−
 
 
−
Element Name: Title
 
−
 
 
−
Label: Title
 
−
 
 
−
Definition: A name given to the resource.
 
−
 
 
−
Comment: Typically, Title will be a name by which the resource is formally known.
 
−
 
 
−
Element Name: Creator
 
−
 
 
−
Label: Creator
 
−
 
 
−
Definition: An entity primarily responsible for making the content of the resource.
 
−
 
 
−
Comment: Examples of Creator include a person, an organization, or a service. Typically, the
 
−
 
 
−
name of a Creator should be used to indicate the entity.
 
−
 
 
−
Element Name: Subject
 
−
 
 
−
Label: Subject and Keywords
 
−
 
 
−
Definition: A topic of the content of the resource.
 
−
 
 
−
Comment: Typically, Subject will be expressed as keywords, key phrases, or classification
 
−
 
 
−
codes that describe a topic of the resource. Recommended best practice is to
 
−
select a value from a controlled vocabulary or formal classification scheme.
 
−
 
 
−
Element Name: Description
 
−
 
 
−
Label: Description
 
−
 
 
−
Definition: An account of the content of the resource.
 
−
 
 
−
Comment: Examples of Description include, but are not limited to: an abstract, table of
 
−
 
 
−
contents, reference to a graphical representation of content or a free-text account
 
−
of the content.
 
−
 
 
−
Element Name: Publisher
 
−
 
 
−
Label: Publisher
 
−
 
 
−
Definition: An entity responsible for making the resource available
 
−
 
 
−
Comment: Examples of Publisher include a person, an organization, or a service. Typically,
 
−
 
 
−
the name of a Publisher should be used to indicate the entity.
 
−
 
 
−
Element Name: Contributor
 
−
 
 
−
Label: Contributor
 
−
 
 
−
Definition: An entity responsible for making contributions to the content of the resource.
 
−
 
 
−
Comment: Examples of Contributor include a person, an organization, or a service. Typically,
 
−
 
 
−
the name of a Contributor should be used to indicate the entity.
 
−
 
 
−
 
 
−
Element Name: Date
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Date
 
−
 
 
−
A date of an event in the lifecycle of the resource.
 
−
 
 
−
Typically, Date will be associated with the creation or availability of the resource.
 
−
Recommended best practice for encoding the date value is defined in a profile of
 
−
ISO 8601 [W3C Date and Time Formats] and includes (among others) dates of the
 
−
form YYYY-MM-DD.
 
−
 
 
−
 
 
−
 
 
−
Element Name:
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Element Name:
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Element Name:
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Element Name:
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Element Name:
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Element Name:
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Type
 
−
 
 
−
Resource Type
 
−
 
 
−
The nature or genre of the content of the resource.
 
−
 
 
−
Type includes terms describing general categories, functions, genres, or
 
−
aggregation levels for content. Recommended best practice is to select a value
 
−
from a controlled vocabulary (for example, the DCMI Type Vocabulary) . To
 
−
describe the physical or digital manifestation of the resource, use the FORMAT
 
−
element.
 
−
 
 
−
Format
 
−
 
 
−
Format
 
−
 
 
−
The physical or digital manifestation of the resource.
 
−
 
 
−
Typically, Format may include the media-type or dimensions of the resource.
 
−
Format may be used to identify the software, hardware, or other equipment
 
−
needed to display or operate the resource. Examples of dimensions include size
 
−
and duration. Recommended best practice is to select a value from a controlled
 
−
vocabulary (for example, the list of Internet Media Types [MIME] defining computer
 
−
media formats).
 
−
 
 
−
Identifier
 
−
 
 
−
Resource Identifier
 
−
 
 
−
An unambiguous reference to the resource within a given context.
 
−
 
 
−
Recommended best practice is to identify the resource by means of a string or
 
−
number conforming to a formal identification system. Formal identification systems
 
−
include, but are not limited to, the Uniform Resource Identifier (URI) (including the
 
−
Uniform Resource Locator (URL)), the Digital Object Identifier (DOI), and the
 
−
International Standard Book Number (ISBN).
 
−
 
 
−
Source
 
−
 
 
−
Source
 
−
 
 
−
A Reference to a resource from which the present resource is derived.
 
−
 
 
−
The present resource may be derived from the Source resource in whole or in
 
−
part. Recommended best practice is to identify the referenced resource by means
 
−
of a string or number conforming to a formal identification system.
 
−
 
 
−
Language
 
−
 
 
−
Language
 
−
 
 
−
A language of the intellectual content of the resource.
 
−
 
 
−
Recommended best practice is to use Tags for the Idenfitication of Languages,
 
−
RFC 3066 , which, in conjunction with ISQ639 , Codes for the representation of
 
−
names of languages, defines two- and three-letter primary language tags with
 
−
optional subtags. Examples include "en" or "eng" for English, "akk" for Akkadian,
 
−
and "en-GB" for English used in the United Kingdom.
 
−
 
 
−
Relation
 
−
 
 
−
Relation
 
−
 
 
−
A reference to a related resource.
 
−
 
 
−
Recommended best practice is to identify the referenced resource by means of a
 
−
string or number conforming to a formal identification system.
 
−
 
 
−
 
 
−
Element Name:
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Element Name:
 
−
 
 
−
Label:
 
−
 
 
−
Definition:
 
−
 
 
−
Comment:
 
−
 
 
−
 
 
−
Coverage
 
−
 
 
−
Coverage
 
−
 
 
−
The extent or scope of the content of the resource.
 
−
 
 
−
Typically, Coverage will include spatial location (a place name or geographic
 
−
coordinates), temporal period (a period label, date, or date range), or jurisdiction
 
−
(such as a named administrative entity). Recommended best practice is to select a
 
−
value from a controlled vocabulary (for example, the Getty Thesaurus of
 
−
Geographic Names ) and to use, where appropriate, named places or time periods
 
−
in preference to numeric identifiers such as sets of coordinates or date ranges.  
 
  
−
Rights
+
===Errata===
 +
:If errors severe enough to cause misunderstanding are discovered too late for correction prior to the distribution of a report, send an errata sheet or update that identifies the report and the error(s) to initial and subsequent recipients.
  
−
Rights Management
+
:;Non-print-specific
 +
::When errors are corrected in a digital environment, notice of the version being accessed should be included in the metadata.
  
−
Information about rights held in and over the resource.  
+
==Glossary==
 +
*[[Administrative metadata]]. [[Administrative metadata]] support maintaining and archiving reports and ensure their long-term availability. [[Administrative metadata]] are needed for migration of data from one format to another and contain rights information used for access control. Such metadata include type and version of software used in preparing the report and rights-management requirements. See also: Rights metadata
 +
*[[Americans with Disabilities Act]] ([[ADA]]). Public Law 101- 336, 101st Congress, enacted July 26, 1990. The ADA prohibits discrimination and ensures equal opportunity for persons with disabilities in employment, state and local government services, public accommodations, commercial facilities, and transportation. See also: Section 508
 +
*[[Best practice]]. Guide and documentation to describe and standardize the use of processes that best support a community's needs.
 +
*[[Data element]]. A discrete component of data or metadata.
 +
*[[Descriptive metadata]]. Metadata that are used for the indexing, discovery, and identification of a resource.
 +
*[[Digital document]]. "Digital document definition: where the view of a document version relevant for the requirements of one (of possibly multiple alternative) applications is represented using a digital representation format, such as a digital file." (ISO 10303, Industrial Automation Systems and Integration)
 +
*[[Digital Object Identifier]] ([[DOI|DOI®]]). A DOI (Digital Object Identifier) is a persistent identifier given to a Web file or other Internet document so that if its Internet address changes, users will be redirected to its new address. The DOI is an implementation of the CNRI Handle System®, in which the term "DOI" is used instead of "Handle" to describe the identifiers. DOI syntax is defined in ANSI/NISO Z39.84. See also: Uniform Resource Name (URN)
 +
*[[Document-Type Definition]] (DTD). In SGML or XML, a formal description of the components of a specific document or class of documents. DTDs provide a formal grammar used for machine processing (parsing) of documents expressed in SGML or XML. A DTD description includes: the containers or elements that make up the document (for example, paragraphs, headings, list items, figures, tables, etc.); the logical structure of the document (for example, chapters containing sections, etc.); additional information associated with elements -- known as attributes (for example, identifiers, date stamps, etc.).
 +
*[[Dublin Core]]. The Dublin Core Metadata Element Set is a set of 15 descriptive semantic definitions that represents a core set of elements likely to be useful across a broad range of disciplines. [[Dublin Core]] metadata supplement existing methods for searching and indexing Web-based metadata, regardless of whether the corresponding resource is an electronic document or a "real" physical object. Described in ANSI/NISO Z39.85.
 +
*[[extensible Markup Language]]. See [[XML]]
 +
*[[extensible Stylesheet Language]]. See [[XSL]]
 +
*[[Ingest]]. The external interface that accepts information into an archive. This process may include staging information to prepare for full acceptance, confirmation of receipt, and validation. OAIS contains the services and functions that accept Submission Information Packages from Producers, prepares Archival Information Packages for storage, and ensures that Archival Information Packages and their supporting Descriptive Information become established. Accession (traditional archives) = Ingest
 +
*[[International Standard Book Number]] (ISBN). The International Standard Book Number (ISBN) uniquely identifies books and book-like products published internationally. Every ISBN consists of a set number of digits (ten prior to a revision in 2004), and whenever it is printed it is preceded by the letters ISBN. The number is divided into four parts of variable length, each part separated by a hyphen. Described in ISO 2108.
 +
*[[International Standard Serial Number]] (ISSN). The International Standard Serial Number (ISSN) uniquely identifies a serial title regardless of language or country in which it is published. An ISSN is eight digits long and always displayed this way: ISSN 1234-5679. The first seven digits serve as the title number and the eighth is a check digit, which provides an efficient means for discovering transcription errors. Described in ISO 3297 and ANSI/NISO Z39.9.
 +
*[[MARC 21]]. MARC is the acronym for MAchine-Readable Cataloging. It defines a data format that emerged from a Library of Congress led initiative begun thirty years ago. MARC became USMARC in the 1980s and MARC 21 in the late 1990s. It provides the mechanism by which computers exchange, use, and interpret bibliographic information and its data elements make up the foundation of most library catalogs used today.
 +
*[[Metadata]]. Literally, "data about data," metadata include data associated with either an information system or an information object for purposes of description, administration, legal requirements, technical functionality, use and usage, and preservation. See also: [[Administrative metadata]], [[Descriptive metadata]], Preservation metadata, Rights metadata, [[Structural metadata]], Technical metadata, Use metadata
 +
*[[Multimedia]]. Materials, documents, or products, such as World Wide Web pages, or components of digital libraries, archival information systems, and virtual museums that use any combination of text, numeric data, still and moving images, animation, sound, and graphics.
 +
*[[Open Archival Information System]] (OAIS). The Open Archival Information System (OAIS ) reference model is a conceptual framework for an archival system dedicated to preserving and maintaining access to digital information over the long term. The reference model increases awareness and understanding of concepts relevant for archiving digital objects, especially among nonarchival institutions; elucidate terminology and concepts for describing and comparing data models and archival architectures; expand consensus on the elements and processes endemic to digital information preservation and access; and create a framework to guide the identification and development of standards. Described in: http://public.ccsds.org/publications/archive/650x0b1.pdf
 +
*[[Preservation metadata]]. Metadata related to the preservation management of information resources, for example, metadata used to document, or created as a result of, preservation processes performed on information resources.
 +
*[[Rights metadata]]. A form of [[administrative metadata]] dealing with rights management statements, including ownership statements, licenses, permissions, etc.
 +
*[[Section 508]]. Section 508 refers to a statutory section in the Rehabilitation Act of 1973 (found at 29 U.S.C. 794d). Congress significantly strengthened section 508 in the Workforce Investment Act of 1998. Its primary purpose is to provide access to and use of Federal executive agencies’ electronic and information technology (EIT) by individuals with disabilities. The statutory language of Section 508 can be found at http://www.section508.gov/ . The Access Board http://www.access-board.gov wrote the Section 508 standards and is the U.S. federal agency responsible for developing and enforcing accessibility requirements. See also: Americans with Disabilities Act (ADA)
 +
*[[Structural metadata]]. Information used to display and navigate digital resources; also includes information on the internal organization of the digital resource. Structural metadata might include information such as the structural divisions of a resource (that is, chapters in a book) or sub-object relationships (such as individual diary entries in a diary section).
 +
*[[Style Sheets]]. Style sheets describe how documents are presented on screens, in print, or perhaps how they are pronounced. By attaching style sheets to structured documents on the Web (for example XML), authors/creators and readers can influence the presentation of documents without sacrificing device-independence or adding new XML tags. See also: XSL
 +
*[[Technical metadata]]. Metadata created for, or generated by, a computer system, relating to how the system or its content behaves or needs to be processed.
 +
*[[Uniform Resource Name]] (URN). Also referred to as "Universal Resource Name/Number." A unique, location-independent identifier of a file available on the Internet. The file remains accessible by its URN regardless of changes that might occur in its host and directory path. For information about Internet addressing, Described in: http://www.w3.org/Addressing/Addressing.html . See also: Digital Object Identifier (DOI®)
 +
*[[Use metadata]]. Metadata, generally automatically created by the computer, that relate to the level and type of use of an information system.
 +
*[[USMARC]]. See: MARC 21
 +
*[[XML]]. XML is extensible Markup Language, a project of the World Wide Web Consortium (W3C): the development of the specification is being supervised by their XML Working Group. It is designed to improve the functionality of the Web by providing more flexible and adaptable information identification. It is called extensible because it is not a fixed format like HTML (a single, predefined markup language). Instead, XML is actually a metalanguage—a language for describing other languages—which allows customized markup languages for limitless different types of objects. XML can do this because it's written in SGML (ISO 8879), the international standard metalanguage for text markup systems.
 +
*[[XSL]]. XSL (extensible Stylesheet Language) is a language for expressing stylesheets for XML objects. It consists of two parts: a language for transforming XML objects, and an XML vocabulary for specifying formatting semantics. The originality and power of XSL is more general than just describing how XML items should be presented; it allows, as well as describes, how these objects can be transformed into other objects. The part of XSL dealing with document transformation is called XSLT. The part of XSL dealing with formatting objects is called XSL-FO. XSL and XSLT are currently working drafts of the World Wide Web Consortium (W3C).
  
−
Typically, Rights will contain a rights management statement for the resource, or
+
[[Category:Reference Books]]
−
reference a service providing such information. Rights information often
 
−
encompasses Intellectual Property Rights (IPR), Copyright, and various Property
 
−
Rights. If the Rights element is absent, no assumptions may be made about any
 
−
rights held in or over the resource.
 

Latest revision as of 21:42, 18 November 2020

Scientific and Technical Reports: Preparation, Presentation, and Preservation (alternatively known as ANSI/NISO Z39.18; hereinafter, the Standard) is the ANSI/NISO Z39.18-2005 (R2010) American national standard that is developed by the National Information Standards Organization and approved in 2005 and reaffirmed by 2010 by the American National Standards Institute.


Trivia

Abstract

The Standard outlines the elements, organization, and design of scientific and technical reports, including guidance for uniform presentation of front and back matter, text, and visual and tabular matter in print and digital formats, as well as recommendations for multimedia reports.

Copyright

Copyright © 2010 by the National Information Standards Organization. All rights reserved under International and Pan-American Copyright Conventions. For noncommercial purposes only, this publication may be reproduced or transmitted in any form or by any means without prior permission in writing from the publisher, provided it is reproduced accurately, the source of the material is identified, and the NISO copyright status is acknowledged. All inquiries regarding translations into other languages or commercial reproduction or distribution should be addressed to: NISO, 3600 Clipper Mill Road, Suite 302, Baltimore, MD 21211.

Appendices

The appendices are not part of the Standard and included for information only.
  • Appendix A -- Selected Annotated Bibliography
  • Appendix B -- Glossary
  • Appendix C -- Dublin Core Data Elements
  • Appendix D -- Formats for Organizing a Scientific or Technical Report
  • Appendix E -- Report Documentation Page, Standard Form (SF)
  • Appendix F -- XML DTD and Sample XSL (Style Sheet)

General Information

Role

The guidelines in the Standard address issues related to creating, discovering, presenting, publishing, disseminating, maintaining, and preserving reports. Previous editions of the Standard focused on reports printed on paper, but, with the increased availability of computers, paper is only one of the many media of publication a report can have. In addition, reports can now include digital sections as well as traditional printed text. This revised Standard attempts to accommodate the diverse forms reports can take. Report writers should refer to the many examples throughout the Standard as models to follow rather than using the Standard as a model.

Scope

The Standard will guide individuals and organizations in preparing reports. It is generally couched in terms of the traditional printed report because that medium is the most concrete and common example for readers to consider and visualize. However, the Standard is expressed in such a way that adapting to other means of publication (for example, electronic formats on the Web) is recognized.
Although the Standard necessarily has to consider means of distribution, facilitate methods of literature control, and accommodate methods of accessibility, it is not a standard for cataloging, describing, or preserving publications. Those roles are fulfilled by other standards, such as those associated with using MARC 21 records, Dublin Core, and evolving standards for persistent identification.

Audience

The Standard will prove valuable to researchers, scientists, and academics to document their research and results, provide consistent guidelines for creating reports, and assist in collaboration among organizations. Writers, editors, and publishers can use the Standard to provide consistency throughout their organizations and adopt uniform practices as needed. Information specialists in areas such as libraries, depositories, databases, and archives will find it helpful in categorizing, discovering, and maintaining information in a consistent fashion.

Best Practices

In keeping with quality standards and practices, the Standard contains examples of best practices used by authors who produce exemplary reports—that is, reports that provide information the user needs in a form and format the user can easily understand. Authors, however, must be aware that the best practices identified by the Standard are those judged to be so at the time the Committee developed it, and they should seek to identify other practices, not only within the user’s organization but also within the user’s discipline.

Key Concepts

Metadata

The Standard advocates provision for the capture of appropriate metadata in report preparation. Metadata refer to information about information or, equivalently, data about data. In current practice, the term has come to mean structured information that feeds into automated processes, and this definition is currently the most useful way to think about metadata. This definition further applies whether the publication that the metadata describes is in print or electronic form. In publishing, metadata can be classified according to a variety of specific functions, such as technical metadata for technical processes, rights metadata for rights resolution, preservation metadata for digital archiving, and descriptive metadata (metadata that characterizes the content itself).

Persistence

The Standard addresses the need for persistence in links that are incorporated in reports. A key component of the digital information infrastructure is a mechanism for addressing and locating digital objects on a network or in an archival system. The current addressing structure for the World Wide Web is based on the Uniform Resource Locator (URL). While the URL provides direct, efficient access, URL-only naming fails whenever the resources are moved or reorganized. The lack of persistence leads to "404" (file not found) errors, inhibiting access to information and causing problems when archiving material for long-term preservation and permanent access. These links should also be documented for accessibility in print format.

Interoperability

The Standard encourages the achievement of interoperability in report presentation. In paper-based publication of scientific and technical reports, interoperability, except for language differences and visual challenges, is achieved through a single publication medium. In the digital environment with its multiple types of media, even defining the concept of publishing is a challenge. Interoperability can be achieved at three levels: technical, content, and organizational. At the technical level, protocol and format should be consistent so messages can be exchanged. Content agreements cover data and metadata and include semantic agreements on interpreting messages. The organizational level of interoperability includes rules for access, for changing collections and services, payment, authentication, etc. While the URL protocol permits interoperability in addressing, it offers no interoperability regarding content.

Creation

The Standard recognizes that certain critical actions must be taken at the time a report is created. The initial stage of creating a report should include a thorough review of intellectual property rights, security issues, ease of repurposing the information, and consistent guidelines for software and file naming conventions. Given the collaborative nature of many reports, copyright should be established at the outset, and permission for using pre-existing material should be consistent with U.S. Copyright Office regulations. Potentially classified material may require authentication for release to a limited audience. If the report is best served by being released through multiple channels and repurposed into multiple formats (for example, print and Web) or parsed for repurposing in other collaborative projects, production should include standards for coding the information for such use. Creators should capture metadata tied to producing the report, such as platform, operating system, software version, and consistent file-naming conventions and extensions when they create the report.

Discovery

The Standard emphasizes the importance of ensuring that reports will be discovered. Traditionally, the ability for the target audience to find and use scientific and technical reports produced solely in print format depended on governmental and commercial bibliographic databases or specific, specialized knowledge of primary resource producers. Reports produced in digital format should also enable discovery and access through the incorporation of appropriate associated metadata. Producers of reports should ensure that the report production workflow provides for metadata capture. Discovery is also enhanced by populating metadata with published, controlled vocabularies rather than ad hoc terminology for subjects.
Another discovery issue in a digital environment is the ability of a report to allow access to all potential audiences, including those with physical restrictions. A 1998 amendment to the Rehabilitation Act (29 U.S.C. 794d), popularly referred to as “Section 508,” requires U.S. Federal agencies to make their electronic and information technology accessible to people with disabilities. Other producers of scientific and technical reports should follow guidelines provided for this requirement for greatest accessibility. A further limit to access to be avoided is using proprietary software not commonly used by the primary target audience.

Presentation in Digital Format

The Standard recommends that reports in digital form be presented in a structured way. Some methods for structured representation of reports in digital form are the DTD, XML, and XSL. The DTD defines the format that reports should follow; XML maintains the report's contents and structures; and XSL defines how to represent the report for different vehicles of display (e.g. desktop computer or PDA). Two main advantages of this approach are its automatic validation and its flexibility of representation. Also, the XML format is widely used and can be easily processed by computer programs.
Document Type Definition (DTD)
A DTD defines the building blocks of a document using extensible Markup Language (XML). XML improves the functionality of the Web by providing more flexible and adaptable information identification, delivery, and presentation.
XML Document
The XML document contains the report with its metadata. Elements in an XML document should comply with the DTD provided (see Appendix F), which validates the document.
XSL (Style Sheet)
The XSL (extensible Style Sheet) provides a mechanism for presenting data available in an XML document. It provides formatting information and ordering of presentation (not always the same order as in the XML document) and can generate extra metadata, such as a table of contents, list of figures, etc. Multiple XSL sheets can be used for the same document to accommodate the needs of various communities: Web publication of reports, printed reports, etc.

Presentation

The Standard is cognizant of and reflects the requirements and limitations of different methods of publication. The concept of publication (literally, to make known to the public) changed drastically in the 1960s when computers were applied to the typesetting process. Suddenly, machine-readable electronic records were being produced along with traditional print. The subsequent development of new media, recording devices, codes of expression, and means of transmission made these electronic records eminently usable. Scientific, business, military, and government communities found these new media to be a convenient and economical means for distributing and storing information, including reports. As a result, we now see diverse ways of publishing data and information, from printed pages to files accessible over the World Wide Web.
The prescriptions of the Standard are flexible enough to be adapted to a great variety of publication methods, both extant and yet to be discovered. However, it also recognizes that many users of a report find a printed version more convenient, portable, or permanent. Therefore, the Standard states that electronic publications be formatted so that standardized, usable print copies can be produced from any medium through common or specialized software. The Standard suggests producing reports that can be converted from medium to medium and format to format to allow ease of use and future migration.

Dissemination

The Standard encourages the effective dissemination of reports. It is important that scientific and technical reports be readily available to as broad an audience as allowed to facilitate research and to promote general education goals. Online access to information opens new arenas to find reports. Reports that can be easily identified and ordered by libraries and the general public through a variety of distribution channels (for example, wholesalers, library jobbers, and online retailers) support the sustainability of the information. Archiving reports on the Web with a unique identifier, and with an agency that can support their presence over time, improves their long-term value. Therefore, creators of reports should envision a dissemination strategy at the outset of the project.

Access and Distribution

The Standard recognizes the importance of controlling access to some reports. Originating organizations have specific responsibilities to determine the distribution of reports. Classification/distribution information is provided by electronic labeling or in print. If physical marking of a report is not possible, identifying information must be accomplished by other means, such as metadata schema. Marking is the means of informing users of classified, or otherwise controlled, information about specific protection requirements for reports (for example, for internal use only). For print materials, this information should be easily visible on the cover or title page. For reports in a digital format, this information should be on the opening screen or other points of initial access.
Examples
  • Approved for public release; distribution is unlimited.
  • Distribution authorized to DoD components only (reason, date). Other requests for this document shall be referred to (controlling office information).

Maintenance and Preservation

The Standard advocates adopting practices that ensure long-term preservation of reports. Compilers and publishers of scientific and technical reports can and should take action to ensure their efforts will be appreciated for as long as the reports have value to users. This requirement means that reports should be prepared using techniques and materials that enable discovery and usability over the long term. Continuing discovery is assured by associating a report with clear, distinct, and unchanging identifying information (descriptive metadata). Continuing usability is assured by adopting an easily navigated and navigable structure, including maintenance of internal and external links, and by using publishing techniques that withstand the test of time. Time-tested publishing techniques involve the appropriate choice of publishing medium, such as acid-free paper or polyester-based silver gelatin film. However, publishing increasingly involves producing digital products that can be migrated and shared across media, platforms, applications, and organizations. At the time the Committee developed the Standard, the most promising method for assuring continuing migration is employment of an XML DTD to encode electronic reports when produced.
Many complex, electronic scientific and technical reports are used to produce multimedia publications and presentations. In such cases, it is particularly important to use presentation standards and practices that not only enable the widest possible access at the time of report creation, but also ensure continuous availability of content and structure despite changes in the delivery environment. In cases of multimedia reports, it is desirable to preserve the original presentation media as well as the original content. When this preservation cannot be achieved, it is most important to preserve the content so that the original source material is preserved.

Components of Reports - Overview

Introduction

There are many possible patterns for organizing the components of reports. Some of these are referenced in Appendix D, Model Formats for Organizing a Scientific or Technical Report. These model formats allow for presenting information about the creation, structure, content, and availability of reports in a readily comprehensible manner. When not using traditional publishing channels, the author/creator should ensure this information is captured and available to potential readers/users.

Metadata

A scientific or technical report is an important information resource and, as such, requires effective information management. The body of the report, with its discussion of methods, results, and conclusions, is content. Any information that helps the user find, assemble, and properly attribute the report are metadata.
Metadata are a significant matter for the Standard because of the large amount and diversity of data represented. The quantity and diversity of report content and format presented information management challenges in an era when reports were published exclusively on paper; in the digital age these challenges have multiplied considerably. A scientific or technical report that does not take metadata into account has no readily-found identity and will not be used. To avoid this problem, compilers of reports must provide metadata in three broad classes: descriptive, structural, and administrative.
Descriptive Metadata
Descriptive metadata, such as cataloging information prepared following standards such as Dublin Core or MARC 21, convey information that helps the user find a report and distinguish it from other similar ones. Descriptive metadata are commonly used for resource discovery, such as author/title/subject searching, or grouping like objects for browsing. Such metadata include the title and creator (author), as well as any keywords or subject references.
Structural Metadata
Structural metadata explain the relationship between parts of multipart objects and enhance internal navigation. Such metadata include a table of contents or list of figures and tables.
Administrative Metadata
Administrative metadata support maintaining and archiving reports and ensure their long-term availability. Administrative metadata are needed for migration of data from one format to another and contain rights information used for access control. Such metadata include type and version of software used in preparing the report and rights-management requirements.

Components

The author/creator of a scientific or technical report must keep all metadata requirements in mind throughout report creation and should prepare the components to enable ready recognition of key descriptive, structural, and administrative information about the report.
Table 1 presents the Standard components of scientific and technical reports in the traditional order of presentation. In reports organized in this manner, the listed components from cover through acknowledgments are commonly referred to as front matter, the components from summary through references are referred to as the body or text matter, and components from appendices through distribution list are referred to as back matter.
In the Inclusion Status column, the table indicates which components are required by the Standard, which are optional, and which are conditional. Finally, in the column headed Function, the table indicates the primary role served by the information conveyed in each component.
Table 1: Components of reports
  Component Inclusion Status Function
Front Matter Cover Optional Descriptive metadata
Title Section Required Descriptive metadata, such as Dublin Core elements: Identifier, Title, Creator, Publisher, Contributor, Date, and Language
Notice Section Conditional (include when needed to specify intellectual property rights or state restrictions on access or use) Administrative metadata, such as the Dublin Core elements: Rights Management and Format
Format Information Section Conditional (include when the original is created in digital format) Administrative metadata, such as Dublin Core element: Format
Report Documentation Section Conditional (include in reports prepared for federal governmental agencies)
Abstract Section Required Descriptive metadata, such as the Dublin Core elements: Description, Subject, and Coverage
Contents Section Required Structural metadata
List of Figures and Tables Conditional (include when there are more than 5 figures and/or tables) Structural metadata
Foreword Conditional (include when background and context is needed) Descriptive metadata
Preface Conditional (include when background and context is needed) Descriptive metadata
Acknowledgments Conditional (include when significant) Content
Body or Text Matter Summary Required Content
Introduction Required Content
Methods, Assumptions, and Procedures Required Content
Results and Discussion Required Content
Conclusions Required Content
Recommendations Conditional (include when purpose of report is to suggest a course of action) Content
References Conditional (use if references are provided) Structural metadata, such as the Dublin Core element: Relation
Back Matter Appendices Conditional (include when needed to supplement Results and Discussion) Structural metadata
Bibliography Conditional (include when needed to amplify references) Structural metadata
List of Symbols, Abbreviations, and Acronyms Conditional (include if symbols, abbreviations, or acronyms appear in any other component of the report; this section might appear as part of the front matter) Structural metadata
Glossary Conditional (include if report incorporates terms unfamiliar to the intended audience) Structural metadata
Index Conditional (include when needed to ensure that a user locates all references to a concept) Structural metadata
Distribution List Conditional (include when needed to control access) Administrative metadata, such as the Dublin Core element: Rights Management

Components of Reports - Details

This section provides guidance on organizing the following report components:

  • Required elements, which are compulsory or mandatory when exchanging data
  • Conditional elements, which are used under specified conditions when exchanging data
  • Optional elements, which may be used when exchanging data [definition from EDSC Glossary]

Front Matter

Front matter consists of all materials preceding the main content and provides:
  • a general idea of the purpose and scope of reports;
  • background about, or a context for, reports; and
  • lists for finding specific chapters, headings, figures, and tables.
Front matter also provides information needed for cataloging in bibliographic databases and digital libraries. The Standard further discusses (1) cover, (2) title section, (3) notice of distribution and access restrictions, (4) format information, (5) report documentation page, (6) abstract, (7) contents, (8) list(s) of figures and tables, (9) foreword, (10) preface, and (11) acknowledgments in details.

Body Matter

The body is the part of the report in which the creator describes methods, assumptions, and procedures, then presents and discusses the results and draws conclusions and recommends actions based on those results. The organization of a report depends on its subject matter and audience as well as its purpose. (See Appendix D for sample organizational models.) Thus, the organization of the content may vary widely and the organization of the report may be divided into sections or chapters. Information on the content follows.
The Standard further discusses (1) summary, (2) introduction, (3) methods, assumptions, and procedures, (4) results and discussion, (5) conclusions, (6) recommendations, and (7) references in details.

Back Matter

The back matter supplements and clarifies the body of the report (for example, appendices), makes the body easier to use (for example, glossary, lists of symbols, abbreviations and acronyms, and index), and shows where additional information can be found (for example, bibliography). Some organizations consider the reference section to be part of the back matter; if the pages following the front matter are numbered sequentially, it is immaterial to the reader if the reference or bibliography section is part of the body or the back matter.
The Standard further discusses (1) appendices, (2) bibliography, (3) list(s) of symbols, abbreviations, and acronyms, (4) glossary, (5) index, and (6) distribution list in details.

Presentation and Display

This section discusses standard methods for ensuring consistency in presentation: designing visual and tabular matter; formatting; presenting units, numbers, formulas, and equations; incorporating footnotes, endnotes, references, and bibliographic entries; preparing lists of symbols, abbreviations, and acronyms; formatting glossaries and indexes; and correcting errata after publication. Within each subsection, a distinction is made between rules applicable to all reports regardless of mode of publication (e.g., paper or Web) and rules applicable to reports published in paper form.

Subordination

General
Indicate subordination of ideas by using headings and subheadings to divide the report into manageable sections, call attention to main topics, and signal changes in topics. Most reports require no more than five levels of headings.
Consistency of presentation is important in showing subordinate relationships. Many reports use a decimal numbering system to show relationships and to simplify extensive cross-referencing. An alternate format for subordination uses a progression of fonts. Indicate headings and subheadings by bold font with initial capital letters for principal words. Indicate primary headings by using a larger font than that used for non-primary headings. Align primary and secondary headings flush with the left column of text and run in other headings with indented text.
Print-Specific Guidelines
Begin each major section on a new page.
Non-Print-Specific
In the digital environment, delineate sections in a way that is easy to understand and access, with full links included as required.

Designation

For ease of use and reference, delimit and uniquely identify segments of a report. For traditional paper reports, the segments are usually pages. For reports published in digital form, they may be pages, but are more likely to be paragraphs or screens.
Once the segments of a report have been determined, use consecutive Arabic numbers to designate them. When reproducing appendix information from another source, retain the designation of the original source in addition to designation for inclusion in the appendix. If a report is divided into sections or chapters because of its length or scope, number the text, exclusive of front matter and back matter, sequentially from one part to the next.

Units and Numbers

Present standard units of measurement clearly, concisely, and consistently in reports. The preferred standard for units is the International System of Units (SI). If another system is used, the corresponding SI units may appear in parentheses. If two systems of measurement are used, indicate the systems in the "Methods, Assumptions, and Procedures" section and in a statement at the beginning of the list of symbols, abbreviations, and acronyms.
Abbreviate units used with specific numbers (for example, 3.7 m) except where a potential exists for misinterpretation; otherwise, spell out units. For SI units derived from proper names, show the symbols in initial capital letters (for example, Hz and N); use lowercase letters for units that are spelled out (for example, hertz and newtons). Write SI symbols in singular form; IEEE/ASTM SI-10-2002, American National Standard for Use of the International System of Units (SI): The Modern Metric System, provides detailed information on using SI symbols and units.
Always use Arabic numbers to express units of measurement and time in mathematical expressions, decimals, percentages, and proportions. For other expressions, the following apply:
  • If a sentence contains only one number and it is greater than nine, indicate it as a numeral; if a number is nine or less, spell it out.
  • Always spell out a number at the beginning of a sentence.
  • Use numerals for a group of two or more numbers if one of them is 10 or greater (for example, a capacitor having 3 leads, 2 pairs of controls, and 12 settings).
  • The same guidelines apply to ordinal numbers, but treat ordinals and cardinals separately if they appear together (for example, the 5th and 14th groups, containing six and seven items, respectively).
  • Use Arabic numbers for all numbering systems (page and section, table, figure, and reference numbers), except for roman-numeral pagination of front matter (for example, page iii).

Formulas and Equations

Present formulas and equations in sentence form and punctuate them for clarity and consistency; however, do not begin a sentence with a formula or equation.
Clarify complicated mathematical formulas and derivations by defining symbols below the formula or derivation or as is customary in the discipline, relating equations to one another and describing the physical reality represented by the mathematics. Chemical symbols need not be defined unless the author/creator chooses to do so for clarification. Use marginal notes to identify modifications of symbols (for example, prime marks) and to distinguish between the letter "O" and "0" (zero); the letter "I" and the number "1"; the letter "x" and the multiplication sign (x). Clearly indicate superscripts and subscripts.
Include brief formulas and equations as part of the text if the formula or equation fits on one line. If a formula or equation is displayed set off from the text, center or indent it, depending on its length. For consistent presentation and cross-referencing in a report with extensive notation, display and number all equations. Italicize formulas and equations, whether included as part of the text or displayed.
Enclose equation numbers in parentheses at the right-hand margin with a minimum of 1/4 inch between the last term in the equation and the equation number. Place the equation number on the same line of a single-line equation and on the last line of a multi-line equation.
If a long formula or equation does not fit on a single line, break it before an operational sign (plus, minus, times, integral, etc.) or after an expression enclosed with parentheses, brackets, etc.
Use an extra line space between the lines when a formula or equation is carried over because of its length. A number of computer software packages supporting the presentation of equations automatically provide correct line spacing.
Define chemical symbols if definition enhances their comprehension. Use close spacing for chemical symbols, numbers, or line bonds in a formula. Chemical equations may be run in or displayed set off from text. Use roman (English) type rather than italics to form chemical symbols. If displayed, they should be numbered in sequence, and the equation numbers placed to the right of the reaction. Number chemical equations consecutively and independently of mathematical equations.
If a chemical equation is too long to fit on one line, break it after the arrow. Align the first element of the runover line with the last element of the preceding line. Leave extra line spacing between the lowest part of the first line and the highest part of the next line.

Footnotes or Endnotes

Include footnotes or endnotes in a report only to clarify information in the text; keep them as brief as possible. To avoid preparing footnotes or endnotes, incorporate material into the text by enclosing it in parentheses or placing it in a separate paragraph.
Use superscript Arabic numbers to key notes to the portion of the text they clarify. Number notes consecutively through the text; place footnotes at the bottom of the page on which each occurs and place endnotes at the end of the section of text they clarify. If a footnote runs longer than its page margin, complete the footnote at the bottom of the subsequent page, preceding any footnote(s) for that page. If a footnote clarifies tabular information, use a superscript sequence of lowercase letters or symbols to avoid confusion with text footnotes.

Errata

If errors severe enough to cause misunderstanding are discovered too late for correction prior to the distribution of a report, send an errata sheet or update that identifies the report and the error(s) to initial and subsequent recipients.
Non-print-specific
When errors are corrected in a digital environment, notice of the version being accessed should be included in the metadata.

Glossary

  • Administrative metadata. Administrative metadata support maintaining and archiving reports and ensure their long-term availability. Administrative metadata are needed for migration of data from one format to another and contain rights information used for access control. Such metadata include type and version of software used in preparing the report and rights-management requirements. See also: Rights metadata
  • Americans with Disabilities Act (ADA). Public Law 101- 336, 101st Congress, enacted July 26, 1990. The ADA prohibits discrimination and ensures equal opportunity for persons with disabilities in employment, state and local government services, public accommodations, commercial facilities, and transportation. See also: Section 508
  • Best practice. Guide and documentation to describe and standardize the use of processes that best support a community's needs.
  • Data element. A discrete component of data or metadata.
  • Descriptive metadata. Metadata that are used for the indexing, discovery, and identification of a resource.
  • Digital document. "Digital document definition: where the view of a document version relevant for the requirements of one (of possibly multiple alternative) applications is represented using a digital representation format, such as a digital file." (ISO 10303, Industrial Automation Systems and Integration)
  • Digital Object Identifier (DOI®). A DOI (Digital Object Identifier) is a persistent identifier given to a Web file or other Internet document so that if its Internet address changes, users will be redirected to its new address. The DOI is an implementation of the CNRI Handle System®, in which the term "DOI" is used instead of "Handle" to describe the identifiers. DOI syntax is defined in ANSI/NISO Z39.84. See also: Uniform Resource Name (URN)
  • Document-Type Definition (DTD). In SGML or XML, a formal description of the components of a specific document or class of documents. DTDs provide a formal grammar used for machine processing (parsing) of documents expressed in SGML or XML. A DTD description includes: the containers or elements that make up the document (for example, paragraphs, headings, list items, figures, tables, etc.); the logical structure of the document (for example, chapters containing sections, etc.); additional information associated with elements -- known as attributes (for example, identifiers, date stamps, etc.).
  • Dublin Core. The Dublin Core Metadata Element Set is a set of 15 descriptive semantic definitions that represents a core set of elements likely to be useful across a broad range of disciplines. Dublin Core metadata supplement existing methods for searching and indexing Web-based metadata, regardless of whether the corresponding resource is an electronic document or a "real" physical object. Described in ANSI/NISO Z39.85.
  • extensible Markup Language. See XML
  • extensible Stylesheet Language. See XSL
  • Ingest. The external interface that accepts information into an archive. This process may include staging information to prepare for full acceptance, confirmation of receipt, and validation. OAIS contains the services and functions that accept Submission Information Packages from Producers, prepares Archival Information Packages for storage, and ensures that Archival Information Packages and their supporting Descriptive Information become established. Accession (traditional archives) = Ingest
  • International Standard Book Number (ISBN). The International Standard Book Number (ISBN) uniquely identifies books and book-like products published internationally. Every ISBN consists of a set number of digits (ten prior to a revision in 2004), and whenever it is printed it is preceded by the letters ISBN. The number is divided into four parts of variable length, each part separated by a hyphen. Described in ISO 2108.
  • International Standard Serial Number (ISSN). The International Standard Serial Number (ISSN) uniquely identifies a serial title regardless of language or country in which it is published. An ISSN is eight digits long and always displayed this way: ISSN 1234-5679. The first seven digits serve as the title number and the eighth is a check digit, which provides an efficient means for discovering transcription errors. Described in ISO 3297 and ANSI/NISO Z39.9.
  • MARC 21. MARC is the acronym for MAchine-Readable Cataloging. It defines a data format that emerged from a Library of Congress led initiative begun thirty years ago. MARC became USMARC in the 1980s and MARC 21 in the late 1990s. It provides the mechanism by which computers exchange, use, and interpret bibliographic information and its data elements make up the foundation of most library catalogs used today.
  • Metadata. Literally, "data about data," metadata include data associated with either an information system or an information object for purposes of description, administration, legal requirements, technical functionality, use and usage, and preservation. See also: Administrative metadata, Descriptive metadata, Preservation metadata, Rights metadata, Structural metadata, Technical metadata, Use metadata
  • Multimedia. Materials, documents, or products, such as World Wide Web pages, or components of digital libraries, archival information systems, and virtual museums that use any combination of text, numeric data, still and moving images, animation, sound, and graphics.
  • Open Archival Information System (OAIS). The Open Archival Information System (OAIS ) reference model is a conceptual framework for an archival system dedicated to preserving and maintaining access to digital information over the long term. The reference model increases awareness and understanding of concepts relevant for archiving digital objects, especially among nonarchival institutions; elucidate terminology and concepts for describing and comparing data models and archival architectures; expand consensus on the elements and processes endemic to digital information preservation and access; and create a framework to guide the identification and development of standards. Described in: http://public.ccsds.org/publications/archive/650x0b1.pdf
  • Preservation metadata. Metadata related to the preservation management of information resources, for example, metadata used to document, or created as a result of, preservation processes performed on information resources.
  • Rights metadata. A form of administrative metadata dealing with rights management statements, including ownership statements, licenses, permissions, etc.
  • Section 508. Section 508 refers to a statutory section in the Rehabilitation Act of 1973 (found at 29 U.S.C. 794d). Congress significantly strengthened section 508 in the Workforce Investment Act of 1998. Its primary purpose is to provide access to and use of Federal executive agencies’ electronic and information technology (EIT) by individuals with disabilities. The statutory language of Section 508 can be found at http://www.section508.gov/ . The Access Board http://www.access-board.gov wrote the Section 508 standards and is the U.S. federal agency responsible for developing and enforcing accessibility requirements. See also: Americans with Disabilities Act (ADA)
  • Structural metadata. Information used to display and navigate digital resources; also includes information on the internal organization of the digital resource. Structural metadata might include information such as the structural divisions of a resource (that is, chapters in a book) or sub-object relationships (such as individual diary entries in a diary section).
  • Style Sheets. Style sheets describe how documents are presented on screens, in print, or perhaps how they are pronounced. By attaching style sheets to structured documents on the Web (for example XML), authors/creators and readers can influence the presentation of documents without sacrificing device-independence or adding new XML tags. See also: XSL
  • Technical metadata. Metadata created for, or generated by, a computer system, relating to how the system or its content behaves or needs to be processed.
  • Uniform Resource Name (URN). Also referred to as "Universal Resource Name/Number." A unique, location-independent identifier of a file available on the Internet. The file remains accessible by its URN regardless of changes that might occur in its host and directory path. For information about Internet addressing, Described in: http://www.w3.org/Addressing/Addressing.html . See also: Digital Object Identifier (DOI®)
  • Use metadata. Metadata, generally automatically created by the computer, that relate to the level and type of use of an information system.
  • USMARC. See: MARC 21
  • XML. XML is extensible Markup Language, a project of the World Wide Web Consortium (W3C): the development of the specification is being supervised by their XML Working Group. It is designed to improve the functionality of the Web by providing more flexible and adaptable information identification. It is called extensible because it is not a fixed format like HTML (a single, predefined markup language). Instead, XML is actually a metalanguage—a language for describing other languages—which allows customized markup languages for limitless different types of objects. XML can do this because it's written in SGML (ISO 8879), the international standard metalanguage for text markup systems.
  • XSL. XSL (extensible Stylesheet Language) is a language for expressing stylesheets for XML objects. It consists of two parts: a language for transforming XML objects, and an XML vocabulary for specifying formatting semantics. The originality and power of XSL is more general than just describing how XML items should be presented; it allows, as well as describes, how these objects can be transformed into other objects. The part of XSL dealing with document transformation is called XSLT. The part of XSL dealing with formatting objects is called XSL-FO. XSL and XSLT are currently working drafts of the World Wide Web Consortium (W3C).
Retrieved from "https://pravka.bskol.com/w/index.php?title=ANSI/NISO_Scientific_and_Technical_Reports&oldid=63673"