TemplateData: Provide property "example" for template parameters
Closed, ResolvedPublic
Actions

Description

From
https://www.mediawiki.org/wiki/Thread:VisualEditor/Feedback/About_TemplateData

'(...) would it be possible to add new parameter "example" (where is example text what should be added to the parameter) in addition "label", "description", "type" and "required"?'

Version: unspecified
Severity: enhancement

Details

Reference: bz51049

Subject	Repo	Branch	Lines +/-
Add example property to HTML rendering	mediawiki/extensions/TemplateData	master	+24 -0
Add an example property to parameters	mediawiki/extensions/TemplateData	master	+54 -1
MWParameterPage: Show the field's example if it exists	mediawiki/extensions/VisualEditor	master	+62 -5

Customize query in gerrit

Related Objects

Mentioned In: rETDA65b101e60c5d: Add example property to HTML rendering
rMEXT22ffa0febc39: Updated mediawiki/extensions Project: mediawiki/extensions/TemplateData…
T97417: VE: does not show a property "example" for templates
rETDAec0467c65a4c: Add an example property to parameters
rMEXT6559b6e3561c: Updated mediawiki/extensions Project: mediawiki/extensions/TemplateData…
rEVED530f5c05f501: MWParameterPage: Show the field's example if it exists

Event Timeline

• bzimport raised the priority of this task from to High.Nov 22 2014, 2:04 AM

• bzimport added a project: TemplateData.

• bzimport set Reference to bz51049.

He7d3r created this task.Jul 9 2013, 5:14 PM

Any progress?

Jdforrester-WMF lowered the priority of this task from High to Medium.Dec 2 2014, 9:16 PM

Jdforrester-WMF moved this task from Backlog to Next-up on the TemplateData board.

Change 194386 had a related patch set uploaded (by Mooeypoo):
Add an example property to parameters

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

gerritbot added a project: Patch-For-Review.Mar 4 2015, 8:33 PM

Change 194416 had a related patch set uploaded (by Mooeypoo):
Show the field's example if it exists

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

Mooeypoo claimed this task.Mar 4 2015, 11:49 PM

Mooeypoo moved this task from Next-up to Doing on the TemplateData board.

Jdforrester-WMF added a project: WMF-deploy-2015-03-11_(1.25wmf21).Mar 9 2015, 9:32 PM

Jdforrester-WMF set Security to None.

Change 194416 merged by jenkins-bot:
MWParameterPage: Show the field's example if it exists

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

Mooeypoo mentioned this in rEVED530f5c05f501: MWParameterPage: Show the field's example if it exists.Mar 9 2015, 9:34 PM

He7d3r added a project: User-notice.Mar 9 2015, 10:04 PM

• gpaumier moved this task from To Triage to Announce in next Tech/News on the User-notice board.Mar 10 2015, 3:03 PM

• gpaumier moved this task from Announce in next Tech/News to In current Tech/News draft on the User-notice board.Mar 12 2015, 7:57 PM

• gpaumier moved this task from In current Tech/News draft to Recently announced in Tech/News on the User-notice board.Mar 13 2015, 10:15 PM

Liuxinyu970226 subscribed.Mar 15 2015, 12:37 AM

The feature support in MWParameterPage is a bit presumptuous as the exact definition and property name are still being reviewed upstream in TemplateData.

Anyway, this feature seems useful, but I'd like to be more explicit about at least one use case before we land it. The talk thread that requests it didn't seem to note anything about the existing properties description, default and autofill which currently cover the use case of showing what a field is for and what kind of value it should have.

I take it it will be used as placeholder in a user interface. However in VisualEditor the default is currently also displayed in the placeholder attribute. And the (already merged) conditional implementation of that does indeed ignore the example value if there is a default. And it seems there is no difference communicated to the user visually to distinguish example from default.

If the user won't be able to tell the difference, can authors?

I feel like the feature would be useful, but it is imho not sufficiently clear in its specification, implementation and current use in VisualEditor to offset it from the other existing features. And I imagine this will lead to confusion or incorrect usage by authors and users.

• gpaumier moved this task from Recently announced in Tech/News to Already announced/Archive on the User-notice board.Mar 19 2015, 5:47 PM

Jdforrester-WMF closed this task as Resolved.Mar 26 2015, 9:12 PM

Jdforrester-WMF edited projects, added WMF-deploy-2015-04-01_(1.25wmf24); removed WMF-deploy-2015-03-11_(1.25wmf21), Patch-For-Review.

Liuxinyu970226 unsubscribed.Mar 27 2015, 12:03 AM

Hypergrove subscribed.Apr 3 2015, 9:42 PM

Change 194386 merged by jenkins-bot:
Add an example property to parameters

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

Diffusion mentioned this in rMEXT6559b6e3561c: Updated mediawiki/extensions Project: mediawiki/extensions/TemplateData….Apr 10 2015, 4:49 PM

Krinkle mentioned this in rETDAec0467c65a4c: Add an example property to parameters.Apr 10 2015, 4:50 PM

Jdforrester-WMF added a project: WMF-deploy-2015-04-15_(1.26wmf2).Apr 12 2015, 10:52 PM