Page MenuHomePhabricator
Create Task
Maniphest T288465

VE template dialog: Update description margins and help text
Closed, ResolvedPublic1 Estimated Story Points
Actions

Assigned To
Lena_WMDE
Authored By
ECohen_WMDE
Aug 9 2021, 3:39 PM
Tags
Referenced Files
F34627738: Specs - vertical spacing2.png
Sep 1 2021, 1:05 PM
F34627737: Specs - vertical spacing.png
Sep 1 2021, 1:05 PM
F34621954: image.png
Aug 27 2021, 12:25 PM
F34621937: image.png
Aug 27 2021, 12:04 PM
F34588638: Screen Shot 2021-08-09 at 17.30.43.png
Aug 9 2021, 3:39 PM
F34588634: Screen Shot 2021-08-09 at 17.30.26.png
Aug 9 2021, 3:39 PM
Subscribers
Aklapper
awight
ECohen_WMDE
Lena_WMDE

Description

Background

  • After increasing the dialog size, adjusting the description to match parameter width to feel more balanced.
  • Small adjustments to the help text to hopefully help users understand why they are seeing what they are seeing and understand where to go for additional info.

Requirements

  • Match title/description/help and other component margins to the parameter field margins
  • Update help text: "Templates are user-generated and may lack complete descriptions. There might be additional information on this [template’s page]."
  • For templates without TemplateData remove the help text completely. A new warning message is implemented in T276574: Add reactive notices and warnings in VE template dialog
  • Note comment from this ticket T272487#7314425 about margins is covered here

General specs:

  • 48px around all elements (outer margins)
  • 48px between 'chunks' (each chunk being a template and all it's messages, components, parameters, etc or wikitext)
  • 16px between individual elements within a chunk (between description, messages, parameters, etc)

Mocks

Screen Shot 2021-08-09 at 17.30.26.png (760×802 px, 73 KB)

Screen Shot 2021-08-09 at 17.30.43.png (740×780 px, 73 KB)

Specs - vertical spacing.png (1×657 px, 119 KB)

Specs - vertical spacing2.png (1×657 px, 128 KB)

Details

SubjectRepoBranchLines +/-
Fix missing and flipped template dialog help messagesmediawiki/extensions/VisualEditormaster+2 -1
Update template dialog help messagesmediawiki/extensions/VisualEditormaster+18 -8
Tighten vertical gap between parametersmediawiki/extensions/VisualEditormaster+11 -1
Try to use margin/padding instead of flex for template dialogmediawiki/extensions/VisualEditormaster+17 -4
Adjust template dialog marginsmediawiki/extensions/VisualEditormaster+18 -0
Customize query in gerrit

Related Objects
Search...

Event Timeline

ECohen_WMDE created this task.Aug 9 2021, 3:39 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 9 2021, 3:39 PM
ECohen_WMDE mentioned this in T276574: Add reactive notices and warnings in VE template dialog.Aug 9 2021, 3:47 PM
ECohen_WMDE moved this task from Backlog to Ready for pickup on the WMDE-Templates-FocusArea board.Aug 10 2021, 7:27 AM
ECohen_WMDE added projects: WMDE-TechWish, VisualEditor-MediaWiki-Templates.
Maintenance_bot added a project: VisualEditor.Aug 10 2021, 7:45 AM
matmarex moved this task from To Triage to Triaged on the VisualEditor board.Aug 10 2021, 3:02 PM
ECohen_WMDE set the point value for this task to 3.Aug 11 2021, 1:57 PM
thiemowmde added a project: WMDE-TechWish-Sprint-2021-08-18.Aug 18 2021, 8:28 AM
Lena_WMDE moved this task from Ready for pickup to In sprint on the WMDE-Templates-FocusArea board.Aug 18 2021, 8:29 AM
awight claimed this task.Aug 27 2021, 11:47 AM
awight moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2021-08-18 board.
awight added a comment.Aug 27 2021, 12:04 PM

Noting that the "add unknown" input should probably get the same margins:

image.png (325×675 px, 22 KB)

awight added a comment.Aug 27 2021, 12:25 PM

@ECohen_WMDE How should the info box appear? With the original padding, like this?

image.png (580×724 px, 52 KB)

gerritbot added a comment.Aug 27 2021, 12:27 PM

Change 715226 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/VisualEditor@master] [WIP] Adjust template dialog margins

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

gerritbot added a project: Patch-For-Review.Aug 27 2021, 12:27 PM
awight removed awight as the assignee of this task.Aug 30 2021, 11:18 AM
awight moved this task from Doing to Sprint Backlog on the WMDE-TechWish-Sprint-2021-08-18 board.
awight subscribed.
awight claimed this task.Aug 30 2021, 11:29 AM
awight moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2021-08-18 board.
awight added a comment.Aug 30 2021, 11:34 AM

Confirmed offline: all elements will have the same padding.

awight updated the task description. (Show Details)Aug 30 2021, 11:34 AM
ECohen_WMDE added a comment.Aug 30 2021, 11:38 AM

Noting that the "add unknown" input should probably get the same margins:

Also confirming this. I had put a comment about this in the related ticket here: https://phabricator.wikimedia.org/T272487#7314425

awight removed awight as the assignee of this task.Aug 30 2021, 12:08 PM
awight moved this task from Doing to Review on the WMDE-TechWish-Sprint-2021-08-18 board.
gerritbot added a comment.Aug 30 2021, 12:17 PM

Change 715491 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/VisualEditor@master] Update template dialog help text

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

awight added a comment.Aug 30 2021, 12:26 PM

Just surfacing some nuance around this,

For templates without TemplateData remove the help text completely.

There are currently (before T276574) three cases, I'll explain and describe what I understand should be done in this task:

  • TemplateData exists and includes a description: show the new help text given here, and the description from templatedata.
  • Template page is missing: show no help text (currently shows "absent template" help text)
  • Otherwise: show no help text (currently shows "no template description" help text)
awight moved this task from Review to Doing on the WMDE-TechWish-Sprint-2021-08-18 board.Aug 30 2021, 12:27 PM
gerritbot added a comment.Aug 30 2021, 3:40 PM

Change 715542 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Try to use margin/padding instead of flex for template dialog

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

ECohen_WMDE added a comment.Aug 31 2021, 7:12 AM

TemplateData exists and includes a description: show the new help text given here, and the description from templatedata.

Yes. And if TemplateData exists but is missing a description, the description field will be empty but the help text will still show.

Template page is missing: show no help text (currently shows "absent template" help text)

Not sure I understand - how can a template exist but not have a page? And what is the "absent template" text? Do you mean the "This template is missing a description..."?

Otherwise: show no help text (currently shows "no template description" help text)

Otherwise don't show help text because in those cases, the template will get a message with more specific help text from T276574: Add reactive notices and warnings in VE template dialog

awight added a comment.Aug 31 2021, 7:27 AM
In T288465#7320900, @ECohen_WMDE wrote:

Template page is missing: show no help text (currently shows "absent template" help text)

Not sure I understand - how can a template exist but not have a page? And what is the "absent template" text? Do you mean the "This template is missing a description..."?

This is the case where a template doesn't exist. Current help text is:

The \"$1\" template doesn't yet exist
ECohen_WMDE added a comment.Aug 31 2021, 7:43 AM

Ah right, forgot about this case when writing the ticket. In this case I would leave the existing help text as is. Don't remove it.

~On a side note: I actually discovered the reason for the button that allows this the other day! It's so you can SUBST: a template from VE.

thiemowmde updated the task description. (Show Details)Aug 31 2021, 8:52 AM
WMDE-Fisch added a project: WMDE-TechWish-Sprint-2021-09-01.Sep 1 2021, 8:12 AM
thiemowmde moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2021-09-01 board.Sep 1 2021, 8:13 AM
gerritbot added a comment.Sep 1 2021, 8:37 AM

Change 715226 abandoned by Awight:

[mediawiki/extensions/VisualEditor@master] Adjust template dialog margins

Reason:

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

gerritbot added a comment.Sep 1 2021, 8:53 AM

Change 715542 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Try to use margin/padding instead of flex for template dialog

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

ReleaseTaggerBot added a project: MW-1.37-notes (1.37.0-wmf.23; 2021-09-13).Sep 1 2021, 9:00 AM
awight moved this task from Doing to Review on the WMDE-TechWish-Sprint-2021-09-01 board.Sep 1 2021, 9:52 AM
awight changed the point value for this task from 3 to 1.
awight added a comment.Sep 1 2021, 10:40 AM

@Lena_WMDE Should the help text changes stay behind our feature flag? Seems like it, since we're depending on other warnings to appear which are also behind the flag.

ECohen_WMDE updated the task description. (Show Details)Sep 1 2021, 1:05 PM
awight claimed this task.Sep 2 2021, 6:58 AM
awight moved this task from Review to Doing on the WMDE-TechWish-Sprint-2021-09-01 board.
awight updated the task description. (Show Details)Sep 2 2021, 12:25 PM
gerritbot added a comment.Sep 2 2021, 12:34 PM

Change 716290 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/VisualEditor@master] Tighten vertical gap between parameters

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

awight removed awight as the assignee of this task.Sep 2 2021, 12:35 PM
awight moved this task from Doing to Review on the WMDE-TechWish-Sprint-2021-09-01 board.
awight updated the task description. (Show Details)
gerritbot added a comment.Sep 2 2021, 1:20 PM

Change 715491 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Update template dialog help messages

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

gerritbot added a comment.Sep 2 2021, 1:49 PM

Change 716290 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Tighten vertical gap between parameters

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

Lena_WMDE added a comment.Sep 2 2021, 1:50 PM

@Lena_WMDE Should the help text changes stay behind our feature flag? Seems like it, since we're depending on other warnings to appear which are also behind the flag.

Yes I think that would make sense. Thanks! It could potentially go behind the increased dialog size feature flag.

awight added a comment.Sep 2 2021, 1:51 PM
In T288465#7328402, @Lena_WMDE wrote:

@Lena_WMDE Should the help text changes stay behind our feature flag? Seems like it, since we're depending on other warnings to appear which are also behind the flag.

Yes I think that would make sense. Thanks! It could potentially go behind the increased dialog size feature flag.

Thanks for the note, I've put behind a flag. But I used the "new sidebar" flag because I wanted to align with other recent messages that were added in T276574.

awight removed a project: Patch-For-Review.Sep 2 2021, 2:04 PM
awight moved this task from Review to Demo on the WMDE-TechWish-Sprint-2021-09-01 board.
gerritbot added a comment.Sep 9 2021, 2:11 PM

Change 720022 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Fix missing and flipped template dialog help messages

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

gerritbot added a project: Patch-For-Review.Sep 9 2021, 2:11 PM
thiemowmde moved this task from Demo to Review on the WMDE-TechWish-Sprint-2021-09-01 board.Sep 9 2021, 2:17 PM
Andrew-WMDE moved this task from Review to Demo on the WMDE-TechWish-Sprint-2021-09-01 board.Sep 10 2021, 9:19 AM
gerritbot added a comment.Sep 10 2021, 9:37 AM

Change 720022 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Fix missing and flipped template dialog help messages

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

Lena_WMDE moved this task from Demo to Done on the WMDE-TechWish-Sprint-2021-09-01 board.Sep 14 2021, 8:39 AM
Lena_WMDE closed this task as Resolved.Sep 14 2021, 8:51 AM
Lena_WMDE claimed this task.
thiemowmde closed subtask T290136: Internal bug: MWTemplateSpecModel.isDocumented gives incorrect result for missing templates as Resolved.Sep 14 2021, 8:51 AM
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