Skip to main content
Contiem Connect

Tools

HelpStudio provides a number of tools to aid with project wide reporting and editing.

Topic List

The Topic List is a grid based view of conceptual topic content in the current project. The Topic list allows you to view and edit the Topic Properties associated with many Topics at a glance, and provides functionality for sorting, filtering and grouping Topics.

You can learn more in the Topic List topic.

Task List

The Task List allows you to create and manage Tasks. Tasks are a useful way to keep track of items of work in your project.

You can learn more in the Task List topic.

Project Index Editor

In HelpStudio, index keywords are associated with individual Topics and the Topic Editor contains an Index Keyword editor. The Project Index Editor provides an alternative Project wide view of the defined index keywords and provides another way to create, edit or remove index keywords.

Project Search

The Project Search tool allows you to search for items throughout your project using one or more Rules.

You can learn more in the Project Search topic.

Project Find and Replace

Project Find And Replace allows you to find or replace a particular word or phrase anywhere in the current project.

Project Spell Check

Project Spell Check allows you to quickly and easily check for spelling errors throughout the current project.

Project Verify Links

The Project Verify Links verifies every Hyperlink, Image reference, and Topic See Also Link reference in each Topic within the current project. Verifying project links is an essential step in ensuring that your Help System is free from errors when deployed.

Undocumented Items

The Undocumented Items tool will find items in the reference documentation part of your project that are undocumented. This tool is invaluable in verifying that you documentation is ready to publish as it will identify any items included in the reference documentation part of your project which do not have a specific level of documentation. By default this tool will check that at least a Summary has been provided, but options are provided to control the criteria used to determine if an item is considered undocumented.

Find Unused Images

The Find unused images tool can be used to locate images that have been added to your project but are no longer referenced in content. Pruning unused images allows you to reduce the size of your Help System.

To run the Find Unused Images tool, click Find Unused Images from the Tools tab. The project will be scanned for unused images, and any that are found will be displayed on a list from which you can immediately remove them from the project.

See Also

Top of page