XMP (Example)

The XMP tag defines unformatted text within an information region.

Syntax


>>-<XMP--+--------+-->--+------+--</XMP>-----------------------><
         '-NOSKIP-'     '-text-'

Parameters

NOSKIP: This attribute causes the blank line normally placed before the example to be skipped.
text: This is the text of the example.

Comments

The XMP tag defines unformatted text within an information region.

Text coded between the XMP start and end tags is indented two spaces and formats from the current left margin. Tags which normally cause word-wrapping (for example, P and LI) do not cause word-wrapping when nested within an XMP tag.

When defining text for an example in your source file, you should be careful not to exceed the width of the information region it is coded within. If the source text on any line exceeds the formatting width, the conversion utility truncates the line. A warning message is issued the first time truncation occurs.

Restrictions

The XMP tag requires an end tag.
You must code the XMP tag within an INFO definition. See INFO (Information Region) for a complete description of this tag.
You can code multiple XMP tags within an INFO definition, as long as they are not nested within each other.

Processing

Table 1. Tags you can code within an XMP definition
Tag	Reference	Usage	Required
DL	DL (Definition List)	Multiple	No
HP	HP (Highlighted Phrase)	Multiple	No
NOTE	NOTE (Note)	Multiple	No
NOTEL	NOTEL (Note List)	Multiple	No
NT	NT (Note)	Multiple	No
OL	OL (Ordered List)	Multiple	No
P	P (Paragraph)	Multiple	No
PARML	PARML (Parameter List)	Multiple	No
PS	PS (Point-and-Shoot)	Multiple	No
RP	RP (Reference Phrase)	Multiple	No
SL	SL (Simple List)	Multiple	No
UL	UL (Unordered List)	Multiple	No

Examples

Here is help panel markup that contains an example. Figure 1 shows the formatted result.

<!DOCTYPE DM SYSTEM>

<HELP NAME=xmp WIDTH=40 DEPTH=20>Help for the Search Function
<AREA>
<INFO>
 <P>To locate a book, type the book
title in the "Title" field and press Enter.
<P>Example:
<XMP>
Title:  THE JOY OF CODING
</XMP>
<P>You don't have to worry about using
upper or lowercase letters; all text is automatically
converted to uppercase for the search.
</INFO>
</AREA>
</HELP>

Figure 1. Example

      Help for the Search Function

 To locate a book, type the book title
 in the "Title" field and press Enter.

 Example:

   Title:  THE JOY OF CODING

 You don't have to worry about using
 upper or lowercase letters; all text
 is automatically converted to
 uppercase for the search.




  F1=Help      F3=Exit      F5=Exhelp
  F6=Keyshelp  F7=PrvTopic  F8=NxtTopic
 F10=PrvPage  F11=NxtPage  F12=Cancel