Subcommands

WIDTH Subcommand
WIDTH n [unit]

Defines the width of the logical page.

n
A number with up to three decimal places is used. The width may vary according to the type of printer being used. For more information, refer to your printer documentation.
unit
Specifies a unit of measurement for the WIDTH subcommand. The choices are IN, MM, CM, POINTS, or PELS.
HEIGHT Subcommand
[HEIGHT n [unit]]
Defines the height of the logical page.
n
A number with up to three decimal places is used. The height may vary according to the type of printer being used. For more information, refer to your printer documentation.
unit
Specifies a unit of measurement for the HEIGHT parameter. The choices are IN, MM, CM, POINTS, or PELS.
LINEONE Subcommand (Traditional)
LINEONE x-pos y-pos

Specifies the values for the MARGIN and TOP parameters used in the POSITION subcommand of the PRINTLINE command.

x-pos
Specifies the offset from the left edge of the logical page (margin position). The valid options for x-pos are described in the SETUNITS command for the horizontal value.
y-pos
Specifies the offset from the top of the logical page (top line position). The valid options for y-pos are described in the SETUNITS command for the vertical value.
DIRECTION Subcommand
DIRECTION {ACROSS |DOWN | BACK | UP}

Specifies the print direction of the logical page. Not all printers can print in all print directions. For more information, refer to your printer documentation.

Note: Some printers have a different form origin and require different direction settings than most page printers. For printing in the landscape page presentation when using wide forms, the PRESENT subcommand must be specified on the FORMDEF command to produce readable output. Alternatively, if you have existing page definitions, the UP direction can be used in the page definition without changes to the form definition to produce the same result.
ACROSS
The page is printed with the characters added to the page from left to right, and the lines added from the top to the bottom.
DOWN
The page is printed with the characters added to the page from top to bottom, and the lines added from the right to the left.
BACK
The page is printed with the characters added to the page from right to left, and the lines added from the bottom to the top.
UP
The page is printed with the characters added to the page from bottom to top, and the lines added from the left to the right.

For Record Format and XML, DIRECTION affects the meaning of the following new margin parameters:

  • If the DIRECTION is ACROSS, then TOPMARGIN refers to the margin in the short end of the physical page where the tops of the characters point toward that same short end.
  • If the DIRECTION is DOWN, then TOPMARGIN refers to the margin in the long end of the physical page where the tops of the characters point toward that same long end.

PELSPERINCH Subcommand
PELSPERINCH n
Specifies the Logical Units in pels per inch for this page format. Use the PELSPERINCH parameter to tell PPFA the pel resolution of your printer to generate more exact object placements.
n
Specifies an integer number between 1 and 3,276, which determines the Logical Units in pels per inch.
TOPMARGIN Subcommand (Record Format and XML)
TOPMARGIN n [IN | MM | CM | POINTS | PELS]
This keyword specifies the amount of space to be reserved at the top of the page.
BOTMARGIN Subcommand (Record Format and XML)
BOTMARGIN n [IN | MM | CM | POINTS | PELS]
This keyword specifies the amount of space to be reserved at the bottom of the page.
LEFTMARGIN Subcommand (Record Format and XML)
LEFTMARGIN n [IN | MM | CM | POINTS | PELS]
This keyword specifies the amount of space to be reserved at the left of the page. This is only used in conjunction with the DRAWGRAPHIC commands. Although PPFA collects the left margin information, the value is used only within PPFA to define an area. The value itself is not passed in the datastream.
RIGHTMARGIN Subcommand (Record Format and XML)
RIGHTMARGIN n [IN | MM | CM | POINTS | PELS

This keyword specifies the amount of space to be reserved at the right of the page. This is only to be used in conjunction with the DRAWGRAPHIC commands. Although PPFA collects the right margin information, it uses the value only within PPFA to define an area. This value itself is not passed in the datastream.

PAGECOUNT Subcommand (Record Format and XML)
PAGECOUNT [CONTINUE [n | 1] | STOP | RESUME [n] | RESET [n | 1]] 
   [CMP] [CCP]
This keyword allows the user to specify how the page counting is to be handled when switching between page formats.
CONTINUE
Page counting continues from the previous page format. This is the default. The n value is only used on the first PAGEFORMAT in the job, otherwise it is ignored. If this is the first PAGEFORMAT and no n value is specified, it defaults to 1.
STOP
Page counting stops. Page count is captured from the previous page format, but does not continue to count.
RESUME
Page counting continues from wherever it was the last time this page format was called. The n value sets the value only the first time page format is invoked.
RESET
Page counting is reset to the n value. If no n value is entered, then the page numbers are reset to 1.
CMP
Count MO:DCA Pages option. Tells the print server to count any imbedded MO:DCA pages in the page count.
CCP
Count Constant Pages options. Tells the print server to count any pages that have no variable data on them.
SOSIFONTS Subcommand
SOSIFONTS sbcs-font , dbcs-font

The SOSIFONTSsubcommand causes a Single-Byte Character Set (SBCS) font and a Double-Byte Character Set (DBCS) font to be mapped in a manner that will allow the proper font switching when Shift-in and Shift-out control sequences are encountered in printed text.

sbcs-font
A Single-Byte Character Set font. This font will be selected by the print server when a Shift-In (SI) control byte is encountered in text being presented.
dbcs-font
A Double-Byte Character Set font. This font will be selected by the print server when a Shift-Out (SO) control byte is encountered in text being presented.

There are four ways to use SOSI fonts in a Traditional page definition:

  1. In the PAGEDEF, using the FONT placement subcommand to specify both the SBCS and DBCS fonts to be used. To use this method, you define both a single-byte and double-byte font with the FONT and DOFONT commands. Then you reference both fonts on the FONT subcommand on the FIELD, PRINTLINE, LAYOUT, and so forth commands, separated by a comma. The single-byte font goes first. For example: 
    Pagedef sosiP1 replace yes;
  FONT sb1 GT10 SBCS;
  FONT db1 M40F DBCS;
  PAGEFORMAT PF1;
    PRINTLINE POSITION 1 in 1.2 in FONT sb1,db1;
  2. In the PAGEDEF, using the PAGEFORMAT subcommand SOSIFONTS to insure that a single byte font is mapped first and a double byte font is mapped second in the PAGEFORMAT. To use this method, code both a single-byte and double-byte font with the FONT command. Then you use the SOSIFONTS subcommand on the PAGEFORMAT command with the desired SBCS font coded first and the desired DBCS font coded next. For example: 
    Pagedef sosiL1 replace yes;
  FONT sb1 GT10 SBCS;
  FONT db1 M40F DBCS;
  PAGEFORMAT PF1 SOSIFONTS sb1,db1;

    PRINTLINE POSITION 1 in 1.2 in;
    Note: The SOSIFONTS subcommand can also be coded on the PAGEDEF command. It will be inherited on any PAGEFORMATs that do not code a SOSIFONTS subcommand.
  3. Define fonts using the CHARS and no fonts in the PAGEDEF or no PAGEDEF using the default PAGEDEF. Using this method the first font defined in the CHARS is a SBCS font and the second is a DBCS font.
  4. Traditional Only: Use the TRCREF command to define the SBCS font as 0 and the DBCS font as 1. Do not specify a FONT subcommand on the PRINTLINE, FIELD, and so forth commands, when using this method. This method is for use with a traditional page definition only. For example: 
    Pagedef sosiL1 replace yes;
  FONT sb1 GT10 SBCS;
  FONT db1 M40F DBCS;
  PAGEFORMAT PF1;
    TRCREF 0 FONT sb1;
    TRCREF 1 FONT db1;
    PRINTLINE;

You cannot mix Data Object fonts (defined with the DOFONT command) with normal FOCA fonts (defined with the FONT command) in the page definition in any but the first method of specifying SOSI fonts. That is only when you specify both fonts on the placement command.

There are three ways to use SOSI fonts in a Record Format or XML page definition:

  1. In the PAGEDEF, using the FONT placement subcommand to specify both the SBCS and DBCS fonts to be used. To use this method, you define both a single-byte and double-byte font with the FONT and DOFONT commands. Then you reference both fonts on the FONT subcommand on the FIELD, PRINTLINE, LAYOUT, and so forth commands, separated by a comma. The single-byte font goes first. For example: 
    Pagedef sosiP1 replace yes;
  FONT sb1 GT10 SBCS;
  FONT db1 M40F DBCS;
  PAGEFORMAT PF1;
    LAYOUT 'L1' POSITION 1 in 1.2 in FONT sb1,db1;
  2. In the PAGEDEF, using the PAGEFORMAT subcommand SOSIFONTS to insure that a single byte font is mapped first and a double byte font is mapped second in the PAGEFORMAT. To use this method, code both a single-byte and double-byte font with the FONT command. Then you use the SOSIFONTS subcommand on the PAGEFORMAT command with the desired SBCS font coded first and the desired DBCS font coded next. For example: 
    Pagedef sosiL1 replace yes;
  FONT sb1 GT10 SBCS;
  FONT db1 M40F DBCS;
  PAGEFORMAT PF1 SOSIFONTS sb1,db1;

    LAYOUT 'L1' POSITION 1 in 1.2 in;
    Note: The SOSIFONTS subcommand can also be coded on the PAGEDEF command. It will be inherited on any PAGEFORMATs that do not code a SOSIFONTS subcommand.
  3. Define fonts using the CHARS and no fonts in the PAGEDEF or no PAGEDEF using the default PAGEDEF. Using this method the first font defined in the CHARS is a SBCS font and the second is a DBCS font.
  4. Use the TRCREF command to define the SBCS font as 0 and the DBCS font as 1. Do no specify a FONT subcommand on the LAYOUT, FIELD, and so forth commands, when using this method. This method is for use with a traditional page definition only. For example: 
    Pagedef sosiL1 replace yes;
  FONT sb1 GT10 SBCS;
  FONT db1 M40F DBCS;
  PAGEFORMAT PF1;
    TRCREF 0 FONT sb1;
    TRCREF 1 FONT db1;
    LAYOUT 'L2';

You cannot mix Data Object fonts (defined with the DOFONT command) with normal FOCA fonts (defined with the FONT command) in the page definition in any but the first method of specifying SOSI fonts. That is only when you specify both fonts on the placement command.

For additional information about using SOSI characters, see the AFP Programming Guide and Line Data Reference, S544-3884.
RECIDLEN Subcommand (Record Format)
RECIDLEN n

Specifies the length of the Record Descriptor ID in bytes. The Record Descriptor ID is also known as the LAYOUT name. If the RECIDLEN parameter is not coded on a PAGEFORMAT command, it inherits the value from the specified or default value on the page definition. If the RECIDLEN parameter is not coded on a PAGEDEF command, the default length is 10 bytes.

Note: If the User Data Type (UDType) is UTF16 and n is odd, it is rounded up to the next even number.
n
Specifies that the record ID on the LAYOUT command is to be n bytes long. The allowable value of n is 1 to 250. UTF-16 data characters are 2 bytes long, allowing up to 125 UTF-16 characters. Any record ID on a LAYOUT command that is less than this length is padded to the specified length with blanks of the type specified or defaulted in the UDType subcommand on the PAGEDEF command. A record ID that is longer than n is flagged as an error by PPFA and no page definition is generated.
Note: If the User Data Type (UDType) is UTF16 and n is odd, it is rounded up to the next even number.
Parent topic: PAGEFORMAT Command