Last modified: 2013-02-07 01:17:59 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T45312, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 43312 - Add pointer to TemplateSandbox documentation
Add pointer to TemplateSandbox documentation
Status: RESOLVED FIXED
Product: MediaWiki extensions
Classification: Unclassified
TemplateSandbox (Other open bugs)
unspecified
All All
: Normal enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
: easy
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2012-12-21 03:41 UTC by MZMcBride
Modified: 2013-02-07 01:17 UTC (History)
3 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description MZMcBride 2012-12-21 03:41:50 UTC
The form that appears below the edit window when editing a template with the TemplateSandbox extension enabled does not have any pointer to the TemplateSandbox documentation.

This is problematic as there's no explanation of what the box is, how it works, etc. It just says:

---
Preview page with this template

Page title: [_________________________] [Show preview]
---

Some kind of "what is this?" feature is needed, at least for now, I think. I tried to request that the "Preview page with this template" MediaWiki message be changed to include a "what's this?" link, but the message is not parsed (cf. <https://en.wikipedia.org/w/index.php?title=MediaWiki_talk:Templatesandbox-editform-legend&oldid=529062236#Add_pointer_to_docs>). I'm not sure why this is.

The message should either be parsed and/or there should be a pointer to the TemplateSandbox documentation from the input area below the edit window. The "Usage" section of the template's documentation is good, it's just impossible to figure out how to find that page on mediawiki.org (<https://www.mediawiki.org/wiki/Extension:TemplateSandbox>) from the edit window.
Comment 1 Alex Monk 2012-12-21 14:27:47 UTC
What this function does is pretty obvious to anyone who knows how templates work. Which should mean anyone editing a template page.
Comment 2 MZMcBride 2012-12-21 14:44:46 UTC
Is there any reason the message isn't being parsed? I don't really want to argue about this feature's discoverability/usability (though I'm right, if for no other reason than it's a big new input box on the edit window that needs at least temporary explanation), I'd be perfectly content to just get the message parsed. Then this can become a local thing.
Comment 3 Alex Monk 2012-12-21 15:10:58 UTC
Gerrit change #39767
Comment 4 Brad Jorsch 2012-12-21 15:12:27 UTC
Gerrit change #39768 adds (empty) messages that can be customized to add help links. It's not possible to make the legend parsed while continuing to use MediaWiki's utility classes for constructing the HTML.
Comment 5 Brad Jorsch 2012-12-21 15:14:17 UTC
(In reply to comment #3)
> Gerrit change #39767

(In reply to comment #4)
> It's not possible to make the legend parsed while continuing to use
> MediaWiki's utility classes for constructing the HTML.

Well, I stand corrected. It just needs a slightly lower-level use of those classes. Let's apply both changesets, IMO.
Comment 6 Alex Monk 2013-02-06 22:21:13 UTC
Shall we consider this bug fixed now?
Comment 7 Brad Jorsch 2013-02-07 01:17:59 UTC
Yes, let's.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links