DECLARE-LAYOUT

Function

Defines the attributes for the layout of an output file.

Syntax

DECLARE-LAYOUT layout_name
[PAPER-SIZE=({paper_width_num_lit[uom],paper_depth_num_lit[uom]}|{paper_name})]
[FORMFEED=form_feed_lit]
[ORIENTATION=orientation_lit]
[LEFT-MARGIN=left_margin_num_lit[uom]]
[TOP-MARGIN=top_margin_num_lit[uom]]
[RIGHT-MARGIN=right_margin_num_lit[uom]
|LINE-WIDTH=line_width_num_lit[uom]
|MAX-COLUMNS=columns_int_lit]
[BOTTOM-MARGIN=bottom_margin_num_lit[uom]
|PAGE-DEPTH=page_depth_num_lit[uom]
|MAX-LINES=lines_int_lit]
[CHAR-WIDTH=char_width_num_lit[uom]]
[LINE-HEIGHT=line_height_num_lit[uom]]
END-DECLARE

Arguments

layout_name

Unique layout name used to reference the layout and its attributes.

uom

Optional suffix which denotes the unit of measure applied to the preceding value.

paper_name

An option of PAPER-SIZE. This name is associated with predefined dimensions.

Description

DECLARE-LAYOUT describes the characteristics of a layout to use for an output file. A layout can be shared by more than one report. You can define as many layouts as are necessary for the requirements of the application. You can override the default layout attributes by defining a layout called DEFAULT in your program. Each layout name must be unique.

Production Reporting maps its line and column positions on the page by using a grid determined by the LINE‑HEIGHT and CHAR‑WIDTH arguments. That is, Production Reporting calculates the number of columns per row by dividing the LINE-WIDTH by the CHAR‑WIDTH and calculates the number of lines by dividing the PAGE-DEPTH by the LINE‑HEIGHT. Each printed segment of text is placed on the page using this grid. Because the characters in proportional fonts vary in width, it is possible that a word or string is wider than the horizontal space you have allotted, especially in words containing uppercase letters or bold characters. To account for this behavior, you can either move the column position in the PRINT or POSITION statements or indicate a larger CHAR-WIDTH in DECLARE‑LAYOUT.

The ORIENTATION parameter selects the proper fonts. In addition, the parameter interacts with PAPER-SIZE as follows:

DECLARE-REPORT (Setup)

DECLARE-LAYOUT (Setup)

DECLARE-PRINTER(Setup)

DECLARE-PROCEDURE (Setup)

DECLARE-TOC (Setup)

USE-REPORT (Body)

USE-PROCEDURE (Body)

USE-PRINTER-TYPE (Body)

TOC-ENTRY (Body)

ALTER-PRINTER (Body)

BEGIN-HEADING For-Tocs=( ) (Construct)

BEGIN-FOOTING For-Tocs=( ) (Construct)

BEGIN-HEADING For-Reports=( ) (Construct)

BEGIN-FOOTING For-Reports=( ) (Construct)

Examples

The following example illustrates the ability to specify parameters using a metrics measurement system. (The syntax results in a paper size of 210mm by 297mm, a top margin of 12.7mm, a left margin of 12.7mm, a right margin of 25.4mma bottom margin of 12.7mm, a portrait orientation, 67 columns, and 63 lines.

declare-layout my-layout
  paper-size=(a4)         
  left-margin=12.7 mm     
  right-margin=25.4 mm 
end-declare         

The following example changes the page dimensions. It also changes the left and right margins to one inch. (The syntax results in a paper size of 14 inches by 11 inches, a top margin of 0.5 inches, a left margin of one inch, a right margin of one inch, a bottom margin of 0.5 inches, a portrait orientation, 120 columns, and 60 lines.)

declare-layout large-paper
  paper-size=(14, 11)
  left-margin=1        
  right-margin=1      
end-declare          

The following example retains the default page dimensions and changes the left and right margins to one inch. (The syntax results in a paper size of 8.5 inches by 11 inches, a top margin of 0.5 inches, a left margin of one inch, a right margin of one inch, a bottom margin of 0.5 inches, a portrait orientation, 65 columns, and 60 lines.)

declare-layout default
  left-margin=1        
  right-margin=1        
end-declare      

The following example changes the orientation to landscape. The columns and rows are recalculated. All other values remain the same. (The syntax results in a paper size of 11 inches by 8.5 inches, a top margin of 0.5 inches, a left margin of 0.5 inches, a right margin of 0.5 inches, a bottom margin of 0.5 inches, 100 columns and 45 lines.)

declare-layout default   
  orientation=landscape   
end-declare    

The following example changes the orientation to landscape. In addition the top margin is set to one inch. (The syntax results in a paper size of 11 inches by 8.5 inches, a top margin of 0.5 inches, a left margin of 0.5 inches, a right margin of 0.5 inches, a bottom margin of 0.5 inches, a landscape orientation, 100 columns and 43 lines.)

declare-layout my_landscape
  orientation=landscape
  top-margin=1 
end-declare

The following example specifies the page dimensions using a predefined name. Note that the orientation changes since this example is an envelope.(The syntax results in a paper size of 4.125 inches by 9.5 inches,. a top margin of 0.5 inches, a left margin of 0.5 inches, a right margin of 0.5 inches, a bottom margin of 0.5 inches, a landscape orientation, 85 columns and 18 lines.)

declare-layout envelope
  paper-size=(com-10)
end-declare

See Also

DECLARE-REPORT