Import Using the koLibRI JAR File (recommended)¶
Java Version¶
On some installations of the koLibRI (expecially on Windows Operating Systems) it seems to be a good idea to use Java8 JDK instead of Java7, so it is recommended to use Java8 right from the start!
Downloading the software¶
Please download at first the configuration and folder ZIP file, where all the needed config files and templates are stored in:
This ZIP file please do extract to your preferred working folder. Furthermore you will need the koLibRI Command Line Module prepared for the usage of the TextGrid import. Please put this JAR into your working folder and rename it to kolibri-cli-6.1.2-SNAPSHOT.jar (just for simplifying things, and for having the right name used in the kolibri-go scripts ... ):
You now should have a folder structure like the following:
kolibri-addon-textgrid-import
⌊ config
⌊ tglab_config.xml
⌊ tgrep_config.xml
⌊ policies.xml
⌊ …some more koLibRI config files…
⌊ folders
⌊ dest
⌊ hotfolder
⌊ data
⌊ hotfolder-dfg-viewer
⌊ hotfolder-test
⌊ log
⌊ metadata-responses
⌊ temp
⌊ work
⌊ kolibri-cli-6.1.2-SNAPSHOT.jar
⌊ kolibri-go.bat
⌊ kolibri-go.sh
⌊ version.txt
Please check if you have the correct ZIP downloaded, the file version.txt should contain the current SNAPSHOT version of the koLibRI import tool: kolibri-addon-textgrid-import-6.1.2-SNAPSHOT
Configuring the koLibRI¶
See “Configuration” below.
Starting the koLibRI workflow tool¶
If everything is configured correctly, and are all data copied, koLibRI can be started. You do need a Java Virtual Machine using Java 7 or higher. Change into your work directory kolibri-textgrid-import containing the JAR file, the config and folder directories and the kolibri-go scripts and type
./kolibri-go.sh config/tglab_config.xml
in a Linux console and MAX OS terminal or
kolibri-go.bat config\tglab_config.xml
in a Windows/DOS command shell.
You can check the status of your imports either in the TextGridLab’s project you imported in or in the TextGridRep Sandbox, depending on your configuration. For using the correct charsets (depending on your local charset configuration some special chars, such as ö, ä, ü, may not be correctly processed), the -D trigger in the kolibri-go scripts already are set to UTF-8. Furthermore you are allowed to use more then the default 50.000 XML child objects, so we set this to 500.000, as needed for handling projects with many objects.
Import Using GIT / Maven with Eclipse¶
(deprecated, but may still work)
Prerequisites¶
Please have Apache Maven and an Apache GIT client ready to use.
Checking out the koLibRI¶
git clone git@git.projects.gwdg.de:kolibri.git
Building an Eclipse project¶
mvn eclipse:eclipse
Import the folder (the one with the pom.xml file) to Eclipse using file > import > existing project into workspace.
Configuring the koLibRI¶
See “Configuration” below.
Running the koLibRI¶
Add an Eclipse runtime configuration:
- Create a new Java application in the Eclipse Runtime Menu.
- Use de.langzeitarchivierung.kolibri.WorkflowTool as main class.
- Add -c [path to chosen config file].
- Maybe you will have to increase memory capacities of the VM, if so, please use something like -Xmx1024m.
Do Run the Application.
You can check your imports either in the TextGridLab’s project you imported in or in the TextGridRep Sandbox, depending on your configuration.
Import Using GIT / Maven and Command Line¶
(deprecated, but may still work)
Prerequisites¶
Please have Apache Maven and an Apache GIT client ready to use.
Checking out the koLibRI¶
git clone git@git.projects.gwdg.de:kolibri.git
Building the module
mvn package
Configuring the koLibRI¶
See “Configuration” below.
Running the koLibRI¶
Run with your chosen configuration file:
mvn exec:java -Dexec.args="-c path/to/config_file.xml"
You can check your imports either in the TextGridLab’s project you imported in or in the TextGridRep Sandbox, depending on your configuration.