VisualEditor: Quick transclusion dialog UX improvements
Closed, InvalidPublic

Description

Template overall:

  • Template panel should have a link to the template's definition page (if it's a real template)
  • Template panel should have a link to the relevant MW Manual page (if it's a parser function)

Parameters:

  • Label for parameter should use the "label" from TemplateData, not the wt name
  • Label panel should use the "description" from TemplateData above the content box
  • Label panel should indicate if a parameter is "mandatory" from TemplateData
  • Label panel should show the "default" from TemplateData
  • Label panel should indicate if a parameter is "deprecated" from TemplateData

Adding parameters:

  • Template panel should show available unused parameters and way to add them
  • Template panel should highlight available unused parameters that are mandatory
  • Template panel should highlight available unused parameters that are in sets
  • Insertion of a template with TemplateData should auto-insert the mandatory parameters

Version: unspecified
Severity: enhancement
See Also:
https://bugzilla.wikimedia.org/show_bug.cgi?id=52576

bzimport set Reference to bz49833.
Jdforrester-WMF created this task.Via LegacyJun 19 2013, 6:50 PM
Krinkle added a comment.Via ConduitJun 24 2013, 11:05 PM

updated:

Template panel:

  • Link to the template page (if it's a transclusion from a MediaWiki page)
  • Link to the MediaWiki.org Manual (if it's a parser function)
  • Use "Root#description" from TemplateData: Done.

Parameter panel:

  • Use "Param#label" from TemplateData: Done.
  • Use "Param#description" from TemplateData: Done.
  • Use "Param#required" from TemplateData: TODO.
  • Use "Param#default" from TemplateData: TODO.
  • Use "Param#deprecated" from TemplateData: TODO.
  • Use "Param#type" from TemplateData: TODO.

"Add parameter" panel:

  • Show available (unused) parameters
  • Use "Param#required" data to prioritise/encourage use of those parameters
  • Use "Root#sets" data to allow addition and/or completion of parameter sets
  • Creating a new Template transclusion should start with all required parameters auto-inserted (instead of requiring the user to add them one-by-one).
Jdforrester-WMF added a comment.Via ConduitJul 9 2013, 5:27 PM

UX items at this point:

Template panel:
* Move “add parameter” button to alongside the search field, not below the results list, so it can be found
* Link to the template page (if it's a transclusion from a MediaWiki page)
* Link to the MediaWiki.org Manual (if it's a parser function)
* Use "Param#required" data to prioritise/encourage use of those parameters
* Use "Root#sets" data to allow addition and/or completion of parameter sets
* Auto-add required parameters when creating a new Template transclusion
* Double-click on a parameter in the selection menu should insert it
* Up/down keys work in the parameter search field results, but not left/right, even though it’s not just a vertical list
* Cursor keys can let you select parameters in the search results off the screen and the dialog doesn’t scroll
* When adding a template, auto-add all mandatory parameters
* Checkbox (?) to substitute a template on save, rather than leave as transclusion
Parameter panel:
* Use "Param#required" from TemplateData
* Use "Param#default" from TemplateData
* Use "Param#deprecated" from TemplateData
* Use "Param#type" from TemplateData
Jdforrester-WMF added a comment.Via ConduitAug 30 2013, 10:01 PM

Have un-trackered-this;

Jdforrester-WMF added a comment.Via ConduitAug 30 2013, 11:33 PM

… of the remaining items, I've split them out into:

(In reply to comment #2)

Template panel:

  • Link to the template page (if it's a transclusion from a MediaWiki page)
  • Link to the MediaWiki.org Manual (if it's a parser function)

Collectively https://bugzilla.wikimedia.org/show_bug.cgi?id=49772

  • Use "Param#required" data to prioritise/encourage use of those parameters

https://bugzilla.wikimedia.org/show_bug.cgi?id=50747

  • Use "Root#sets" data to allow addition and/or completion of parameter sets

https://bugzilla.wikimedia.org/show_bug.cgi?id=53609

  • Cursor keys can let you select parameters in the search results off the screen and the dialog doesn’t scroll

https://bugzilla.wikimedia.org/show_bug.cgi?id=53610

  • Checkbox (?) to substitute a template on save, rather than leave as transclusion

https://bugzilla.wikimedia.org/show_bug.cgi?id=49904

Parameter panel:

  • Use "Param#required" from TemplateData

https://bugzilla.wikimedia.org/show_bug.cgi?id=53611

  • Use "Param#default" from TemplateData

https://bugzilla.wikimedia.org/show_bug.cgi?id=52753

  • Use "Param#deprecated" from TemplateData

https://bugzilla.wikimedia.org/show_bug.cgi?id=53612

  • Use "Param#type" from TemplateData

https://bugzilla.wikimedia.org/show_bug.cgi?id=53613

So, closing as INVALID.

Add Comment