Catalog Lister Reports

This document explains in detail the reports generated by the Catalog Lister API for FrameMaker 4.0.For further explanation about the format names or attribute characteristics, please refer to your FrameMaker Reference manual. If you are using FrameMaker5.0, please see ``Catalog Lister Reports`` for FrameMaker5.0.

Field Name	Description
Basic Properties
Paragraph Tag	Lists the name of the paragraph tag as it is found in the paragraph catalog.
Indents: First, Left, Right	Indicates in points, how much a paragraph tag should be indented from the left and right margins.
Space Above/ Below	Indicates in points how much space should be allotted above or below a paragraph tag.
Line/ Fixed	Indicates intra-line spacing for paragraphs (measured in points) and indicates with Yes (Y) and No (N) whether spacing is fixed.
Align	Indicates if a paragraph tag should be aligned left (L), right (R), or centered (C) on a page.
Pos	Indicates in inches the Position of the tab stop. Three boxes below give the user room to add more tab stops, up to five positions.
Aln	Indicates where the tab stop is aligned; L=Left, R=Right, C=Center, and D=Decimal.
Ldr	Indicates the leader of the paragraph.
Dec	Indicates Decimal Character of the paragraph; can align a tab stop to the decimal.
Pagination Properties
Start	Indicates where a paragraph tag should start on a page. Frequently used with first level headings, this option ensures that such headings will begin at the top of a page by forcing a page break before. (A=Anywhere, C=Top of Column, P=Top of Page, L=Top of Left Page, R= Top of Right Page).
Keep	Options indicate which paragraphs should be kept together. (N=keep with Next paragraph, P=keep with Previous paragraph).
W/O	Indicates how many Widow/Orphan lines are needed for each paragraph tag.
Format	Indicates pagination format: N=Normal R/% (%=default punctuation) SF=Side Head, Alignment=First Baseline ST=Side Head, Alignment=Top Edge SL=Side Head, Alignement=Last Baseline A=Across Side Heads and Normal Areas.
Advanced Properties
Next Frm Above/ Below	This column specifies the next paragraph tag (a basic property) and which frame (from Reference Pages) appears above or below paragraph.
Hyph/ Lang	Indicates whether Hyphenation should be on or off. (N=No Hyphenation, Y= Yes Hyphenation.) and the language
Max/ Word/ Pref/ Suff	Maximum # Adjacent/Shortest Word/Shortest Prefix/Shortest Suffix. Gives numerical values for these parameters which determine how the paragraph is hyphenated.
Min/ Max/ Opt/ Auto	Indicates, with percentage values, minimum, maximum, and optimum word spacing, and with (Y) Yes or (N) No whether Automatic Letter Spacing is allowed.
Default Font Properties
Family	Describes the family font to be used.
For Description of Default Font Properties, see descriptions under Character Catalog Listing Fields.
Numbering Properties
Format	Indicates what numbering or special format (eg. bullet) will appear before text. The Format under Autonumber is usually up to the writer.
Char For	Indicates the special font the Autonumber Format is printed in.
P	Indicates the Position for the autonumbering format; S for the Start of a paragraph, and E for the end of a paragraph. For instance, legal documents may autonumber paragraphs at the end.
Table Cell Properties
Table Cell	Indicates whether the table cells are created with custom cell margins (Custom), or with cell margins where there is an added amount to the default cell margins in the table format (Plus)
Top	Indicates in points, the measurement of the Top cell margin.
Bottom	Indicates in points, the measurement of the Bottom cell margin.
Left	Indicates in points, the measurement of the Left cell margin.
Right	Indicates in points, the measurement of the Right cell margin.
Aln	Indicates vertical alignment within the table cell. Alignment can be at the Top (T), Middle (M), or Bottom (B) within the table cell.

Field Name	Description
Character Tag	Lists the name of the character format listed in the character catalog
Family	Describes the family font to be used.
Angle/ Weight/ Variation	Indicates Angle (Italic, Oblique,...), Weight (bold, light, semi-bold...), and Variation (Reverse, Narrow,...).
Size/ Color/ Spread	Indicates font size (in pts), Color (Black, Cyan,...), and spread of lettering (percentage amount).
Und	Indicates by Yes (Y), or No (N), whether text has Underline applied to it.
Ovr	Indicates by Yes (Y) or No (N) whether text has Overline applied to it.
Str	Indicates by Yes (Y) or No (N) whether text has Strikethrough applied to it.
ChB	Indicates by Yes (Y) or No (N) if change bars are turned on or off.
Scpt	Indicates whether text has Subscript (B) or Superscript (A) or neither (N) applied to it.
Case	Indicates whether text has Small Caps (C) or Upper Case (U) Lower Case (L) or none (N).
PrK	Indicates by Yes (Y) or No (N), if Pair Kerning is turned on or off.

Field Name	Definition
Table Tag	Gives name of table format listed in table catalog.
Indents: Left, Right	Indicates in points, how much a table should be indented from the left and right margins.
Space Above/ Below	Indicates in points how much space should be allotted above or below a table.
Top	Indicates in points, the measurement of the Top cell margin.
Bottom	Indicates in points, the measurement of the Bottom cell margin.
Left	Indicates in points, the measurement of the Left cell margin.
Right	Indicates in points, the measurement of the Right cell margin.
Aln	Indicates horizontal alignment of the Table. Alignment can be (L) Left, (R) Right, (C) Center
Start	Indicates where table starts on page: A=Anywhere, C=Top of Column, P=Top of Page, L=Top of Left Page, R= Top of Right Page
Number	Indicates numbering: R=Row First, C=Column First
Pos	Indicates Title position: A=Above Table, B=Below Table, N=No Title
Gap	Indicates Gap between Table and Title.
Orphan	Indicates number or orphan rows allowed in table.
Col: #/Others	Indicates column ruling for #th column and for all others.
Row: #/Others	Indicates row ruling for every #th row and for all others.
H/F: Sep/Row	Indicates ruling for separators and for rows in Heading and Footing
Top	Indicates outside ruling for top of table
Bottom	Indicates outside ruling for bottom of table
Left	Indicates outside ruling for left side of table.
Right	Indicates outside ruling for right side of table.
Last	Indicates with (Y)Yes or (N) No whether Bottom ruling should be drawn on last sheet only.
H/FShade Fill/Color	Indicates Fill and Color of Heading and Footing shading.
Body	Indicates whether shading is by rows or by columns. R=Rows, C=Columns.
First #/Fill/Color	Indicates fill and color of first # columns/rows (whichever was indicated in Body field)
Next #/Fill/Color	Indicates fill and color of next # columns/rows (whichever indicated in Body field)

Field Name	Description
Format	Lists name of cross-reference format
Definition	Gives definition of format.

Catalog Lister API: Introduction Frame5 version

[ Frame API's | SII Home Page | Contact Us ]