.ig >>
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
-->
</STYLE>
<title>ploticus: proc page</title>
<body bgcolor=D0D0EE vlink=0000FF>
<br>
<br>
<center>
<table cellpadding=2 bgcolor=FFFFFF width=550 ><tr>
<td>
  <table cellpadding=2 width=550><tr>
  <td><br><h2>proc page</h2></td>
  <td align=right>
  <small>
  <a href="../doc/Welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  <a href="../doc/Welcome.html">Welcome</a> &nbsp; &nbsp;
  <a href="../gallery/index.html">Gallery</a> &nbsp; &nbsp;
  <a href="../doc/Contents.html">Handbook</a> 
  <td></tr></table>
</td></tr>
<td>
<br>
<br>
.>>

.TH proc_page PL "11-DEC-2001   PL ploticus.sourceforge.net"

.SH DESCRIPTION
\fBproc page\fR begins a new "page", and may be used to set attributes 
that effect the entire "page".
Here, the word "page" can mean a paper page, image, EPS file, or interactive screen,
depending on the what kind of results are being generated.
.LP
It is not mandatory to invoke proc page for single-page results.
If multiple page results are desired, \fBproc page\fR is used
to perform page breaks.
If \fBproc page\fR is used, it must be used before any other procs that
will draw on the page.  
.LP
Many of the \fBproc page\fR attributes have equivalent command line arguments.
When given, command line arguments always take precedence over \fBproc page\fR
attributes.

.SH PREREQUISITES
None.

.SH MANDATORY ATTRIBUTES
None.  Default behavior is for a \fCportrait\fR-style
page to be set up.

.SH ATTRIBUTES
.LP
\fBlandscape\fR  \fCyes\fR | \fCno\fR
.IP
Does the same thing as the \fB-landscape\fR command line option,
except on a per-page basis.  Default is no.
If \fCyes\fR paper orientation will be landscape (oblong)
when using paginated postscript.  The absolute units 
origin (0,0) will be the lower left corner of the paper (paper 
held oblong).

.LP
\fBtitle\fR 
.ig >>
<a href="attributetypes.html#text">
.>>
\fI multiline-text \fR
.ig >>
</a>
.>>
.IP
Specifies a page title.
By default, title is rendered at the top center of the page, in large bold text.
Title text is specified as multi-line text, ending with the first blank line.
Blank lines that are to be part of the title should be escaped using a backslash (\\).
.br
Example: 
.nf
.ft C
\fCtitle: Comparison of Survey Techniques 
     By Region 
     \\
     Fall, 1997
.fi
.ft R

.LP
\fBoutfilename\fR \fIfilename\fR
.IP
Does the same thing as the \fB-o\fR command line option.
Specifies a filename where PNG, GIF, EPS, or paginated postscript result will be placed.
For PNG, GIF and EPS a different file name should be used for every Page.

.LP
\fBtitledetails\fR 
.ig >>
<a href="textdetails.html">
.>>
\fI textdetails \fR
.ig >>
</a>
.>>
.IP
Specifies detail options for the rendering of the page title.
Example: \fCtitledetails: size=14 style=BI \fR


.LP
\fBcolor\fR 
.ig >>
<a href="color.html">
.>>
\fI color \fR
.ig >>
</a>
.>>
.IP
Does the same thing as the \fB-color\fR command line option.
Sets the default color for drawn lines and text.  
.br
Example \fCcolor: white\fR

.LP
\fBbackgroundcolor\fR 
.ig >>
<a href="color.html">
.>>
\fI color \fR
.ig >>
</a>
.>>
.IP
Does the same thing as the \fB-backgroundcolor\fR command line option.
Sets the background color for the page.  
Example \fCbackgroundcolor: blue\fR

.LP
\fBlinewidth\fR \fIw\fR
.IP
Does the same thing as the \fB-linewidth\fR command line option.
Sets the default line width.  All line width specifications
will be rendered as relative to this.  
See also
.ig >>
<a href="linedetails.html">
.>>
linedetails 
.ig >>
</a>
.>>

.br
Example: \fClinewidth: 3.0\fR

.LP
\fBtextsize\fR  \fIp\fR
.IP
Does the same thing as the \fB-textsize\fR command line option.
Sets the default point size of text.  All text size specifications
will be rendered as relative to this.  
See also
.ig >>
<a href="textdetails.html">
.>>
textdetails 
.ig >>
</a>
.>>
.br
Example: \fCtextsize: 16\fR

.LP
\fBfont\fR \fIfont\fR
.IP
Does the same thing as the \fB-font\fR command line option.
sets the overall default font to \fIfont\fR.
See also
.ig >>
<a href="fonts.html">
.>>
\0fonts
.ig >>
</a>
.>>
and 
.ig >>
<a href="textdetails.html">
.>>
\0textdetails
.ig >>
</a>
.>>
.br
PostScript example: \fCfont: /Times-Roman\fR

.LP
\fBdobackground\fR \fCyes \fR| \fCno\fR
.IP
Fill of the entire page area with 
the backgound color.  Default is \fCyes\fR, except for
EPS where it defaults to \fCno\fR.
.br
Example: \fCdobackground: no\fR

.LP
\fBdopagebox\fR \fCyes \fR| \fCno\fR
.IP
If \fBproc page\fR is used with \fCeps\fR, \fCpng\fR, or \fCgif\fR as the device,
this attribute may be used so that the 
bounding box includes the whole page 
(normally it is cropped to the design with a small margin).
Default is \fCno\fR for EPS, PNG or GIF, \fCyes\fR otherwise.
.br
Example: \fCpagebox: yes\fR

.LP
\fBtightcrop\fR \fCyes \fR| \fCno\fR
.IP
Does the same thing as the \fB-tightcrop\fR command line option.
After rendering crop PNG, GIF or EPS result 
to the extent of the design with no margin
(normally a small margin is allowed).

.LP
\fBcrop\fR  \fIx1 y1 x2 y2\fR
.IP
Same thing as \fB-crop\fR command line option.
After rendering crop PNG, GIF, or EPS result to a box in absolute units.

.LP
\fBcroprel\fR  \fIleft bottom right top\fR
.IP
Same thing as \fB-croprel\fR command line option.
After rendering crop PNG, GIF, or EPS result to the extent of the design but
with an adjustable margin; positive values always adjust
the crop outward from center, negative values inward.

.LP
\fBscale\fR \fIscalex\fR  [\fIscaley\fR]
.IP
Does the same thing as the \fB-scale\fR command line option.
Enlarges or reduces the size of the entire result by
the given factor(s) (less than 1.0 reduces, greater than 1.0 enlarges).
.br
Example: \fCscale: 0.7 0.5\fR

.LP
\fBpagesize\fR \fIwidth height\fR
.IP
Similar to the \fB-pagesize\fR command line option.
However, unlike with the command line option, X11 window size will be affected
if overall scaling is done.  Another noticed difference is that
background fill color on large pages works with the command line option
but not with this attribute.

.IP
Example: \fCpagesize: 7 3\fR


.LP
\fBnumbernotation:\fR \fCstandard\fR | \fCus\fR | \fCeuro\fR
.IP
Specifies how decimal point and thousands separators will be displayed.  
This overrides the \fCnumbernotation\fR specification in any ploticus config file
that might exist.  The default is \fCstandard\fR.  See
.ig >>
<a href="../doc/config.html">
.>>
config
.ig >>
</a>
.>>
for a complete description.

.LP
\fBclickmapdefault:\fR  \fIurl\fR
.IP
If
.ig >>
<a href="clickmap.html">
.>>
\0clickmaps
.ig >>
</a>
.>>
are being generated, this attribute allows a "default" url to be supplied, for when
a mouse click is in none of the defined regions.

.ig >>
<br>
<br>
</td></tr>
<td align=right>
<a href="Welcome.html">
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine &nbsp; <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif">
</center>
</td></tr>
</table>
.>>
