| commit | cdae2e0237e36bda9d0a340fcd55794a800ca4a8 | [log] [tgz] |
|---|---|---|
| author | Akron <nils@diewald-online.de> | Mon Mar 22 17:05:52 2021 +0100 |
| committer | Akron <nils@diewald-online.de> | Mon Mar 22 17:05:52 2021 +0100 |
| tree | 6c89c026c4b1501a134fec7ead9a1013a9031727 | |
| parent | 83f3994486fd90076e3f13127b9279087a639be8 [diff] |
Set default value for error message This seems to be hard to reproduce as an error, but happened following the logs. Change-Id: I0b33996ff77efd8b3cb859270e1c9d677c73b0ef
Kalamar-Plugin-Export
Description
Kalamar-Plugin-Export is a web service that integrates in the plugin framework of Kalamar, to export matches for the KorAP Corpus Analysis Platform in various formats. Currently supported are RTF, CSV, and JSON.
Kalamar-Plugin-Export is meant to be a basic export plugin and should demonstrate and evaluate the plugin capabilities of Kalamar.
Prerequisites
Java 8 (OpenJDK or Oracle JDK), Git, Maven 3. Further dependencies are resolved using Maven.
Build
To build the latest version of Kalamar-Plugin-Export, do ...
$ git clone https://github.com/KorAP/Kalamar-Plugin-Export $ cd Kalamar-Plugin-Export
... and build the jar file ...
$ mvn clean package
Afterwards the jar file is located in the target/ folder and can be started with ...
$ java -jar KalamarExportPlugin-[VERSION].jar
Per default, this will start a server at http://localhost:7777. It will also create a subfolder files to temporarily store created exports.
Registration of the plugin in Kalamar is not yet officially supported. Registration works by passing the following JSON blob to the plugin registration handler.
{ "name" : "Export", "desc" : "Exports Kalamar results", "embed" : [{ "panel" : "result", "title" : "exports KWICs and snippets", "icon" : "\uf019", "classes" : ["button-icon", "plugin" ], "onClick" : { "action" : "addWidget", "template" : "http://localhost:7777/export" } }] }
An example demo showcases the embedded plugin.
Customization
The default configuration file is stored in src/main/resources/exportPlugin.conf. This file can be overwritten, when a file of that name is stored in the same directory as the jar file.
License
Copyright (c) 2020, IDS Mannheim, Germany
Kalamar-Plugin-Export is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for the German Language (IDS).
Kalamar-Plugin-Export is published under the BSD-2 License.