Preparation of technical Publications in an automated support environment can be viewed as a multi-step process:
a. Creating a document type declaration for publication control if one does not exist;
b. Creating a FOSI if one does not exist to specify the formatting to be applied to documents conforming with the document type declaration;
c. Authoring the publication and inserting SGML markup tags;
d. Verifying that the syntax is correct according to the rules of SGML;
e. Using a FOSI and document type declaration to direct the composition of the document so that the produced (printed or displayed) copy corresponds to the proper formal and style;
f. Optionally, reviewing the document electronically using SGML for the comments; and
g. Optionally, generating a text presentation metafile in a page description language (PDL) to drive the display device, such as a printer or typesetter.
This specification addresses all the steps in the publication preparation process with the exception of the authoring process. Refer to MIL-M-38784 and applicable service Technical Manual (TM) functional specifications for detailed authoring requirements.
It is in the interest of both DoD and industry to agree on the most widely applicable set of conventions for the preparation and interchange of technical publications for both defense and non-defense use. The preparing office for this specification encourages proposals that would contribute toward tins goal. For example, the Air Transport Associations (ATA) is developing an SGML application for use within the commercial airline industry, and both ATA and DoD have expressed interest in collaborating on common specifications. The Society of Automotive Engineers (SAE) has already published a specification (AS4159) that makes use of DoD specifications and standards for automated interchange of technical standards.
Appendices A, B, and C provide the tools for steps a, b, and c above, the result of which is a complete publication source file, or input file, together with a document type declaration support file when required by 3.2. Delivery requirements for source files am in 3.1.1. It is the source file to which all subsequent changes and updates must be made to maintain the technical publication throughout its operational life. Therefore, the source file is a mandatory final deliverable
when this specification is cited in the contract. Source files containing either the complete text of the technical publication, or portions of the text, may be delivered as interim Products. Through the use of the SGML declaration (appendix A, 30.7), the document type declaration, the tag descriptions, the output specification and a FOSI, the delivered source will contain the required information for subsequent processing. An appropriate SGML document type declaration set should be developed and used both for document preparation and for technical publication verification that the document conforms to the logical constructs within the document type declaration set.
An SGML document type declaration set is used in steps a, b, and c above. Appendix B provides an output style and formatting specification used to accomplish step e in the document preparation process. The document type declaration set and FOSI are the support files, delivery requirements for which are in 3.1.2. If a public document type declaration set is used as publicly defined, it need only be cited with the delivery. However, the text of the document type declaration set support file must be delivered with the source file when the technical Publication does not conform to the requirements of public document type declaration sets. A complete FOSI must be delivered with the source file until publicly identified FOSIs are available.
Step g in the document preparation process uses a PDL to produce an output file, sometimes called a text presentation metafile, to drive an output device such as a printer.
This specification Provides the tags by which raster or vector illustration files can be referenced in the source file, and incorporated in the final composed technical publication document. Preparation requirements for technical publication illustration files are addressed in MIL-STD--1840. Delivery requirements for technical publication MIL-STD-1840.
Tables are typically included as SGML-tagged text in the source file. The definition of the table may be explicitly included in the document instance or may be included through the use of an entity reference to an external or internal table definition. If an external entity is used, it may be me that is publicly identified or one that is created for use with a particular document instance and is known as a SYSTEM external entity. A publicly identified entity need not be submitted with a MIL-STD-1840-compliant deliverable, although it must be cited in the document type declaration submitted with the document instance. A SYSTEM external entity declaration must be submitted with the MIL-STD-1840-compliant deliverable. When creating a tagged instance for a specific document or contract, tables can also be delivered as illustration files (using the graphic element type) where preparation requirements make this alternative more cost effective, or where preparation requirements exceed the capability of the markup tags in the tags in the reference DTD. Delivery of tables as separate illustration files seriously limits their utility for additional processing, and is discouraged.
The delivery options in this specification (see 6.1.2, 6.1.3, 6.1.4. and 6.1.5) should be applied based on an analysis of how the information is to be used. For example, an output (PDL) file can be used for both electronic publishing of hardcopy and electronic softcopy display, but it cannot support interactive retrieval as can an SGML-tagged text source file.
View Less