Search


Ploticus > Scripts >
proc page


proc page indicates the beginning of a new page or image, and can be used to set attributes that affect an entire page or image. For scripts that produce multiple output pages or images, proc page indicates the page break and is required. Otherwise it is optional. In order to just do a page break (only), invoke proc page with no attributes, eg.
#proc page




Attributes



title     multiline-text

    Specifies a page title. By default, title is rendered at the top center of the "page" (as determined by pagesize). 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 (\\).
    Example: 
    title: Comparison of Survey Techniques 
     By Region 
     \\
     Fall, 1997


titledetails     textdetails

    Specifies detail options for the rendering of the page title.
    Example: titledetails: size=14 style=BI

dobackground     yes | no

    The only time this attribute is useful is to override the default behavior for EPS, which is to not fill the entire EPS page area with the background color (allowing EPS to draw over existing background). For all other output devices the page area is always filled with the background color when one is specified.
    Example: dobackground: no

dopagebox     yes | no

    If proc page is used with eps, png, or gif 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 no for EPS, PNG or GIF, yes otherwise.
    Example: pagebox: yes




Command line option equivalents

A number of proc page attributes more or less duplicate the functionality of certain command line arguments; see the pl(1) manual page for fuller descriptions. Besides being made in proc page or on the command line, some of these settings can be also be made using proc settings and/or your config file.


outfilename     filename

    Does the same thing as the -o 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.
    Example: outfilename: myplot_p2.png

color     color

    Does the same thing as the -color command line option. Sets the default color for drawn lines and text.
    Example color: white

backgroundcolor     color

    Does the same thing as the -backgroundcolor command line option. Sets the background color for the page.
    Example backgroundcolor: blue

linewidth     w

    Does the same thing as the -linewidth command line option. Sets the default line width. All line width specifications will be rendered as relative to this. See also linedetails.
    Example: linewidth: 3.0

textsize     p

    Does the same thing as the -textsize command line option. Sets the default point size of text. All text size specifications will be rendered as relative to this. See also textdetails.
    Example: textsize: 16

font     font

    Does the same thing as the -font command line option. sets the overall default font to font. Font names having embedded spaces will be parsed correctly (but may still be problematic). See also fonts and textdetails
    PostScript example: font: /Times-Roman

crop     x1 y1 x2 y2

    Same thing as -crop command line option. After rendering crop PNG, GIF, or EPS result to a box in absolute units.
    Example: crop: 2.0 1.5 6.5 5.0

tightcrop     yes | no

    Does the same thing as the -tightcrop 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).

croprel     left bottom right top

    Same thing as -croprel 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.
    Example: croprel: 2.3 1.7 6.5 5.3

pixsize     width height

    Same thing as -pixsize command line option. If specified, the result PNG/GIF/JPG image will have exactly the specified width and height in pixels. Does not interact with scaling or cropping... user is responsible for ensuring that content fits appropriately into the specified size. User is also responsible for setting pagesize appropriately for larger images. New in 2.40

scale     scalex     [scaley]

    Does the same thing as the -scale 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).
    Example: scale: 0.7 0.5

landscape     yes | no

    Does the same thing as the -landscape command line option, except on a per-page basis. Default is no. If yes 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).

pagesize     width height

    Similar to the -pagesize command line option. There are a few subtle differences due to the order in which various tasks are done.
    Example: pagesize: 7 3

outlabel     label

    Does the same thing as the -outlabel command line option. Set an output label or title to label. For X11 this is the window title. For PostScript and SVG it sets the %%Title attribute (first page only).




Clickmaps

csmap     yes | no

    If yes, this turns on client-side image map generation (equivalent to the -csmap command line option).

mapfilename     filename

    Does the same thing as the -mapfile command line option.

clickmapdefault     url

    If clickmaps are being generated, this attribute allows a "default" url to be supplied, for when a mouse click is in none of the defined regions.

 


Ploticus 2.42 ... May 2013 Terms of use /