The following is an example of stacked lists with braces used within a table. The <LIST> tags are indented simply as an aid for visually checking the nesting of tags.

#10

<TABLE> <TABLE_SETUP>(2\20) <TABLE_HEADS>(Items\Description) <TABLE_ROW>(<LIST>(stacked\braces) <LE>one <LE>two <LE>three <ENDLIST>\Stacked in a table.) <TABLE_ROW>(Another item\<LIST>(stacked\braces) <LE>one <LE>two <LE>three <ENDLIST>) <TABLE_ROW>(This is the last item\) <ENDTABLE>

This example produces the following output:

Items	Description
one two three	Stacked in a table.
Another item	one two three
This is the last item

The following is an example of an unnumbered list.

<P>To create a system that more closely suits the requirements of 
your site, you can do any of the following: 
<LIST>(UNNUMBERED) 
<LE>Select a default bootstrap command procedure 
<LE>Modify system parameters for special hardware configuration needs or 
special workload requirements 
<LE>Perform other site-specific modifications 
<ENDLIST>

This example produces the following output:

To create a system that more closely suits the requirements of your site, you can do any of the following:

• Select a default bootstrap command procedure
• Modify system parameters for special hardware configuration needs or special workload requirements
• Perform other site-specific modifications

The following is an example of how you can specify a character other than a bullet to label each list element.

<P>To create a system that more closely suits the requirements of 
your site, you can do any of the following: 
<LIST>(UNNUMBERED\+) 
<LE>Select a default bootstrap command procedure 
<LE>Modify system parameters for special hardware configuration needs or 
special workload requirements 
<LE>Perform other site-specific modifications 
<ENDLIST>

This example produces the following output:

To create a system that more closely suits the requirements of your site, you can do any of the following:

• Select a default bootstrap command procedure
• Modify system parameters for special hardware configuration needs or special workload requirements
• Perform other site-specific modifications

Allows you to specify text that contains words in angle brackets that might otherwise be interpreted as tags.

Format

<LITERAL> (literal text)

or

<LITERAL>

literal text

.
.
.

<ENDLITERAL>

ARGUMENTS

literal text

Specifies the literal text to be output exactly as you code it.

restrictions

Do not nest a <LITERAL> tag within another <LITERAL> tag.

required terminator

<ENDLITERAL> ---Required if you do not specify an argument to the <LITERAL> tag.

DESCRIPTION

The <LITERAL> tag allows you to specify text that contains words in angle brackets that might otherwise be interpreted as tags.

Examples

The following example shows how to use the <LITERAL> and <ENDLITERAL> tags.

<P> I have experimented with my own method for noting questionable 
phrases, by placing <LITERAL><NOTE_PROBLEM><ENDLITERAL> near the 
phrase. 
 

This example produces the following output:

I have experimented with my own method for noting questionable phrases, by placing <NOTE_PROBLEM> near the phrase.

The following example shows how to use the <LITERAL>(literal text) tag.

<P> I've experimented with my own method for noting questionable 
phrases, by placing <LITERAL>(<NOTE_PROBLEM>) near the 
phrase. 
 

This example produces the same output as the first example.

Labels text that you want to appear as lowercase in the final output.

Format

<LOWERCASE> (text)

ARGUMENTS

text

Specifies the text to appear in lowercase.

related tags

• <UPPERCASE>

---

DESCRIPTION

The <LOWERCASE> tag labels text that you want to appear as lowercase in the final output. In your book, you may have a text element, such as a heading, that normally appears in uppercase. For example, in some doctypes, first-level headings use all uppercase letters. If you need to overcome the default case in one of your tags and ensure that the result in the final output appears in lowercase, use this tag.

---

Example

The following example shows how to use the <LOWERCASE> tag. Assume that the doctype being used causes the <HEAD2> tag to output a heading that is in uppercase, no matter what the case of the text passed to it.

<HEAD2>(HeRe iS aN ExAmPlE oF <LOWERCASE>(lOwErCaSe) tExT)

The example produces the following output:

HERE IS AN EXAMPLE OF lowercase TEXT

The default to uppercase letters causes the heading to be uniformly uppercase, with the exception of the text used in the argument to the <LOWERCASE> tag.

---

<MARK>

Indicates the beginning of new or modified information.

---

Format

<MARK>

---

ARGUMENTS

None.

related tags

• <REVISION>
• <UPDATE_RANGE>

restrictions

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

Both the <MARK> and <ENDMARK> tags must be within the code for a stacked list (using the <LIST>(stacked) tag) if you want change bars in a stacked list.

<MARK> tags within the arguments to the following tags must be terminated within the argument by the <ENDMARK> tag.

• <APPENDIX>, <CHAPTER>, <EXAMPLE>, <FCMD>, <FIGURE>, <FPARMS>, <FOOTNOTE>, <GLOSSARY>, <HEADN>, <REVISION_INFO>, <TABLE>, and <TITLE> when used within the context of a <PART_PAGE> tag
  Using <MARK> and <ENDMARK> within the arguments to all these tags, (except for <FCMD>, <FPARMS>, <FOOTNOTE>, and <REVISION_INFO>), create change bars in the table of contents.
• The following SOFTWARE doctype tags: <COMMAND>, <COMMAND_SECTION>, <ROUTINE>, <ROUTINE_SECTION>, <STATEMENT>, <STATEMENT_SECTION>, <SUBCOMMAND>, <SUBCOMMAND_SECTION_HEAD>, <SDML_TAG>, and <TAG_SECTION>

required terminator

<ENDMARK>

DESCRIPTION

The <MARK> tag indicates the beginning of new or modified information. The <MARK> tag, along with the <ENDMARK> tag, must be enabled by the <REVISION> tag in order to produce vertical bars in the margin of the document (and optionally, in the table of contents---see the RESTRICTIONS section), as well as in MAIL, TERMINAL, and LINE output.

Make sure to place the <MARK> and <ENDMARK> tags next to the text they mark, without preceding or following the text with other tags. The text formatter interprets the <MARK> tag based on the last text character encountered before the <MARK> tag.

Example

In the following example, the first paragraph is the original and the second paragraph is the modified version that shows how to use the <MARK> and <ENDMARK> tags.

<P>
The following characters are legal in MACRO-11 source programs: 
<LIST>(UNNUMBERED) 
<LE>The letters A through Z. Both upper- and lowercase letters are 
acceptable, although, upon input, lowercase  letters are converted to 
uppercase. 
<LE>The digits 0 through 9. 
<LE>The characters period <PARENDCHAR>(.) and dollar sign 
<PARENDCHAR>($). These characters  are reserved for use as Digital 
Equipment Corporation system program symbols. 
<ENDLIST>
 


 
<REVISION>
   .
   .
   .
<P>
The following characters are legal in MACRO-11 source programs: 
<LIST>(UNNUMBERED) 
<LE>The letters A through Z. Both upper- and lowercase letters are 
acceptable, although, upon input, lowercase  letters are converted to 
uppercase. 
 
 
<MARK>
<LE>Characters in the Digital Multinational Character Set (MCS). A chart 
showing the MCS is located in <REFERENCE>(mcs_app), 
with a list of directives that 
support the MCS. 
<ENDMARK>
 
<LE>The digits 0 through 9. 
<LE>The characters period <PARENDCHAR>(.) and dollar sign 
<PARENDCHAR>($). These characters  are reserved for use as Digital 
Equipment Corporation system program symbols. 
<ENDLIST>
 

The output for the original paragraph and the modified paragraph follows:

The following characters are legal in MACRO-11 source programs:

• The letters A through Z. Both upper- and lowercase letters are acceptable, although, upon input, lowercase letters are converted to uppercase.
• The digits 0 through 9.
• The characters period (.) and dollar sign ($). These characters are reserved for use as Digital Equipment Corporation system program symbols.

The following characters are legal in MACRO-11 source programs:

• The letters A through Z. Both upper- and lowercase letters are acceptable, although, upon input, lowercase letters are converted to uppercase.

• Characters in the Digital Multinational Character Set (MCS). A chart showing the MCS is located in Appendix A, with a list of directives that support the MCS.
• The digits 0 through 9.
• The characters period (.) and dollar sign ($). These characters are reserved for use as Digital Equipment Corporation system program symbols.

Labels a short mathematical expression or the beginning of an extended mathematical example.

Format

<MATH> (

• math expression
• DISPLAY[\symbol name]

)

ARGUMENTS

math expression

Specifies a mathematical expression that you want to include in the text of a sentence or paragraph.

DISPLAY

This keyword specifies that a mathematical equation or expression that is longer than one line is to be set off from the surrounding text. If you use DISPLAY, you must use the <ENDMATH> tag to terminate the display.

symbol name

This is an optional argument. It specifies a symbol name by which a mathematical equation that is longer than one line is to be referenced. If you specify this argument, the equation is assigned a number and the number is printed to the right of the equation.

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

• <CODE_EXAMPLE>
• <MATH_CHAR>
• <REFERENCE>

restrictions

You cannot use mathematical examples that are longer than one line in the context of a <TABLE> or an <EXAMPLE> tag.

Invalid in the context of a <HEADN> tag.

Invalid in the context of a <FOOTNOTE> tag.

Invalid in the context of a <FORMAT> tag.

You cannot use tab characters and carriage returns for space in the context of a <MATH> tag.

The set of tags valid within a mathematical expression is limited to those listed in the tables in the following DESCRIPTION section.

required terminator

<ENDMATH> ---Required if you specify the DISPLAY argument to the <MATH> tag.

DESCRIPTION

The <MATH> tag labels a short mathematical expression or the beginning of an extended mathematical example. Within an argument to the <MATH> tag or within the bounds of the <MATH>(DISPLAY)...<ENDMATH> tags, you can specify simple or complex mathematical expressions, according to the rules outlined below. The context in which you enter text and tags within a mathematical expression is severely restricted.

In a mathematical expression, all formatting is controlled by the text processor. When you use the DISPLAY keyword, the output will be offset from the surrounding text, but you do not have any control over its positioning. Furthermore, blank spaces and carriage returns are ignored; the text processor assumes that all text strings are mathematical variable names and makes all decisions regarding the output formatting.

Parentheses

Most of the tags valid in math do not accept arguments. Parentheses, however, are frequently used in mathematical expressions. You must be careful, therefore, to use a space between the tag and the parentheses. For example:

<MATH>(A <minus> (B<PLUS>C))

Note At times, it may be helpful to you to use the <OPAREN> and <CPAREN> tags in place of the opening and closing parenthesis in math equations. This way, you and the text formatter can determine what you mean to be a literal parenthesis as opposed to the opening or closing parenthesis of an argument.

Simple Expressions

The following tags are used to indicate simple binary operations. In the context of a mathematical expression, you can use either the tag name or the function's symbol.

<TIMES>	*	Multiplication
<PLUS>	+	Addition
<MINUS>	-	Subtraction
<DIVIDED_BY>	/	Division
<EQUALS>	=	Equality

For example, the following are equivalent:

<MATH>(total = A + B - C * D / E) <MATH>(total <EQUALS> A <PLUS> B <MINUS> C <TIMES> D <DIVIDED_BY> E)

Both produce the following output: total = A + B - C * D / E

Note Using any nonalphanumeric characters (such as, @, #, $, tabs, and so on) other than those specified above in the context of math may produce unpredictable results, including errors from the text formatter.

Operators are evaluated using the normal mathematical rules for precedence of operators. You can control the evaluation by using the <GROUP> tag, much as you would use parentheses in a mathematical expression. Note the use of the <GROUP> tag in the second math expression in the following code fragment:

<MATH>(total = A +B-C*D<OVER>(e) ) <P> <MATH>(total = <GROUP>(<GROUP>(A +B-C*D)<OVER>(e)) )

This example produces the following output:

total = A +B-C*D
e

total = A +B-C*D
e

The effect of the <GROUP> tag is supplied by default for fractional expressions when you use the <FRACTION> tag. For example:

<MATH>(display) total = <FRACTION>(A + B - C * D\E) <ENDMATH>

Variable Names

The text formatter assumes that variable names are primarily alphabetic letters or special characters represented by the <MATH_CHAR> tag. If you need to specify any variable names in expressions that contain special characters, you must use the <VARIABLE> or <TEXT> tags. For example:

<MATH>(<variable>(event_flag) = 1)

If you require multiword variable names, you must use the <SP> tag to indicate spacing. For example:

<MATH>(display) <VARIABLE>(SUCCESS<sp>RATE) <equals> <group>( <VARIABLE>(TOTAL<SP>HITS) <over>(<VARIABLE>(TOTAL<sp>HITS) <plus> <VARIABLE>(TOTAL<sp> MISSES) ) ) <times> 100 <ENDMATH>

This example produces the following output:
SUCCESS RATE = TOTAL HITS
TOTAL HITS + TOTAL MISSES * 100

You can provide special annotation for variable names by using the following tags:

Tag	Output
<BAR_CHAR>(x)	x
<DOT_CHAR>(x)	x
<HAT>(xyz)	xyz
<HAT_CHAR>(x)	x
<OVERLINE>(var)	var
<TILDE>(xyz)	xyz
<TILDE_CHAR>(x)	x
<UNDERLINE>(var)	var
<VECTOR>(x)	x

Summary of Tags

Table 1-1 summarizes the tags that are valid in mathematical expressions.

Table 1-1 <MATH > Expressions

Tag	Operation and Output
<AMPERSAND>	Specifies a literal ampersand character in a math expression.
<ATOP>( expression)	Stacks an expression, as in a b .
<BACKSLASH>	Specifies a literal backslash character in a math expression.
<CAL>( letter)	Specifies a calligraphic uppercase letter, as in .
<CASES> <CASE_ROW> <ENDCASES>	Specifies a case construction. See "Matrixes and Cases" in this tag description.
<CDOTS>	Specifies centered dots, as in ... .
<CHOOSE>( expression1\ expression2)	Parenthetical notation, as in ab .
<DDOTS>	Specifies diagonal dots, as in ... .
<DIVIDED_BY>	Division, as in a/b .
<DOTS>	Specifies horizontal dots, as in ... .
<DOT_TIMES>	Multiplication, as in a· b .
<EQUALIGN> <ELINE> <ENDEQUALIGN>	Starts an alignment section, so that expressions on the right and left side of a character (usually an equal sign) are balanced. See "Aligning Expressions" in this tag description.
<EQUALS>	Equality, as in a=b .
<FRACTION>( numerator\ denominator)	Specifies a fraction, as in a b .
<FUNC>( expression)	Specifies a function, as in f(a) .
<GROUP>( expression)	Provides control over the order of operation. See example four in the "Examples" section in this tag description.
<INTEGRAL>	Specifies an integral, as in S0^ <pi symbol> 2 . See "Operators With and Without Limits" in this tag description.
<INTEGRAL_LIMITS>	Specifies an integral that places superscripts and subscripts above and below the sign, rather than to the right. See "Operators With and Without Limits" in this tag description.
<INTEGRAL_NOLIMITS>	Specifies an integral that places superscripts and subscripts to the right of the sign, rather than above and below. See "Operators With and Without Limits" in this tag description.
<MATRIX> <MATRIX_ROW> <ENDMATRIX>	Specifies a matrix. See "Matrixes and Cases" in this tag description.
<MINUS>	Minus, as in a-b .
<MOD>	Modulo, as in nmod .
<LBAR>	Begins an expression delimited with vertical bars. See "Delimited Expressions" in this tag description.
<LBRACE>	Begins an expression delimited with curly braces. See "Delimited Expressions" in this tag description.
<LBRACKET>	Begins an expression delimited with square brackets. See "Delimited Expressions" in this tag description.
<LCEIL>	Begins an expression delimited with ceiling characters (<lceil symbol>). See "Delimited Expressions" in this tag description.
<LFLOOR>	Begins an expression delimited with floor characters (<lfloor symbol>). See "Delimited Expressions" in this tag description.
<LPAREN>	Begins an expression delimited with parentheses. See "Delimited Expressions" in this tag description.
<OVER>( expression)	Division, as in a b .
<PI>	The pi character, <pi symbol> .
<PLUS>	Plus, as in a+b .
<PMOD>( expression)	Parenthetical mod, as in a<pmod symbol>p .
<PROD>	Specifies a product, as in <prod symbol>0^ <pi symbol> 2 . See "Operators With and Without Limits" in this tag description.
<PROD_LIMITS>	Specifies a product that places superscripts and subscripts above and below the sign, rather than to the right. See "Operators With and Without Limits" in this tag description.
<PROD_NOLIMITS>	Specifies a product that places superscripts and subscripts to the right of the sign, rather than above and below. See "Operators With and Without Limits" in this tag description.
<RBAR>	Ends an expression delimited with vertical bars. See "Delimited Expressions" in this tag description.
<RBRACE>	Ends an expression delimited with curly braces. See "Delimited Expressions" in this tag description.
<RBRACKET>	Ends an expression delimited with square brackets. See "Delimited Expressions" in this tag description.
<RCEIL>	Ends an expression delimited with ceiling characters (<rceil symbol>). See "Delimited Expressions" in this tag description.
<RFLOOR>	Ends an expression delimited with floor characters (<rfloor symbol>). See "Delimited Expressions" in this tag description.
<RPAREN>	Ends an expression delimited with parentheses. See "Delimited Expressions" in this tag description.
<SP>	Provides space in a variable name or expression.
<SQRT>( expression)	The square root, as in <sqrt symbol>a .
<SUBSCRIPT>( expression)	Subscription, as in a_b .
<SUM>	Specifies summation, as in a<sum symbol> . See "Operators With and Without Limits" in this tag description.
<SUM_LIMITS>	Specifies summation that places superscripts and subscripts above and below the sign, rather than to the right. See "Operators With and Without Limits" in this tag description.
<SUM_NOLIMITS>	Specifies summation that places superscripts and subscripts to the right of the sign, rather than above and below. See "Operators With and Without Limits" in this tag description.
<SUPERSCRIPT>( expression)	Exponentiation, as in a^ b . See "Operators With and Without Limits" in this tag description.
<TEXT>	Specifies text in a math expression.
<TIMES>	Multiplication, as in a*b .
<TO>	Indicates progression, as in 1<to symbol> .
<VARIABLE>	Specifies a variable name that contains nonalphanumeric characters.
<VDOTS>	Specifies vertical dots, as in <vdots symbol> .
<VECTOR>( var)	A vector, as in .
<X_TIMES>	Multiplication, as in a x b .

Operators With and Without Limits

When you specify <SUBSCRIPT> and <SUPERSCRIPT> tags, the subscript or superscript applies to the immediately preceding variable or expression. You can specify these tags in any order, as shown in the following example:

---

Previous

Next

Contents

Index