Config Files

The default location of customization files is /etc/projectconfigs/
The location can be changed using the corporaInterfaceDataDir setting in the Global Settings File.

/etc/projectConfigs/

└─ 

corpus-1/

   ├─ 

search.xml

   ├─ 

help.inc

   ├─ 

about.inc

   ├─ 

article.xsl

   ├─ 

meta.xsl

   ├─ 

static/

   |  ├─ 

locales/

   |  |  ├─ 

en-us.json

   |  |  └─ 

...

   |  └─ 

...

   ├─ 

corpus-2/

   ├─ 

corpus-3/

   ├─ 

...

   ├─ 

default/

   |  ├─ 

search.xml

   |  └─ 

...

   └─ 

...

<--- The location set in the corporaInterfaceDataDir setting

<--- Exact name/ID of the corpus as in BlackLab

 

 

 

 

 

 

<--- Language files for the interface, specific to this corpus

 

 

<--- Anything else you want to make available client-side

 

 

 

<--- Fallbacks / Defaults go here

 

 

 

Overlay System

Important to know

Files and static files 'overlay' each other, meaning we will always check all of the following locations, in order of precedence:

1. The directory of the corpus itself
2. The default dir (corporaInterfaceDefault)
3. Inside the WAR

Example of overlaying

When requesting /blacklab-frontend/my-corpus/static/some_script.js the server will return the first file it finds in the following locations:

1. my-corpus/static/some_script.js
2. default/static/some_script.js
3. src/main/resources/interface-default/static/some_script.js (inside the WAR)

ℹ️ This is also true for locales, help.inc, about.inc and search.xml files!