suspend_cmd

View page source

Suspend and Resume Commands

Syntax

  • {xrst_suspend}

  • {xrst_suspend boolean }

  • {xrst_suspend left op right }

  • {xrst_resume}

Discussion

It is possible to suspend (resume) the xrst extraction and processing. One begins (ends) the suspension with a line that only contains spaces, tabs and a suspend command (resume command). Each suspend command must have a corresponding resume command.

White Space

Leading and trailing spaces in boolean , left , op , and right are ignored.

boolean

If the argument boolean is present, it must be true or false. If is true, or not present, the section of input up to the next resume is not included in the xrst extraction and processing for this page. This argument is intended to be used by the template command where it can be assigned the value true or false for a particular expansion of the template_file .

op

This argument must be == or !=. It must be separated one or more spaces from left and right .

left, right

If arguments left and right must not have any white space in them. If

left op right

is true (false) , the section of input up to the next resume is not included in the xrst extraction and processing for this page.

Example

suspend_example