WMDE Technical Wishes/VisualEditor template dialog improvements/Release notes

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search

Add and remove parameters in the sidebar using checkboxes (T272368)[edit]

Previous behavior (removed)[edit]

  • Remove parameter with trash can
  • Add parameter with the “Add more information” dropdown component

Existing behavior (remains)[edit]

  • Clicking on the name of a parameter in the sidebar will scroll to that parameter on the right hand side. Sidebar can be used like a table of contents to navigate the template

New behavior[edit]

  • The entire parameter list is visible in the sidebar
  • Checking a parameter in the sidebar makes it visible in the main area and adds it to the template invocation
  • Unchecking a parameter removes it from the template invocation
  • Required parameters have a disabled checkbox so that they cannot be removed from the template invocation
  • Recommended parameters are automatically added to a template invocation, but they can be easily removed by unchecking them
  • Sidebar remains open while editing and the dialog size is bigger, for better navigation

Search for parameters in the sidebar using the search field at the top (T272481)[edit]

Previous behavior (removed)[edit]

  • Search was integrated into the “Add more information” component

Existing behavior (remains)[edit]

  • Search terms find results based on names and descriptions to find relevant parameters (ie. same search, just in a new location)

New behavior[edit]

  • Parameter search has an input field underneath each template name in the sidebar
  • When a search term is entered, it filters both the list in the sidebar and in the main area to help you find both parameters that you would like to add and parameters that are already part of the template invocation

Add undocumented parameters with a dedicated input and instructions (T272487)[edit]

Previous behavior (removed)[edit]

  • Adding undocumented parameters behavior was integrated into the “Add more information” dropdown, mixed in with adding documented parameters

Existing behavior (remains)[edit]

  • Ability to add a parameter that is missing from the documentation

New behavior[edit]

  • “Add undocumented parameter” is now its own input component with instructions and error messages to help the user understand what they need to do and when it is relevant to add parameters in this way
  • The input is visible when parameters cannot be autogenerated, there are no parameters documented, or an undocumented parameter has already been added to the template (for example, in the wikitext)
  • If you would like to add an undocumented parameter and the input is not visible, you can use a shortcut to make it appear: Ctrl+Shift+D

Tools only visible when editing relevant content (T272482)[edit]

Previous behavior (removed)[edit]

  • Toolbar for adding parameters, templates, wikitext, and removing template invocations accessible by clicking the “Show options” button to open the sidebar
  • Toolbar mixed functions of editing multi-part template content and adding undocumented parameters

Existing behavior (remains)[edit]

  • Ability to edit existing multi-part template content, including adding additional template or wikitext, remove elements and change their order (when selecting in VE, the entire chunk of related content is highlighted as one element and edited simultaneously in the dialog)

New behavior[edit]

  • Toolbar only displays actions related to multi-part content (adding and removing templates, wikitext, and reordering content)
  • The toolbar is only visible when editing existing multi-part template content
  • If you would like to turn a single template into a multi-part template but the toolbar is not visible, you can use shortcuts to do so. These shortcuts can also be used if the toolbar is visible.
- Add a template: Ctrl+D (or Cmmd+D on mac)
- Add wikitext: Ctrl+Shift+Y (or Cmd+Shift+Y on mac)
  • If you prefer keyboard navigation, all of the tools in the toolbar can be used with shortcuts. First, tab to the template name or wikitext title in the sidebar and press Spacebar to select it.
- To move up: Ctrl+Shift+Up arrow (Cmd+Shift+Up arrow on mac)
- To move down: Ctrl+Shift+Down arrow (Cmd+Shift+Down arrow on mac)
- To delete: Ctrl+Del (Cmd+Del on mac)

Additional help messages integrated into the interface (T276574)[edit]

Previous behavior (removed)[edit]

  • None

Existing behavior (remains)[edit]

  • When templates have TemplateData their description is displayed
  • In all cases, the link to the template’s page is displayed

New behavior[edit]

  • Additional messages were added to help users understand the state of the template they are editing, including:
- When template parameters have been autogenerated
- When no parameters can be autogenerated and no parameters have been documented
- When encountering muli-part template content

[[]] button removed (T285669)[edit]

Previous behavior (removed)[edit]

  • [[]] ‘wikitext’ button would force a parameter field to turn into a plain wikitext field and remove validation. This was not needed as fields already allow wikitext and most do not validate. The button was found to only confuse and increase tabs between fields (reducing accessibility)

New behavior[edit]

  • Users can continue to use wikitext in the standard fields as before, no need to use a button

Keyboard navigation added (T285323)[edit]

Existing behavior (remains)[edit]

  • Tab between interactive elements

New behavior[edit]

  • When parameter list is focused in the sidebar:
- Use arrow keys to move been parameters
- ‘Enter’: selects parameter and moves focus to the main area to add the value
- ‘Spacebar’: selects the parameter but keeps the focus in the list (allows users to easily add many parameters at once using the keyboard)
  • When editing multi-part template content: When template name or wikitext element is in focus,
- ‘Spacebar’: selects the template so that the toolbar actions can be applied to it (remove, or move up and down), including by using shortcuts (see section 4.3)