commit	0f4a5a3c94135a1f344544c700a95a70bd8b1736	[log] [tgz]
author	Akron <nils@diewald-online.de>	Tue Sep 07 11:27:49 2021 +0200
committer	Akron <nils@diewald-online.de>	Wed Sep 08 15:41:09 2021 +0200
tree	9dde2a338c9e3f4111871d67b20674797bcf610d
parent	1e9a2c4b6c19ddf8f6ce1e379004c4c8007885bc [diff]

tree: 9dde2a338c9e3f4111871d67b20674797bcf610d

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 basic configuration file is stored in src/main/resources/exportPlugin.conf. To change the configuration create a new config file and run the jar with the according filename as argument:

$ java -jar KalamarExportPlugin-[VERSION].jar myconf_exportPlugin.conf

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.