CONTENTS Title Page Copyright Page Preface New Features 1 Overview of the Doctype-Specific Tags 1.1 Using Doctypes and Doctype-Specific Tags 2 Using the ARTICLE Doctype 2.1 ARTICLE Doctype Common Elements 2.1.1 Titles and Subtitles 2.1.2 Author Information 2.1.3 Abstracts, Source Notes, and Acknowledgments 2.1.4 Headings 2.1.5 Running Titles and Running Feet 2.1.6 Quotations 2.1.7 Numbered Notes 2.1.7.1 Back Notes 2.1.7.2 Reference Notes 2.1.8 Bibliographies 2.2 Improving the Format of a 2-Column Doctype 2.2.1 Line Breaks in Columns 2.2.2 Wide Tables and Examples 2.2.3 Final Adjustment of Column and Page Breaks 2.3 A Sample Use of the ARTICLE Doctype Tags 2.4 ARTICLE Doctype Tag Reference <ABSTRACT> <ACKNOWLEDGMENTS> <AUTHOR> <AUTHOR_ADDR> <AUTHOR_AFF> <AUTHOR_LIST> <BACK_NOTE> <BACK_NOTES> <BIBLIOGRAPHY> <BIB_ENTRY> <COLUMN> <DOCUMENT_ATTRIBUTES> <QUOTATION> <REF_NOTE> <REF_NOTES> <RUNNING_FEET> <RUNNING_TITLE> <SOURCE_NOTE> <SUBTITLE> <TITLE> <TITLE_SECTION> <VITA> 3 Using the HELP Doctype 3.1 Creating a HELP File 3.1.1 How HELP Interprets Reference Sections 3.1.2 How HELP Interprets the Input File 3.1.3 How to Selectively Include and Exclude Text for Help Output 3.1.4 How to Handle Special Cases 3.2 How to Read the Help File Online 3.3 HELP Doctype Tag Reference <BOOK_ONLY> <HELP_ONLY> <KEEP_HELP_LEVEL> <SET_HELP_LEVEL> 4 Using the LETTER Doctype 4.1 Sample Uses of the LETTER Doctype Tags 4.1.1 A Sample Memo 4.1.2 A Sample Letter 4.2 LETTER Doctype Tag Reference <CC> <CCLIST> <CLOSING> <DISTLIST> <FROM_ADDRESS> <MEMO_DATE> <MEMO_FROM> <MEMO_HEADER> <MEMO_LINE> <MEMO_TO> <SALUTATION> <SUBJECT> <TO_ADDRESS> 5 Using the MANUAL Doctype 5.1 Example of Using the MANUAL Doctype 6 Using the MILSPEC Doctype 6.1 MILSPEC Template Files 6.2 MILSPEC Doctype Conformance and Format 6.2.1 Example of Using the MILSPEC.SECURITY and MILSPEC.DRAFT Doctypes 6.3 Creating MIL-STD-490A Documents 6.4 Creating Data Item Description Documents 6.4.1 Creating DOD-STD-2167 Documents 6.4.2 Creating DOD-STD-2167A Documents 6.4.2.1 Using the Data Item Description Template Files 6.5 MILSPEC Doctype Tag Reference <CODE_EXAMPLE> <DOCUMENT_ATTRIBUTES> <HEADn> <HIGHEST_SECURITY_CLASS> <RUNNING_FEET> <RUNNING_TITLE> <SECURITY> <SET_APPENDIX_NUMBER> <SET_CONTENTS_SECURITY> <SET_PAGE_SECURITY> <SET_SECURITY_CLASS> <SIGNATURE_LINE> <SIGNATURE_LIST> <SPECIFICATION_INFO> <SPEC_TITLE> <SUBTITLE> 7 Using the ONLINE Doctype 7.1 ONLINE Doctype Tag Reference <BOOK_ONLY> <BOOK_REF> <EXTENSION> <HOTSPOT> <HELP_ONLY> <KEEP_HELP_LEVEL> <LMF> <LMF_ALTNAME> <LMF_INFO> <LMF_PRODUCER> <LMF_PRODUCT> <LMF_RELEASE_DATE> <LMF_VERSION_NUMBER> <ONLINE_CHUNK> <ONLINE_POPUP> <ONLINE_TITLE> <SET_HELP_LEVEL> <SET_ONLINE_TOPIC> <SHELF_CREATE> <SHELF_REF> 8 Using the OVERHEADS Doctype 8.1 A Sample Use of the OVERHEADS Doctype Tags 8.2 OVERHEADS Doctype Tag Reference <AUTHOR_INFO> <AUTO_NUMBER> <INTRO_SUBTITLE> <INTRO_TITLE> <RUNNING_FEET> <RUNNING_TITLE> <SLIDE> <SUBTITLE> <TEXT_SIZE> <TITLE> <TOPIC> 9 Using the REPORT Doctype 9.1 Characteristics of the REPORT Design 9.2 Sample Use of the REPORT Doctype Tags 9.3 A Sample Use of the REPORT.TWOCOL Doctype Tags 9.4 REPORT Doctype Tag Reference <AUTHOR> <BYLINE> <COLUMN> <DOCUMENT_ATTRIBUTES> <LEVEL> <OUTLINE> <RUNNING_FEET> <RUNNING_TITLE> <SECTION> <SHOW_LEVELS> <SIGNATURES> 10 Using the SOFTWARE Doctype 10.1 Characteristics of the SOFTWARE Designs 10.2 Common Software Description Tasks 10.3 Documenting Terminal Keys and Keypads 10.3.1 Describing Individual Keys 10.3.2 Describing Keypads and Keypad Keys 10.4 Documenting Code Fragments 10.5 Documenting Software Messages 10.6 Documenting Arguments, Parameters, and Qualifiers 10.7 Creating a Series of Interactive or Code Examples 10.8 Using the Reference Templates 10.9 Creating Your Own Reference Template Tags 10.10 Creating Your Own Template Tables 10.11 Modifying the Reference Templates 10.12 Modifying Default Headings in a Template 10.13 Using the Template-Enabling Tags 10.13.1 Template-Enabling Tag Behavior in the SOFTWARE.SPECIFICATION Doctype 10.14 Using the <SET_TEMPLATE_templatename> Tags FIND_FIRST 10.15 Using the Command Template 10.15.1 Sample SDML File of the Command Template 10.15.2 Sample Output File of the Command Template APPEND 10.16 Using the Routine Template 10.16.1 Sample SDML File of the Routine Template 10.16.2 Sample Output File of the Routine Template $ENQ MTH$xSQRT 10.17 Using the Statement Template 10.17.1 Sample SDML File of the Statement Template 10.17.2 Sample Output File of the Statement Template RECORD MID$ 10.18 Using the Tag Template 10.18.1 Sample SDML File of the Tag Template 10.18.2 Sample Output File of the Tag Template <SYNTAX> 10.19 The SOFTWARE Doctype Tags <ARGDEF> <ARGDEFLIST> <ARGITEM> <ARGTEXT> <ARGUMENT> <ARG_SEP> <AUTHOR> <BYLINE> <COMMAND> <COMMAND_SECTION> <CONSTRUCT> <CONSTRUCT_LIST> <CPOS> <DELETE_KEY> <DESCRIPTION> <DISPLAY> <DOCUMENT_ATTRIBUTES> <EXAMPLE_SEQUENCE> <EXAMPLES_INTRO> <EXC> <EXI> <EXTEXT> <FARG> <FARGS> <FCMD> <FFUNC> <FORMAT> <FORMAT_SUBHEAD> <FPARM> <FPARMS> <FRTN> <FTAG> <FUNCTION> <GRAPHIC> <KEY> <KEYPAD> <KEYPAD_ENDROW> <KEYPAD_ROW> <KEYPAD_SECTION> <KEY_NAME> <KEY_PLUS> <KEY_SEQUENCE> <KEY_TYPE> <MESSAGE_SECTION> <MESSAGE_TYPE> <MSG> <MSGS> <MSG_ACTION> <MSG_FACILITY> <MSG_SEVERITY> <MSG_TEXT> <OVERVIEW> <PARAMDEF> <PARAMDEFLIST> <PARAMITEM> <PROMPT> <PROMPTS> <QPAIR> <QUALDEF> <QUALDEFLIST> <QUALITEM> <QUAL_LIST> <QUAL_LIST_DEFAULT_HEADS> <QUAL_LIST_HEADS> <RELATED_ITEM> <RELATED_TAG> <RELATED_TAGS> <RESTRICTIONS> <RETTEXT> <RETURNS> <RETURN_VALUE> <RITEM> <ROUTINE> <ROUTINE_SECTION> <RSDEFLIST> <RSITEM> <RUNNING_FEET> <RUNNING_TITLE> <SDML_TAG> <SET_TEMPLATE_ARGITEM> <SET_TEMPLATE_COMMAND> <SET_TEMPLATE_HEADING> <SET_TEMPLATE_LIST> <SET_TEMPLATE_PARA> <SET_TEMPLATE_ROUTINE> <SET_TEMPLATE_STATEMENT> <SET_TEMPLATE_SUBCOMMAND> <SET_TEMPLATE_TABLE> <SET_TEMPLATE_TAG> <SIGNATURES> <STATEMENT> <STATEMENT_FORMAT> <STATEMENT_LINE> <STATEMENT_SECTION> <SUBCOMMAND> <SUBCOMMAND_SECTION> <SUBCOMMAND_SECTION_HEAD> <SYNTAX> <SYNTAX_DEFAULT_HEAD> <TAG_SECTION> <TERMINATING_TAG> EXAMPLES 6-1 Coding a 2167A-Formatted Document FIGURES 2-1 ARTICLE Doctype Design 2-2 ARTICLE Doctype Output Example, Page 1 2-3 ARTICLE Doctype Output Example, Page 2 4-1 LETTER Doctype Design 4-2 LETTER Doctype Output Example for Memo 4-3 LETTER Doctype Output Example for Letter 5-1 MANUAL Doctype Designs 5-2 MANUAL Doctype Output Example, Title Page 5-3 MANUAL Doctype Output Example, Interior Page 6-1 MILSPEC Doctype Designs 6-2 MILSPEC.SECURITY Doctype Output Example, Title Page 6-3 MILSPEC.SECURITY Doctype Output Example, Interior Page 6-4 MILSPEC.DRAFT Doctype Output Example, Title Page 6-5 MILSPEC.DRAFT Doctype Output Example, Interior Page 1 6-6 MILSPEC.DRAFT Doctype Output Example, Interior Page 2 8-1 OVERHEADS Doctype Designs 8-2 OVERHEADS Doctype Output Example, First Slide 8-3 OVERHEADS Doctype Output Example, Second Slide 9-1 REPORT Doctype Designs 9-2 REPORT Doctype Output Example, Title Page 9-3 REPORT Doctype Output Example, Interior Page 9-4 REPORT.TWOCOL Doctype Output Example, Title Page 9-5 REPORT.TWOCOL Doctype Output Example, Interior Page 10-1 SOFTWARE Doctype Designs TABLES 1 Conventions Used in this Manual 1-1 Supported Doctypes 2-1 Page Layout of the ARTICLE Design 2-2 Tags Available in the ARTICLE Doctype 2-3 Doctype-specific Tags Enabled by the <DOCUMENT_ATTRIBUTES> Tag 4-1 Page Layout of the LETTER Doctype Design 4-2 Tags Available in the LETTER Doctype 5-1 Page Layout of the MANUAL.GUIDE Doctype Design 5-2 Page Layout of the MANUAL.PRIMER Design 5-3 Page Layout of the MANUAL.REFERENCE Design 6-1 Page Layout of the MILSPEC Designs 6-2 MILSPEC Doctype Tags 6-3 MILSPEC Doctype DOD-STD-2167 Data Item Description Templates 6-4 MILSPEC.SECURITY Doctype DOD-STD-2167A Data Item Description Templates 6-5 Doctype-specific Tags Enabled by the <DOCUMENT_ATTRIBUTES> Tag 8-1 Page Layout of the OVERHEADS Design 8-2 Page Layout of the OVERHEADS.35MM Design 8-3 Tags Available in the OVERHEADS Doctype 9-1 Page Layout of the REPORT Doctype Design 9-2 Page Layout of the REPORT.TWOCOL Doctype Design 9-3 Tags Available in the REPORT Doctype 9-4 Doctype-specific Tags Enabled by the <DOCUMENT_ATTRIBUTES> tag 10-1 Page Layout of the SOFTWARE.BROCHURE Doctype Design 10-2 Page Layout of the SOFTWARE.GUIDE Doctype Design 10-3 Page Layout of the SOFTWARE.HANDBOOK Doctype Design 10-4 Page Layout of the SOFTWARE.POCKET_REFERENCE Doctype Design 10-5 Page Layout of the SOFTWARE.REFERENCE Doctype Design 10-6 Page Layout of the SOFTWARE.SPECIFICATION Doctype Design 10-7 Default Headings of Reference Template Tags 10-8 Command Template Tags as Available from DOC$TEMPLATES 10-9 Routine Template Tags as Available from DOC$TEMPLATES 10-10 Statement Template Tags as Available from DOC$TEMPLATES 10-11 Tag Template Tags as Available from DOC$TEMPLATES 10-12 Doctype-specific Tags Enabled by the <DOCUMENT_ATTRIBUTES> Tag