Skip to main content

Multilingual fields for CKAN

Project description


This extension provides a way to store and return multilingul
fields in CKAN datasets, resources, organizations and groups.

Add the `fluent` plugin to your ckan.plugins configuration
settings and use ckanext-scheming or a custom form plugin to
use the provided validators to store multilingual text in
extra fields.

The easiest way to use fluent multilingual text fields is with
Add `ckanext.fluent:presets.json` to your scheming.presets
configuration settings:

scheming.presets = ckanext.scheming:presets.json

A fluent multilingual field in a scheming schema
will look something like::

"field_name": "books",
"preset": "fluent_text",
"label": {
"en": "Books",
"fr": "Livres"
"form_languages": ["en", "fr"]

This new extra field "books" will appear as multiple fields in the
dataset form, one for each language specified in `form_languages`
by the [form snippet](ckanext/fluent/templates/scheming/form_snippets/fluent_text.html).

![Example of fluent form snippet](docs/multilingual-form.png)

When displayed, each language with text entered will appear separately
by the
[display snippet](ckanext/fluent/templates/scheming/display_snippets/fluent_text.html), eg.:

![Example of fluent display snippet](docs/multilingual-display.png)

When the dataset is accessed from the API the language values appear
and are updated as an object, eg.:

"...": "...",
"books": {
"en": "Franklin",
"fr": "Benjamin"
"...": "..."

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext-fluent-1.0.0.tar.gz (6.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page