Skip to content

Defining Local Resources for Stoplists

Stéfan Sinclair edited this page Jun 29, 2018 · 2 revisions

N.B. This functionality is experimental and may change. This is available since VoyantServer 2.4 M8.

Some content providers run an instance of Voyant that's tailored to a given collection, with pre-existing corpora or local sources. In some cases content providers might want to provide custom-built stopword lists that override the built-in lists distributed with Voyant. VoyantServer allows you to provide a local source for resources like keywords, following a specific pattern.

VoyantServer has a data directory (by default it's a first-level subdirectory within the zip archive that you downloaded; the location can also be overridden in the server-settings.txt file). Within that you can create a directory called trombone-resources (if it's not there already) and within that you should also create a folder called keywords. When Voyant's backend tried to load a stopList file it will check in this folder before checking the distribution folder. So, for instance, a stopList value of auto for a text in English uses stop.en.taporware.txt. So the contents at this location would take precedence:

trombone-resources/keywords/stop.en.taporware.txt

As always, the file is assumed to be plain Unicode text with Unix newline characters.

Various mappings for languages can be found in the StopListOption code.