Create & Manage Wordlists

This article provides both visual and written instructions for creating and assigning highlighted terms for a project.

Wordlists - Highlights

Wordlists are lists of words or phrases in quotation marks set out separated by hard returns with highlight colors specified to readily show the presence of these terms within any document in the dataset viewed by a Team member assigned to the wordlist. The purpose of a wordlist is to draw the reviewers’ attention to the appearance of a word or phrase and allow them to quickly navigate a document in the viewer to each occurrence of the word or phrase in its original context.

1. Login to Reveal as an Administrator.
2. Click Project Admin in the navigation bar  at left.
3. Project Admin will open in a new window.
4. Select Wordlists. The screen will open to the Highlights tab.
5. You will see a table of all existing Wordlists; here you may --
   1. +Add a new wordlist.
   2. Edit an existing wordlist.
   3. Delete an existing wordlist.
   4. Assign Teams to an existing wordlist.
6. To add a new wordlist.
   1. Click +Add.
   2. Enter a name for the wordlist (required).
   3. In the Words box, enter the Words (or phrases in quotation marks) to be highlighted for this wordlist. Wildcards may be used with single words for highlighting, but not within phrases. Caution Please Read: There are two symbols that are treated as text: the period  "." and underscore "_"  symbols. These symbols will NOT be considered spaces.  Instead, they will be treated as a character. Please see examples below: 
      • Example 1: "first.last" will be tokenized as a single term "first.last" 
      • Example 2: "first_last" will be tokenized as a single term "first_last"
      • Example 3: "first-last" will be tokenized as two separate terms "first" and "last"
   4. Note that Wordlist Terms are separated by being placed on a new line. Multi-word phrases must be placed in quotation marks for highlighting. 
   5. Select the Highlight color to be used for terms in this wordlist. If using a pale color, don't forget to uncheck Use white text.
   6. Click ADD.
   7. In the Highlights table, select the new wordlist.
   8. Click Assign Teams to select the Team or Teams that will see the highlights for this wordlist during review. 
      
7. To Edit a wordlist:
   1. Select a wordlist from the table. 
   2. Click Edit.
   3. Any aspect of the wordlist may be changed or updated here. 
      
   4.  Click EDIT when done. 
8. Once assigned, Team members may turn off the display of available wordlist highlights in the Document Review screen where an excessive number of highlighted terms in the Viewer may distract from search terms.

Wordlist Highlights Do's and Don’ts

• Each term or phrase should be added to new line.
• Proximity searches are not supported (example: w/2).
• Phrases MUST be in quotes (example: "Phrase in quotes").
• Single terms do not require quotes but they are also supported.
• Ending wildcards are supported for SINGLE terms (example: Conf*); quotes are not supported here.
• Wildcards in the middle of terms are supported (example: T*N = Ten, Then, Thorn…).
• Leading wildcards are not supported (example: *thing).
• Wildcards are not supported for phrases (example: "Priv* Conf*").
• Double spacing is not supported (example: "Work<space><space>Product").
• Leading special characters are not supported - special characters treated as spaces (example: "@enron.com").
• Common words are allowed if in quotes (example: "this and that").
• AND and OR operators are not supported (example: blue AND red).
• Periods and underscores are considered and not treated as empty space (example: first.last).

Last Updated 6/10/2024