Skip to content
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.

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

Deprecate non-BCP-47 language tags for name keys #1356

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

Conversation

winstonsung
Copy link

@winstonsung winstonsung commented Oct 9, 2024

Bug: #1356
Bug: openstreetmap/iD#10488
Change-Id: Ib079be59b77870f0519a97a5d9365932f57e73a2

Description, Motivation & Context

We should stop using non-standard BCP 47 language tags.

Links and data

Relevant OSM Wiki links:

Relevant tag usage stats:

Checklist and Test-Documentation Template

Read on to get your PR merged faster…

Follow these steps to test your PR yourself and make it a lot easier and faster for maintainers to check and approve it.

This is how it works:

  1. After you submit your PR, the system will create a preview and comment on your PR:

    🍱 You can preview the tagging presets of this pull request here.
    If this is your first contribution to this project, the preview will not happen right away but requires a click from one of the project members. We will do this ASAP.

  2. Once the preview is ready, use it to test your changes.

  3. Now copy the snippet below into a new comment and fill out the blanks.

  4. Now your PR is ready to be reviewed.

## Test-Documentation

### Preview links & Sidebar Screenshots

<!-- Use the preview to find examples, select the feature in question and **copy this link here**.
     Find examples of nodes/areas. Find examples with a lot of tags or very few tags. – Whatever helps to test this thoroughly.
     Add relevant **screenshots** of the sidebar of those examples. -->

<!-- FYI: What we will check:
     - Is the [icon](https://github.com/ideditor/schema-builder/blob/main/ICONS.md) well chosen.
     - Are the fields well-structured and have good labels.
     - Do the dropdowns (etc.) work well and show helpful data. -->

### Search

<!-- **Test the search** of your preset and share relevant **screenshots** here.
     - Test the preset name as search terms.
     - Also test the preset terms and aliases as search terms (if present). -->

### Info-`i`

<!-- **Test the info-i** for your fields and preset and share relevant **screenshots** here.
     The info needs to help mappers understand the preset and when to use it.
     [Learn more…](https://github.com/tordans/id-tagging-schema/blob/main/CONTRIBUTING.md#info-i)
 -->

### Wording

- [ ] American English
- [ ] `name`, `aliases` (if present) use Title Case
- [ ] `terms` (if present) use lower case, sorted A-Z
<!-- Learn more in https://github.com/openstreetmap/id-tagging-schema/blob/main/GUIDELINES.md#2-design-the-preset -->

Copy link

github-actions bot commented Oct 9, 2024

🍱 You can preview the tagging presets of this pull request here.

winstonsung added a commit to winstonsung/openstreetmap-id-tagging-schema that referenced this pull request Oct 9, 2024
Bug: openstreetmap#1356
Change-Id: Ib079be59b77870f0519a97a5d9365932f57e73a2
winstonsung added a commit to winstonsung/openstreetmap-id-tagging-schema that referenced this pull request Oct 9, 2024
- `alt_name`
- `loc_name`
- `name`
- `nat_name`
- `official_name`
- `reg_name`
- `short_name`

Bug: openstreetmap#1356
Change-Id: Ib079be59b77870f0519a97a5d9365932f57e73a2
Comment on lines +1449 to +1460
{
"old": {"name:nan-TL": "*"},
"replace": {"name:nan-Latn-tailo": "$1"}
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Some of these deprecations replace very common keys with much less common keys. For example, name:nan-TL=* still has some 38,000 occurrences while name:nan-Latn-tailo=* has only eight. I realize that’s part of the motivation for this change, and conforming to the standard is good for interoperability, but have you given a heads-up to the relevant communities yet? Not everyone uses id-tagging-schema–powered editors, and some data consumers may need to update their special cases for nonconformant codes. Given the number of languages involved, consider posting something to the global forum and then reaching out to individual local or language communities separately (such as the Asia Telegram chat).

Copy link
Author

@winstonsung winstonsung Oct 9, 2024

Choose a reason for hiding this comment

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

This had been already discussed in both OpenStreetMap Mainland China and OpenStreetMap Taiwan Telegram groups.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for these links. I can’t read Chinese, but assuming the changes were uncontroversial, the next step would be to alert the broader community. Many software developers don’t participate in the Chinese-language communication channels. Off the top of my head, here are some data consumers that will be affected by the deprecation of name:zh_pinyin=* in favor of name:zh-Latn-pinyin=* or the deprecation of name:zh-CN=*, name:zh-HK=*, and name:zh-TW=* in favor of name:zh-Hans-CN=*, name:zh-Hant-HK=*, and name:zh-Hant-TW=*, respectively:

Additionally, some closed-source products such as Mapbox Streets might be affected, but I don’t have any specific information about that.

Please consider starting a conversation somewhere more visible, such as the tagging forum category, and opening issues against the relevant repositories. We don’t have to wait to merge these changes until the data consumers are fully updated, but we should start the discussion ahead of time, as a courtesy. Thanks for your attention to detail!

Copy link
Author

Choose a reason for hiding this comment

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

I've asked other community members to handle something about the tagging forum category, waiting for their reply.

We're also checking which repositories are relevant to this change.

Copy link
Author

Choose a reason for hiding this comment

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

(2024-10-09 17:55 (UTC) Note: https://github.com/osmlab/name-suggestion-index had been identified.)

Copy link
Author

Choose a reason for hiding this comment

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

- `alt_name`
- `loc_name`
- `name`
- `nat_name`
- `official_name`
- `reg_name`
- `short_name`

Bug: openstreetmap#1356
Change-Id: Ib079be59b77870f0519a97a5d9365932f57e73a2
@winstonsung winstonsung marked this pull request as ready for review October 9, 2024 16:27
@winstonsung winstonsung requested a review from 1ec5 October 9, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants