Proposed features/:note suffix

From OpenStreetMap Wiki
Jump to navigation Jump to search
:note suffix
Proposal status: Proposed (under way)
Proposed by: Push-f
Drafted on: 2022-06-27
RFC start: 2022-06-27

Proposal

Deprecate the note: prefix in favor of the :note suffix to add a note specific to a tag.

Rationale

"note" is often used as a prefix to add information about a specific tag, for example:

However we also have a convention of using language suffixes, for example:

  • note:en & note:ja are used to add notes in English and Japanese respectively

The problem that arises with both of these conventions combined is that language codes may clash with key names, for example:

The solution to this ambiguity is to use "note" as a suffix to add information about a specific tag, for example:

By using suffixes for tag-specific notes we remove the ambiguity. For example it would be clear that note:to=* is a note in Tongan while to:note=* is a note about the to=* tag.

Tagging

To add a note for other mappers about a specific key, add a tag named <keyname>:note.

Examples

Features/Pages affected

External discussions

Comments

Please comment on the discussion page.