Skip to content

Update CONTRIBUTING.md about wiki items and wiki links#1600

Open
zbycz wants to merge 2 commits intoopenstreetmap:mainfrom
zbycz:patch-1
Open

Update CONTRIBUTING.md about wiki items and wiki links#1600
zbycz wants to merge 2 commits intoopenstreetmap:mainfrom
zbycz:patch-1

Conversation

@zbycz
Copy link
Copy Markdown
Contributor

@zbycz zbycz commented Jun 13, 2025

Documentation was missing about how iD resolves the wiki items. I learned it from @1ec5 here #1590 (comment) (thanks!)

@github-actions
Copy link
Copy Markdown

🍱 Your pull request preview is ready

Please use this preview to check your changes. Ideally use the test documentation template and document your test results by commenting on the PR. This will speed up the review process for everyone.

FYI, once this PR is merged, you can use the iD Editor Preview to test your changes in interaction with all other changes.

@tordans
Copy link
Copy Markdown
Collaborator

tordans commented Jun 13, 2025

I would like to merge #1506 first and then review.
(I need a review on that, first…)
In general I am in favor of improving this!

@zbycz

This comment was marked as resolved.

Comment thread CONTRIBUTING.md
- Does your tag have a Wikibase entry? Click the small pencil icon next to the text to open the Wikibase item on the OSM wiki. Improve this wording if needed. If the Wikibase item is missing, [learn more about how to add it in "Current methods for creating new items"](https://wiki.openstreetmap.org/wiki/Data_items#Item_creation_process).
- Does your tag have a Wikibase entry? Click the small pencil icon next to the text to open the Wikibase item on the OSM wiki. Improve this wording if needed.
- If the Wikibase item is missing, [learn more about how to add it in "Current methods for creating new items"](https://wiki.openstreetmap.org/wiki/Data_items#Item_creation_process).
- iD queries the `Tag:<key>=<value>` page or `Key:<key>` page and prefers the more specific variant. It then uses "wiki sitelinks" to get the data item from the page. These can be set [here](https://wiki.openstreetmap.org/wiki/Special:SetSiteLink//wiki), see the documentation in link above.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think I never did this before. Lets double check first if this is actually needed for the lookup … or only for the Wiki-Relation part.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@harahu you added wiki data items for your last two PRs, did you add those SiteLinks described here? Or did it work with just the data item with the right values?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I added the SiteLinks as described in the guide, but I don't know whether that was on the critical path to getting the description and picture to show up.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

For me it was crtitical to show the description, though i am not sure about the image.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This comment helped me understand it is really needed and I also had to set the sitelink for all other wiki items i created.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

is this the only unresolved issue? I can confirm that Special:SetSiteLink is a required step.

and it's the hardest step to figure out imo, because the UI is broken1

Footnotes

  1. the link appears in the top right corner of the screen for a split second while the page loads (example). you have to be very quick to click it before it disappears

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The link to Special:SetSitelink should be in the Tools section, alongside the link to the permalink. Depending on your skin and appearance preferences, it might be tucked away in a menu somewhere. The flash is because of the gadget (installed by default) that puts the link in Tools.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

To be pedantic, iD queries the wiki for data items that are linked to these page titles. It doesn’t run a separate query for the article then the data item. MediaWiki (Wikibase) handles all that for the client.

But to answer the original question, yes, setting a sitelink is necessary. It’s a bit confusing because there’s also typically a documentation wiki pages (P31) property listing all the different translations, but that only matters once the sitelink to the English version is established.

@matkoniecz
Copy link
Copy Markdown
Collaborator

Pinging @1ec5 as an expert here

@matkoniecz matkoniecz added the documentation Improvements or additions to documentation label Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants