Advanced Question: Text Highlighter

This article will help you setup a Text Highlighter question. 

Adding a Text Highlighter Question

1. If you have not created a question before, please see the following article before you begin 
   1. How to add a Question
2. The 'New Question' box will then appear
   1. Edit the question number if necessary. 
   2. Select 'Advanced' from the Question menu
   3. Select 'Text Highlighter' 
   4. Click 'Create'

General

Now that your question has been created, its time to customize it. 

1. Add your question text as needed
   • See article: Add or Update Question Text

Highlight States

You can add/modify the 'Highlight States' to include as many states/highlight colors you need. You can modify any of the following based on the requirements for your survey: 

1. Highlight Color - The color you text will be highlighted to indicate a response
2. Highlight Value - The Value in the data for the corresponding clicks
3. Highlight Label - The text label that will also appear in the data

Presets:

You can also use some of the more common built in presets by clicking on the 'Select a Preset' drop-down to select one of them and add it by clicking on the '+ Highlight State' button:

1. Green/Positive: rgba(96, 168, 69, 0.5)
2. Red/Negative: rgba(217, 30, 24, 0.5)
3. Blue/Confusing: rgba(34, 167, 240, 0.5) 
   

Deleting a Highlight State:

If you decide you do not need one of the 'Highlight States' on the list, you can delete it. 

1. Find the line item in the list for the 'Highlight State' you wish to remove.
2. Click on the (X) icon to the right of the item you want to remove
   

Highlights

The 'Highlights' section is where you will input your text to be highlighted and where your variables are created for each word or phrase. 

Content:

1. In the 'Highlights' Content section, type in or paste in your text to be highlighted.
2. If you need any html or line breaks, add those here as well. 

   
   

Highlight:

Once you have entered your full content with all the line breaks needed, you will now need to create the words or phrases you want to be clickable. 

1. Click on the 'Highlights' button to switch the view. 

   

2. You can have every word or specific phrases be clickable. 
   1. If you want to split it on every word, click on the 'Split Words' and they will all highlight. 
      
   2. If you want to select specific phrases, highlight by holding down the left button on your mouse and release it once the first phrase is done.
   • You will see the breaks will have spaces between the highlights
   • Make sure to update the report labels as you go so you know which phrases each code refers to. 
     

Updating Highlights

Should you need to update any of the highlights or add additional html for formatting, the best practice is to start over. To do this:

1. Delete everything in the 'Content' section. 
2. Click on the 'Highlight' tab. Make sure all of your variable labels have disappeared. If they have not, wait a few moments OR go back to the top of this list and follow the directions
3. Go back to the 'Content' tab and and paste in your text and then make all your adjustments. 
4. Click on the 'Highlight' tab and start highlighting your words/phrases as needed.  

Don't Know Responses

By default, the respondent will be forced to highlight at least one item to be able to continue. You have the ability to give them an opt out in the 'Don't Know Responses' section. 

1. Click on the 'Add Response' link 
2. Then type in the text you wish to appear
3. You can have as many as you need. Continue to click on the 'Add Response' link until you are done. 

Overall Settings

There are some overall settings you can also use. 

1. Click on the gear icon to see the overall question settings
2. You can hide the Key. 
3. You can also not require a response at all. 

Testing

1. Use Preview & Test to see this question with all functionalities
2. If you have several highlights, you'd need to click multiple times on the same word(s) to get from one to another; one extra click will take you back to no highlight over the text

   3. Check the Response Log to see how answers are being registered