@ldf/feature-summary NPM

Linked Data Fragments Server - Summary

This module adds summaries to datasources based on turtle files corresponding to the datasource name.

This package is a Linked Data Fragments Server module.

Usage in `@ldf/server`

This package exposes the following config entries:

SummaryController: Responds to requests for summaries. This is enabled by default in @ldf/server. Should be used as @type value.
SummaryQpfHtmlView: Extends the Quad Pattern Fragments HTML view with a summary link. This is enabled by default in @ldf/server. Should be used as @type value.
SummaryQpfRdfView: Extends the Quad Pattern Fragments RDF view with a summary link. This is enabled by default in @ldf/server. Should be used as @type value.
SummaryRdfView: Represents a data summary in RDF. This is enabled by default in @ldf/server. Should be used as @type value.
summaryDir: Path to a directory where summaries can be found. Should be used as key in a Server config or SummaryController.
summaryPath: URL path for summaries. Should be used as key in a Server config or SummaryController.

@ldf/server and @ldf/preset-qpf provide default instantiations of SummaryController, SummaryQpfHtmlView, SummaryQpfRdfView and SummaryRdfView, which means that you don't have to define them in your config file yourself. The only thing you still need to do is defining the summary directory and the URL on which they should be exposed, as shown in the example below.

Example:

{
  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@ldf/server/^3.0.0/components/context.jsonld",
  "@id": "urn:ldf-server:my",
  "import": "preset-qpf:config-defaults.json",

  "summaryDir": "../../summaries",
  "summaryPath": "/summaries/"
}

Usage in other packages

When this module is used in a package other than @ldf/server, then the JSON-LD context https://linkedsoftwaredependencies.org/contexts/@ldf/feature-summary.jsonld must be imported.

For example:

{
  "@context": [
    "https://linkedsoftwaredependencies.org/bundles/npm/@ldf/core/^3.0.0/components/context.jsonld",
    "https://linkedsoftwaredependencies.org/bundles/npm/@ldf/preset-qpf/^3.0.0/components/context.jsonld",
    "https://linkedsoftwaredependencies.org/bundles/npm/@ldf/feature-qpf/^3.0.0/components/context.jsonld",
    "https://linkedsoftwaredependencies.org/bundles/npm/@ldf/feature-summary/^3.0.0/components/context.jsonld",
  ],
  "@id": "urn:ldf-server:my",

  "controllers": [
    {
      "@id": "urn:ldf-server:mySummaryController",
      "@type": "SummaryController"
    }
  ],

  "views": [
    {
      "@id": "urn:ldf-server:myQpfHtmlView", // This should refer to your existing QpfHtmlView
      "viewExtension": {
        "@id": "urn:ldf-server:mySummaryQpfHtmlView",
        "@type": "SummaryQpfHtmlView"
      }
    },
    {
      "@id": "urn:ldf-server:myQpfRdfView", // This should refer to your existing QpfRdfView
      "viewExtension": {
        "@id": "urn:ldf-server:mySummaryQpfRdfView",
        "@type": "SummaryQpfRdfView"
      }
    },
    {
      "@id": "urn:ldf-server:mySummaryRdfView",
      "@type": "SummaryRdfView"
    }
  ]

  // Same as above...
}