Copyright © Cloud Software Group, Inc. All Rights Reserved
Copyright © Cloud Software Group, Inc. All Rights Reserved


Chapter 3 Tools : TEXTSETUP
TEXTSETUP
Defines a setup for formatting a text document. (E)
Invocation
Do one of the following:
From the…
Move the cursor to the…
And…
Developer’s workbench
EX Execute Rule option
Type TEXTSETUP(setupname) <Enter>
COMMAND prompt
Type EX TEXTSETUP (setupname) <Enter>
Where:
 
setupname
The name of the setup to use.
Usage Notes
•
If you do not supply a value for setupname, invoking TEXTSETUP displays a screen prompting for a value.
•
After TEXTSETUP is invoked, a screen appears for defining a new setup or modifying an existing setup.
•
Use the .setup setupname SCRIPT command at the beginning of a text file to have SCRIPT use a particular setup to format a file.
TEXTSETUP Screens
TEXTSETUP contains three screens:
 
Page Setup screen
Defines the page layout.
Top Title screen
Defines the title lines for the setup.
Bottom Title screen
Defines the bottom lines for the setup.
Setups Supplied with TIBCO Object Service Broker
TIBCO Object Service Broker supplies four predefined setups:
 
Default
In effect whenever formatting begins and if no setup is specified.
It turns formatting on and sets the page setup to suit the 24 line screen.
Screen
Sets a larger page size intended to fill a screen.
Help
Sets a page without a page number and is used by the Screen Definer to display both field- and screen-level help.
Print
Sets a page that can print in portrait form through the use of a print function that you provide later.
These predefined setups cannot be overwritten (saved) or deleted.
Page Setup Screen
After entering a new or existing text setup name, a screen similar to the following appears:
 
TEXT SETUP: DEFAULT COMMAND ==>
This is the page definition; change any field as desired.
+-------------------------------------+
| : | |
|< ADjust = 5 >|< LineLength = 60 >|
| : | 1L 1C 1R | Top Margin has 2 line(s).
| P | 2L 2C 2R | The first three lines can have titles
| a | 3L 3C 3R | in the positions shown. PF5 to set.
|---g-----------|---------------------|
| e | |
| L | This area is | Page Length is the number of lines
| e = 23 | used for the | used for the text and top and
| n | formatted text. | bottom margins.
| g | |
|---t-----------|---------------------|
| h | | Bottom Margin has 2 line(s).
| : | 3L 3C 3R | Last three lines can have titles
| : | 2L 2C 2R | in the positions shown. PF6 to set.
| : | 1L 1C 1R |
+-------------------------------------+
Format Parameters -- FOrmat on: Y JUstify on: Y Line Spacing = 1
PageNumbering: Y Bullet Characters = ->
PFKEYS: 3=SAVE 5=TOP TITLES 6=BOTTOM TITLES 12=CANCEL 22=DELETE
 
Use the Page Setup screen to define the page layout; it contains formatting parameters for a page. You can change these parameters as required. The name of the setup is shown at the top of the screen in the TEXT SETUP field. You can change the name and save the setup under a new name.
Formatting Parameters
Each parameter name contains two capitalized letters. These letters indicate the SCRIPT command that sets the formatting. Refer to SCRIPT page layout commands for more information.
The formatting parameters are as follows:
Primary Commands and PF Keys for the Page Setup screen
These primary commands and PF keys are available from the Page Setup screen:
Command
PF Key
Function
SAVE
PF3
Saves the definition and exit.
TOP
PF5
Displays the TOP Titles screen.
BOTTOM
PF6
Displays the BOTTOM Titles screen.
CANCEL
PF12
Cancels the definition and exit.
DELETE
PF22
Deletes the definition. You are prompted to confirm the deletion.
Top Titles Screen
You use the TOP Titles screen to define the title lines for the setup. You can change the default values for a user-defined setup. Press PF5 to display this screen. The following shows the screen that appears for DEFAULT setup:
 
TEXT SETUP: DEFAULT
COMMAND ==>
 
TOP Titles
 
Enter titles. If you want the same title on all
pages, enter it for both odd and even numbered pages.
 
Even Numbered Pages Odd Numbered Pages
1L = 1L =
1R = page % 1R = page %
2L = 2L =
2R = 2R =
3L = 3L =
3R = 3R =
 
Centre Titles
1C =
2C =
3C =
 
 
PFKEYS: 3=SAVE 12=CANCEL
 
Title lines contain the following characteristics:
•
Lines are numbered from the top down.
•
Lines can be entered for even, odd, or all pages. To enter values for all pages, title lines must be entered for both even and odd pages.
•
Odd and even pages are treated as separate entities.
•
Center titles apply to both even and odd numbered pages.
•
Each title line can be left justified, right justified, or centered within each page type.
•
You can enter up to three title lines, if there is enough room in the margin.
•
A title line can start with .date str. The variable str is any date format acceptable to $TRXDATE. This is replaced with the current date in the format you specify.
•
The percent sign (%) is entered as a default value (for the first line, right side (1R) even and odd pages). This symbol is converted to a page number if page numbering is ON. The symbol does not print if page numbering is OFF. Refer to SCRIPT page layout commands for more information on page numbering.
Bottom Titles Screen
Use the BOTTOM Titles screen to define bottom lines for the setup. You can change the default values for a user-defined setup. Press PF6 to display this screen. The following figure shows the screen that appears for DEFAULT setup:
 
TEXT SETUP: DEFAULT
COMMAND ==>
 
BOTTOM Titles
 
Enter titles. If you want the same title on all
pages, enter it for both odd and even numbered pages.
 
Even Numbered Pages Odd Numbered Pages
3L = 3L =
3R = 3R =
2L = 2L =
2R = 2R =
1L = 1L =
1R = 1R =
 
Centre Titles
3C =
2C =
1C =
 
 
PFKEYS: 3=SAVE 12=CANCEL
 
The BOTTOM Titles screen is similar to the TOP Titles screen except that the lines are numbered from the bottom up.
Primary Commands and PF Keys for the Titles Screens
The following primary commands and PF keys are available from both Titles screens:
Command
PF Key
Function
SAVE
PF3
Saves the changes and exit. Changes saved from this screen do not actually take effect until you save the text setup.
CANCEL
PF12
Cancels the changes and exit.
Example
The following is an example setup:
 
TEXT SETUP: EXAMPLE COMMAND ==>
This is the page definition; change any field as desired.
+-------------------------------------+
| : | |
|< ADjust = 2 >|< LineLength = 60 >|
| : | 1L 1C 1R | Top Margin has 2 line(s).
| P | 2L 2C 2R | The first three lines can have titles
| a | 3L 3C 3R | in the positions shown. PF5 to set.
|---g-----------|---------------------|
| e | |
| L | This area is | Page Length is the number of lines
| e = 21 | used for the | used for the text and top and
| n | formatted text. | bottom margins.
| g | |
|---t-----------|---------------------|
| h | | Bottom Margin has 2 line(s).
| : | 3L 3C 3R | Last three lines can have titles
| : | 2L 2C 2R | in the positions shown. PF6 to set.
| : | 1L 1C 1R |
+-------------------------------------+
Format Parameters -- FOrmat on: Y JUstify on: N Line Spacing = 2
PageNumbering: Y Bullet Characters = *
PFKEYS: 3=SAVE 5=TOP TITLES 6=BOTTOM TITLES 12=CANCEL 22=DELETE
 
Unscripted Text
The following is an example of unscripted text created using the TED tool. The first line instructs SCRIPT to use the setup EXAMPLE:
 
Text Editor ====>
Scroll: P
Editing: @TEXT(BZDD1, EXAMPLE)
_ ----------------------------------------------------------------------------
_ .setup example
_ .cc.textsetup example
_ .p.This example illustrates how the setup determines the format of
_ scripted text. Some of the qualities that the setup controls are:
_ .ul.
_ .li.Line length
_ .li.Justification
_ .li.Page length
_ .li.Bullet characters
_ .p.These are easily set using the TEXTSETUP tool.
 
 
 
 
 
 
 
 PFKEYS: 12=CANCEL 22=DELETE 3=SAVE 5=SCRIPT 9=REPEAT CMND
 
Scripted Text
The scripted text appears as follows:
 
Formatted Output
Command ====> Scroll: P
page 1
TEXTSETUP EXAMPLE
This example illustrates how the setup determines the
format of scripted text. Some of the qualities that the
setup controls are:
* Line length
* Justification
* Page length
* Bullet characters
 
page 2
 
These are easily set using the TEXTSETUP tool.
 
Copyright © Cloud Software Group, Inc. All Rights Reserved
Copyright © Cloud Software Group, Inc. All Rights Reserved