Background
Currently, there are only two states with descriptions. Template descriptions from TemplateData and a message about templates missing TemplateData. We are expanding how many states/types of content get messages.
This is being done to give users better information about what they are seeing, why it looks the way it does and what they need to do next based on that. Each will also have links directly to relevant documentation for confusing terms and concepts.
Requirements
- Add new notices and warnings, showing the various relevant ones as needed for each state described below. Use OOUI components: MessageWidget (type: 'notice') and (type: 'warning').
- Show messages for single templates also when they are part of a transclusion with multiple parts (row 3 in the table below).
- All links open in new tabs
Note: current no TemplateData message is removed in T288465: VE template dialog: Update description margins and help text
New mocks and text
| State | MessageWidget | Mock | Text | ||
|---|---|---|---|---|---|
| Single Template | without TemplateData | params autogenerated | Warning |  | This template is missing TemplateData[3], and its parameters have been autogenerated[4]. As a result the template and its parameters lack descriptions. There might be additional information on this template’s page[1]. |
| Single Template | with OR without TemplateData | no parameters are documented OR params cannot be autogenerated | Notice |  | This template may be intended for use without parameters[2]. If this template does contain parameters, they are undocumented[4]. |
| Template content (previously multi-part) | - | - | Notice |  | You are currently editing a template and one or more pieces of connected content[4] (wikitext and/or additional templates). |
Mocks and specs when combined
- 48px between "chunks"
- 16px between elements within "chunks"
Links
[1] Link to the template page
[2] https://www.mediawiki.org/wiki/Help:Templates#Parameters
[3] https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide#Template_parameters (content to be improved)
[4] (content to be created, link to documentation to come)