Context
We want to improve the user experience around the TemplateDialog that's used for citation templates. To test assumptions around the usage of the citation template form we need to instrument it fully.
Since the TemplateDialog is also used when users edit and add templates outside of citation templates, we want to give context to the events tracked so that we're able to differentiate the usage with/without citation templates.
Task
This task is about adding missing instrumentation to citation templates and adding context to the all other instrumentation already present in the TemplateDialog so that we can conduct analysis in superset.
Wikipedias: all
Properties: all general VisualEditor featureuse properties should be sent with the instrumentation event (e.g. edit count, timestamps, wiki, session ids, etc.).
Additional buttons and interactions to instrument for editing citation templates:
- Hide unused and show all (left hand side)
- input in search bar (left hand side)
- check/uncheck properties (left hand side)
- Click on 'more' / 'less' (right side)
- pop up ' Required field missing'
- button in pop-up 'go back' and 'continue anyway'
- Click on question mark (bottom right side)
- Click on links in help pop-up in template dialog
Scope: All Wikipedias
Acceptance Criteria
- Instrumentation events for the above items are available in Superset.
- Create a table with the new event keys
- Add the new events to https://www.mediawiki.org/wiki/VisualEditor/FeatureUse_data_dictionary (Only transclusion, not transclusion-cite)
- TemplateDialog events can be differentiated by origin
- Create new patch demo for viewing events in the dev tools' console tab.
Tracking Events
transclusion = All templates
transclusion-cite = Citation templates
| action | feature | description | done? |
|---|---|---|---|
| required-field-warning-shown | transclusion | Pop-up warning shown that a required field is missing | yes |
| required-field-warning-shown | transclusion-cite | Pop-up warning shown that a required field is missing | yes |
| required-field-go-back | transclusion | User clicked "Go back" on the required field missing pop-up | yes |
| required-field-go-back | transclusion-cite | User clicked "Go back" on the required field missing pop-up | yes |
| required-field-continue | transclusion | User clicked "Continue anyway" on the required field missing pop-up | yes |
| required-field-continue | transclusion-cite | User clicked "Continue anyway" on the required field missing pop-up | yes |
| link-click-keyboard-shortcuts | transclusion | User clicked the "Keyboard shortcuts" link in the help pop-up | yes |
| link-click-keyboard-shortcuts | transclusion-cite | User clicked the "Keyboard shortcuts" link in the help pop-up | yes |
| link-click-edit-templates | transclusion | User clicked the "Help for editing templates" link in the help pop-up | yes |
| link-click-edit-templates | transclusion-cite | User clicked the "Help for editing templates" link in the help pop-up | yes |
| parameter-expand | transclusion | User clicked "More" to expand additional parameter field | yes |
| parameter-expand | transclusion-cite | User clicked "More" to expand additional parameter field | yes |
| parameter-collapse | transclusion | User clicked "Less" to collapse additional parameter field | yes |
| parameter-collapse | transclusion-cite | User clicked "Less" to collapse additional parameter field | yes |
| help-dialog-open | transclusion | User clicked the question mark (help icon) to open the help dialog | yes |
| help-dialog-open | transclusion-cite | User clicked the question mark (help icon) to open the help dialog | yes |
| add-unknown-parameter | transclusion | User added a parameter that was not listed in the template | yes |
| add-unknown-parameter | transclusion-cite | User added a parameter that was not listed in the template | yes |
| edit-parameter-value | transclusion | User typed or changed a value in a parameter input field | yes |
| edit-parameter-value | transclusion-cite | User typed or changed a value in a parameter input field | yes |
| template-doc-link-click | transclusion | A user clicked the template dialog help link, leading to the template page | yes |
| template-doc-link-click | transclusion-cite | A user clicked the template dialog help link, leading to the template page | yes |
| parameter-check | transclusion | User selected a parameter checkbox | yes |
| parameter-check | transclusion-cite | User selected a parameter checkbox | yes |
| parameter-uncheck | transclusion | User deselected a parameter checkbox | yes |
| parameter-uncheck | transclusion-cite | User deselected a parameter checkbox | yes |
| search-input | transclusion | User typed in the search bar to filter parameters | yes |
| search-input | transclusion-cite | User typed in the search bar to filter parameters | yes |
| hide-unused-parameters | transclusion | User clicked "Hide unused" to hide deselected parameters | yes |
| hide-unused-parameters | transclusion-cite | User clicked "Hide unused" to hide deselected parameters | yes |
| show-all-parameters | transclusion | User clicked "Show all" to display all selected parameters | yes |
| show-all-parameters | transclusion-cite | User clicked "Show all" to display all selected parameters | yes |