Plugin Installation

This guide explains how to install the available plugins to a Recogito Studio instance.

Available Plugins

• GeoTagger – Tag annotations with geographical references from a gazetteer.
• Reconciliation Service API – Use a Reconciliation Service API endpoint as a tag source in your projects.
• NER Plugin – Automatically perform Named Entity Recognition on plain text and TEI documents.
• Revisions Plugin – Basic annotation revision functionality.
• TEI Inliner Plugin – Export TEI annotations as inline markup.
• Sandcastle3D Export – Custom annotation export for the Sandcastle project.

Local Development Environment

In the root of the recogito-client repo (see Client Application Setup), install whichever plugins you intend to use:

npm install @recogito/plugin-geotagging  # GeoTagger
npm install @recogito/plugin-reconciliation-service. # Reconciliation Service API
npm install @recogito/plugin-ner  # NER
npm install @recogito/plugin-revisions  # Revisions
npm install @recogito/plugin-tei-inliner  # TEI Inliner
npm install @recogito/plugin-sandcastle-export  # Sandcastle3D Export

Then, in your astro.config.mjs file (and/or astro.config.node.mjs depending on which adapter you are using), add relevant imports and integrations for those plugins:

astro.config.mjs

import { defineConfig } from 'astro/config';
import react from '@astrojs/react';
import netlify from '@astrojs/netlify';

 import GeoTaggingPlugin from '@recogito/plugin-geotagging';
 import ReconcilationPlugin from '@recogito/plugin-reconciliation-service';
 import NERPlugin from '@recogito/plugin-ner';
 import RevisionsPlugin from '@recogito/plugin-revisions';
 import TEIInlinePlugin from '@recogito/plugin-tei-inliner';
 import Sandcastle3D from '@recogito/plugin-sandcastle-export';

export default defineConfig({
  integrations: [
    react(),
    GeoTaggingPlugin(),
    ReconcilationPlugin(),
    NERPlugin(),
    RevisionsPlugin(),
    TEIInlinePlugin(),
    Sandcastle3D(),
  ],
  output: 'server',
  adapter: netlify(),
  vite: {
    ssr: {
      noExternal: ['clsx', '@phosphor-icons/*', '@radix-ui/*']
    },
    optimizeDeps: {
      esbuildOptions: {
        target: 'esnext'
      }
    }
  }
});

Self-Hosted Production Environment

TODO: Documentation needed

Enabling an Installed Plugin

TODO: Documentation needed