Document! X & HelpStudio Bundle 2022.1
Working with Images and Tables / Tools / Project Verify Links
In This Topic
    Project Verify Links
    In This Topic

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

    Project Verify Links Fundamentals

    Show All
    Hide All

    Check Project Links

    1. Select the Project Verify Links option on the Tools tab. The Project Link Check window appears.
    2. If you want to only check links in particular project elements, select or clear specific items in the Check Links In list.
    3. If your project contains more than one Build Profile, select the Build Profile that you want to check links for.
    4. Select Start Link Check button. The link checking starts and the broken or unknown links are listed in the results grid.
    Any internet links are initially marked with a status of Unknown in the results. Click the Check Unknown Links button to verify that those internet links are valid.

    To correct a broken link:

    1. Select the broken link on the results grid.
    2. Select the  Edit Link button on the results grid toolbar.

      A Project Link Check Item window appears to define the correct link.

    3. Select Build to show the Link Designer and identify the correct target for the link.
    4. Select Replace to replace this one instance of the broken link with the corrected link target -or - select Replace All to replace all instances of this same link target with the corrected link target.
    From the Project Link Check Item window, you can click the  Edit button to open the content containing the broken link for edit.
           

    To add a missing image or other file to the project:

    Images or other files that are referenced or linked to in content but are not included in the project are identified as broken links by the Project Verify Links tool.

    To add a missing file to the project:

    1. Select the broken link with a status of "Missing from Project" on the results grid.
    2. Select the  Add Missing File button on the results grid toolbar.

    The missing file is added to the project.

    If many missing files are identified, click Add All Missing Files to quickly add all missing files to the project.
           

    Navigation Bar

    When you open an item from the results grid (e.g. by double clicking), a Navigation Bar opens above the document tab area:

    Example Navigation Bar

    The navigation bar makes it easy to step through the items on the results grid.

     

     

    © 2023 Innovasys. All Rights Reserved.

    Send Feedback