commit	a241a4766bd4be5d2b8b4058f31c23527dc84ea3	[log] [tgz]
author	Akron <nils@diewald-online.de>	Tue Apr 27 18:55:58 2021 +0200
committer	Akron <nils@diewald-online.de>	Thu May 06 09:46:24 2021 +0200
tree	8362558ffbf2ec5b222eeb2458c5bdb1fa6a1980
parent	1cbe798821a516a00fa25e0618cda3b6f3cfd87f [diff]

tree: 8362558ffbf2ec5b222eeb2458c5bdb1fa6a1980

README.md

Kalamar-Plugin-Export

Kalamar-Plugin-Export Screenshot

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

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.