@netwerk-digitaal-erfgoed/network-of-terms-catalog
v9.19.0
Published
Catalog of Network of Terms datasets
Downloads
567
Readme
Network of Terms Catalog
This is the catalog of terminology sources that can be queried through the Network of Terms.
Data model
Each terminology source is modelled as a Schema.org Dataset. The catalog directory contains all datasets.
Most of the dataset’s properties match the NDE Requirements for Datasets, with the following additions specific to the Network of Terms:
schema:url
is used for the HTTP URI prefix of terms in the dataset, e.g.http://vocab.getty.edu/aat/
for Getty resources. This prefix is needed when clients look up terms by their URI in the Network of Terms: the Network then has to know which source to consult to retrieve the term;schema:inLanguage
is a required property;schema:genre
is a required property, with values restricted to the list of Termennetwerk onderwerpen;schema:mainEntityOfPage
is a required property;- each distribution has two or more
schema:potentialAction
s:- a
schema:SearchAction
and aschema:FindAction
, both with aschema:query
property that points to the queries directory; - optionally, a number of
schema:Action
s that configure the features that the Network of Terms provides for the distribution, such as Reconciliation.
- a
The queries directory contains SPARQL queries for retrieving terms from the datasets. There are two types of queries:
- search queries find terms matching a textual string query input;
- lookup queries retrieve a single term based on its URI.
Contributing
Adding a dataset
- Create a
your-dataset.jsonld
file in thecatalog/datasets
directory and add a description. - Create a
your-dataset.rq
file in thequeries/search
directory and add your SPARQL search query. A SPARQL lookup query goes into thequeries/lookup
directory.- If your SPARQL server supports fulltext search relevance scores, you can return them as
vrank:simpleRank
values to have search results ordered by rank instead of the default, alphabetical order.
- If your SPARQL server supports fulltext search relevance scores, you can return them as
- Run the tests to make sure your dataset description conforms to the dataset SHACL.
- To try your queries locally, you can run the GraphQL API with your catalog.