Click here to learn how to customize the text highlighter element in the XML.
1: About Text Highlighter Question
The text highlighter element utilizes a select type question with at least one marker and multiple highlightable text items. It offers an interactive experience, allowing the respondent to rate the likability of the concept/text by highlighting the words or sentences.
- The concept is automatically sized based on the browser size.
- For mobile devices, white space is included on the right side of the concept to allow respondents to scroll up or down.
Learn more: Text Highlighter Concepts
2: Adding a Text Highlighter Element
Note: You can set the "Show" filter to display only elements that are compatible or optimized for the devices allowed for your project. Click here to learn how to verify your project settings.
To insert a text highlighter element, add a new survey element, select the "Dynamic" tab and choose "Text Highlighter." Then click "Insert."
Enter the question text into the area provided. Question instructions can be entered in the "Instruction" field. Add the answer options by clicking the "+New Marker" and "+New Highlightable Text."
To allow respondents to be able to mark each word of the highlightable individually, each word must be entered on its own line. To highlight phrases, or a string of words, those words must be entered on one line together. The "Text Assist Tool" will help alleviate most of the work required by replacing all "spaces" and putting words on individual lines. Click "Text Assist Tool" to open the formatting tool in a new window.
To use the tool, simply enter the text you want the respondent to be able to highlight in the top field. As you type or paste in the text, the field below will automatically generate each word on a new line. Once all of the text is entered, click the "Copy to Clipboard" button. Then return to the survey builder.
Tip: If your project will be fielded in multiple languages and contains the text highlighter element, create a hidden question with the highlightable text in its original format. This will provide the translators with the context for more accurate translations.
Once you've returned to the survey builder, paste the text into the "Highlightable Text" field. Each word will appear on a new line, allowing respondents to highlight the individual words.
Enter the text for the color-coded markers in the "Markers" field. Text Highlighter elements must have 1-3 markers specified. Additional markers can be added in the XML. The pre-defined colors are assigned as follows:
- If only 1 marker is specified, the marker color will be green.
- If 2 markers are specified, the first marker will be green and the second marker will be red.
- If 3 markers are specified, the first marker will be green, the second marker will be blue, and the third marker will be red.
- If 4 or more markers are specified, the first 3 markers are assigned as described above. The additional markers will not have any color until one is specified in the survey XML, using
Do not number the answer options unless you want numbering to appear for the respondent. The system will automatically provide labels/numbers for the answer options, which you can edit later in "Options."
All answers will appear in the question box with labels (ch1, ch2,... and r1, r2, r3, etc.). You may edit the answer options by selecting the "Marker Actions" and "Text Assist Tool Actions."
3: Style Settings
To configure the display settings for the text highlighter element, click the "Style: Text Highlighter" link.
The "Question Display Options" window will appear. You may configure the settings for the text highlighter element using the options on the left. Additional information about each feature will appear when you mouse-over the text. Click "Save and Preview" to preview the settings. Once you are satisfied with the style options settings, click "Save and Close."
- Minimum Highlights: Allows you to define a minimum number of words that the respondent must highlight.
- For example: 5 minimum highlights means a respondent must highlight 5 words in order to continue to the next question.
- Maximum Highlights: Allows you to define a maximum number of words that the respondent can highlight (must be greater than the minimum highlights or greater than zero).
- For example: 20 means a respondent may highlight up to 20 words.
You can preview the element at any time by clicking on "Preview" located at the top right corner of the element. To find out more about previewing an element, click here.
4: Options for a Text Highlighter Element
The options available are located on the right side of the screen. You can set rules for the entire question by clicking near the question text or set rules for individual markers/columns by clicking on the marker/column you wish to edit. The option section will show the question, highlightable text/row or marker/column label and type you have selected to edit.
4.1: General Options
Each of the following options, when altered, affect all attributes within the element.
- Label: The label assigned to the element. You may edit the default label for the text highlighter element here.
- Type: Displays the element type.
- Show If: Allows you to create new logic conditions or select an existing logic condition for the element. For more information, click here.
- Languages: Select what languages the element will show in if the survey has multiple languages. The default is "all languages."
- Mandatory: The minimum and maximum response requirements are set in the style settings.
- Shuffle Groups
4.2: Marker (Choice) Options
These options only affect specific highlightable text (i.e., choice) line attributes.
- Label: The label assigned to the choice. You may edit the default label for the choice here.
- Data Value: The value assigned to the choice in the data. You may edit the default value for the choice here if the option is available.
- Show If: Allows you to create new logic conditions or select an existing logic condition for the choice. For more information, click here.
- Languages: Select what languages the choice will show in if the survey has multiple languages. The default is "all languages."
- Hidden: The option will hide the choices from respondents.
- Do Not Randomize
4.3: Highlightable Text (Row) Options
These options only affect specific marker (i.e., row) line attributes.
- Label: The label assigned to the row. You may edit the default label for the row here.
- Data Value: The value assigned to the row in the data. You may edit the default value for the row here if the option is available.
- Show If: Allows you to create new logic conditions or select an existing logic condition for the row. For more information, click here.
- Languages: Select what languages the row will show in if the survey has multiple languages. The default is "all languages."
- Hidden: The option will hide the row from respondents.
- No Answer: This option will replace the select form with an exclusive checkbox form. It is primarily used if there is a "Don't Know" or "None of These" answer choice in the question.
- Do Not Randomize
5: Charting in Crosstabs
Note: The text highlighter chart cannot be exported, however it's possible save the chart to your computer by taking a screenshot.
Once you've applied your desired crosstabs, locate the text highlighter element and select the "Add/Edit Charts" icon .
Select "Custom" and "Highlighter Chart", then click "Save."
Select the chart type and segment from the dropdown menus and the report will load. The color coding is defined in the chart options (found in the "View Options" menu).
The legend for the text highlighter chart contains 6 color-coded buckets. The lowest count sets the low end of "Least Selected" and the highest count sets the highest end of "Most Selected." The 6 buckets distribute the responses inside that range.