Kalamar-Plugin-ExternalProvider is a web service that integrates in the plugin framework of Kalamar, to allow linking texts by their text sigle to external data providers, mainly for full text access.
Kalamar-Plugin-ExternalProvider is meant to be a basic plugin and should demonstrate and evaluate the plugin capabilities of Kalamar.
Go 1.19 or later
To build the latest version of Kalamar-Plugin-ExternalProvider, do ...
$ git clone https://github.com/KorAP/Kalamar-Plugin-ExternalProvider $ cd Kalamar-Plugin-ExternalProvider $ go test . $ go build .
The binary can be started without prerequisites. The templates folder has to be kept in the root directory.
Registration of the plugin in Kalamar is not yet officially supported. Registration works by passing the JSON blob generated at /plugin.json to the plugin registration handler.
To index further data, the mappings need to be stored in a csv-file, like
"WPD11/A00/00001","Wikipedia","http://de.wikipedia.org/wiki/Alan_Smithee" "WPD11/A00/00003","Wikipedia","http://de.wikipedia.org/wiki/Actinium" "WPD11/A00/00005","Wikipedia","http://de.wikipedia.org/wiki/Ang_Lee"
Then run the indexation with:
$ ./Kalamar-Plugin-ExternalProvider data.csv
The following environment variables can be set either as environment variables or via .env file.
KORAP_SERVER: The server URL of the hosting service.KORAP_EXTERNAL_PROVIDER_PORT: The port the service should be listen to.KORAP_EXTERNAL_PROVIDER: The exposed URL the service is hosted.Copyright (c) 2023, IDS Mannheim, Germany
Author: Nils Diewald
Kalamar-Plugin-ExternalProvider is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for the German Language (IDS).
Kalamar-Plugin-ExternalProvider is published under the BSD-2 License.