Page MenuHomePhabricator

Document Wikibase hooks on Mediawiki.org
Closed, DeclinedPublic

Description

Right now there is no documentation for Wikibase hooks on mediawiki.org. This should be fixed - each hook should be documented under https://www.mediawiki.org/wiki/Manual:Hooks/ namespace. The hooks list in Wikibase code:

  • WikibaseHandleChange
  • WikibaseHandleChanges
  • WikibaseRepoEntityTypes
  • WikibaseRepoDataTypes
  • WikibaseClientOtherProjectsSidebar
  • WikibaseClientDataTypes
  • WikibaseClientEntityTypes
  • WikibaseEntityNamespaces
  • WikibaseTextForSearchIndex
  • GetEntityByLinkedTitleLookup
  • WikibaseContentModelMapping
  • WikibaseChangeNotification

There is documentation in docs/hooks-php.md but it is much harder to locate and search it.

May be automatable (see T157757 for similar task) i.e. just running a script that would create wiki pages

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 29 2018, 9:37 PM

Change 562233 had a related patch set uploaded (by Addshore; owner: Addshore):
[mediawiki/extensions/Wikibase@master] docs, cleanup hooks doc files & add links

https://gerrit.wikimedia.org/r/562233

Change 562233 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] docs, cleanup hooks doc files & add links

https://gerrit.wikimedia.org/r/562233

WMDE-leszek closed this task as Declined.May 11 2020, 3:17 PM
WMDE-leszek added a subscriber: WMDE-leszek.

All hooks listed in the description (with the different that WikibaseEntityNamespaces has been meanwhile replace with a Repo and Client specific hooks) have a documentation published automatically on https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_hooks-php.html, which is not a central documentation place. It is used instead of documenting Wikibase hooks on mediawiki.org

Therefore I decline this task, as WMDE considers the documentation work done in this area.