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).

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

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"
},
"...": "..."
}
==============
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).

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

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)
| 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 |