SII

Paragraph Utilization Audit API

This API is designed to list all of the paragraph formats used in a certain document, set of documents, or book. It generates three output tables listing all the paragraph tags used as well as if it was an authorized tag, how many times it was used, and if it exists with overrides.There are many reasons why this API is important:

Running the API interactively

This API can be run for three different cases.

This requires the API to be run in batch mode. For more information on running the API in batch mode see ``Running the API from batch``.

To run the API for a single document the program is invoked by selecting Paragraph report (document) from the Special menu. See Figure 1.

To run this API for a book it is invoked by selecting SII Utilities-Paragraph reports (book) under the book menu. An example of this menu is shown in Figure 2.
Figure 1 Example Special menu
  • External Graphics Example Special menu
Figure 2 Example book File menu

Running the API from batch

To be written

API Output

The API will generate a new FrameMaker document consisting of three types of reports:

Each of the output reports contain certain columns identifying where the problem lies and other information so you can pinpoint the problem and correct it. Each of the output tables are defined below with further explanations.

Paragraph Utilization Report

This report lists all the paragraph tags used in a particular document, set of documents, or book. This report is to provide you with a statistical report of your paragraph utilization. An example is shown in Figure 3 below.
Tag
Catalog
Authorized
Total Times Used
Total Times Used with Overrides
0body
Y
Y
41
4
0body_compact
Y
Y
0
0
0caution_body
Y
Y
0
0
0caution_head
Y
Y
0
0
0note
Y
Y
0
0
0note_header
Y
Y
0
0
1body
Y
Y
0
0
1body_compact
Y
Y
0
0
1caution_body
Y
Y
0
0
1caution_head
Y
Y
0
0
1head
Y
Y
0
0
1ol1f-ordered_first
Y
Y
0
0
1ol1n-ordered_normal
Y
Y
0
0
Figure 3 Sample Paragraph Utilization Output Report
This output report consists of five columns:

Tag
A listing of each paragraph tags that are used in the document, set of documents or book.These should be listed in the paragraph catalog.

Catalog
A yes/ no indicator which shows if that paragraph tag exists in the paragraph catalog.

Authorized
A yes/no indicator which shows when formatting parameters are different from those in paragraphs catalog.

Total Times Used
A numeric count of how many times a particular tag is used throughout the document or book.

Total Times Used With
Overrides
A numeric count of how many times the tag is used with format parameters different from those specified in the paragraph catalog.

Override Report

This is a listing of the formatting parameters that are different from those listed in the paragraph catalog and used on each paragraph tag. This report allows you to find any overrides and take corrective actions. For example, if there are four overrides on a certain tag you would want to correct them and this report allows you to do so. An example is shown in Figure 4.
Tag
Document
Page Number
0body
64G1729.129
Master Page 2
0body
64G1729.129
Master Page 5
0body
64G1729.129
Master Page 5
0body
64G1729.129
Master Page 5
1ul1n-bullet
64G1729.129
1
1ul1n-bullet
64G1729.129
1
1ul1n-bullet
64G1729.129
3
2head
64G1729.129
1
2head
64G1729.129
1
2head
64G1729.129
1
2head
64G1729.129
1
2head
64G1729.129
3
2head
64G1729.129
3
Figure 4 Example Override Output Report
This output report consists of three columns:

Tag
A listing of each paragraph tags that are used in the document, set of documents or book that have override problems. These should be listed in the paragraph catalog.

Document
A listing of the particular document where the paragraph override exists. This is useful for locating the override and correcting it.

Page Number
This is a list of the exact page number where the override occurs.This can be either a master page, reference page, or body page.

Unauthorized Paragraphs Report

This report lists all the paragraph formats that are not defined in the document's table catalog. This report shows any unauthorized paragraphs and where they exist, allowing you to take corrective action to fix it. An example is shown in Figure 5.
Tag
Document
Page Number
Body
64G1729.129
1
Body
64G1729.129
3
Body
64G1729.129
3
cc_CellCenter
64G1729.129
10
cc_CellCenter
64G1729.129
10
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
cellbodycenter
64G1729.129
Reference Page 4
footer_right
64G1729.129
Master Page 1
footer_right
64G1729.129
Master Page 1
footer_right
64G1729.129
Master Page 4
footer_right
64G1729.129
Master Page 4
Figure 5 Example Unauthorized Paragraph Report
This output report consists of three columns:

Tag
A listing of each paragraph tags that are used in the document, set of documents or book.These should be listed in the paragraph catalog.

Document
A listing of the particular document where the paragraph override exists. This is useful for locating the override and correcting it.

Page Number
This is a list of the exact page number where the unauthorized paragraph occurs.This can be either a master page, reference page, or body page.

Related API's

Catalog Lister API

The Catalog Lister API creates an inventory of all tags and attributes in Frame catalogs. These include paragraph catalogs, character catalogs, table catalogs, cross-reference formats, and condition. This is particularly useful for template designers and document administrators maintaining a large number of formats.

Paragraph Utilization API: Installation and Maintenance
[ Frame API's | SII Home Page | Contact Us ]