Skip to main content

Example of Favorite Profile in Use

Example 1. Favorite profile used for a review assignment

Let's say you have an introduction topic that is reused in the user guide for two different products (we'll call them Acme 100 and Acme 200). That topic uses variables for the product names and has a note that only applies to the Acme 200 version of the product. So that note has a filter so that it can be excluded when it is not needed.

The topic looks like this:

Topic in the editor. It has numbered labels. 1 points to the product name variables in the content. 2 points to a note that has a filter.

Where:

  • 1 is the product variables that are used to swap out the product name, depending on whether the content is for the Acme 100 or Acme 200

  • 2 is the note that only applies to the Acme 200. This note has an xinfo:product filter with a filter value of Acme 200.

You want to set up favorite profiles so that you can easily switch between the content for the Acme 100 and the content for the Acme 200.

You go into the profile settings and create a new favorite called Acme 100.

Profile settings dialog. Favorites tab shows a profile named Acme 100.

On the Variables tab, you set the Acme Products variable to use the Acme 100 variant.

Profile settings. The variables tab is selected and shows the Acme Products variable has been set to Acme 100.

On the Profiling tab, you set the Product filter to use a value of Acme 100.

Profile settings dialog. The Profiling tab is selected. It shows the Product filter is set to Acme 100.

You then go back to the Favorites tab, make sure your Acme 100 favorite is selected, and then select Update.

Next, you select Reset so that no profiling is applied to your content. You then select New and create a new favorite profile for Acme 200. You repeat the steps for setting up the profile, only this time, you set the variables and profiling to use Acme 200.

The topic now has two favorite profiles in place.

Profile settings dialog. The Favorites tab is displayed and shows there are two favorite profiles, Acme 100 and Acme 200. Acme 200 is in bold.

You create a new review assignment for the topic and in the assignment settings, there is a profiling option. There, you can choose to apply any of the favorite profiles that are associated with your content. You choose Acme 100 and send the review assignment.

Review assignment dialog. The settings show the topic is being sent for review and the profiling is set to Acme 100.

When the reviewer receives the assignment, they see it with the Acme 100 profiling applied to it, so the variables show "Acme 100" and the note is excluded from the content (as it has a filter to only appear for the Acme 200 product).

Topic shown in a review with the Acme 100 profile applied. The variables appear as Acme 100 and the note is filtered out.