ArborX

text

Longname: text   Open the Documentation Legend
Released: 7.67a 
Created: 7.67a 
See also: <?page> <?frame> clear default width height kill add-to-page raw position size text-margins page-kill event pageoffset end-of pb (n/a) after-page text-flags ttmapret ttmaprety ttignmsp ttignssp ttignesp ttignsp resize update ttmaptab (n/a) select setcols

Summary
 Provides different methods for inserting text into the new frame as part of an inline frame creation command sequence within the <?frame> command.
Example extract

This sample when placed inline and formatted will create a frame of 80 x 30mm positioned at 50mm down 70mm accross with the frame name "Simple_1". The example also shows how to insert text into an inline frame.

 <?frame clear> 1
 <?frame size 80mm, 30mm> 2
 <?frame position 50mm, 70mm> 3
 <?frame raw name "Simple_1"> 4
 <?frame text 1, "body","TEXT IN AUTOFRAME"> 5
 <?frame add-to-page> 6
4
Always clear any preexisting frame properties that may be in memory, otherwise they could get applied to the frame that you are creating.
6
The size of your frame.
8
The position of your frame.
10
Give the frame a name. This is because frames are always referred to by name if they require modification (the frame number is never used). This is also useful because of the way auto frames are handled internally - the name is required to uniquely identify a frame. This is particularly important for the autocopy feature, and for killing frames.
12
Create a text stream containing the the string "TEXT IN AUTOFRAME"
14
Always add to page (this actually adds the frame to the page).

Syntax (7.67a)
text type:n style:s  <method>?
where
<method> ::= (  string:s  ) | (  terminator:s  ) | (  stream_name:s para_start:s para_end:s  )
type:n

This option gives a number of ways to insert text into the frame.

1  The string of text following the style name.
2  Inserts text from the main text stream, from the reference until the default terminator string <?"|=|"> or a specified string, is found. (The text is ’cut’ from the text stream.)
3  As option 2, but the text is copied.
4  Inserts text from the given text stream from the start paragraph until the end paragraph. If no text stream is specified, the main text stream will be used.
style:s The style tag to be used for the inserted text.
string:s If option 1 is used, this is the string of text that will be inserted.
terminator:s If option 2 or 3 are used this is the terminator string at which the text inclution is stopped, this can be in the form of a tag or yank. If no option is specified it will default to the defined terminator string: <?"|=|">
stream_name:s If option 4 is used; this is the stream name from which the text will be taken.
para_start:s If option 4 is used; this is the 'comence' string. Can be a string, number or showstring.
para_end:s If option 4 is used; this is the 'terminate' string. Can be a string, number or showstring.

Type 1: The string of text follows the style
 <?frame text 1, "body", "Text in Auto Frame">

Type 2: Inserts text from the main text stream, from the reference until the default terminator string <?"|=|"> or a specified string, is found. The text is 'cut' from the text stream.
 <?frame text 2, "body">text in the main text stream<?"|=|">

Type 3: The same syntax as type 2 above, except that the text is 'copied' from the text stream, not 'cut'.
 <?frame text 3, "", "/\60\\/fred\62\/tc"> text in the main 1
 text stream </fred> 2

Type 4: inserts text from the given text stream from the start paragraph until the end paragraph. If no text stream is specified , the main text streamwill be used.
 <?frame text 4, "body", "strm2", "para_start", 1
 "para_end"> 2
'para__start' and 'para__end' can be numbers e.g "4" or show strings e.g "$^(x(0)*2-1"). Auto generated text streams are named 'atxp_strm_n' where 'p' is the page number, 'strm' is the source text stream where the text came from and 'n' the auto text stream number on that page e.g atx1_strm3_2.

Document created on 07-Apr-2003 (revision 001)