## Report File Naming Conventions

File names of reports generated vary based on the type and format of the report generated.

For text files, a single text file containing all selected reports may be generated or separate files for each type of report may be generated. A single text file is named <project_name>.txt. For separate text files, the root of the file name is <project_name> with varying suffixes added to the file name to distinguish the type of report. The following table shows the file names used for each text report.

A .pcn is also created as in index to every program unit, listing its parameters and file/line declaration.

For HTML files, a single HTML file containing all selected reports may be generated or separate files for each type of report may be generated. HTML files are further broken down into separate files, either alphabetically by entity name or in groups of N number of entities. An index file is also generated and contains links to all the other HTML reports generated. The report index file is named index.html.

The following table shows the file names used for each separate HTML and text report. In the HTML Reports column, n is a letter from A-Z if “Alphabetic” was selected. If “Every n entities” was selected, n is a number beginning with zero.

Report Name | Alpha or Numeric HTML Reports | Text Reports
--- | --- | ---
Data Dictionary | dictionary_n.html | project.dic
Program Unit Cross Reference | progunit_xref_n.html | project.pux
Object Cross Reference | object_xref_n.html | project.obx
Type Cross Reference | type_xref_n.html | project.tyx
Declaration Tree | decltree_n.html | project.dct
Invocation Tree | invocation_n.html | project.inv
Simple Invocation Tree | simpleinvtree_n.html | project.sit
With Tree | withtree_n.html | project.wit
Simple With Tree | simplewithtree_n.html | project.swt
Generic Instantiation Report | Gen_inst_n.html | project.gnx
Exception Cross Reference | exception_xref_n.html | project.exx
Renames Report | renames_n.html | project.rnx
Program Unit Complexity | progunitcomp_metrics_n.html | project.cmx
Project Metrics | projmetrics.html | project.jme
Program Unit Metrics | progunit_metris_n.html | project.pmx
File Metrics | file_metrics_n.html | project.fmx
Unused Objects | unusedobject_n.html | project.qno
Unused Types | unusedtype_n.html | project.qnt
Unused Program Units | unusedprogunit_n.html | project.qnu
Withs Not Needed | withsnotneeded_n.html | project.qwn

Scientific Toolworks, Inc. http://www.scitools.com