DECdocument
Using Doctypes and Related Tags
Volume 1

Contents

Index

<DOCUMENT_ATTRIBUTES>

Enables doctype-specific tags that override the default design format of the MILSPEC doctypes.

Syntax

<DOCUMENT_ATTRIBUTES>

related tags

<RUNNING_FEET>
<RUNNING_TITLE>

required terminator

<ENDDOCUMENT_ATTRIBUTES>

DESCRIPTION

The <DOCUMENT_ATTRIBUTES> tag enables doctype-specific tags that override the default design format of the MILSPEC doctypes. The <DOCUMENT_ATTRIBUTES> tag enables a group of tags that let you modify the default format of these doctypes. The default format of these doctypes is:

Appendixes are numbered by Roman numerals and Arabic numerals.
Formal tables, figures, and examples are numbered using the current section (paragraph) number.
Headings are placed, alternately, on the right and left pages.
Running footers (running headings at the bottom of the page) are placed, alternately, on the right and left pages.

The tags that let you modify the default format are recognized only in the context of the <DOCUMENT_ATTRIBUTES> tag. If you use other SDML tags in this context, they are ignored, as if they had occurred in the context of a <COMMENT> tag.
Use the <DOCUMENT_ATTRIBUTES> tag at the beginning of an input file (or in a file specified using the DOCUMENT /INCLUDE qualifier) to alter the default format of a doctype for the processing of that entire file.
Table 7-5 summarizes the formatting tags enabled by the <DOCUMENT_ATTRIBUTES> tag in these doctypes.

Table 7-5 Doctype-specific Tags Enabled by the<DOCUMENT_ATTRIBUTES> Tag
Formatting Tags Description

Tags Enabled in the MILSPEC.SECURITY and MILSPEC.DRAFT Doctypes

<INDENT_FIRST_LIST>(TRUE)
<INDENT_FIRST_LIST>(FALSE) Specifies whether to indent lists that are not nested in other lists.

The TRUE keyword causes lists and their list item designators (such as numbers or bullets) to be indented from the current left text margin.
The FALSE keyword causes lists and their list item designators to be placed flush with the current left text margin.
The default keyword is FALSE.

<SET_APPENDIX_ENUMERATION>(ALPHABETIC)
<SET_APPENDIX_ENUMERATION>(ROMAN) Specifies whether appendixes are identified using letters or Roman numerals. By default in the MILSPEC doctypes, appendixes are assigned Roman numerals and Arabic numerals. If you specify <SET_APPENDIX_ENUMERATION>(ALPHABETIC), then the appendixes will be identified using letters.

<SET_FORMAL_ELEMENT_NUMBERING>(BY_SECTION)
<SET_FORMAL_ELEMENT_NUMBERING>(SEQUENTIAL) Specifies how formal tables, figures, and examples are to be numbered in a document processed using the MILSPEC doctypes. By default, formal tables, figures, and examples are numbered in this doctype using the current section (paragraph) number.
The SEQUENTIAL keyword indicates that formal elements are to be numbered sequentially throughout the document; for example, the eighth formal table in the document, regardless of what chapter it occurs in, is numbered Table 8.

<SET_HEADERS>(RIGHT)
<SET_HEADERS>(LEFT)
<SET_HEADERS>(CENTERED)
<SET_HEADERS>(CYCLE) Specifies the positioning of running headings near the top of the page.

The RIGHT keyword causes headings to be placed on the right-hand side of the page.
The LEFT keyword causes headings to be placed on the left-hand side of the page.
The CENTERED keyword causes headings to be centered on the page.
The CYCLE keyword indicates that headings should appear on the right-hand side when the page number is odd and on the left-hand side of the page when the page number is even.

The default keyword is CYCLE.

<SET_FOOTERS>(RIGHT)
<SET_FOOTERS>(LEFT)
<SET_FOOTERS>(CYCLE) Specifies the positioning of running feet near the bottom of the page.

The RIGHT keyword causes the running footer to be placed on the right-hand side of the page.
The LEFT keyword causes the running footer to be placed on the left-hand side of the page.
The CYCLE keyword causes the running footer to be placed on the right-hand side when the page is even and on the left-hand side of the page when the page number is odd.

The default keyword is CYCLE.

**Table 7-5 Doctype-specific Tags Enabled by the<DOCUMENT_ATTRIBUTES> Tag**
Formatting Tags	Description
Tags Enabled in the MILSPEC.SECURITY and MILSPEC.DRAFT Doctypes
<INDENT_FIRST_LIST>(TRUE) <INDENT_FIRST_LIST>(FALSE)	Specifies whether to indent lists that are not nested in other lists. The TRUE keyword causes lists and their list item designators (such as numbers or bullets) to be indented from the current left text margin. The FALSE keyword causes lists and their list item designators to be placed flush with the current left text margin. The default keyword is FALSE.
<SET_APPENDIX_ENUMERATION>(ALPHABETIC) <SET_APPENDIX_ENUMERATION>(ROMAN)	Specifies whether appendixes are identified using letters or Roman numerals. By default in the MILSPEC doctypes, appendixes are assigned Roman numerals and Arabic numerals. If you specify <SET_APPENDIX_ENUMERATION>(ALPHABETIC), then the appendixes will be identified using letters.
<SET_FORMAL_ELEMENT_NUMBERING>(BY_SECTION) <SET_FORMAL_ELEMENT_NUMBERING>(SEQUENTIAL)	Specifies how formal tables, figures, and examples are to be numbered in a document processed using the MILSPEC doctypes. By default, formal tables, figures, and examples are numbered in this doctype using the current section (paragraph) number. The SEQUENTIAL keyword indicates that formal elements are to be numbered sequentially throughout the document; for example, the eighth formal table in the document, regardless of what chapter it occurs in, is numbered Table 8.
<SET_HEADERS>(RIGHT) <SET_HEADERS>(LEFT) <SET_HEADERS>(CENTERED) <SET_HEADERS>(CYCLE)	Specifies the positioning of running headings near the top of the page. The RIGHT keyword causes headings to be placed on the right-hand side of the page. The LEFT keyword causes headings to be placed on the left-hand side of the page. The CENTERED keyword causes headings to be centered on the page. The CYCLE keyword indicates that headings should appear on the right-hand side when the page number is odd and on the left-hand side of the page when the page number is even. The default keyword is CYCLE.
<SET_FOOTERS>(RIGHT) <SET_FOOTERS>(LEFT) <SET_FOOTERS>(CYCLE)	Specifies the positioning of running feet near the bottom of the page. The RIGHT keyword causes the running footer to be placed on the right-hand side of the page. The LEFT keyword causes the running footer to be placed on the left-hand side of the page. The CYCLE keyword causes the running footer to be placed on the right-hand side when the page is even and on the left-hand side of the page when the page number is odd. The default keyword is CYCLE.

Example

The following example shows how to use the <DOCUMENT_ATTRIBUTES> tag to create centered headings and to cause appendixes to be ordered using letters.

<DOCUMENT_ATTRIBUTES> 
<SET_HEADINGS>(CENTERED) 
<SET_APPENDIX_ENUMERATION>(ALPHABETIC) 
<ENDDOCUMENT_ATTRIBUTES>

<HEADn>

Marks a heading of the level specified (1 through 20).

Syntax

<HEADn> (heading text [\symbol name])

ARGUMENTS

heading text
Specifies the text of the heading. If the book design you are using outputs headings that are all capital letters, those headings capitalize regardless of the way you enter them in your input file. However, use uppercase and lowercase letters, according to your local conventions, to obtain the proper capitalization of the heading in the table of contents and in cross-references.
symbol name
This is an optional argument. It specifies the name of the symbol used in all references to this heading.
Symbol names must not exceed 31 characters and must only contain alphabetic letters, numbers, or underscores. Do not begin a symbol name with an underscore.

related tags

The global <CHEAD> tag
The global <SUBHEAD1> tag
The global <SUBHEAD2> tag

DESCRIPTION

The <HEADN> tag marks a heading of the level specified (1 through 20). Each of the 20 tags (<HEAD1> through <HEAD20>) does the following:

Outputs the heading text specified in its first argument
Automatically numbers the heading
Resets all lower heading levels (if any)
Specifies the symbol name with which cross-references to that heading should be made
Automatically places an entry for the heading in the table of contents

The proper choice of the heading level depends on an understanding of the logical structure of the document you are writing. A <HEAD2> tag will always be logically subordinate to a <HEAD1> tag. The same is true for the relationship between <HEAD3> and <HEAD2>, <HEAD4> and <HEAD3>, and so on.

Examples

The following tag creates a fourth-level heading.

#1
<HEAD4>(SET and SHOW Tasks\set_show_sec)
The following tag creates an eighth-level heading.

#2
<HEAD8>(Other Tasks\other_sec)
An example of a heading created by the <HEAD4> tag would be 1.1.1.1 Set. If the heading number created by the tag was 1.1.1.1, then a reference to \set_show_sec would output as Section 1.1.1.1.
Use the <REFERENCE> tag as shown in the following table to modify the output of the cross-reference.

Reference Output

<REFERENCE>(set_show_sec) Section 1.1.1.1

<REFERENCE>(set_show_sec\value) 1.1.1.1

<REFERENCE>(set_show_sec\text) Set and Show Tasks

<REFERENCE>(set_show_sec\full) Section 1.1.1.1, Set and Show Tasks

<HIGHEST_SECURITY_CLASS>

Prints the classification text associated with the highest security classification encountered in a document.

Syntax

<HIGHEST_SECURITY_CLASS>

Reference	Output
<REFERENCE>(set_show_sec)	Section 1.1.1.1
<REFERENCE>(set_show_sec\value)	1.1.1.1
<REFERENCE>(set_show_sec\text)	Set and Show Tasks
<REFERENCE>(set_show_sec\full)	Section 1.1.1.1, Set and Show Tasks

related tags

<SECURITY>
<SET_PAGE_SECURITY>

DESCRIPTION

The <HIGHEST_SECURITY_CLASS> tag prints the classification text associated with the highest security classification encountered in a document. When processing a document, DECdocument keeps track of the security levels associated with each <SECURITY> tag you specify. DECdocument saves the highest of these security levels and you can place it anywhere in your document using the <HIGHEST_SECURITY_CLASS> tag. For example, to place the highest security level found in a document on the title page as a subtitle, you would enter the <HIGHEST_SECURITY_CLASS> tag as an argument to the <SUBTITLE> tag.

Example

The following example shows how to use the <HIGHEST_SECURITY_CLASS> tag to place the highest security classification found in a document on the title page as a subtitle.
<TITLE_PAGE> <SPECIFICATION_INFO>(WS-99999\PAGM NNNN D036\<DATE>) <SPEC_TITLE>(Program Design Specification \For The \Machinery Control Program (MCP)) <subtitle>(<HIGHEST_SECURITY_CLASS>)
<RUNNING_FEET>

Creates a single-line running footer at the bottom of each page, next to the page number.

Syntax

<RUNNING_FEET> (footer text)

ARGUMENTS

footer text
Specifies the text of the running footer. The footer appears next to the page number on the bottom of each page.

related tags

<SET_FOOTERS>

DESCRIPTION

The <RUNNING_FEET> tag creates a single-line running footer at the bottom of each page, next to the page number. Use the <SET_FOOTERS> tag, enabled by the <DOCUMENT_ATTRIBUTES> tag, to alter the position of the page number and title text in the running footer. This tag is ignored for Bookreader output.

Example

The following example creates the running footer, Special Report, at the bottom of the page.
<RUNNING_FEET>(Special Report)
<RUNNING_TITLE>

Creates a 1- to 4-line heading at the top of each page, including the current page.

Syntax

<RUNNING_TITLE> (title text-1 [\title text-2...
\title text-4])

ARGUMENTS

title text-n
Specifies the text of the running title lines. The first title you specify is the title that appears closest to the top of the page. Subsequent title arguments output below the first title argument.

related tags

<DOCUMENT_ATTRIBUTES>
<RUNNING_FEET>

DESCRIPTION

The <RUNNING_TITLE> tag creates a 1- to 4-line heading at the top of each page, including the current page. By default, DECdocument places the running title on the right-hand side of the page when the page number is odd and on the left-hand side of the page when the page number is even. The running title you specify only appears on the title page of the document if you specify the <RUNNING_TITLE> tag before the <ENDTITLE_PAGE> tag.
Use the <SET_HEADERS> tag enabled by the <DOCUMENT_ATTRIBUTES> tag to change the positioning of the running titles on the page.

Example

The following example creates a 3-line running title at the top of the page.
<RUNNING_TITLE>(Introduction to SDML\September 1988\Company Confidential)
<SECURITY>

Assigns a security classification level to a text element.

Syntax

<SECURITY> (classification keyword)

ARGUMENTS

classification keyword
Is a keyword indicating the classification level. Each keyword has associated text output with a text element, as well as text printed at the top and bottom of each page. The following table shows default classification levels and the keywords associated with them.

Classification
Keyword Abbreviated
Text Output Classification Text for
Running Headers and Footers

TOP_SECRET (TS) TOP SECRET

SECRET (S) SECRET

CONFIDENTIAL (C) CONFIDENTIAL

UNCLASSIFIED (U) UNCLASSIFIED

You modify classification keywords and associated output text with the <SET_SECURITY_CLASS> tag.

Classification Keyword	Abbreviated Text Output	Classification Text for Running Headers and Footers
TOP_SECRET	(TS)	TOP SECRET
SECRET	(S)	SECRET
CONFIDENTIAL	(C)	CONFIDENTIAL
UNCLASSIFIED	(U)	UNCLASSIFIED

related tags

<HIGHEST_SECURITY_CLASS>
<SET_CONTENTS_SECURITY>
<SET_PAGE_SECURITY>
<SET_SECURITY_CLASS>

required terminator

<ENDSECURITY>

DESCRIPTION

The <SECURITY> tag assigns a security classification level to a text element. You can apply a security classification to one of the following text elements:
<CHAPTER> and <APPENDIX> tags
The classification applies to the title of the chapter or appendix.
<HEADN> tags The classification applies to the heading. If a classification is established before a heading, that classification can be overridden in the heading text argument.
<P> tags The classification of a paragraph created using the <P> tag outputs immediately before the text of the paragraph.
<TABLE> and <FIGURE> tags. If a classification is in effect when DECdocument processes a <FIGURE> or <TABLE> tag sequence, the classification applies to the entire figure or table, and is placed in the caption. Specify the <SECURITY> tag inside the caption argument to <FIGURE> or <TABLE> tag to apply a security to the caption only. Note that if you place a security classification in the caption of a multi-page figure or table, all pages of that figure or table will have that security applied.
<TABLE_ROW> tag, You specify <SECURITY> at the beginning of text you want to classify. Otherwise, security classifications are not automatically applied to table row text or to paragraph text, marked by <P> tags, in table rows.
The following example illustrates how to mark security codes on text elements in a table:
<SECURITY>(CONFIDENTIAL) <TABLE>(Tools Needed to Install the MXXK Internal Circuitry\tools_tab) <TABLE_SETUP>(2\15) <TABLE_HEADS>(Tool\Part Number) <TABLE_ROW>(Voltmeter\RQ-3341-2) <TABLE_ROW>(<SECURITY>(SECRET)3-Stage Neutralizer<ENDSECURITY> \The first neutralizer stage uses part number RQ-3321-1. <SECURITY>(TOP_SECRET) <P> Neutralizer stages 2 and 3 use experimental enhanced RQ-3321-1 parts, RXX-3321-A and RXX-3321-B. <ENDSECURITY>) <TABLE_ROW>(Screwdriver\RQ-1221-1) <ENDTABLE> <ENDSECURITY>
When you specify a <SECURITY> tag, the specified security classification is in effect for all subsequent text elements (as described in the preceding list). The abbreviated form of the classification appears in the output text, on the page on which the text is output.
When the text formatter finishes formatting each page of output, it determines the highest classification level applied to any text on that page, and it prints that classification on the top and bottom of the page.
A specific classification stays in effect until you do one of the following:

Specify the <SECURITY> tag with another classification.
Specify the <ENDSECURITY> tag, indicating that there is no more classified material.

You can nest <SECURITY> tags to any level, but all levels must be terminated using <ENDSECURITY> tags by the end of the file.
If you use a <SECURITY> tag anywhere in a document, every page of the document is marked with a security classification. For example, if you assign only one chapter in a multiple-chapter document the Top Secret classification, each page of that chapter is marked Top Secret, and all other pages in the document are automatically marked Unclassified, to indicate that there is no specific classification attached to text on those pages.

Example

In the following example, the security applied by the <SECURITY> tag affects the <CHAPTER>, <P>, and <HEAD1> tags shown.

<SECURITY>(TOP_SECRET) 
<CHAPTER>(MXXK-5 Internal Circuitry) 
<p>This document describes the internal circuitry of the MXXK-5. 
<head1>(SPECIFICATIONS\specs) 
<P> 
The following information specifies the internal circuitry of the MXXK-5 unit. 
. 
. 
. 
<ENDSECURITY>

<SET_APPENDIX_NUMBER>

Overrides the default appendix Roman numeral DECdocument assigns to an appendix.

Syntax

<SET_APPENDIX_NUMBER> (Roman numeral integer)

ARGUMENTS

Roman numeral integer
Specifies an integer equivalent to the Roman numeral for the appendix; for example, the integer 3 is equivalent to the Roman numeral III. This argument must be an integer greater than zero.

related tags

The global <APPENDIX> tag
The global <SET_APPENDIX_LETTER> tag
The global <SET_CHAPTER_NUMBER> tag

restrictions

This tag should not be used in a file that uses a book build profile or that uses the /PROFILE qualifier during processing. If either of these conditions occurs, DECdocument issues a warning message and ignores the <SET_APPENDIX_NUMBER> tag for the book build.

DESCRIPTION

The <SET_APPENDIX_NUMBER> tag overrides the default appendix Roman numeral DECdocument assigns to an appendix. The <SET_APPENDIX_NUMBER> tag resets the current appendix Roman numeral to the integer you specify as the Roman numeral integer. For example, if you specified 4 as the Roman numeral integer, DECdocument would set the appendix number to IV. Place the <SET_APPENDIX_NUMBER> tag in your SDML file before the <APPENDIX> tags you want it to affect. The new appendix number you specify resets the numbering for all following appendixes. For example, if you set the appendix number to 2, the next appendix will be numbered II, the appendix following that appendix will be numbered III, and so on. The <SET_APPENDIX_NUMBER> can be used multiple times in an SDML file.

Example

In the following example, the <SET_APPENDIX_NUMBER> tag explicitly sets the appendix to 4. This causes any subsequent appendixes to be numbered beginning with the Roman numeral IV.

<SET_APPENDIX_NUMBER>(4) 
<APPENDIX>(Run-time Functions\functions_ap) 
<p> 
The following functions are used at run time: 
. 
. 
. 
<APPENDIX>(Run-time Messages\messages) 
<p> 
The following messages may occur at run time: 
. 
. 
.

<SET_CONTENTS_SECURITY>

The <SET_CONTENTS_SECURITY> tag assigns a security classification level to a text element. DECdocument applies this security classification to all pages in the table of contents and index, overriding the default security classification.

Syntax

<SET_CONTENTS_SECURITY> (classification keyword)

ARGUMENTS

classification keyword
Specifies a keyword indicating the classification level. Each keyword has associated text displayed in conjunction with a text element, as well as text printed at the top and bottom of each page. The default classification levels and the classification keywords associated with them are:

Classification
Keyword Abbreviated
Text Output Classification Text for
Running Headers and Footers

TOP_SECRET (TS) TOP SECRET

SECRET (S) SECRET

CONFIDENTIAL (C) CONFIDENTIAL

UNCLASSIFIED (U) UNCLASSIFIED

Classification keywords and associated output text can be modified with the <SET_SECURITY_CLASS> tag. Any keywords defined using <SET_SECURITY_CLASS> are valid for <SET_CONTENTS_SECURITY>.

Classification Keyword	Abbreviated Text Output	Classification Text for Running Headers and Footers
TOP_SECRET	(TS)	TOP SECRET
SECRET	(S)	SECRET
CONFIDENTIAL	(C)	CONFIDENTIAL
UNCLASSIFIED	(U)	UNCLASSIFIED

related tags

<SECURITY>
<SET_CONTENTS_SECURITY>
<SET_SECURITY_CLASS>

DESCRIPTION

The <SET_CONTENTS_SECURITY> tag assigns a security classification level to a text element. By default, when security classification marking is in effect, the table of contents and index are assigned the highest classification level assigned to the entire document. For the contents and index, use the <SET_CONTENTS_SECURITY> tag to override the security classification that would be applied by default.

Example

In the following example, the <SET_CONTENTS_SECURITY> tag specifies that the pages in the table of contents and index are to be assigned the UNCLASSIFIED security classification, regardless of the classification of any of the other pages in the document.
<SET_CONTENTS_SECURITY>(UNCLASSIFIED) <SECURITY>(SECRET) . . .
Previous Next Contents Index

DECdocumentUsing Doctypes and Related Tags Volume 1

<DOCUMENT_ATTRIBUTES>

Syntax

<DOCUMENT_ATTRIBUTES>

related tags

required terminator

DESCRIPTION

Example

<HEADn>

Syntax

<HEADn> (heading text [\symbol name])

ARGUMENTS

heading text

symbol name

related tags

DESCRIPTION

Examples

<HIGHEST_SECURITY_CLASS>

Syntax

<HIGHEST_SECURITY_CLASS>

related tags

DESCRIPTION

Example

<RUNNING_FEET>

Syntax

<RUNNING_FEET> (footer text)

ARGUMENTS

footer text

related tags

DESCRIPTION

Example

<RUNNING_TITLE>

Syntax

<RUNNING_TITLE> (title text-1 [\title text-2... \title text-4])

ARGUMENTS

title text-n

related tags

DESCRIPTION

Example

<SECURITY>

Syntax

<SECURITY> (classification keyword)

ARGUMENTS

classification keyword

related tags

required terminator

DESCRIPTION

Example

<SET_APPENDIX_NUMBER>

Syntax

<SET_APPENDIX_NUMBER> (Roman numeral integer)

ARGUMENTS

Roman numeral integer

related tags

restrictions

DESCRIPTION

Example

<SET_CONTENTS_SECURITY>

Syntax

<SET_CONTENTS_SECURITY> (classification keyword)

ARGUMENTS

classification keyword

related tags

DESCRIPTION

Example

DECdocument
Using Doctypes and Related Tags
Volume 1

<RUNNING_TITLE> (title text-1 [\title text-2...
\title text-4])