Versions Compared

Old Version 4

changes.mady.by.user Jenny Seifert

Saved on

compared with

New Version Current

changes.mady.by.user Jenny Seifert

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

What to Include and Not Include in the Front Matter

A large amount of the front matter content that appears in typeset USGS documents is static, or boilerplate, text. Further, several components of the front matter are duplicated in the final PDF; for example, the document title and authors appear more than once on different pages in the front matter. eXtyles can automatically generate much of the front matter boilerplate content, and in an XML workflow it is

not

best practice to avoid having duplicate content (that is,

have

the same thing

appear

in more than one place) in the XML. Because of this, when using eXtyles the front matter in

the

USGS Word documents is greatly simplified.


Panel
titleIn this section

Table of Contents


Include

Title Page

The

associated

following example shows how the

front matter

title page of a typical USGS document is organized in eXtyles. Note that only the

only

following elements

that

are retained

are

:

  • USGS logo (not required, but can be retained if desired)
Secondary Identification
  • Document title for the Suggested Citation (note the sentence-style capitalization)
  • Document title for the Running Head (note the shortened length)
  • Cooperator statement, if provided
  • Program note information, if provided
  • Document title
  • Document authors
  • Author affiliations, if provided
Note
titleA note about the Suggested Citation and Running Head

Despite the XML best practice to avoid duplicate content, to ensure the accurate automated layout of content in InDesign using Typefi, some content must be provided in more than one place; specifically, the document title, the suggested citation, and the running head.

  • document authors

    • All other front matter content is deleted from the document.

    Image Removed

    These three versions of the document title are, in fact, slightly different from one another: the suggested citation follows different capitalization rules and the running head is often a shorter version of the title. Because of this, the document title will need to appear in more than one place on the title page, as shown in the example.


    Other Front Matter

    If present, the following front matter elements are also retained:

    • List of Plates, Maps (or other objects that do not appear in the Word document)
    • Version history dates and descriptions
    • Associated Data
    • Foreword
    • Preface
    • Acknowledgments
    • Conversion Factors
    • Datum Statements
    • Abbreviations

    See USGS Styles for more information about how to style these front matter sections.

    Note
    titleA note about the List of Plates, Maps, and so on

    Occasionally the table of contents for a USGS publication will include a list of objects that do not also appear in the Word document (e.g., maps, plates, etc.). This is distinct from TOC lists of figures and tables, the captions and titles of which are also included in the Word document. Therefore, to ensure that these lists of objects are included in the PDF, they must be included in the front matter of the document.


    Panel
    titleTypical Front Matter Elements

    Image Added


    Panel
    titleAssociated Data Example

    Image Added

    Do Not Include

    Boilerplate Content

    Boilerplate content–that is, content that remains static across documents, such as information about the Secretary of the Interior and

    Director–can

    the USGS Director–will be added to the XML during export. Because of this, boilerplate content should be removed from the Word document.

    In USGS documents, boilerplate content includes:

    • U.S. Department of the Interior Secretary and USGS Director information
    • USGS address
    • USGS "for more information" content
    • USGS copyright statement
    • ISBNs and/or ISSNs

    Suggested Citation

    Following XML best practice to avoid duplicate content, the suggested citation should be removed from the Word document. It can be constructed from existing metadata (e.g., publication year) and information in the Word document (e.g., title and authors).


    Table of Contents / List of Figures and Tables

    The document's table of contents is best generated from the XML during layout. Because of this, remove entirely the tables of contents and lists of figures and tables from the Word documents (see, however, the previous note about Lists of Plates, Maps, and so on).