Skip to content
  • There are no suggestions because the search field is empty.

Adding Category Help Text in Cognidox

Enhance Category Descriptions with Links and Useful Information

This article explains how to add explanatory text about category content, include useful links, and control how links are displayed.

Videos in this article

video-icon-mask

What's in this article?

This article contains the following information for Admin users:

Tip: If you want more on this topic, check out the online help.

Back to top

Adding help text with a URL link

You can include a URL in category help text.

To add help text to a category listing:

  1. Navigate to the category, click Manage this Category, and display the Name & Help tab.
  2. Enter some text in the Help text field (hover over the help icon to see pop-up help).
  3. If you want to include a URL, enter it in square brackets.
  4. Click Update Help Information.  

See also this help topic.

Back to top

Adding a Cognidox document link to help text

Following on from the previous section, here's how to add a link to a Cognidox document in the category help text.

To add a document link in category help text:

  1. Navigate to the category, click Manage this Category, and display the Name & Help tab.
  2. Copy and paste the document number into a suitable place in the existing Help text field. You don't need any special formatting (like square brackets).
  3. Click Update Help Information.

See also this help topic.

Back to top

Advanced help text techniques

In this section you'll learn how to:

  • Create a subtitle to make your help text stand out (at [00:26] in the video)
    See also this help topic
  • Display links as HTML overlays, specifying a version (at [01:36] in the video)
    See also this help topic.

Watch the video

To add a subtitle to the category help text:

  1. Navigate to the category, click Manage this Category, and display the Name & Help tab.
  2. Enter the subtitle text in the New subtitle field.
  3. Click Rename.

To preview a document link as an HTML overlay (rather than opening the Document Details page):

  1. Navigate to the category, click Manage this Category, and display the Name & Help tab.
  2. Edit the Help text field to include a link to the Cognidox document. You must specify a version, and use the following syntax:

    [<your-cognidox-server>/vdata/<docnum>-<version>.html]

  3. Click Update Help Information.

Back to top