## 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.

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
File Contents | contents_file_n.html | project.fil
Object Cross Reference | object_xref_n.html | project.obx
Class/Type Cross Reference | type_xref_n.html | project.tyx
Function Cross Reference | function_xref_n.html | project.pux
Macro Cross Reference | macro_xref_n.html | project.max
Include File Cross Ref | inc_xref_n.html | project.inc
Invocation Tree | invocation_n.html | project.inv
Simple Invocation Tree | simpleinvtree_n.html | project.sit
Function Complexity | funccpx_n.html | project.puc
Project Metrics | projmr.html | project.jme
Function Metrics | funcm_n.html | project.pme
Class Metrics | classm_n.html | project.cme
Class OO Metrics | classoom_n.html | project.cmo
File Metrics | filem_n.html | project.fme
File Average Metrics | fileam_n.html | project.fam
Unused Objects | object_unused.html | project.uob
Unused Functions | function_unused_n.html | project.ufu

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