Whenever one of the following actions is completed we want to log it. For that we can use ve.track as for example in https://gerrit.wikimedia.org/g/mediawiki/extensions/Cite/+/d70af9b1ba0e1edb0b92d02a72a6a1ca56c2f7fc/modules/ve-cite/ve.ui.MWCitationNeededContextItem.js#102
Implementation details
- Check what might already be logged in https://www.mediawiki.org/wiki/VisualEditor/FeatureUse_data_dictionary
- In every case we need key for each event. Defining these is part of this task and each could be documented in the parent ticket
- Opens of the cite dialog. Make sure this works with/without Citoid.
Could be different events depending on workflow
- feature: activity.citoid, action: window-open-from-command ( when Citoid is installed )
- feature: activity.reference, action: window-open-from-tool ( when opening re-use or basic without Citoid )
- feature: activity.reference, action: window-open-from-trigger ( when opening basic without Citoid )
- feature: activity.cite, action: window-open-from-command ( when opening the dialog for a template based reference without Citoid )
- Opens of the re-use tab
https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Cite/+/1023053
- feature: activity.reference, dialog-open-reuse`
https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Citoid/+/1023055
- feature: activity.citoid, action: panel-switch-reuse
- Actively uses of the re-use dialog ( defined by interacting with the search box/scrolling through the list ). This is sticky per opening of the dialog, so we are recording either 0 or 1.
https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Cite/+/1023053
- feature: activity.reference, action: reuse-dialog-use ( Cite & Citoid )
-
Left the re-use dialog after actively using it without adding a reference re-use (e.g. pressing ESC or clicking outside of the dialog).
In the aggregation step of the data, we could merge above activities that fall under the same edit session and then a separate "closed-with-active-reuse-usage" event should be obsolete.
- Left the re-use dialog successfully by adding a reference re-use
- feature: activity.reference, action: reuse-choose
- Tries to add a new reference using the dialog. We don't care if this actually ended in a new reference being added to the article, only that a selection in the cite dialog was made.
- feature: activity.reference, action: dialog-insert ( without template )
- feature: activity.cite, action: dialog-done ( with using a template )
- feature: activity.citoid, action: automatic-insert ( inserting an auto generated reference )