Page MenuHomePhabricator

Edit Check: Enable Edit Checks to evaluate content within templates
Open, Needs TriagePublic

Description

Background

At the moment, the Edit Checks just react to content included within the article but not within templates included in the article (e.g. Infobox).

We should consider adjusting the Edit Checks to also identify issues within templates, specifically highlighting the problematic sections of the text.

Design proposal

Once the design proposal has been created in Figma, remove this note and link the Figma file below.

Design proposal

Open questions

Add here the questions to be answered in order to design and implement the component

Acceptance criteria (or Done)

Design

  • Explore solutions to display Edit Checks in article's template

Implementation

  • Evaluate if this is feasible and in which templates it will apply
  • Implement the solution proposed (if finally needed)

Event Timeline

Unfortunately template renderings are generally not visible to VE. Fixing this is an extremely complex problem that would take several quarters work, mostly within the content transform team. It has been discussed many times over the past 10+ years but is unlikely to be fixed any time soon.

If we were to come up with a solution for editing template parameters inline, it is very likely that this issue would be resolved automatically as it uses core VE APIs for editing, so I don't think we need a separate task for this issue.

Wellverywell subscribed.

That's... unexpected to say the least.
If adding support for templates editing is too hard, what about something like just allowing VE to just "view" inline templates' text? Not for editing (and so nothing changes for VE user -- still can see the text in template but still can't edit) but at least so that they could be matched by EditCheck.

You could do that but there's no way of knowing which part of the template is generated from its parameters, and therefore "editable" by most users. It would be odd to suggest an issue with a template that was caused by a data label in that template, for example.

Well, in the way I'm imagining that it wouldn't be required -- and "we can detect issues in all text of templates but can't limit to which isn't user-provided" is IMO better than "we can't detect issues in templates". It also wouldn't be that odd in my opinion -- if there's indeed a real issue it makes a perfect sense to display it in each template's occurence.