Gitiles
Code Review Sign In
korap.ids-mannheim.de / KorAP / Kalamar-Plugin-ExternalResources / de33179dee5a859d7740905f4205f4e796e64a23
commitde33179dee5a859d7740905f4205f4e796e64a23[log] [tgz]
authorAkron <nils@diewald-online.de>Tue Jan 10 11:36:15 2023 +0100
committerAkron <nils@diewald-online.de>Tue Jan 10 11:36:15 2023 +0100
treeb6a59b5e50c1b34e12010173a2908a72326de456
parenta128b42e1974905e8d06c52d3d84e784ac11d878 [diff]
Rename plugin to ExternalResources

Change-Id: Ieb7bee4929e4351316ad19d9bcd3752d466437da
5 files changed
tree: b6a59b5e50c1b34e12010173a2908a72326de456
  1. templates/
  2. .gitignore
  3. go.mod
  4. go.sum
  5. LICENSE
  6. README.md
  7. service.go
  8. service_test.go
README.md

Kalamar-Plugin-Resources

Description

Kalamar-Plugin-ExternalResources 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-ExternalResources is meant to be a basic plugin and should demonstrate and evaluate the plugin capabilities of Kalamar.

Prerequisites

Go 1.19 or later

Build

To build the latest version of Kalamar-Plugin-ExternalResources, do ...

$ git clone https://github.com/KorAP/Kalamar-Plugin-ExternalResources
$ cd Kalamar-Plugin-ExternalResources
$ go test .
$ go build .

Running

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.

Indexation

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-Resources data.csv

Customization

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_RESOURCES_PORT: The port the service should be listen to.
  • KORAP_EXTERNAL_RESOURCES: The exposed URL the service is hosted.

License

Copyright (c) 2023, IDS Mannheim, Germany
Author: Nils Diewald

Kalamar-Plugin-ExternalResources is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for the German Language (IDS).

Kalamar-Plugin-Resources is published under the BSD-2 License.