Page MenuHomePhabricator
Create Task
Maniphest T97619

Document new addHelpLink() in 1.25
Closed, ResolvedPublic
Actions

Description

Gerrit 157497 added addHelpLink() feature. It could be documented better.

  • It's not mentioned in RELEASE-NOTES-1.25 (the underlying indicator facility is).
  • Its doxgen help doesn't document the parameters or mention the hardcoded //www.mediawiki.org/wiki/Special:MyLanguage/ URL path.
  • The BoilerPlate extension's SpecialHelloWorld.php should show this working.
  • It's not mentioned on mediawiki.org pages such as writing an extension, Category:Extension help, Project:PD Help, etc. (I'll work on this bit.)

Details

SubjectRepoBranchLines +/-
add an addHelpLink() examplemediawiki/extensions/examplesmaster+2 -0
Customize query in gerrit

Related Objects

Event Timeline

• Spage created this task.Apr 30 2015, 1:34 AM
• Spage raised the priority of this task from to Needs Triage.
• Spage updated the task description. (Show Details)
• Spage added projects: MW-1.25-release, Documentation.
• Spage subscribed.
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 30 2015, 1:34 AM
• Spage assigned this task to Nemo_bis.Apr 30 2015, 1:37 AM
• Spage updated the task description. (Show Details)
• Spage set Security to None.
Nemo_bis added a project: MediaWiki-Documentation.May 4 2015, 6:23 AM
Nemo_bis added a project: Patch-For-Review.

I was already working on documentation as part of the parent task: https://gerrit.wikimedia.org/r/208378

Nemo_bis removed Nemo_bis as the assignee of this task.May 8 2015, 7:47 PM
Nemo_bis subscribed.

Ic849dde00be7379c1909a8486cf20f48c5aea5cf / rMW36801c9e907b does all this, someone else can continue.

I've never touched the extension example but I added https://www.mediawiki.org/w/index.php?title=Manual%3ASpecial_pages&type=revision&diff=1645623&oldid=1557945

greg triaged this task as Medium priority.May 13 2015, 7:14 PM
gerritbot subscribed.May 23 2015, 12:59 PM

Change 212906 had a related patch set uploaded (by Microchip08):
add an addHelpLink() example

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

gerritbot added a comment.May 23 2015, 1:07 PM

Change 212906 merged by jenkins-bot:
add an addHelpLink() example

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

MC8 mentioned this in rMEXT3bd5bea0a92b: Updated mediawiki/extensions Project: mediawiki/extensions/examples….May 23 2015, 1:07 PM
Legoktm updated the task description. (Show Details)May 23 2015, 1:42 PM
MC8 claimed this task.May 23 2015, 1:43 PM
MC8 updated the task description. (Show Details)
MC8 added a comment.May 23 2015, 2:01 PM

The Doxygen information seems sufficient as it is. I've added the documentation to a couple of places on MediaWiki.org; not sure there's anywhere else appropriate.

MC8 removed a project: Patch-For-Review.May 23 2015, 2:01 PM
• demon closed this task as Resolved.May 23 2015, 2:08 PM
• demon updated the task description. (Show Details)
• demon subscribed.

Docs look good to me (code docs + example extension usage), plus initial docs on-wiki.

MW.org can always be cleaned up later if need be.

MC8 mentioned this in rEXAM11fdea21d8d1: add an addHelpLink() example.May 23 2015, 3:10 PM
MC8 mentioned this in rEBOP11fdea21d8d1: add an addHelpLink() example.May 25 2023, 6:59 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL