We want to know:
- Scanner button clicked
- Barcode read
- Resulting citation inserted
This will go into the VisualEditorFeatureUse schema alongside the existing tracking that was implemented in T221305.
Description
Description
Details
Details
Related Changes in Gerrit:
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| Barcode scanning | mediawiki/extensions/Citoid | master | +1 K -3 |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | ppelberg | T216775 Add ability to cite books by scanning their ISBN barcode in mobile web | |||
| Open | None | T231031 Instrument usage of ISBN barcode scanner |
Event Timeline
Comment Actions
Stages we could instrument:
- Click on the scanner button
- Get a successful read OR close the dialog without a read
As successful ISBN read automatically submits the Citoid search form, so the next step would be
- Insert a citation generated after use the tool
Comment Actions
what sort of things they scan (presumably: 99.9% books, but let's confirm that)
The tool only reads ISBNs, which stands for International Standard Book Number[0], so...
0. https://en.wikipedia.org/wiki/International_Standard_Book_Number
Comment Actions
Educational DVDs can get them too! Though I admit I didn’t bother to look up whether there’s any distinguishing characteristic in the code.
Comment Actions
I suppose we could log the ISBN itself for later analysis, but that may require some privacy considerations? Or maybe just the ISBN prefix if that contains enough information.
Comment Actions
The scanner reads all EANs, so you could log all stuff before the /^97[89]/ filter to see whether there are users trying to cite something from their breakfast cereal box by scanning its barcode ...
Comment Actions
The problem that is that even if you point your camera at a valid ISBN you get a bunch of partial reads that are valid EANs, so filtering out everything except ISBNs is crucial to the scanner working sensibly.
Comment Actions
So I think we should begin with the following
- Scanner button clicked
- Barcode read
We don't really need to log the close button as we can infer that from the drop off rate between 1 & 2.
We should then set an "Scanner used" flag that isn't cleared until the "auto" field is next changed. While this flag is set we should record:
- Citation inserted
I don't think we need to know if the ISBN lookup found results as that should almost always work, and we could get that data from the server logs anyway.
Comment Actions
Change 493494 had a related patch set uploaded (by Esanders; owner: Esanders):
[mediawiki/extensions/Citoid@master] Barcode scanning
Comment Actions
Test wiki created on Patch Demo by ESanders (WMF) using patch(es) linked to this task:
Comment Actions
Test wiki created on Patch demo by ESanders (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/b9bf6906b0/wiki/Douglas Adams
Comment Actions
Test wiki on Patch demo by ESanders (WMF) using patch(es) linked to this task was deleted:
Comment Actions
Test wiki created on Patch demo by ESanders (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/1346aed9a7/wiki/Douglas Adams
Comment Actions
Test wiki on Patch demo by ESanders (WMF) using patch(es) linked to this task was deleted:
Comment Actions
Test wiki on Patch demo by ESanders (WMF) using patch(es) linked to this task was deleted:
Comment Actions
Test wiki created on Patch demo by ESanders (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/3b416c7370/wiki/Douglas Adams
Comment Actions
Change 493494 merged by jenkins-bot:
[mediawiki/extensions/Citoid@master] Barcode scanning
Comment Actions
https://inventaire.io/add/scan also has this available for desktop using the webcam... maybe worth considering?
Comment Actions
@Mvolz there's a preference included that'll turn it on for desktop-citoid, in which case I believe it'd use the webcam. I think it might be more contentious from a security perspective just because it's almost-guaranteed to be a camera pointing at the user's face, whereas the phone camera is almost-certainly pointing away from them.
Comment Actions
Test wiki on Patch demo by ESanders (WMF) using patch(es) linked to this task was deleted:
Comment Actions
@DLynch: Per emails from Sep18 and Oct20 and https://www.mediawiki.org/wiki/Bug_management/Assignee_cleanup , I am resetting the assignee of this task because there has not been progress lately (please correct me if I am wrong!). Resetting the assignee avoids the impression that somebody is already working on this task. It also allows others to potentially work towards fixing this task. Please claim this task again when you plan to work on it (via Add Action... → Assign / Claim in the dropdown menu) - it would be welcome. Thanks for your understanding!