DECdocument
Using Global Tags

<SET_FIGURE_FILE_SPACING_DEFAULT>

Overrides the default for vertical blank space that appears before and after an included graphics file.

Format

<_FIGURE_FILE_SPACING_DEFAULT>[space before]
\[space after])0

ARGUMENTS

space before
This is an optional argument. It specifies the amount of vertical space in picas that is to be output before the graphics file (there are 6 picas to an inch). This argument may be a nonnegative integer or decimal number, including zero.
space after
This is an optional argument. It specifies the amount of vertical space in picas that is to be output following the graphics file (there are 6 picas to an inch). This argument may be a nonnegative integer or decimal number, including zero.

related tags

<FIGURE>
<FIGURE_FILE>

DESCRIPTION

The <SET_FIGURE_FILE_SPACING_DEFAULT> tag overrides the default for vertical blank space that appears before and after an included graphics file. Each doctype specifies default values for spacing that is inserted before and after a graphics file included using the <FIGURE_FILE> tag. These defaults assume that the file does not have any built-in white space.
In some instances, graphics files may have included white space, and you may not be able to remove it from the graphics file itself. In these instances, you can use the <SET_FIGURE_FILE_SPACING_DEFAULT> tag to modify the amount of white space that DECdocument places before and after the graphics file.
The values specified by the <SET_FIGURE_FILE_SPACING_DEFAULT> tag remain in effect for all subsequent figures, or until you use the <SET_FIGURE_FILE_SPACING_DEFAULT> tag again.
If you do not specify one of the arguments to the <SET_FIGURE_FILE_SPACING_DEFAULT> tag, the spacing remains as though you had not used the tag.

Examples

The following example shows how to set the figure file spacing default to 0 picas before a figure and 1.24 picas after a figure. All subsequent graphics files included using the <FIGURE_FILE> tag will also have this amount of white space around the figure.

#1
<SET_FIGURE_FILE_SPACING_DEFAULT>(0\1.24) <FIGURE>(Graphic File Inclusion) <FIGURE_FILE>(LN03\MY_FILES:HOUSE.SIX\13.76) <ENDFIGURE>
In the following example, the figure file spacing is set to 10 picas before the figure and 0 picas after it. Using the second <SET_FIGURE_FILE_SPACING_DEFAULT> tag resets the amount of spacing for any subsequent figures to 2 picas before the figure and 2 picas after the figure.

#2
<SET_FIGURE_FILE_SPACING_DEFAULT>(10\0) <FIGURE>(Graphic File Inclusion) <FIGURE_FILE>(LN03\MY_FILES:HOUSE.SIX\13.76) <ENDFIGURE> <SET_FIGURE_FILE_SPACING_DEFAULT>(2\2)
<SET_TABLE_ROW_BREAK_DEFAULT>

Overrides the default value for a multipage table's first valid break.

Format

<_TABLE_ROW_BREAK_DEFAULT>number of rows)0

ARGUMENTS

number of rows
Specifies the number of default table rows that must be on the first page of a multipage table. This argument must be a positive integer.
You can specify the <SET_TABLE_ROW_BREAK_DEFAULT> tag anywhere in an SDML file. The value you specify using this tag will affect subsequent tables until the next occurrence of the tag or until the end of the file.

related tags

<TABLE_ROW_BREAK>

DESCRIPTION

The <SET_TABLE_ROW_BREAK_DEFAULT> tag overrides the default value for a multipage table's first valid break. By default, tables are considered to be multipage; that is, if there is not enough room on the current page for a table, the table is continued onto subsequent pages, with any captions and headings repeated at the top of each new page. When the text formatter chooses places in the table at which to insert page breaks, it normally breaks the table between <TABLE_ROW> tags. By default, it assumes that it is correct to break a table between any two table rows after the first table row.
You can override this default behavior in the following ways:

Specify the <SET_TABLE_ROW_BREAK_DEFAULT> tag to provide a default number of rows that must be on the first page of the table. For example, if you specify the <SET_TABLE_ROW_BREAK_DEFAULT>(3) tag, any subsequent table will not be broken until after the third row.
Specify the CONTROLLED argument to the <TABLE_ATTRIBUTES> tag, which indicates that you are going to specify, explicitly, the range in which the table will be allowed to break. You then must use the <TABLE_ROW_BREAK>(FIRST) and <TABLE_ROW_BREAK>(LAST) tags to indicate the first and last allowable page break points. Between these two tags, the table may be broken between any two <TABLE_ROW> tags. See the example in the description of the <TABLE_ATTRIBUTES> tag.
Use the KEEP argument to the <TABLE_ATTRIBUTES> tag to indicate that the table must not be broken across pages, unless it is longer than a page. See the example in the description of the <TABLE_ATTRIBUTES> tag.
Use the <VALID_TABLE_ROW_BREAK> tag to indicate a place within a long table row that is an allowable break point. See the example in the description of the <VALID_BREAK> tag.
Use the <NESTED_TABLE_BREAK> tag to indicate a place in a nested table (a table within a table) that is an allowable break point.

This tag has no effect for Bookreader output.

Example

In the following example, the table consists of short, one-line items. The <SET_TABLE_ROW_BREAK_DEFAULT> tag indicates that this table, and any following it, must not be broken until after the fifth row.
<SET_TABLE_ROW_BREAK_DEFAULT>(5) <TABLE> <TABLE_ATTRIBUTES>(SINGLE_SPACED) <TABLE_SETUP>(2\5) <TABLE_HEADS>(Code\Numeric Value) <TABLE_ROW>(A\1) <TABLE_ROW>(B\2) . . . <TABLE_ROW>(Z\26) <ENDTABLE>
<SINGLE_QUOTE>

Supplies a single quotation mark as it appears on a keyboard.

Format

<SINGLE_QUOTE>

ARGUMENTS

None.

related tags

<DOUBLE_QUOTE>
<PARENDCHAR>
<QUOTE>

DESCRIPTION

The <SINGLE_QUOTE> tag supplies a single quotation mark as it appears on a keyboard. This is different from the single quotation mark that appears on your terminal screen.
If you use the single quotation mark from your keyboard instead of the tag, your output will contain an unmatched closing single quotation mark---one half of what should be a matched pair according to typesetting conventions.

Example

The following example shows how to use the <SINGLE_QUOTE> tag. The <PARENDCHAR> tag simply provides better spacing of the single quote within the parentheses.
<P>Notice the difference between using the <tag>(single_quote) tag to output a single quotation mark, for example, <PARENDCHAR>(<SINGLE_QUOTE>), and using the keyboard single quotation mark, for example, <PARENDCHAR>(').
This example produces the following output:
Notice the difference between using the <SINGLE_QUOTE> tag to output a single quotation mark, for example, ('), and using the keyboard single quotation mark, for example, (').

<SPAN>

Specifies that the accompanying argument in a table row or a table head spans more than one table column.

Format

<SPAN> (number of columns[\LEFT])

ARGUMENTS

number of columns
Specifies the number of table columns that the text following the <SPAN> tag spans. This argument must be a whole number and must be no larger than the number of table columns remaining in the table row, including the table column in which you placed the <SPAN> tag itself.
LEFT
This is an optional keyword argument. It specifies that the text of the argument be aligned to the left-most position of the spanned columns. If you do not use this argument, the text of the argument is centered in the spanned columns.

related tags

<RULE>
<TABLE_HEADS>
<TABLE_UNIT_HEADS>

restrictions

Valid only in an argument to a <TABLE_ROW>, <TABLE_HEADS>, or <TABLE_UNIT_HEADS> tag.
Must immediately precede the argument text.

DESCRIPTION

The <SPAN> tag specifies that the accompanying argument in a table row or a table head spans more than one table column. The text is displayed without regard to the gutter that separates the columns. The text is centered in the spanned columns, unless you specify the LEFT argument.
If the text length exceeds the width of the spanned columns, it is broken at a word boundary and displayed on additional table lines. Any additional lines of text are centered or aligned against the left margin to agree with the alignment of text in the first line.
Use the <RULE> tag if you want to place a rule beneath a spanned heading created using the <SPAN> tag.

Examples

The following example shows how to use the <SPAN> tag to center the table heading over three columns. It also shows how to use the LEFT keyword to position a table unit heading to the left-most position of the spanned columns. Note the use of the <RULE> tag in this example.

#1

<TABLE> 
<TABLE_SETUP>(3\12\12) 
<TABLE_HEADS>(<SPAN>(3)Types of Ancient Weaponry) 
<TABLE_UNIT> 
<TABLE_UNIT_HEADS>(Polearms) 
<TABLE_ROW>(Spear\Javelin\Halberd) 
<ENDTABLE_UNIT> 
<TABLE_UNIT> 
<TABLE_UNIT_HEADS>(Maces\<SPAN>(2\LEFT)Swords<RULE>) 
<TABLE_UNIT_HEADS>( \Short swords\Long swords) 
<TABLE_ROW>(Great Mace\Gladius\Great Sword) 
<ENDTABLE_UNIT> 
<ENDTABLE>

This example produces the following output:

Types of Ancient Weaponry

Polearms

Spear Javelin Halberd

Maces Swords

Short swords Long swords

Great Mace Gladius Great Sword

In the following example, notice how using the <SPAN> tag in this way centers "Small Fixture" correctly.

Types of Ancient Weaponry
Polearms
Spear	Javelin	Halberd
Maces	Swords
	Short swords	Long swords
Great Mace	Gladius	Great Sword

#2

<table>             
<table_setup>(5\9\9\9\9) 
<table_row>(\<span>(2)Small Fixture\<span>(2)Large Fixture) 
<table_row>(Component\Minimum\Maximum\Minimum\Maximum) 
<endtable>

Notice, however, that "Large Fixture" may be too far to the right, as in the following example:

Small Fixture Large Fixture

Component Minimum Maximum Minimum Maximum

This occurs because the <SPAN> tag attempts to span the last column to the margin. To fix this problem, code the table to specify an additional column and specify a width for the next to last column, thereby limiting the distance that is spanned. The following is an example of such a correction:
<table> <table_setup>(6\8\8\8\8\8) <table_row>(\<span>(2)Small Fixture\<span>(2)Large Fixture) <table_row>(Component\Minimum\Maximum\Minimum\Maximum) <endtable>
This example produces the following output:

Small Fixture Large Fixture

Component Minimum Maximum Minimum Maximum

<SPECIAL_CHAR>

Provides access to special characters that are not available on the terminal keyboard.

Format

<SPECIAL_CHAR> (keyword)

ARGUMENTS

keyword
Specifies a keyword associated with the special character you want to produce in your output file. The character is always a non-math character. The following are valid keywords:

Keyword Character

CLOSE_DOUBLE_BRACKET ]]

DAGGER +

DOUBLE_DAGGER ++

DOUBLE_HYPHEN -

FULL_DIAMOND <>

OPEN_DOUBLE_BRACKET [[

REGISTERED_SYMBOL ®

SECTION_SIGN §

TRADEMARK_SYMBOL ^tm

Keyword	Character
CLOSE_DOUBLE_BRACKET	]]
DAGGER	+
DOUBLE_DAGGER	++
DOUBLE_HYPHEN	-
FULL_DIAMOND	<>
OPEN_DOUBLE_BRACKET	[[
REGISTERED_SYMBOL	®
SECTION_SIGN	§
TRADEMARK_SYMBOL	^tm

related tags

<MATH_CHAR>
<MCS>

DESCRIPTION
The <SPECIAL_CHAR> tag provides access to special characters that are not available on the terminal keyboard.
You can use the <SUBSCRIPT> and <SUPERSCRIPT> tags with the <SPECIAL_CHAR> tag to get subscripted and superscripted characters. For example, you can enter the following code to get a superscripted registered symbol:
<SUPERSCRIPT>(<SPECIAL_CHAR>(REGISTERED_SYMBOL))
Example

In the following example, the special character <> is used in an example of terminal output to show that text wraps at the end of a line.
%COPY-I-COPIED, $DISK1:[MYDIRECTORY]MYFILE.PLI;5 <tag>(special_char)(FULL_DIAMOND) copied to $DISK1:[YOURDIRECTORY]YOURFILE.PLI;5
This example produces the following output:
%COPY-I-COPIED, $DISK1:[MYDIRECTORY]MYFILE.PLI;5 <> copied to $DISK1:[YOURDIRECTORY]YOURFILE.PLI;5
<SUBHEADn>

Marks an unnumbered subsidiary heading.

Format

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

ARGUMENTS

heading text
Specifies the text of the subsidiary heading.
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

<CHEAD>
<HEAD1> through <HEAD6>

DESCRIPTION

The <SUBHEAD1> and <SUBHEAD2> tags mark an unnumbered subsidiary heading. You are allowed only two levels of subheadings. Each reflects a logical hierarchy within the structure of the text.
These subheadings are not numbered and do not appear in the table of contents. They cannot be readily used for cross-references and you should use them only when the clarity of your exposition requires such a fine level of distinction.
In some doctypes, the distinction is made between the <SUBHEAD1> and <SUBHEAD2> tags by making the <SUBHEAD2> tag a run-in heading. This means that the following text begins on the same line as the subheading. The doctype controls the text formatter's placement of the text following the <SUBHEAD2> tag. Whether or not you expect the heading to be run-in, always tag the text element following the heading (for example, always mark a paragraph with a <P> tag).

Example

The following example shows how to use the <SUBHEADN> tag.
<SUBHEAD1>(Using a Subhead\use_of_subhead) <P>The use of subheads should be restricted to occasions when the clarity of your exposition absolutely requires one.
This example produces the following output:
Using a Subhead

The use of subheads should be restricted to occasions when the clarity of your exposition absolutely requires one.

<TABLE>

Begins a sequence of columnar data.

Format

<TABLE> [(table caption[\symbol name])]

ARGUMENTS

table caption
This is an optional argument. It specifies the text of the caption to be associated with the table. Using this argument indicates that the table is a formal table, because the table has a number and a caption and is listed in the table of contents. If you do not specify a table caption argument, the table is considered an informal table, because it has no number or caption and is not listed in the table of contents.
If the body of the table spans more than a single page of text, the table caption is repeated on each page on which the table continues.
symbol name
This is an optional argument. It specifies the symbolic identifier to be associated with the table. The symbol is assigned a numeric value, which is the current table number. The symbol and its value are placed in the symbol table.
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

<ALIGN_CHAR>
<ALIGN_NUMBER>
<NESTED_TABLE_BREAK>
<REFERENCE>
<RULE>
<SPAN>
<TABLE_ATTRIBUTES>
<TABLE_FILE>
<TABLE_HEADS>
<TABLE_KEY>
<TABLE_KEYREF>
<TABLE_ROW>
<TABLE_ROW_BREAK>
<TABLE_SETUP>
<TABLE_SPACE>
<TABLE_UNIT>
<TABLE_UNIT_HEADS>
<VALID_TABLE_ROW_BREAK>

restrictions

Invalid in the context of an <EXAMPLE>, <FOOTNOTE>, <MATH>, or <FIGURE> tag.

required terminator

<ENDTABLE>

DESCRIPTION

The <TABLE> tag begins a sequence of columnar data. A formal table has a number and a caption, can be cross-referenced, and is listed in the table of contents. An informal table does not have a number or a caption, cannot be cross-referenced, and is not listed in the table of contents.
Note the following when processing a book for Bookreader display:

You must use the symbol name argument to process a formal table for Bookreader display.
DOCUMENT automatically creates pop-up windows for all formal tables.
When introducing and cross-referencing a formal table, you must use the <REFERENCE> tag to create a hotspot. Hotspots are regions in the windows you click on with your mouse to access cross-referenced topics.
You can use the <ONLINE_POPUP> tag if you want to make informal tables pop up.
Remember that coding a table for printed output may not be suitable for Bookreader output, because the Bookreader's window is narrower than a printed page and the Bookreader's font size is bigger.

Examples

The following example shows how to produce a two-column table.

#1

<TABLE>(Rules for Determining Expression Modes\express_modes_tab) 
<TABLE_ATTRIBUTES>(MULTIPAGE) 
<TABLE_SETUP>(2\43) 
<TABLE_HEADS>(Expression\Value Type) 
<TABLE_ROW>(String value\String) 
<TABLE_ROW>(Integer lexical function\Integer) 
<TABLE_ROW_BREAK>(first) 
<TABLE_ROW>(Integer symbol\Integer) 
<TABLE_ROW>(String symbol\String) 
<ENDTABLE>

This example produces the following output:
Table n--n: Rules for Determining Expression Modes

Expression Value Type

String value String

Integer lexical function Integer

Integer symbol Integer

String symbol String

The following example shows how to code a nested table.

Expression	Value Type
String value	String
Integer lexical function	Integer
Integer symbol	Integer
String symbol	String

#2

<TABLE>(Food Combining Workshop\schedule_tab) 
<TABLE_SETUP>(2\10) 
<TABLE_HEADS>(Day\Schedule ) 
<TABLE_ROW>(Monday\<TABLE>
                   <TABLE_SETUP>(2\8) 
                   <TABLE_ROW>(Morning\Review Workshop Objectives) 
                   <TABLE_ROW>(Afternoon\Study Protein Groups) 
                   <TABLE_ROW>(Evening\Study Minerals) 
                   <ENDTABLE>) 
<TABLE_ROW>(Tuesday\<TABLE>
                   <TABLE_SETUP>(2\8) 
                   <TABLE_ROW>(Morning\Study Fruit Groups) 
                   <TABLE_ROW>(Afternoon\Study Vegetable Groups) 
                   <TABLE_ROW>(Evening\Combining Food Groups) 
                   <ENDTABLE>) 
<TABLE_ROW>(Wednesday\<TABLE>
                   <TABLE_SETUP>(2\8) 
                   <TABLE_ROW>(Morning\Poultry and Fish Diets) 
                   <TABLE_ROW>(Afternoon\Special Diets) 
                   <TABLE_ROW>(Evening\Closing Remarks) 
                   <ENDTABLE>) 
<ENDTABLE>

This example produces the following output:
Table n--n: Food Combining Workshop

Day Schedule

Monday

Morning Review Workshop Objectives

Afternoon Study Protein Groups

Evening Study Minerals

Tuesday

Morning Study Fruit Groups

Afternoon Study Vegetable Groups

Evening Combining Food Groups

Wednesday

Morning Poultry and Fish Diets

Afternoon Special Diets

Evening Closing Remarks

Contents

Index

	Small Fixture		Large Fixture
Component	Minimum	Maximum	Minimum	Maximum

DECdocumentUsing Global Tags

<SET_FIGURE_FILE_SPACING_DEFAULT>

Format

<_FIGURE_FILE_SPACING_DEFAULT>[space before] \[space after])0

ARGUMENTS

space before

space after

related tags

DESCRIPTION

Examples

<SET_TABLE_ROW_BREAK_DEFAULT>

Format

<_TABLE_ROW_BREAK_DEFAULT>number of rows)0

ARGUMENTS

number of rows

related tags

DESCRIPTION

Example

<SINGLE_QUOTE>

Format

<SINGLE_QUOTE>

ARGUMENTS

related tags

DESCRIPTION

Example

<SPAN>

Format

<SPAN> (number of columns[\LEFT])

ARGUMENTS

number of columns

LEFT

related tags

restrictions

DESCRIPTION

Examples

<SPECIAL_CHAR>

Format

<SPECIAL_CHAR> (keyword)

ARGUMENTS

keyword

related tags

DESCRIPTION

Example

<SUBHEADn>

Format

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

ARGUMENTS

heading text

symbol name

related tags

DESCRIPTION

Example

<TABLE>

Format

<TABLE> [(table caption[\symbol name])]

ARGUMENTS

table caption

symbol name

related tags

restrictions

required terminator

DESCRIPTION

Examples

DECdocument
Using Global Tags

<_FIGURE_FILE_SPACING_DEFAULT>[space before]
\[space after])0