ArborX


raw

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

Summary
Specifies to use a 3B2 'raw' verb to build specific parts of a 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".

 <?frame clear> 1
 <?frame size 80mm, 30mm> 2
 <?frame position 50mm, 70mm> 3
 <?frame raw name "Simple_1"> 4
 <?frame add-to-page> 5
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
Always add to page (this actually adds the frame to the page).

Syntax (7.67a)
raw Ø
verb_params:n

The raw verb (internal command) to use and it's required parameters.

absvjust num:n  See Absolute VJ mode in tfmisc
anchor name:s, group:s, condition:s, priority:n  These are the same parameters as the tfanchor macro
arabic on-off:o  Text in the frame rows from right to left.
avmethod ...  Frame avoid details - see tfav.
avoid yes-no:o  By default avoid is set to yes, so this is only needed to set avoid to no.
bcolour colour:c  Background colour where col is a standard 3B2 colour e.g bcolour Red or for a graduated tint bcolour 76/48 Blue
bfrefnames ref1:s, ref2:s, ref:s  Bestfit references. If used, the last reference in the list must be an empty tag. Technote 0069; Bestfit Reference Streams; 7.70a for more detail.
ccolour colour:c  Column colour where col is a standard 3B2 colour e.g ccolour Cyan or for a graduated tint ccolour 88/56 Green.
cjk on-off:o  Set cjk mode on/off
ckskip on-off:o  Set ckskip on/off
column x:uv, y:uv  Colum position in the frame relative to the left margin of the frame e.g column 7,20
commname stream_name:s  Frame comment stream name
copyfit ....  see frame tpacopy macro.
cpymodes w:uv, x:uv, y:uv, z:uv  See values for Frame Copy Mode, tfcmodes
crefname refname:s  Column reference tag name
cut x:uv, y:uv  Frame cutting guides where x = size, y=offset. tfcut
faltview n  Where n is frame alternate view setting, tfaltview.
fdnames str_num:n, stream:s  Footnote control streams for the frame
fillname strmx:s  Frame filler stream name
fill fill_mode:n  Fill mode = 1 is fill top, 2 is fill columns.
frame left:uv, top:uv, right:uv, bottom:uv  Defines the position and size of the frame, e.g frame 0, 0, 210,297
gap left:uv, top:uv, right:uv, bottom:uv  Set gap around frame
htone min,max,gamma  Half tone control for frames. see macro tfcont e.g ht2 "Cyan",0, 100,100,100,100, 100,100,100, 0,0
lock on-off:o  set the lock attribute so the frame cannot be moved
lrefname refname:s  line reference tag name
mode frame_mode:n  Frame mode: 1 = left pages, 2 = right pages, 4= footnotes, 5 = odd pages, 6 = even pages
name frame_name:s  To name a frame - e.g name "fred"
objects object:s, top:uv, bottom:uv, left:uv, right:uv, across:uv, down:uv  frame object, top, bottom, left and right margins, and across and down coordinates
olock on-off:o  Set frame overlap lock
overmatter on-off:o  Frame allow overmatter mode
pageclip on-off:o  Turn page clip on/off
pagelife pages:n  where 'pages' is the number of pages the frame would be copied to by the autocopy. It will default to 1 for an auto frame. To have an auto frame copied infinitely, pagelife must be set to a high number e.g 99999.
prmode rules_mode:n  Frame page rules mode. See macro tfprmode
prefname strm:s  Frame paragraph reference stream.
pro on-off:n  Turn profressional leading on/off.
raster raster_name:s, top:uv, bottom:uv,left:uv,right:uv,across:uv,down:uv  Raster graphic, top, bottom, left and right margins, and across and down coordinates.
refname refname:s  Frame reference tag name.
restart on-off:n  Repeat text in all frames assigned the same text stream.
rot deg:n  The degree of rotation of the frame - 90, 180, 270, 312 etc
rules tot:n,p:n,t:uv, "c:c;p:n,r:n"..., grw,"grc"  see macro tfrules
:uv

Frame rule definitions.

p

The global sides and rounded corners position

t

Rule thickness

c

Rule colour

p

Rule position

r

Rule radius

grw

Inter-column (gutter) rule thickness

grc

The colour

<?frame raw rules 2,0,2,"Red;9,3",4,"Cyan;6,5",5,"Yellow">

scolour colour:c  status colour where col is a standard 3B2 colour e.g scolour Cyan or for a graduated tint scolour 88/56 Green
snap_gap w:uv, x:uv, y:uv, z:uv  Enabled text snap for the frame. See macro tfsnap for the values
strtgrp w:uv, h:uv  this follows a frame verb and groups all frames until an endgrp verb. w and h are the width and height dimensions
addtogrp  Use this instead of add-to-page to add frames to a group
endgrp  Indicates the end of the grouped frames
text stream:s:uv, t:uv, b:uv, l:uv, r:uv  The text stream assigned to the frame - stream name, followed by the top, bottom, left and right margins e.g. text "strm1",5,5,5,5.
tie_id target:s, x, y  where 'target' is target area to tie frame to, x is for update, y is rotation. See frame tie macro tftie e.g tie_id "?p",1,0
tie_vals ...  Frame tie values.
vjbal num:n  See Vertical Justify between balanced groups, macro tfmisc
vjust num:n  Ssee vertical justify type in tfmisc.
widows x, y  Widows/Orphans. See tfwidows.
vjbot on-off:o  Vertically justify text in all columns to the bottom margin of the frame, on/off.
xbrk on-off:o  Set extended break mode.
xorphan on-off:o  Set extended orphan mode.

Like the <?page raw ...?> verbs, these are currently used internally by 3B2 to build a frame. They provide a way of applying every possible attribute to a frame that is not already covered by other <?frame?> keywords.

A good way to ensure you have all the correct 'raw' verbs required for your desired operation is to copy a selected frame to an internal 'file' with tp:tcopy "{0}before", make changes to the frame, copy it again with tp:tcopy "{0}after" and then compare the 'before' and 'after' streams. This will also show how the parameters of each verb are used.

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