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

Make it clear that summary is mandatory for Wikibase upload #6306

Open
cooperzoe opened this issue Jan 15, 2024 · 6 comments
Open

Make it clear that summary is mandatory for Wikibase upload #6306

cooperzoe opened this issue Jan 15, 2024 · 6 comments
Labels
Status: Pending Review Indicates that the issue or pull request is awaiting review by project maintainers or collaborators Type: Feature Request Identifies requests for new features or enhancements. These involve proposing new improvements.

Comments

@cooperzoe
Copy link

When I was close to finishing my Wikibase edit and needed to add a summary in the upload menu, it wasn't clear to me that the summary was mandatory for the upload to work.

Let's add a visual cue - for example, an asterisk - to indicate the field is required.
Upload edits

@cooperzoe cooperzoe added Status: Pending Review Indicates that the issue or pull request is awaiting review by project maintainers or collaborators Type: Feature Request Identifies requests for new features or enhancements. These involve proposing new improvements. labels Jan 15, 2024
@thadguidry
Copy link
Member

I think asterisk is not enough and can be confusing. We can have a div that includes the asterisk, and div/span next to it with some translatable text element. We could then reuse this "required" div in many input fields throughout OpenRefine when the field is required.

image

@trnstlntk
Copy link
Contributor

trnstlntk commented Jan 15, 2024

? It's not mandatory on the side of the website that is being uploaded to (at least not on Wikibases, Wikidata, Wikimedia Commons) so the upload should not fail on the OpenRefine side if the user does not fill in anything.

@wetneb
Copy link
Sponsor Member

wetneb commented Jan 15, 2024

@thadguidry yes it would be good to have a unified way to mark such fields as required (I also can't remember on top of my mind any field in the UI where we currently signal the fact that it is required visually). It would be useful for instance for the column name field in "add column based on this column".

I can share why I made this field mandatory when first developing this feature (happy to change it). When uploading edits to a Wikibase, OpenRefine tries to minimize the number of edits it makes on each entity. For instance, if you are adding two statements on the same Wikidata item, they will generally be added in a single edit. That saves time and computing resources on the Wikibase instance. As a consequence, the edit summary that is automatically generated by Wikibase for this edit will be something like "Updated Item: ". When reviewing the history of a Wikidata item, those sorts of summaries are very uninformative, so I thought it's good to encourage users to supply a more descriptive summary of their own.
I think it makes sense that the Wikibase UI does not ask for summaries on its side, since it would be very cumbersome to have to supply that for each manual edit, for which the automated summaries will generally work well enough.

@t8210103
Copy link
Contributor

t8210103 commented May 2, 2024

Hello, i would like to be assigned this issue.
Also, according the implementation, should i add a "* required" as suggested, should i add a pre-made standardized message that can be edited (by clicking on the input box as it is right now) and helps the user from having to fill the empty input or should i focus on creating automated summaries (which can also be edited), that represent the edits the user is about to upload?
If i should implement the last proposal, i would like some guidance on how to collect necessary information about the edits, so i can create custom messages.

@wetneb
Copy link
Sponsor Member

wetneb commented May 2, 2024

I would go for marking the field as required. I am not sure if we use the * sign anywhere else in the UI, but perhaps it's widespread enough to be understood anyway.

If I remember correctly, when trying to validate the form without a summary, we currently only focus the field but not make it clearer that it's required. In some forms there is an additional explanation that shows up in such a case, such as a "This field is required." in red. Maybe we could also consider that.

@wetneb
Copy link
Sponsor Member

wetneb commented May 2, 2024

I just remembered that HTML actually has a required attribute for form inputs which would very well do the job (for implementing the "This field is required" hint):
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Review Indicates that the issue or pull request is awaiting review by project maintainers or collaborators Type: Feature Request Identifies requests for new features or enhancements. These involve proposing new improvements.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants