ArborX


<?smapret>

Longname: s tream map ret urns   Open the Documentation Legend
Released: not available 
Created: not available 
See also: ttignesp ttignmsp ttignsp ttmapret ttmaprety <?ttignesp> <?ttignssp> <?signsp> <?ttignssp> <?smaprety>

Summary
Specifies that a given text stream should map all hard return characters in the stream to a space. Used with <?smaprety>.
Example (n/a)
No example is available for this feature.

Syntax (SVNNA)
<?smapret  on_off:o?  level:n? >
on_off:o
Off.
On.
Default for the stream.
level:n

Root level - text stream (strm0, see below).
Current level (body).
Sub level (textstyle).

Imagine, for example, you are formatting a document and you have "strm0" as the stream being formatted, which calls "body" which calls "textstyle", i.e. you have the following heirarchy.

strm0 (root - level 0)

If level is greater than 0, then the space flag will apply to that level, i.e. if "textstyle" contains <?signsp 1,1> then only spaces inside body will be ignored. Spaces inside "strm0" and textstyle will still be processed as normal. In other words, the tag to apply the pi to is counted upwards from the main root tag.

Note that if the pi <?signsp 1,1> is placed in "strm0", so there is no level 1 tag, then it will apply to the current tag, "strm0". This means that setting level to a high number (e.g. 99) will ensure that the pi will always apply to the current tag regardless of it's position in the heirarchy.

If level is less than 0, then the space flag will apply to the tag at the level counting *downwards* from the current tag, so if you put <?signsp 1,-1> in "textstyle" then the pi will act on it's parent (body), <?signsp 1,-2> will act on it's grandparent (strm0), etc.


Document created on 01-Oct-2004 (revision 1)