From a2e9600504f2df2dc291178698d7dd6b16fe1084 Mon Sep 17 00:00:00 2001 From: amercader Date: Thu, 15 Aug 2024 12:33:36 +0200 Subject: [PATCH] Add conf reference to README Not yet automated --- README.md | 150 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 149 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 21ced668..cd1b51e1 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ Check the [overview](#overview) section for a summary of the available features. - [Translation of fields](#translation-of-fields) - [Structured data and Google Dataset Search indexing](#structured-data-and-google-dataset-search-indexing) - [CLI](#cli) +- [Configuration reference](#configuration-reference) - [Running the Tests](#running-the-tests) - [Releases](#releases) - [Acknowledgements](#acknowledgements) @@ -95,7 +96,7 @@ These are implemented internally using: 3. Enable the required plugins in your ini file: - ckan.plugins = dcat dcat_rdf_harvester dcat_json_harvester dcat_json_interface structured_data + ckan.plugins = dcat dcat_rdf_harvester structured_data 4. To use the pre-built schemas, install [ckanext-scheming](https://github.com/ckan/ckanext-scheming): @@ -105,6 +106,11 @@ Check the [Schemas](#schemas) section for extra configuration needed. Optionally, if you want to use the RDF harvester, install ckanext-harvest as well ([https://github.com/ckan/ckanext-harvest#installation](https://github.com/ckan/ckanext-harvest#installation)). +For further configuration options available, see [Configuration reference](#configuration-reference). + + + + ## Schemas The extension includes ready to use [ckanext-scheming](https://github.com/ckan/ckanext-scheming) schemas that enable DCAT support. These include a schema definition file (located in `ckanext/dcat/schemas`) plus extra validators and other custom logic that integrates the metadata modifications with the RDF DCAT [Parsers](#rdf-dcat-parser) and [Serializers](#rdf-dcat-serializer) and other CKAN features and extensions. @@ -1142,6 +1148,148 @@ The latter form allows chaininig commands for more complex metadata processing, For the full list of options check `ckan dcat consume --help` and `ckan dcat produce --help`. +## Configuration reference + + + +### General settings + +#### ckanext.dcat.rdf.profiles + +Example: + +``` +ckanext.dcat.rdf.profiles = euro_dcat_ap_2 my_local_ap +``` + +Default value: `euro_dcat_ap_2` + +RDF profiles to use when parsing and serializing. See https://github.com/ckan/ckanext-dcat#profiles +for more details. + + +#### ckanext.dcat.translate_keys + +Default value: `True` + +If set to True, the plugin will automatically translate the keys of the DCAT +fields used in the frontend (at least those present in the `ckanext/dcat/i18n` +po files). + + +### Parsers / Serializers settings + +#### ckanext.dcat.output_spatial_format + +Default value: `wkt` + +Format to use for geometries when serializing RDF documents. The default is +recommended as is the format expected by GeoDCAT, alternatively you can +use `geojson` (or both, which will make SHACL validation fail) + + +#### ckanext.dcat.resource.inherit.license + +Default value: `False` + +If there is no license defined for a resource / distribution, inherit it from +the dataset. + + +#### ckanext.dcat.normalize_ckan_format + +Default value: `True` + +When true, the resource label will be tried to match against the standard +list of CKAN formats (https://github.com/ckan/ckan/blob/master/ckan/config/resource_formats.json) +This allows for instance to populate the CKAN resource format field +with a value that view plugins, etc will understand (`csv`, `xml`, etc.) + + +#### ckanext.dcat.clean_tags + +Default value: `False` + +Remove special characters from keywords (use the old munge_tag() CKAN function). +This is generally not needed. + + +### Endpoints settings + +#### ckanext.dcat.enable_rdf_endpoints + +Default value: `True` + +Whether to expose the catalog and dataset endpoints with the RDF DCAT +serializations. + + +#### ckanext.dcat.catalog_endpoint + +Example: + +``` +ckanext.dcat.catalog_endpoint = /dcat/catalog/{_format} +``` + +Default value: `/catalog.{_format}` + +Custom route for the catalog endpoint. It should start with `/` and include the +`{_format}` placeholder. + + +#### ckanext.dcat.dataset_per_page + +Default value: `100` + +Default number of datasets returned by the catalog endpoint. + + +#### ckanext.dcat.enable_content_negotiation + +Default value: `False` + +Enable content negotiation in the main catalog and dataset endpoints. Note that +setting this to True overrides the core `home.index` and `dataset.read` endpoints. + + +### Harvester settings + +#### ckanext.dcat.max_file_size + +Default value: `50` + +Maximum file size that will be downloaded for parsing by the harvesters + + +#### ckanext.dcat.expose_subcatalogs + +Default value: `False` + +Store information about the origin catalog when harvesting datasets. +See https://github.com/ckan/ckanext-dcat#transitive-harvesting for more details. + + +### Deprecated options (will be removed in future versions) + +#### ckanext.dcat.compatibility_mode + +Default value: `False` + +Whether to modify some fields to maintain compatibility with previous versions +of the ckanext-dcat parsers. + + +#### ckanext.dcat.json_endpoint + +Default value: `/dcat.json` + +Custom route to expose the legacy JSON endpoint + + + + + ## Running the Tests To run the tests do: