Reports

From the Reports folder in the Project Organizer, you can generate custom reports based on information contained in your project. In addition, you can design the look and feel of reports, save them for future access, and open them in a browser window (where you can print them). 

Following are the various types of information that you can include in your reports. Some reports appear in multiple categories.

Bookmarks

  • Broken Bookmarks
  • Unused Bookmarks
  • Used Bookmarks

Concepts

  • Concept Links
  • Files With Concepts
  • Files Without Concepts
  • Topics With Concept Links
  • Topics With Concept Links Missing a Concept
  • Used Concepts
  • Used Search Filters

Conditions

  • Applied Conditions

    This report lists every conditional expression that is applied to content, files, or folders throughout the project. For example, Topic1.htm has the condition "web" applied. Topic2.htm has that same condition applied, in addition to the condition called "advanced." This report lists all items that have the "web" condition and all items that have the "web and advanced" condition.

  • Files With Condition Tags

    This report lists all files in your project that have conditions applied to them. You can see conditions set at the topic level, and on individual snippet blocks.

  • Files With Snippet Conditions

    This report lists the files (e.g, topics, snippets) in your project that have snippet conditions applied to them. You can see snippet conditions set at the topic level, as well as snippet conditions set on individual snippet blocks.

  • Undefined Condition Tags

    Undefined conditions might occur, for example, if you have applied a condition tag in a topic and then later change the name of the tag or condition tag set. The old tag or set name is still used at the location where it was previously applied in the topic. Therefore, a problem exists.

  • Unused Condition Tags

    This report lists any condition tags that are not used anywhere. A condition is considered used when it is applied to content or at least one file. It is also considered used if it is set as included or excluded in a target or within topic properties (as a snippet condition).

  • Used Condition Tags

    This report lists every tag from every condition tag set and displays all files, folders, and tags to which each is applied. For example, Topic1.htm has the condition "web" applied. Topic2.htm has that same condition applied, in addition to the condition called "advanced." This report lists each place the "advanced" condition is applied and then each place the "web" condition is applied.

Content Files

  • Empty Content Folders
  • File Word Count
  • Files With Annotations
  • Files With Changes (includes annotations)
  • Files With Concepts
  • Files With Condition Tags
  • Files With Equations
  • Files With File Tags
  • Files With Glossary Term Links
  • Files With Images
  • Files With Keywords
  • Files With Language Tags
  • Files with Micro Content Links
  • Files With Multimedia
  • Files With Named Destinations
  • Files With QR Codes
  • Files With Snippets
  • Files With Variables
  • Files Without Concepts
  • Files Without File Tags
  • Unused Content Files

CSH

  • Assigned CSH IDs
  • Duplicate Map IDs
  • Topics Linked By Map ID
  • Topics Not Linked By Map ID
  • Unused CSH IDs

File Tags

  • Files With File Tags
  • Files With Tag: Author
  • Files With Tag: Status
  • Files Without File Tags
  • Undefined File Tags
  • Unused File Tags
  • Used File Tags
  • Files With Glossary Term Links
  • Undefined Glossary Term Links
  • Used Glossary Term Links

Images

  • Files With Images
  • Unused Images
  • Used Images

Index

  • Files With Keywords
  • Index Keyword Links
  • Index Keyword Suggestions
  • Topics Not In Index
  • Topics With Keyword Links
  • Topics With Keyword Links Missing a Keyword
  • Used Index Keywords

Language Tags

  • Files With Language Tags
  • Used Language Tags
  • Absolute Links
  • Broken Bookmarks
  • Broken Links
  • Broken Snippet Links
  • Concept Links
  • Cross-Reference Suggestions
  • External Links
  • Index Keyword Links
  • Named Destinations
  • Topics Linked By Map ID
  • Topics Not Linked
  • Topics Not Linked By Map ID
  • Topics With Concept Links
  • Topics With Concept Links Missing a Concept
  • Topics With Keyword Links
  • Topics With Keyword Links Missing a Keyword
  • Undefined Glossary Term Links
  • Unused Bookmarks
  • Used Bookmarks
  • Used Glossary Term Links

Micro Content

  • Duplicate Micro Content Phrases
  • Files with Micro Content Links
  • Micro Content Empty Phrases
  • Micro Content Empty Responses

Multimedia

  • Files With Multimedia
  • Unused Multimedia
  • Used Multimedia

Project

  • Database Errors
  • Files With Annotations
  • Statistics
    • Broken links
    • Image count
    • Segment count
    • Snippet count
    • Topic count
    • Undefined condition tags
    • Undefined glossary term links
    • Undefined styles
    • Undefined variables
    • Word count

Snippets

  • Broken Snippet Links
  • Files With Snippet Conditions
  • Files With Snippets
  • Snippet Suggestions
  • Topics With Snippet Variables
  • Unused Snippets
  • Used Snippets

Styles

  • Duplicate Style Formats
  • New Style Suggestions
  • Replace Local Style Suggestions
  • Undefined Styles
  • Unused Styles
  • Used Stylesheets

Target

  • Condition Tags Not Set

    This displays all condition tag sets that have not been explicitly included or excluded in each target file.

  • Variables Not Overriden

    This displays all variables (with multiple definitions) that have not been set to be overridden in each target file.

  • Word Count

    This displays the total word count of all topics within your target file, based on the associated TOC.

TOC

  • Duplicate TOC Items
  • TOC - Primary Target
  • Topics Not In Any TOC

Topics

  • Accessibility Suggestions
  • Broken Bookmarks
  • Broken Links
  • Cross-Reference Suggestions
  • File Word Count
  • Files With Snippet Conditions

    This report shows not only topics that have snippet conditions, but it also indicates the location of those snippet conditions. This helps to determine whether a snippet condition is applied at a topic level (html) or content level (MadCap:snippetBlock).

  • Markup Suggestions
  • Non-XML Topics
  • Topics Linked By Map ID
  • Topics Not In Any TOC
  • Topics Not In Index
  • Topics Not Linked
  • Topics Not Linked By Map ID
  • Topics With Concept Links
  • Topics With Concept Links Missing a Concept
  • Topics With Keyword Links
  • Topics With Keyword Links Missing a Keyword
  • Topics With Meta Tags
  • Writing Suggestions

Variables

  • Files With Variables
  • Topics with Snippet Variables
  • Undefined Variables
  • Unused Variables
  • Used Variables
  • Variable Suggestions

What’s Noteworthy?

Note For items starting with the words "Files With…," the files listed in the report may include topics, snippets, master pages, stylesheets, or page layouts. For example, if you run a report for "Files With Variables," the results may show a list of topics, snippets, and page layouts that contain variables.

The item "Files With Condition Tags" may include any content or project files, as well as content folders. The item "Files With File Tags" may include any content or project files.

Note Reports that begin with "Undefined" (e.g., Undefined Styles, Undefined Variables) list files that have references to elements that do not exist. You might experience this is you rename an element, but the name does not also get changed in the file where it is referenced. For example, let's say you have a variable called "CompanyName" and you insert it into a topic. Later, you are working in the topic in code view and change the name of the variable where it is referenced to "Company," but it remains as "CompanyName" in the variable set, so the two do not match. Or the opposite might happen. You might change the name of the variable in the Variable Set Editor, but somehow the old name remains where it is referenced in the topic. Either way, you have a reference to a variable that does not exist. To fix this, you can rename the variable in the Variable Set Editor or rename it in the topic.