commit	63cd58b830ad2b1585d90806d7f21a9e5959a464	[log] [tgz]
author	Akron <nils@diewald-online.de>	Wed Sep 04 09:46:41 2024 +0200
committer	Akron <nils@diewald-online.de>	Fri Nov 15 14:57:27 2024 +0100
tree	a7fd8d19b89caeba6cb8f65ce955cc534e62c9f8
parent	719a0c2827354a83bc3c1a880be50203fce21036 [diff]

tree: a7fd8d19b89caeba6cb8f65ce955cc534e62c9f8

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 17 (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 [-h|--help]

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",
      "permissions":["forms","scripts","downloads"]
    }
  }]
}

This template will also be displayed when starting the jar with the argument [-h|--help]. Alternatively it is returned by:

http://localhost:7777/export/template

At the moment the simplest way to register the plugin is by storing the json blob in a file (the blob needs to be in a list, i.e. surrounded by [...]). The file then can be loaded using the Plugins addon in Kalamar using the Kalamar configuration file.

{
  Kalamar => {
    plugins => ['Plugins'],
  },
  'Kalamar-Plugins' => {
    default_plugins => 'plugins.json'
  }
}

For example, with this configuration addition, the content of plugins.json will be registered on every Kalamar page load.

An example demo showcases the embedded plugin.

At the moment the integration reuses the session of the host service. To make this possible, the Content Security Policy of Kalamar needs to be extended to include the whole domain that hosts both services (at the moment it's not possible to host the service on a different domain). If the domain is, e.g., ids-mannheim.de, the configuration in the Kalamar configuration file needs to be:

{
  CSP => {
    'frame-src' => 'self',
    'frame-ancestors' => ['self','https://*.ids-mannheim.de/']
  }
}

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

Alternatively a file named exportPlugin.conf can be stored in the same directory as the java jar.

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.