These CKAN Versions are exactely matched:

• 2.10.0
• 2.10.1
• 2.10.2
• 2.10.3
• 2.10.4
• 2.10.5
• 2.10.6
• 2.10.7
• 2.10.8
• 2.10.9
• 2.11.0
• 2.11.1
• 2.11.2
• 2.11.3
• 2.11.4
• 2.12.0
• 2.9.0
• 2.9.0a
• 2.9.1
• 2.9.10
• 2.9.11
• 2.9.13
• 2.9.2
• 2.9.3
• 2.9.4
• 2.9.5
• 2.9.6
• 2.9.7
• 2.9.8
• 2.9.9

ckanext-datasetsnippets

This plugin belongs to a set of plugins for the Datenregister – the non-public CKAN instance that is part of Berlin’s open data portal daten.berlin.de. ckanext-datasetsnippets provides markup snippets for dataset pages and dataset search. These snippets can be loaded from the data portal’s public CMS to handle all requests for datasets.

Requirements

This plugin has been tested with CKAN 2.9.10 (which requires Python 3).

API

The Snippet API has the following two endpoints:

/snippet/dataset

This is the search endpoint of the snippet API, which is equivalent to /dataset in the regular CKAN UI. Without additional parameters, this returns markup for the paginated list of all datasets. Parameters (search facets, ordering etc.) can be used to restrict the result. The parameters are identical to the regular CKAN search parameters.

/snippet/dataset/<id>

This is the dataset detail endpoint of the snippet API, which is equivalent to /dataset/<id> in the regular CKAN UI. <id> is the name or id of a dataset.

Parameters

Both endpoints allow a root_breadcrumb parameter to set the root element of the breadcrumb returned in the snippets.

Configuration

The plugin introduces the following configuration options:

# Defines the path component prefixed to links in snippets
datasetsnippets.path = 'datensaetze'

# Datasets shown per result page in pagination
datasetsnippets.datasets_per_page = 10

# String used as root element for breadcrumb
datasetsnippets.default_root_breadcrumb = 'Berlin Open Data'

# URL to the datenportal for generating feeds
datasetsnippets.datenportal_url = link_to_portal

# Title string used in feeds
datasetsnippets.datenportal_title = 'Berlin Open Data'

Plugin Interfaces Implemented

• ITemplateHelpers
• IBlueprint
• IAuthFunctions

License

This material is copyright © BerlinOnline GmbH.

This extension is open and licensed under the GNU Affero General Public License (AGPL) v3.0.