Standard UI Elements

Voyant is a web-based tool. To use it go to http://voyant-tools.org. This is what you will see,

To use Voyeur you need to specify a text. You can do this different ways:

  • Type the text into the field and then press reveal. You can also cut and paste from somewhere else.
  • Type a URL (Uniform Resource Locator or web address) into the field and press reveal. Voyeur recognizes a URL and retrieves the web page as text. If you type many URLs Voyeur will retrieve them all and treat them as a corpus of many documents
  • Upload a text from your hard drive and press reveal.

Voyeur, once it retrieves your text, will index it for analysis and display this simple arrangement of two panels,

Once your text or collection is indexed Voyeur will present you will a display with two panels. The right hand panel summarizes the text. The left panel shows you the high frequency words. You can show an hide different panels using the double arrow button. You can also see more panels by selected a word or words to follow. Try the Words in the Entire Corpus panel.

There are a number of features to the Words in the Entire Corpus panel:

  • Selection: You can select one or more words by clicking on the selection box. To select all in view click the selection box at the top. You can also use that to de-select all.
  • Searching: You can search for a word in the list by typing it into the Search box. If you want a number of words type them with commas as in:
salt, pepper, sardines, oil
  • Phrases: You can search for phrases by using quotes as in:
"digital humanities"
  • Favorites: Any selected word can be added to a favorites list by clicking the heart with the plus (+). You can add as many words as you want. You can toggle between the full list and the favorites list by clicking the plain heart icon.
  • Sorting Columns: Click on the column title to sort the list by that column. Click the arrow to choose direction for sorting and to add other columns.
  • Options: For this list of all the words in the collection it is useful to use a stop word list that hides the common words like “the”, “a”, “an”. Click on the Option button in the top right. The Option button looks like a gear.
  • Save: You can export and save the results of by clicking the button in the top right with an icon for a floppy disk. There are different formats you can save or export the results.

Once you select one or more words you will get an arrangement of panels like this,

The panels are connected so that clicking in one will trigger updates in the others. Typically the order is the following:

  • You select a word or words in the Words in the Entire Corpus panel (1).
  • If you are looking at a collection of documents, in the Words within each Document panel (3) you will see how the selected words are distributed across documents.
  • In the Word Trends panel (6) you can see a distribution graph if your documents are distributed chronologically.
    • If you select a particular document the Word Trends will show distribution just in the document.
    • If you click on a document node in the Word Trends display it will show the Keywords in Context for that document.
  • Likewise, if you select a particular document in the Words within each Documents panel, you can see a Keywords in Context display (4) for the selected words and the document. Clicking the plus (+) button next to each context will show you more context.
    • You can save contexts as favorites to compare or export.