Comment syntax shown in template's name in VisualEditor
Closed, ResolvedPublic0 Estimated Story Points
Actions

Assigned To

Authored By

	matmarex
	Feb 15 2015, 7:31 PM

Description

Comment syntax is shown in template's name in VisualEditor if a comment is included in the template invocation in wikitext.

Example: https://en.wikipedia.org/wiki/Skyfall#Box_office has a {{multiple image}} template included as such:

{{multiple image
<!-- Essential parameters -->
| align     = left
| direction = vertical
…
}}

When that article is opened for editing in VisualEditor, the name of the template in the context menu is shown as "multiple image ". (The template can be edited and the changes saved just fine, and the dialog correctly has "Multiple image" in the header, so this is presumably a VE and not a Parsoid issue.)

The dialog also has other comments inside that appear in the fields for template values, but that falls under T52355 I suppose.

Details

	Subject	Repo	Branch	Lines +/-
	Add !!html/php parser test for HTML comment after template name	mediawiki/core	master	+20 -6

Customize query in gerrit

Related Objects

Mentioned Here: rEVED624211a60f52: Use Parsoid data for template names rather than detect from wikitext
T150468: A template transclusion with an HTML comment after the template name cannot be adapted by Content Translation
T52355: VisualEditor: Add support for editing templates' parameters as DOM elements ("visually"), including supporting nested templates

Event Timeline

matmarex created this task.Feb 15 2015, 7:31 PM

matmarex raised the priority of this task from to Needs Triage.

matmarex updated the task description. (Show Details)

matmarex added projects: VisualEditor, VisualEditor-MediaWiki, VisualEditor-MediaWiki-Templates.

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 15 2015, 7:31 PM

Jdforrester-WMF triaged this task as Low priority.Feb 17 2015, 12:13 AM

Jdforrester-WMF moved this task from To Triage to Freezer on the VisualEditor board.

Jdforrester-WMF set Security to None.

matmarex merged a task: T101493: Hidden HTML comment appears to be part of the template's name, when the template is selected.Jun 14 2015, 10:29 AM

matmarex added a subscriber: • Whatamidoing-WMF.

Jdforrester-WMF merged a task: T123353: Visual editor misparses comments in templates.Jan 26 2016, 8:19 PM

Jdforrester-WMF added subscribers: coren, StudiesWorld.

coren awarded a token.Feb 5 2016, 5:45 PM

Jdforrester-WMF merged a task: T150476: An HTML comment after a template name in a transclusion appears in VisualEditor's popup.Nov 10 2016, 7:38 PM

Jdforrester-WMF added a subscriber: Amire80.

So, T150468 appears to be related, and it's in Content Translation and not really VE, so maybe it is in Parsoid?

In T89615#2787110, @Amire80 wrote:

So, T150468 appears to be related, and it's in Content Translation and not really VE, so maybe it is in Parsoid?

This is invalid wikitext, and Parsoid is trying its best. Mostly I think we should get users to not try to break the wikis. :-)

In T89615#2787114, @Jdforrester-WMF wrote:

In T89615#2787110, @Amire80 wrote:

So, T150468 appears to be related, and it's in Content Translation and not really VE, so maybe it is in Parsoid?

This is invalid wikitext, and Parsoid is trying its best. Mostly I think we should get users to not try to break the wikis. :-)

This appears to be good enough for page rendering, so it looks like at the moment the users don't notice that it's invalid. I also cannot find that it's invalid in parser tests. Is it documented anywhere?

I'm fine with suggesting users to get rid of instances of such comments with a bot or something along these lines, but it should be at least based on parser documentation.

There's not really a "spec" for wikitext, of course: https://lists.wikimedia.org/pipermail/wikimedia-l/2016-November/085415.html

@Amire80 found a relevant parser test, and added a clause for the PHP parser: https://gerrit.wikimedia.org/r/320973

The relevant fragment of parsoid output from the parser test is:

"target":{"wt":"echo\n&lt;!-- should be ignored -->\n","href":"./Template:Echo"},"

which is as it should be: we parse it correctly as an invocation of Template:Echo, and provide the raw wikitext (including all relevant whitespace or non-semantic content).

VisualEditor should probably use the href field here in its context menu, not the wt field; this seems like a VE UI bug. Once you open the template for editing, perhaps you'd want to be able to edit the raw wikitext, but the href field is more appropriate in terms of showing the user which template is represented.

Change 320973 had a related patch set uploaded (by C. Scott Ananian):
Add !!html/php parser test for HTML comment after template name

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

gerritbot added a project: Patch-For-Review.Nov 11 2016, 5:36 PM

Change 320973 merged by jenkins-bot:
Add !!html/php parser test for HTML comment after template name

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

ReleaseTaggerBot added projects: MW-1.29-release-notes, MW-1.29-release (WMF-deploy-2016-11-15_(1.29.0-wmf.3)).Nov 11 2016, 11:00 PM

Krinkle removed projects: MW-1.29-release (WMF-deploy-2016-11-15_(1.29.0-wmf.3)), Patch-For-Review.May 25 2017, 1:49 PM

In T89615#2789085, @cscott wrote:

VisualEditor should probably use the href field here in its context menu, not the wt field; this seems like a VE UI bug. Once you open the template for editing, perhaps you'd want to be able to edit the raw wikitext, but the href field is more appropriate in terms of showing the user which template is represented.

Looks like I've done this a while ago with rEVED624211a60f52: Use Parsoid data for template names rather than detect from wikitext.

Restricted Application added a project: User-Ryasmeen. · View Herald TranscriptMay 10 2018, 9:45 PM

Jdforrester-WMF added a project: MW-1.30-release-notes (WMF-deploy-2017-06-27_(1.30.0-wmf.7)).May 10 2018, 11:05 PM

Jdforrester-WMF set the point value for this task to 0.

Comment syntax shown in template's name in VisualEditorClosed, ResolvedPublic0 Estimated Story PointsActions

Description

Details

Related Objects

Event Timeline

Comment syntax shown in template's name in VisualEditor
Closed, ResolvedPublic0 Estimated Story Points
Actions