Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better display of which reconciliation service a specific column is reconciled against #4824

Open
lozanaross opened this issue May 1, 2022 · 4 comments · May be fixed by #6156
Open

Better display of which reconciliation service a specific column is reconciled against #4824

lozanaross opened this issue May 1, 2022 · 4 comments · May be fixed by #6156
Assignees
Labels
reconciliation API design when changing the reconciliation API is required to improve a workflow

Comments

@lozanaross
Copy link

Currently a default OpenRefine workflow supposes users only reconcile data against a single service, e.g. Wikidata, and then proceed towards schema building and data upload with this single service in mind. However, in reality - with the introduction of the possibility to reconcile against and upload data edits to any arbitrary Wikibase (and soon Wikimedia Commons too, thanks to the work on the Commons extension) - users may wish to work across several services at once. For example enriching (or extending) a dataset from one Wikibase with data from another, in addition to also including data from various other authority control sources (e.g. GND, Getty’s ULAN, VIAF, etc). Currently, however, once a reconciliation operation is carried out — there is no easy visual cue to a user to specify what each column has been reconciled against, leading easily to making mistakes during schema building.

Proposed solution

The proposal here is to introduce small logos of the reconciliation service in question right underneath the column name (and column options menu), adjacent to the status bar that indicates if a column has been fully reconciled or not:
Image

In addition these logos could also be integrated in the UI during Schema building, like so:
Image

A further complication here is that reconciliation service maintainers will need to include a logo in their manifest in order for the OpenRefine UI to be able to display it then in the two locations identified above. If no logo is provided, the name of the service may need to be spelled out in full - although this solution is not ideal due to potential of having to display long names in small font sizes (see below in Alternatives considered). The latter also won’t be practical in the schema building UI and therein column rendering should remain as it has been until now.

Alternatives considered

Alternative considerations included a change in color scheme for each service. However this can easily introduce issues with regards to accessibility: if random colors are assigned to each service - making sure there is enough contrast between different colors and between different states (i.e fully reconciled vs partially reconciled) would add additional complexity to the UI. Furthermore, this would be a departure from currently established OpenRefine branded color palette.

Another solution was to spell out the name of the service in type beneath the green bar indicating state of the reconciliation completion, but this would also be difficult to balance in terms of size of font (so that it's legible) vs length of the title of the service.

Additional context

This issue concerns a UI enhancement proposed during the design process for the Wikimedia Commons extension (see the wireframes where this solution was first introduced here: https://commons.wikimedia.org/wiki/File:Structured_Data_on_Commons_file_upload_in_OpenRefine_-_wireframes_draft_v2.pdf), however it is not specific to that extension alone, but rather can be useful to the core OpenRefine UI, too.

@trnstlntk trnstlntk added the reconciliation API design when changing the reconciliation API is required to improve a workflow label May 1, 2022
@thadguidry
Copy link
Member

@lozanaross @wetneb I'm fine with the logos, but I think the logos additionally should have hover text for the service name coming off the manifest?

@wetneb
Copy link
Sponsor Member

wetneb commented May 2, 2022

Sounds sensible indeed!

@lozanaross
Copy link
Author

@lozanaross @wetneb I'm fine with the logos, but I think the logos additionally should have hover text for the service name coming off the manifest?

@thadguidry Great, yes - I agree.

@wetneb
Copy link
Sponsor Member

wetneb commented Oct 23, 2023

@ayushrai206 here is a test service which advertises a logo:
http://wdreconcile.pintoch.ulminfo.fr/en/api
You should be able to use this to test your work on this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
reconciliation API design when changing the reconciliation API is required to improve a workflow
Projects
Status: Done
Status: 📡 On the radar / Dependencies
6 participants