Skip to content

Docs: Document "strings" with "title" and "description" #205

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

Merged
k-yle merged 2 commits into from
Jan 10, 2026
Merged

Docs: Document "strings" with "title" and "description" #205

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac08f7d
Docs: Document "strings" with "title" and "description"
tordans May 23, 2025
e16cbdf
Merge branch 'main' into tordans-patch-1
k-yle Jan 10, 2026
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
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,11 +558,14 @@ The user can pick from any of the options, or type their own value.

The `strings` object contains values that the field wants to be translated on Transifex.

[Combo field types](#combodropdown-fields) can accept key-label pairs in the `options` value of the `strings` property.
[Combo field types](#combodropdown-fields) can accept custom translations for `options` values via the `strings` property.
These values populate the `options` property if it isn't otherwise specified.
If `autoSuggestions` is `true` (as per default), then raw and labeled values might be mixed
in the dropdown suggestions.

The options can either be a string or `{"title": "…", "description": "…"}` object where the description is shown on mouse over
in iD to give additional context on a value ([Example](https://github.com/openstreetmap/id-tagging-schema/blob/main/data/fields/parking.json)).

```js
{
"key": "smoothness",
Expand All @@ -584,6 +587,20 @@ in the dropdown suggestions.
}
```

```js
//…
"strings": {
"options": {
"excellent": {
"title": "Thin Rollers: rollerblade, skateboard",
"description": "As-new asphalt or concrete, smooth paving stones with seamless connections, etc."
},
//…
}
}
//–
```

[Checkbox field tyes](#checkboxes) use the options keys to specify the values of the OSM tag corresponding
to the different states of the checkbox input element, in the following order:
1. fields of type `check`: _unset state_ (must use the option `undefined`), _checked state_,
Expand Down
⚡