1. User's Guide
  2. Smart View and Narrative Reporting
  3. Authoring Doclets
  4. Working with Variables
  5. Highlighting Variables in Doclets

Highlighting Variables in Doclets

You can quickly view the instances of a variable in a doclet using the Highlight command for the selected variable.

To highlight a variable in a doclet:

  1. Open a report package, and then open a doclet.

    You do not need to check out a doclet in order to highlight variables.

  2. In the drop-down list in the Report Package panel, select Variables.

    Shows the options available in drop-down list in the Report Package. Options are Report Center and Variables.

    The list of variables available in the report package is displayed in the panel.

  3. To highlight all variables in a doclet:
    1. Click the Options button, Options button to view the drop-down menu:

      Options menu
    2. Select Highlight All from the drop-down list.

      Figure 22-39, shows a portion of doclet with several variables highlighted. Additionally, the NetRevenue_Above/Below variable is selected and the variable name is displayed above it.

      Figure 22-39 Doclet After Selecting Highlight All


      Shows a portion of a doclet with several variables within the text highlighted in yellow
    3. To unhighlight all variables, click the Options button, Options button, and, from the drop-down menu, select Unhighlight All.

      Note:

      To remove the highlighting from an individual variable when all variables are highlighted, you may select a variable from the list in the Variables panel and, from the More Actions menu for the individual variable, select Unhighlight.

  4. To highlight all instances of an individual variable in a doclet:
    1. Select a variable from the list in the Variables panel.
    2. Click the More Actions button for the variable, The More Actions button for a selected variable, resembles the head of an arrow pointing downward and, from the drop-down menu, select Highlight.

      In Figure 22-40, the CurrentMonth variable, a static variable, is selected in the Variables panel. After selecting Highlight from the drop-down menu, the NetIncome_Value variable is highlighted in the doclet at the left.

      Figure 22-40 Doclet with Highlighting Enabled for a Selected Variable


      On the right, in the Variables panel, a selected variable is shown, along with the menu options available for that variable from the Options button after selecting the Highlight action. On the left, the location of the selected variable inserted in the doclet is shown with yellow highlight.
    3. To unhighlight the selected variable, click the More Actions button, The Options button for a selected variable, resembles the head of an arrow pointing downward and, from the drop-down menu, select Unhighlight.

Note:

  • Variables within content controls or text boxes will not be highlighted whether using Highlight All or the Highlight action on the individual variable.

  • Highlighting is not supported on variables placed within headers and footers in Word doclets.

  • All highlighting is cleared upon performing an Upload or Upload and Check In.

  • Highlight All and Unhighlight All requires Narrative Reporting extension 24.10 or later.