#set TITLE = "proc annotate"
#include top

.SH DESCRIPTION
\fBproc annotate\fR may be used to place arbitrary text at 
specific locations, in either absolute space or scaled space.
Annotation may include one or two arrows and a box if desired.

#include space
.SH FEATURES
Text may be single line or multiple lines.
Optional backing box for text, that can be colored, outlined,
and have a bevel or drop shadow.
Semi-intelligent placement of one or two arrows.
Control over text and arrow color.
#set FILE = "clickmap.html"
#set TAG = "HTML clickmap support"
#include link
for annotations box.

#include space
.SH EXAMPLES
See the Gallery Annotations examples
.ig >>
<a href="../gallery/gall.annot.html"><img src="../gallery/btn/here.gif"></a>
.>>

#include space
.SH PREREQUISITES
None.

#include space
.SH MANDATORY ATTRIBUTES
The \fCtext\fR and \fClocation\fR attributes MUST be specified.
If an arrow is desired, the \fCarrowhead\fR attribute must be specified.

#include space
.SH ATTRIBUTES
.LP
\fBtext\fR 
#set FILE = "attributetypes.html#text"
#set TAG = "multiline text"
#include link
.IP
The text to be displayed.  Terminates with a blank line.
Text may also come from a file or command (see below).
.br
Example:
.nf
.ft C
text:	Value
	as of 1/15/99

.LP
\fBlocation\fR 
#set FILE = "attributetypes.html#xy"
#set TAG = "x y"
#include link
.IP
The text will be placed at this location.
By default the text will be centered around X, and
the bottom of the first line will be at Y.
Absolute units are assumed;
append \fC(s)\fR to one or both values to indicate scaled units.  
.br
Example: \fClocation: 2.2(s) 3.0\fR


.LP
\fBarrowhead\fR 
#set FILE = "attributetypes.html#xy"
#set TAG = "x y"
#include link
.IP
If specified, an arrow will be drawn pointing at this location.
The tail of the arrow will be placed automatically if \fCarrowtail\fR
is not specified.
Absolute units are assumed;
append \fC(s)\fR to one or both values to indicate scaled units.  
.br
Example: \fCarrowhead: 2012(s) 85(s)\fR

.LP
\fBarrowhead2\fR 
#set FILE = "attributetypes.html#xy"
#set TAG = "x y"
#include link
.IP
Same as \fCarrowhead\fR above, for a second arrow.

#include space
.SH DETAIL ATTRIBUTES
.LP
\fBfromfile\fR \fIfilename\fR
.IP
If specified, the text will be read from this file.
This filename is expanded by a shell.

.LP
\fBfromcommand\fR \fIshell command\fR
.IP
If specified, this shell command will be executed to yield 
text on its standard output.

.LP
\fBtextdetails\fR 
#set FILE = "attributetypes.html#textdetails"
#set TAG = "textdetails"
#include link
.IP
Allows control of details pertaining to the text, such as alignment, color, size, and font.
Example: \fCtextdetails: align=C size=9\fR

.LP
\fBbox\fR 
#set FILE = "attributetypes.html#linedetails"
#set TAG = "linedetails"
#include link
.IP
If specified, a box will be drawn around the text.
May be used with or without \fCbackcolor\fR.
.br
Example: \fCbox: yes\fR  (do a default box)
.br
Example: \fCbox: color=yellow width=1.0\fR

.LP
\fBboxmargin\fR \fIn\fR
.IP
If specified, increase the size of any backing box by
\fIn\fR absolute units on all four sides. 
.br
Example: boxmargin: 0.15

.LP
\fBbackcolor\fR 
#set FILE = "color.html"
#set TAG = "color"
#include link
.IP
Supply a colored rectangle backing box, to be filled with \fIcolor\fR.
No box outline is drawn, use \fCbox\fR to get one.
May be used with or without \fCbox\fR.

.LP
\fBarrowdetails\fR 
#set FILE = "linedetails.html"
#set TAG = "linedetails"
#include link
.IP
Allows control of details pertaining to the arrows, such as line thickness and color.

.LP
\fBarrowheadsize\fR \fIn\fR
.IP
Controls the size of the arrowhead.  
\fIn\fR is the length of the arrowhead in absolute units (default 0.1 inches).
This attribute may be set to 0 to suppress arrowhead and just draw line.

.LP
\fBarrowtail\fR 
#set FILE = "attributetypes.html#xy"
#set TAG = "x y"
#include link
.IP
If specified, tail of 1st arrow will be at this point.  

.LP
\fBarrowtail2\fR 
#set FILE = "attributetypes.html#xy"
#set TAG = "x y"
#include link
.IP
If specified, tail of 2nd arrow will be at this point.  

.LP
\fBverttext\fR  \fCyes\fR | \fCno\fR
.IP
If \fCyes\fR, text will be rendered vertically, from low to high.
This is a limited implementation;
backing box does not work with vertical text, nor does
automatic arrow tail placement (arrow tail must be specified).

.LP
\fBclickmapurl\fR \fIurl\fR
.IP
If generating an
#set FILE = clickmap.html
#set TAG = "HTML clickmap"
#include link
on the attribute box,
this specifies a url.
See
#set FILE = clickmap.html
#set TAG = "HTML clickmap"
#include link
for more details and examples.
.br
Example: \fCclickmapurl: http://abc.com/docs/explanation.html\fR

#include space

.SH Pertaining to optional bevel & drop shadow 
.LP
\fBbevelsize\fR \fIn\fR
.IP
Width of optional bevel area, in
#set FILE = "attributetypes.html#positionunits"
#set TAG = "absolute units."
#include link
Default is \fC0.0\fR (no bevel).

.LP
\fBshadowsize\fR \fIn\fR
.IP
Width of visible portion of optional drop shadow in absolute units.
Default is \fC0.0\fR (no drop shadow).

.LP
\fBhibevelcolor\fR
#set FILE = "color.html"
#set TAG = "color"
#include link
.IP
Color of upper and lefttmost bevels.  Default is \fCgray(0.6)\fR

.LP
\fBlowbevelcolor\fR
#set FILE = "color.html"
#set TAG = "color"
#include link
.IP
Color of lower and rightmost bevels.  Default is \fCgray(0.8)\fR

.LP
\fBshadowcolor\fR
#set FILE = "color.html"
#set TAG = "color"
#include link
.IP
Color of drop shadow.  Default is \fCblack\fR.


#include bottom
