Widget in Inline Manual / How to: show only topics relevant to a page

How to: show only topics relevant to a page

Filter by context
Context url

By setting Context paths you can indicate the path in which a topic should appear. This is a way of associating a topic such as an article or a walkthrough to a certain page on your site, so you can display only what is relevant to that page.

In this article, we’ll show you how to set it up in 2 steps.

Setting up context URLs

To set up context URLs:

  1. Login to the Inline Manual portal with your e-mail and password.
  2. Go to Topics tab and choose the desired topic.

  1. Go to the Settings tab.

  1. In the Topic Details section scroll down to the Advanced Settings section.

  1. In Topic context URLs provide desired paths.

  1. Confirm changes with the Update Topic button.

Great! Now, proceed to the next section and enable filter by context.

Enabling Filter by Context

To enable filter by context:

  1. While within the Inline Manual portal, go to Sites.

  1. Choose a relevant site (the one that includes a topic for which you set up context paths).
  2. Go to Widget tab. Then go to Settings.

  1. Within Widget content toggle Filter by context.

  1. Confirm with Save and Publish button.

Perfect! From now on, only topics relevant to the page/path will be visible in the widget.

Important notes

Enabling this option without adding Context URLs will result in a blank list.

If you don’t enable Filter by context (just add Context URLs to the topic), all topics will be visible in the widget. However, topics for which you set up Context URLs will be highlighted and pushed to the top of the list when the user lands on that particular page. See more here.

If you have a path like https://example.com/dashboard/?control=project&action=create&private=1 and you want the topic to only show on https://example.com/dashboard/?control=project&action=create, then you can activate "strict mode" for checking params by prepending the exclamation mark (!) in front of the params pattern. Example: dashboard/?!control=project&action=create

If you want to show topics on all pages even with the Filter by context enabled, add * in the Context path.

When to show only relevant topics?

The Widget, by default, includes all the content you created such as articles, walkthroughs, or redirects. By setting the context URL for a topic, you can make sure that it only appears within certain sections of your application. This can be a huge time-saver for your users because they get relevant content without having to search for it. We do believe that providing in-context help improves the user experience.

Widget
How to: display content dynamically (context paths)
Articles
Walkthroughs