Next: Special purpose tags Previous: Tags Contents: Contents |
Tags are directives embedded into the text stream, commanding how certain parts of the text should be interpreted. The general syntax is <name>[{<options>}][<body>]. Whether a part is optional or not depends on the tag (at least a tag name is required ;-).
A tag name is made of a backslash and a number of alphanumeric characters (capitals):
\TAG |
B<Tag options> can be optional (see the specific tags documentation). They follow the tag name immediately, enclosed by a pair of corresponding curly braces. Each option is a simple string assignment. The value should be quoted if /^\w+$/
does not match it. Option settings are separated by whitespace(s).
\TAG{par1=value1 par2="www.perl.com" par3="words and blanks"} |
If a tag accepts options, it can be made conditional which means it can be activated depending on the result of passed Perl code, which is evaluated as Active Content. This code is passed by option _cnd_
.
\IMAGE{_cnd_="$illustrate" src="piegraph.gif"} |
If Active Contents is disabled, the condition defaults to be false.
The tag body may be optional. If used, it is anything you want to make the tag valid for. It immediately follows the optional parameters, enclosed by angle brackets:
\TAG<body> Tag bodies \TAG<can be multilined>. \TAG{par=value}<body> |
Tags can be nested.
\TAG1<\TAG2<body>> |
Every PerlPoint translator defines its own tags, but usually all of them support B, C, EMBED, FORMAT, HIDE, I, IMAGE, INCLUDE, LOCALTOC, READY, REF, SEQ, STOP and TABLE as a base set. Additionally, there are a few reserved tags which are implemented by every translator. See the next section for details.
Next: Special purpose tags Previous: Tags Contents: Contents |