Proposal:Note suffix

:note suffix
Proposal status:	Proposed (under way)
Proposed by:	Push-f
Draft started:	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:

• note:name adds a note for other mappers about the name=* tag

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:

• note:bin=*: are these notes in Bini or notes about the bin=* tag?
• note:to=*: are these notes in Tongan or notes about the to=* tag?
• note:id=*: are these notes in Indonesian or notes about the id=* tag?
• note:gay=*: are these notes in Gayo or notes about the gay=* tag?
• note:sat=*: are these notes in Santali or notes about the sat=* tag?
• note:men=*:are these notes in Mende or notes about the men=* tag?

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

• name:note adds a note for other mappers about the name=* tag

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

• taginfo search for note:
• taginfo search for :note

Features/Pages affected

• Key:note
• Key:note:collection times (mark as deprecated in favor of Key:collection times:note)
• Key:pilotage (currently suggests note:pilotage=* despite it not being used anywhere)

Comments

Please comment on the discussion page.