Next: REF   Previous: PAGEREF   Contents: Contents

READY

The \READY tag instructs PerlPoint to ignore remaining parts of a document.

Syntax

\READY

Options

No options are allowed. Used options will not be recognized as belonging to this tag.

Body

No body is allowed. A used body will not be recognized as a body of this tag.

Notes

\READY is part of the basic tag set supported by all PerlPoint translators.

Example

In this example, \READY is used to process just a small portion of a source, e.g. to build an overview:


 ? flagSet(overviewMode)

 \B<Short Overview>

 This document will give you an impression.

 // ready in overview mode
 \READY

 ? 1

 // usual document

Notes

The behaviour of this tag is still subject to changes. Currently, not even the current paragraph will become part of the result. That's why it s recommended to use it in a line of its own (as demonstrated by the example).

See also

More basic set tags: B, C, EMBED, FORMAT, HIDE, I, IMAGE, INCLUDE, LOCALTOC, READY, REF, SEQ and STOP.

Next: REF   Previous: PAGEREF   Contents: Contents