Allows you to specify text that contains a tag in an argument to another tag. Execution of the <DELAYED> tag is delayed until the outer tag's text is processed.

SYNTAX

<DELAYED> (delayed text)

or

<DELAYED>

delayed text

.
.
.

<ENDDELAYED>

ARGUMENTS

delayed text

Specifies the text containing tags whose execution is delayed until the text is output.

related tags

• <DEFINE_BOOK_NAME>
• <DEFINE_SYMBOL>
  Any tag that takes a symbol name argument

restrictions

The <DELAYED> tag cannot be nested within itself.

You must use this tag if you want to nest a tag in the argument of a tag that also takes a symbol name argument.

required terminator

<ENDDELAYED> ---Required if you do not specify an argument to the <DELAYED> tag.

DESCRIPTION

The <DELAYED> tag allows you to specify text that contains a tag in an argument to another tag. Execution of the <DELAYED> tag is delayed until the outer tag's text is processed.

Using a tag within an argument to another tag is called nesting a tag in an outer tag's argument. Normally, the tag translator evaluates the nested tag first, then evaluates the outer tag.

When you want the outer tag to be processed before the nested tag, you must use the <DELAYED> tag to surround the nested tag. For example, when the outer tag is the <DEFINE_SYMBOL>(symbol name\text string) tag, you must use the <DELAYED> tag to surround the nested tag in the text string argument. This causes the nested tag to be preserved until it is about to be output using the <REFERENCE> tag.

Example

The following example shows how to use the <DELAYED> tag. The symbol TEMP_CHART_EX is associated with the text string that is enclosed by the <DELAYED> and <ENDDELAYED> tags. None of the enclosed tags will have been evaluated.

<define_symbol>(temp_chart_ex\<delayed> 
<example>(Temperature Chart) 
<code_example> 
      Centigrade   0    Fahrenheit  32 
      Centigrade 100    Fahrenheit 212 
<endcode_example> 
<endexample> 
<enddelayed>) 
 

Subsequently, you can refer to the symbol name with a <REFERENCE> tag, as in the following example:

<REFERENCE>(temp_chart_ex)

Using this reference results in the following output:

Example n--n: Temperature Chart

________________________________________________________________ Centigrade 0 Fahrenheit 32 Centigrade 100 Fahrenheit 212 ________________________________________________________________

Identifies the doctype for your file. This tag is for informational purposes only.

SYNTAX

<DOCTYPE> (document type)

ARGUMENTS

document type

Specifies the doctype you want to use for your file.

DESCRIPTION

The <DOCTYPE> tag identifies the doctype for your file. This tag is for informational purposes only; it does not designate the doctype.

You can include this tag anywhere in your file for informational purposes. You do not have to include the <DOCTYPE> tag in your file in order to process your file, however. Instead, you must specify the doctype on the DOCUMENT command line, which allows you to process your file using different doctypes to determine which one suits your needs.

Example

The following example shows how you can identify a book's doctype as "REPORT". Refer to Using Doctypes and Related Tags for sample output of the various doctypes.

<DOCTYPE>(report) 

Supplies a double quotation mark as it appears when it is typeset.

SYNTAX

<DOUBLE_QUOTE>

ARGUMENTS

None.

related tags

• <PARENDCHAR>
• <QUOTE>
• <SINGLE_QUOTE>

---

DESCRIPTION

The <DOUBLE_QUOTE> tag supplies a double quotation mark as it appears when it is typeset. This is different from the double quotation mark that your keyboard produces.

Your keyboard has two possible characters you can use for quotation marks: the double quote, (") (ASCII 34) and the single quote (') (ASCII 39). In programming languages, a quoted string usually begins and ends with the same character, either "a quoted string," or 'a quoted string.' Using the double or single quotation marks from your keyboard is usually adequate for showing examples of user input or screen displays.

If you want your output to show a double quotation mark as it is appears when it is typeset, however, use the <DOUBLE_QUOTE> tag.

If you want your output to follow typesetting conventions by using distinct opening and closing quotation marks, use the <QUOTE> tag instead of double quotation marks from your keyboard. You would use the <QUOTE> tag, for example, in citing a passage from another book. See the <QUOTE> tag description for more information.

---

Examples

The following example shows how to use the <DOUBLE_QUOTE> tag.

#1

<P>You can cause the translation of a symbol by using a double quotation mark (<DOUBLE_QUOTE>) directly in front of it.

This example produces the following output:

You can cause the translation of a symbol by using a double quotation mark (") directly in front of it.

The following example shows what your output would be like without using the tag, but just entering the double quotation mark character from the keyboard.

#2

<P>You can cause the translation of a symbol by using a double quotation mark (") directly in front of it.

This example produces the following output:

You can cause the translation of a symbol by using a double quotation mark (") directly in front of it.

---

<ELEMENT>

Identifies a file that contains an element of a book.

---

SYNTAX

<ELEMENT> (file spec)

---

ARGUMENTS

file spec

Specifies a file. You must supply the file type (for example, .sdml).

related tags

• <INCLUDES_FILE>
• <PROFILE>

restrictions

Valid only in the context of a <PROFILE> tag.

DESCRIPTION

The <ELEMENT> tag identifies a file that contains an element of a book. A profile of a book is required in order to build (process) a book. A book's profile contains an ordered list of the elements that comprise the book. In the profile, you label each of these elements with an <ELEMENT> tag. Only those files listed with <ELEMENT> tags are included in the book during the bookbuild. List those files in the profile according to the order in which they appear in the book.

A file specified as an element must begin with one of the following tags:

• <APPENDIX>
• <CHAPTER>
• <FRONT_MATTER>
• <GLOSSARY>
• <PART>

For more information on creating a profile and bookbuilding, see Producing Online and Printed Documentation.

Example

Assume that a writer is writing a book that contains several chapters. One of the chapters is the file My_Intro_Chap.SDML. At the top of this file is included the <CHAPTER>(Introduction\intro_chap) tag to distinguish it as a chapter.

Along with the other <ELEMENT> tags for this book, the profile would then contain the following:

<ELEMENT>(My_Intro_Chap.SDML)

See the example in the <PROFILE> tag description to see how to arrange the <ELEMENT> tags in a profile.

Supplies vertical ellipsis points to show omitted material in text and tables.

SYNTAX

<ELLIPSIS>

ARGUMENTS

None.

related tags

• <HELLIPSIS>

restrictions

Invalid in the context of a <MATH> tag.

Place the tag alone on a line in monospaced examples, or else the first "dot" of the ellipsis will be misaligned.

DESCRIPTION

The <ELLIPSIS> tag supplies vertical ellipsis points to show omitted material in text and tables. The vertical ellipsis is positioned with respect to the current left margin.

Examples

The following example shows how to use the <ELLIPSIS> tag.

<P>The instruction sequence listed here (patterned after code in 
module PROCSTRT) shows this second technique. 
<CODE_EXAMPLE>
PUSHL     executive-mode-PSL 
BSBB      DOREI                      
<ELLIPSIS>
PUSHL     user-mode-PSL 
BSBB      DOREI 
<ELLIPSIS>
DOREI:    REI 
<ENDCODE_EXAMPLE>

This example produces the following output:

The instruction sequence listed here (patterned after code in module PROCSTRT) shows this second technique.

PUSHL executive-mode-PSL BSBB DOREI . . . PUSHL user-mode-PSL BSBB DOREI . . . DOREI: REI

The following example shows how you can use the <ELLIPSIS> tag in a table.

<TABLE>(Rules for Determining Expression Modes\express_modes_tab) 
  <TABLE_ATTRIBUTES>(MULTIPAGE) 
  <TABLE_SETUP>(2\43) 
  <TABLE_HEADS>(Expression\Value Type) 
  <TABLE_ROW>(Integer value\Integer) 
  <TABLE_ROW>(<ELLIPSIS>\<ELLIPSIS>) 
  <TABLE_ROW>(String value\String) 
  <TABLE_ROW>(Integer lexical function\Integer) 
  <TABLE_ROW>(String lexical function\<ELLIPSIS>) 
  <TABLE_ROW>(Integer symbol\Integer) 
  <TABLE_ROW>(String symbol\String) 
  <TABLE_ROW>(Any value .AND. or .OR. any value\Integer) 
  <TABLE_ROW>(Any value\Integer) 
  <TABLE_ROW>(Any value\Integer) 
<ENDTABLE>
 

This example produces the following output:

Table n--n: Rules for Determining Expression Modes

Expression	Value Type
Integer value	Integer
. . .	. . .
String value	String
Integer lexical function	Integer
String lexical function	. . .
Integer symbol	Integer
String symbol	String
Any value .AND. or .OR. any value	Integer
Any value	Integer
Any value	Integer

Marks a word or phrase for distinctive typographical treatment.

SYNTAX

<EMPHASIS> (text

• \[BOLD]
• \[ITALIC]
• \[SMALLCAPS]
• \[SMALL_BOLDCAPS]

)

ARGUMENTS

TEXT

Specifies the text you want to emphasize.

BOLD

This is an optional keyword argument and must be the second argument if used. It specifies that the text be set in a bold font.

ITALIC

This is an optional keyword argument and must be the second argument if used. It specifies that the text be set in the current italic font. This is the default.

SMALLCAPS

This is an optional keyword argument and must be the second argument if used. It specifies that the text be set in small capital letters.

SMALL_BOLDCAPS

This is an optional keyword argument and must be the second argument if used. It specifies that the text be set in small capital letters in a bold font.

related tags

• <QUOTE>
• <UNDERLINE>

---

DESCRIPTION

The <EMPHASIS> tag marks a word or phrase for distinctive typographical treatment. The default form of emphasis is to set the text in an italic font. Use one of the arguments to change the emphasis to another font.

---

Example

The following example shows how to use the <EMPHASIS> tag.

<P>An <EMPHASIS>(overuse) of the <TAG>(EMPHASIS) tag <EMPHASIS>(inevitably\bold) ALWAYS <EMPHASIS>(reduces\small_boldcaps) its <EMPHASIS>(effectiveness\smallcaps).

This example produces the following output:

An overuse of the <EMPHASIS> tag inevitably ALWAYS REDUCES its EFFECTIVENESS.

---

<ENDCOPYRIGHT_PAGE>

Terminates the copyright page and optionally provides text that is output at the bottom of the copyright page.

---

SYNTAX

<ENDCOPYRIGHT_PAGE> [(identification)]

---

ARGUMENTS

identification

This argument is optional. It specifies a local convention for information on the copyright page.

related tags

• <COPYRIGHT_PAGE>
• <FRONT_MATTER>
• <PRINT_DATE>

restrictions

Use only to terminate a <COPYRIGHT_PAGE> tag. You can only use the copyright page in the context of the <FRONT_MATTER> tag.

DESCRIPTION

The <ENDCOPYRIGHT_PAGE> tag terminates the copyright page and optionally provides text that is output at the bottom of the copyright page.

Example

The following example shows the order in which to use the copyright page tags. The output of this example is a separate copyright page in the front matter of the book, and the page contains the print and copyright dates. The argument to the <ENDCOPYRIGHT_PAGE> tag, "ZK5352", is a local identification number that appears at the bottom of the copyright page.

<FRONT_MATTER>(front)
<COPYRIGHT_PAGE>
<PRINT_DATE>(November 1990) 
<COPYRIGHT_DATE>(1990) 
<ENDCOPYRIGHT_PAGE>(ZK5352) 
<ENDFRONT_MATTER>

To see an example of all the front matter tags in their correct order, see the example in the <FRONT_MATTER> tag description.

See the copyright page of this manual for a sample copyright page.

Terminates a part page (which is a dividing page between major sections of a document) and optionally specifies paging attributes for text that follows.

SYNTAX

<ENDPART_PAGE> [(RENUMBER)]

ARGUMENTS

RENUMBER

This is an optional keyword argument. It specifies that page numbering following the part page begins with 1. If you do not use this argument, page numbering continues following the part page with the next odd-numbered page.

Using this argument has no effect on Bookreader output.

related tags

• <PART_PAGE>

restrictions

Use only to terminate a <PART_PAGE> tag.

DESCRIPTION

The <ENDPART_PAGE> tag terminates a part page and optionally specifies paging attributes for text that follows.

Example

See the example in the discussion of the <PART> tag.

Terminates a title page and optionally specifies text to appear at the bottom of the title page.

SYNTAX

<ENDTITLE_PAGE> [(text)]

ARGUMENTS

text

This is an optional argument. It specifies that a line of text appear at the bottom of the title page.

related tags

• <PART_PAGE>

restrictions

Use only to terminate a <TITLE_PAGE> tag.

DESCRIPTION

The <ENDTITLE_PAGE> tag terminates a title page and optionally specifies text to appear at the bottom of the title page.

Example

The following example shows how to code a title page of a short document. See the example in the discussion of the <FRONT_MATTER> tag for an example of using this tag in the front matter of a book.

<TITLE_PAGE>
<TITLE>(How to Code your SDML Source Files)
<ENDTITLE_PAGE>(This is for informational purposes only.)

Labels the beginning of an example.

SYNTAX

<EXAMPLE> [(example caption[\symbol name])]

ARGUMENTS

example caption

This is an optional argument. It specifies the text of the caption to be associated with the example. The example caption and the associated example number will be included in the table of contents of the document.

symbol name

This is an optional argument. It specifies the symbolic identifier to be associated with the example. The symbol name is assigned a numeric value, which is the current example number. The symbol and its value are placed in the symbol table.

Symbol names must not exceed 31 characters and must only include alphabetic letters, numbers, or underscores. Do not begin a symbol name with an underscore.

related tags

• <CODE_EXAMPLE>
• <EXAMPLE_ATTRIBUTES>
• <EXAMPLE_FILE>
• <EXAMPLE_SPACE>
• <INTERACTIVE>
• <REFERENCE>
• <S>
• <SAMPLE_TEXT>
• <U>
• <VALID_BREAK>

restrictions

Cannot contain any text element tags, such as <CHAPTER>, <FIGURE>, <MATH>, <LIST>, <P>, or <TABLE>.

Invalid in the context of a <FOOTNOTE> tag.

Can only contain text that you label with <CODE_EXAMPLE>, <INTERACTIVE>, and <SAMPLE_TEXT> tags. Use a <P> tag within the context of the <SAMPLE_TEXT> tag to provide paragraph format of the sample text.

If you use an <EXAMPLE_FILE> tag in the context of an <EXAMPLE> tag, that file included by the <EXAMPLE_FILE> tag must contain either a code example (using the <CODE_EXAMPLE> tag) or an interactive example (using the <INTERACTIVE> tag).

required terminator

<ENDEXAMPLE>

DESCRIPTION

The <EXAMPLE> tag labels the beginning of a formal example or informal example. A formal example is an example that has a number and a caption, can be referenced, and is listed in the table of contents. An informal example does not have a number or a caption, cannot be referenced, and is not listed in the table of contents. Moreover, you create an informal example with the <CODE_EXAMPLE> tag. See the <CODE_EXAMPLE> tag description for more information.

You can create a formal example in a number of ways:

• By including a specified file in your example by using the <EXAMPLE_FILE> tag
• By leaving space for an example to be pasted in during final production by using the <EXAMPLE_SPACE> tag
• By using text labeled with <CODE_EXAMPLE>, <INTERACTIVE>, <S>, <SAMPLE_TEXT>, and <U> tags

You cannot use tables, lists, paragraphs, and other text elements in a formal example. You can, however, use a <P> tag within the context of a <SAMPLE_TEXT> tag to provide paragraph format of the sample text. See the <EXAMPLE_SEQUENCE> tag description in Using Doctypes and Related Tags for information about how to construct an example sequence that can include a variety of text elements.

If the body of the example spans more than a single page of text, the example caption is repeated on each page on which the example continues.

If the example is more than a page, page breaks are handled automatically by the text processor. You can control the page breaking by using <PAGE> tags to specify explicit page breaks, or <VALID_BREAK> tags within the example to specify good breaking points. If you explicitly break a page by using the <PAGE> or <VALID_BREAK> tags, the example caption is continued on the following page, as it is if the page is broken automatically by the text processor.

When a floating figure or floating example precedes a multipage table (all tables not marked with the KEEP keyword are multipage), a succession of short pages may occur before the page on which the table begins. This is because a multipage table forces any previous floating figures or examples to be output before the table begins.

If this situation occurs, code the preceding floating figures or examples with the KEEP keyword so that they will be kept with the text preceding them, resulting in better-balanced pages.

See the description of the FLOAT keyword argument to the <EXAMPLE_ATTRIBUTES> tag for information about floating figures or examples.

Note the following when processing a book for Bookreader display:

• You must use the symbol name argument to process a formal example for Bookreader display.
• DOCUMENT automatically creates pop-up windows for all formal examples.
• When introducing and cross-referencing a formal example, 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 examples pop up.

Examples

The following example shows a one-page example that uses the WIDE argument of the <EXAMPLE_ATTRIBUTE> tag. The contents of the example are included using the <EXAMPLE_FILE> tag. The file that is included must contain either a code example or interactive example.

<EXAMPLE>(VAXcluster Multi-file Summary\multi_file_exam) 
<EXAMPLE_ATTRIBUTES>(WIDE) 
<EXAMPLE_FILE>(monitor_multi_file_summary.sdml) 
<ENDEXAMPLE>

This example produces the following output:

Example n--n: VAXcluster Multi-file Summary ___________________________________________________________________________________________________________ +-----+ VAX/VMS Monitor Utility | AVE | TIME IN PROCESSOR MODES +-----+ MULTI-FILE SUMMARY Node: MOE CURLEY LARRY From: 15-APR-1984 18:17 15-APR-1984 18:17 15-APR-1984 18:17 Row Row Row To: 15-APR-1984 20:17 15-APR-1984 20:17 15-APR-1984 20:17 Sum Average Minimum Interrupt Stack 6.51 0.50 6.25 13.2 4.4 0.50 Kernel Mode 25.73 0.42 12.43 38.5 12.8 0.42 Executive Mode 9.46 0.95 1.81 12.2 4.0 0.95 Supervisor Mode 1.97 0.00 0.16 2.1 0.7 0.00 User Mode 13.24 5.33 56.14 74.7 24.9 5.33 Compatibility Mode 0.00 0.07 0.00 0.0 0.0 0.00 Idle Time 23.61 0.02 92.63 116.2 38.7 0.02 +-----+ VAX/VMS Monitor Utility | AVE | PAGE MANAGEMENT STATISTICS +-----+ MULTI-FILE SUMMARY Node: MOE CURLEY LARRY From: 15-APR-1984 18:17 15-APR-1984 18:17 15-APR-1984 18:17 Row Row Row To: 15-APR-1984 20:17 15-APR-1984 20:17 15-APR-1984 20:17 Sum Average Minimum Page Fault Rate 36.73 8.81 0.49 46.0 15.3 0.49 Page Read Rate 14.28 4.71 0.00 19.0 6.3 0.00 Page Read I/O Rate 1.20 0.70 0.00 1.9 0.6 0.00 Page Write Rate 0.00 0.00 0.00 0.0 0.0 0.00 Page Write I/O Rate 0.00 0.00 0.00 0.0 0.0 0.00 Free List Fault Rate 8.60 1.40 0.24 10.2 3.4 0.24 Modified List Fault Rate 5.83 2.29 0.00 8.1 2.7 0.00 Demand Zero Fault Rate 12.96 1.68 0.24 14.8 4.9 0.24 Global Valid Fault Rate 8.10 2.69 0.00 10.8 3.6 0.00 Wrt In Progress Fault Rate 0.00 0.00 0.00 0.0 0.0 0.00 System Fault Rate 4.92 0.53 0.18 5.6 1.8 0.18 Free List Size 7586.30 8630.14 9665.06 25881.5 8627.1 7586.30 Modified List Size 87.69 324.07 32.12 443.8 147.9 32.12 ___________________________________________________________________________________________________________

---

Previous

Next

Contents

Index