README

======================
FOR ENGLISH, SEE BELOW
======================

De GTB is een applicatie waarmee een gebruiker historische woordenboeken van het Nederlands en het Fries kan raadplegen. 

Het GTB-frontend wordt gegenereerd met een script. Dit script bevindt zich in de bovenste map en heet "maak.sh".

De bronbestanden bevinden zich in de map met de naam "source".
De bestanden van het resultaat van het genereren bevinden zich in de map met de naam "target.dev"; deze map wordt bij het genereren verwijderd en opnieuw aangemaakt.

Te midden van de bronbestanden bevindt zich een bestand met de naam "source/xslt/gtb.sef". Dit bestand wordt met behulp van Saxon-JS (onderdeel van Oxygen XML Editor) aangemaakt op basis van de het XSLT-bestand "gtb.xslt". Maak het bestand gtb.sef aan voor het genereren van de target-bestanden.

De reden dat het genereerscript dit niet doet, is dat daarvoor een enterprise-licentie van Saxon vereist is. Deze zit ingebakken in Oxygen.

Het genoemde script maak.sh dient om het eigenlijke genereerscript op een makkelijke manier aan te roepen met de juiste parameters. Het eigenlijke genereerscript bevindt zich in de map met de naam "generate-gtb-html-files" en heet "generate-gtb-html-files.sh". Op zijn beurt verwijst dit shellscript weer naar een XSLT-stylesheet met de naam "generate-gtb-html-files.xslt".

De omgevingsvariabelen voor het genereren worden ingesteld in bestand "generate-gtb-html-files/sourceme". Dit bestand moet voor gebruik handmatig worden aangemaakt door een kopie te maken van bestand sourceme.example en de kopie aan te passen. Vereist zijn een verwijzing naar een Java-JRE en naar de Saxon-jarfile.

Als je over een enterprise-licentie van Saxon beschikt, kun je in het sourceme-bestand de omgevingsvariabele SAXON_EE_AVAILABLE op true laten staan om ook het aanmaken van de SEF-file
zonder tussenkomst van Oxygen te laten doen.

Tevens is vereist dat de map met het git-commando in de PATH-variabele zit (wat het meestal doet als git geïnstalleerd is).

Ga als volgt te werk om te genereren:

cd /PAD/NAAR/GTB-html
./maak.sh


===================
ENGLISH TRANSLATION
===================

The GTB is an application that allows users to consult historical dictionaries of the Dutch and Frisian languages.

The GTB frontend is generated by a script. This script is stored in the toplevel folder and is called "maak.sh".

De source files for the script live in the folder with the name "source". The files that are created by the script will be stored in the folder with the name "target.dev"; this folder is deleted and recreated with every build.

One of the source files is the file with the name source/xslt/gtb.sef. This file is created by Saxon-JS (which is included in the Oxygen XML Editor) on the basis of the file "gtb.xslt". Be sure to create the file gtb.sef before generating the target files.

The above-mentioned script maak.sh is an easy way the call the actual generation-script with the right  parameters. The actual generation-script lives in the folder with the name "generate-gtb-html-files" and is called "generate-gtb-html-files.sh". In its turh, this script refers to an XSLT stylesheet with the name
"generate-gtb-html-files.xslt".

The environment variables that are required for generating the files are set in the file named "generate-gtb-html-files/sourceme". This file has to be created by making a copy of the file sourceme.example and editing it to reflect local requirements. You will have to reference a Java JRE and a Saxon-jarfile.

If you own a Saxon enterprise license, you can leave the value of the environment variable SAXON_EE_AVAILABLE to the value true in order to generate the SEF file without the need of using
Oxygen.

Finally, the folder containing git command should be included in the PATH variable (which probably is the case if git has been installed).

Issue the following commands in order to generate the files:

cd /PATH/TO/GTB-html
./maak.sh