Document! X and HelpStudio 2019
Project Fundamentals / Project Tools
In This Topic
    Project Tools
    In This Topic

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

    Project Find and Replace

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

    Movies

     

    Project Spell Check

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

    Movies

     

    Project Verify Links

    The Project Link Verifier will verify 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 will be free from errors when deployed.

    Movies

     

    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.

    Movies

     

    Project Index Editor

    In Document! X and 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.

     

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

    You can access the Task List in 2 ways. Accessed from the Tools Ribbon Tab, the Task Editor will open for all Tasks in the open project. Accessed from the Tasks tab in an individual Topic or Content File Editor, the Task Editor will show only those Tasks associated with that item.

     

    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 Ribbon 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