Skip to main content
ckanext-fluent
==============

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
[ckanext-scheming](https://github.com/open-data/ckanext-scheming/).
Add `ckanext.fluent:presets.json` to your scheming.presets
configuration settings:

```json
scheming.presets = ckanext.scheming:presets.json
ckanext.fluent:presets.json
```

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

```json
{
"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.:

```json
{
"...": "...",
"books": {
"en": "Franklin",
"fr": "Benjamin"
},
"...": "..."
}

Metadata

Release files for ckanext-fluent 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ckanext-fluent 1.0.0
File Size Uploaded
ckanext-fluent-1.0.0.tar.gz 6.9 kB Details

Release files / ckanext-fluent-1.0.0.tar.gz

Download URL ckanext-fluent-1.0.0.tar.gz
Size 6.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f612d48db729281e500b70b392ec7c08205ed06ac7b935b150aceaea48d1db4c
BLAKE2b-256 checksum
How to use checksums
6d8abf6c92686ec39b70b20021a76fa43ef084fc7587816a75590ef42ed9b455
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page