Versions Compared

Key

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


Info

This section provides detailed information about how to use the styles on the Title tab of the eXtyles style palette. Descriptions of the specific use of styles are provided along with XML and Word samples.

Cover Elements

Document Details

Measurement is applied to the paragraph indicating the measurement units used throughout the document. If a specified unit of measurement is not applicable to the document, then this style may be applied to the text “NOT MEASUREMENT SENSITIVE” or synonymous string. DocID is applied to the standard’s ID or designation string. Date is applied to the specification date (see Example 1).

Superseding Document

Documents that supersede earlier standards include the label “SUPERSEDING,” which takes the Supersedes paragraph style. Supersedes Designation is applied to the designation (or ID) of the standard that is superseded by the document. Supersedes Date is applied to the date of the superseded document (see Example 1).

Document Title

Title Prefix is applied to the prefix of the title, which usually indicates the type of document or specification. Report Title is applied to the primary title of the document. The subtitle of the document, if any, appears as a separate paragraph after the main title, and it takes the Report Subtitle paragraph style (see Example 1).

Specification Information

Distribution Info is applied to the paragraph describing the intended audience of the document. Contact Info is applied to paragraphs containing the contact information associated with the document (see Example 1).


Panel
bgColor#b5b8bc

Back to the Style Guide


Panel
titleOn This Page

Table of Contents



Example 1: Cover Page

Word Sample

The following example shows the proper application in the Word document of title page styles available on the Title tab of the eXtyles style palette.


XML Samples

The following XML samples are derived from the previous Word example. All of this content is located in <std-doc-meta> in the <front> of the document.

Document Details

Code Block
languagexml
titleMeasurement
<custom-meta-group>
<custom-meta><meta-name>Units</meta-name><meta-value>INCH-POUND</meta-value></custom-meta>
</custom-meta-group>

Code Block
languagexml
titleDocument ID (DocID)
<std-ref type="dated">MIL-DTL-11484/327A</std-ref>

Dates

For standards documents, dates associated with the publication process are generally included in the Word file to be rendered in print. So long as they are correctly styled, eXtyles will automatically identify the various dates associated with the publication and apply the appropriate attribute to the date in the XML file. All of this identification can be done without any special markup in the Word file. The key to this process is the consistent use of wording to identify each date.

This previous Word example has on the title page a date styled as “Release Date” following the document ID; for example,

Panel

MIL-PRF-39012F

29 May 2018

The following XML is generated; note the iso-8601-date attribute.

Code Block
languagexml
titleDate
<release-date date-type="other" iso-8601-date="2018-05-29">29 May 2018</release-date>

As can be seen from this example, eXtyles automatically parses the date into an attribute in the <release-date> element (e.g., iso-8601-date="2017-05-18"). This process is most robust if months are spelled out as words or as abbreviations and years are given as four digits.

Dates given in the form XXXX-XX-XX (e.g., 2012-05-11) will be parsed as YYYY-MM-DD (i.e., 11 May not 5 November). If months are given as digits (e.g., 12-08-2010 or 12-08-10), by default, eXtyles will identify the date as MM-DD-YY(YY) (i.e., U.S. date format; December 8, 2010) and will warn that the date is ambiguous.

Image Added

The character used to separate the various elements of the date is reasonably flexible: slashes, colons, hyphens, or periods all enable dates to parse correctly.

If particular dates are not available at the time that the XML is exported, eXtyles will allow either X (e.g. XX-XX-XXXX) or two or more Ys, Ms, and Ds (e.g. MM-DD-YYYY) as placeholders that can later be replaced in the XML once the date is known.

Superseding Document

Code Block
languagexml
titleSuperseding Document
<std-xref type="supersedes">
<std-ref type="dated">MIL-DTL-11484/327</std-ref>
<release-date>8 July 2013</release-date>
</std-xref>

Document Title

Code Block
languagexml
titleDocument Title
<title-wrap>
<intro>DETAIL SPECIFICATION SHEET</intro>
<main-title-wrap>
<main>LAPEL BUTTON, NATIONAL INTELLIGENCE MEDAL FOR DISTINGUISHED PUBLIC SERVICE, OFFICE OF THE DIRECTOR OF NATIONAL INTELLIGENCE</main>
</main-title-wrap>
</title-wrap>

Specification Information

Code Block
languagexml
titleDistribution
<notes notes-type="distribution">
<p>This specification is approved for use by all Departments and Agencies of the Department of Defense</p>
</notes>










Example 2: Cover Page

Another example of the proper use of the styles available on the Title tab of the eXtyles style palette.

Word Sample

XML Samples

The following XML samples are derived from the previous Word example. All With the exception of agency and agent information, all of this content is located in <std-doc-meta> in the <front> of the document.

Document Details

Code Block
languagexml
titleDocument ID (DocID) and Edition
<std-ref type="dated">NIST Special Publication 800-30
<edition>Revision 1</edition>
</std-ref>


Code Block
languagexml
titleRelease Date
<release-date date-type="other" iso-8601-date="2012-09">September 2012</release-date>

Document Title 

Code Block
languagexml
titleDocument Title
<title-wrap>
<main-title-wrap>
<main>Guide for Conducting Risk Assessments</main>
</main-title-wrap>
</title-wrap>

Authorization and Subject Group

Code Block
<authorization>JOINT TASK FORCE TRANSFORMATION INITIATIVE</authorization>
<subj-group>
<subject>Information Security</subject>
</subj-group>

Publisher Information

Code Block
languagexml
titlePublisher Location
<std-org-group>
<std-org>
<std-org-loc>
<addr-line>Computer Security Division</addr-line>
<addr-line>Information Technology Laboratory</addr-line>
<addr-line>National Institute of Standards and Technology</addr-line>
<addr-line>Gaithersburg, MD 20899-8930</addr-line>
</std-org-loc>
</std-org></std-org-group>

Agency Information

Note that agency and agent information is placed after <std-doc-meta> in the <front>.

Code Block
languagexml
titleAgent and Agency
<notes notes-type="agencies">
<p content-type="agency">U.S. Department of Commerce</p>
<p content-type="agent">Rebecca M. Blank, Acting Secretary</p>
<p content-type="agency">National Institute of Standards and Technology</p>
<p content-type="agent">Patrick D. Gallagher, Under Secretary for Standards and Technology and Director</p>
</notes>