Skip to content

spec: add multilingual example, context #966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wardi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

spec: add multilingual example, context #966

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/croissant-spec-draft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,15 @@ Furthermore, we can describe the structure and the data types in the data using

The [RecordSets](#recordsets) section explains how to define recordsets and fields, as well as extract, transform and join their data.

`name` and `description` values may also be provided in mulitple languages using BCP-47 language codes:

```json
"description": {
"en": "The date the photo was taken.",
Copy link
Contributor

@benjelloun benjelloun Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer not to use a language map in the example, so that we don't change the default Croissant context. This is because our library implementation depends on the context being stable (which is not correct, but would require a significant effort to fix).

Copy link
Contributor Author

@wardi wardi Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the library implementation the python library? I made changes to the context used in #932 so that this feature would work, what does it mean that the default context can't be changed?

"de": "Das Datum, an dem das Foto aufgenommen wurde."
}
```

## Prerequisites

Before jumping into the main components of a Croissant dataset, we describe some constructs that are used throughout.
Expand Down Expand Up @@ -2166,6 +2175,9 @@ TODO: Add guidance on representing data use restrictions.
"@id": "cr:dataType",
"@type": "@vocab"
},
"description": {
"@container": "@language"
},
"examples": {
"@id": "cr:examples",
"@type": "@json"
Expand All @@ -2182,6 +2194,9 @@ TODO: Add guidance on representing data use restrictions.
"jsonPath": "cr:jsonPath",
"key": "cr:key",
"md5": "cr:md5",
"name": {
"@container": "@language"
},
"parentField": "cr:parentField",
"path": "cr:path",
"recordSet": "cr:recordSet",
Expand Down
Loading