You are here: Features > Project Information and Issues
Project Information and Issues
There are several features in Analyzer that let you obtain information about your project and see any issues with it.
Project Information Features
- Accessibility Accessibility has to do with making sure that your documentation can be accessed by people with disabilities (i.e., individuals who have visual, hearing, and mobility impairments). Documentation is considered accessible when it is easier for those with disabilities to use and easier to read using assistive technologies such as Microsoft Windows Narrator, Connect Outloud, and Job Access With Speech (JAWS). See About Accessibility.
- Annotations You can view a list of all files where annotations (internal comments) have been inserted. You can also double-click a row to open the topic in question. See Viewing Files with Annotations.
- Bookmarks When working with projects in Analyzer, you can generate reports about bookmarks. See Bookmarks.
- Concepts When working with projects in Analyzer, you can generate reports about concepts. See Concepts.
- Condition Tags A condition is something that you can apply to different areas of your content so that some sections show up in some of your outputs but not in others. See About Condition Tags.
- Context-Sensitive Help IDs When working with projects in Analyzer, you can generate reports about context-sensitive Help IDs. See Context-sensitive Help IDs.
- Database Errors You can view miscellaneous errors that may occur regarding the Analyzer database. These happen when your project contains data not compatible with the Analyzer database. If a file is listed in this pane, it will not be included in any analysis or suggestions. If your project contains database errors, please contact MadCap Software's technical support team for help. See Viewing Database Errors.
- File Tags When working with projects in Analyzer, you can generate reports about file tags. See File Tags.
- Frequent Segments Analyzer lets you view lists of segments that occur frequently throughout your project. See About Frequent Segments.
- Glossaries You can view a list of all files where you have glossary term links inserted into content, but those glossary terms do not appear in any of your glossary files. This might occur, for example, if you have created a new term in a glossary and then inserted that term into a topic as a glossary term link. Later, you remove that term from the glossary. You now have a glossary term link in a topic, but the term no longer exists in the glossary. Therefore, a problem exists. You need to either remove the glossary term link from the content, or you need to add the term to the glossary again. From the Undefined Glossary Term Links window pane, you can quickly unbind or rename multiple glossary term link occurrences in a single batch, add a new glossary term, or map the undefined term to an existing glossary term. See Viewing Undefined Glossary Term Links.
- Images When working with projects in Analyzer, you generate reports about images. See Images.
- Indexes When working with projects in Analyzer, you can generate reports about indexes. See Indexes.
- Language Tags You can view a list showing each file where a language tag is found, the content tag to which it has been applied (e.g., html, span), and the language used. See Viewing Used Language Tags.
- Links When working with projects in Analyzer, you can generate reports about links. See Links.
- Markup Suggestions When working with projects in Analyzer, you can view markup suggestions. See Markup Suggestions.
- Snippets Snippets are chunks of content that you can use in your project over and over. Think of them as miniature topics. It’s content that you want to reuse in many different topics, but you don’t want to have to keep retyping that content, so you just type it once in a snippet. Then you insert that snippet into as many topics as you need it to be in. You can even insert them into other snippets, creating nested snippets. Normally snippets are made up of one or more paragraphs, perhaps including elements such as lists, images, tables, or text. We’re not usually talking about single words or phrases here. That’s what variables are for. See About Snippets.
- Styles When working with projects in Analyzer, you can generate reports about styles. See Styles.
- Tables of Contents When working with projects in Analyzer, you can generate reports about tables of contents. See Tables of Contents.
- Topics When working with projects in Analyzer, you can generate reports about topics. See Topics.
- Track Changes You can view a list of files with tracked changes (and annotations). You can then open the file where the changes are located and deal with them appropriately (e.g., accept or reject changes). See Viewing Files with Changes.
- Variables Variables are used for brief, non-formatted pieces of content (such as the name of your company's product or your company's phone number) that you need to use in your project over and over. They're especially good for text that might change frequently, such as version numbers and dates. Variables are stored in variable sets, which can hold multiple variables. See About Variables.
- Writing Suggestions When working with projects in Analyzer, you can view writing suggestions. See Writing Suggestions