Fix obscured 'Comment' bug
Needs ReviewPublic

Authored by michaelh on Apr 7 2018, 6:49 PM.

Details

Reviewers
ngraham
Group Reviewers
Baloo
Dolphin
Summary

Since R824:caf155114b3b users can check/uncheck userComments in InfoPanel's config dialog.
Because of the same label this obscures the setting for comments stored in the file.

Test Plan

Visual inspection
Check/Uncheck 'User Comment' and 'Comment' checkboxes.

Diff Detail

Repository
R824 Baloo Widgets
Branch
userComment (branched from Applications/18.04)
Lint
No Linters Available
Unit
No Unit Test Coverage
michaelh created this revision.Apr 7 2018, 6:49 PM
Restricted Application added a project: Baloo. · View Herald TranscriptApr 7 2018, 6:49 PM
michaelh requested review of this revision.Apr 7 2018, 6:49 PM
michaelh added inline comments.
src/filemetadataprovider.cpp
397

The label name is not good. Maybe a native speaker can come up with something better.

michaelh edited the summary of this revision. (Show Details)Apr 7 2018, 6:52 PM
bruns added a subscriber: bruns.Apr 7 2018, 6:55 PM
bruns added inline comments.
src/filemetadataprovider.cpp
397

Annotation, Note

michaelh added inline comments.Apr 7 2018, 7:13 PM
src/filemetadataprovider.cpp
397

Another idea: Keep the userComment as "Comment" and use "Description" for comment

elvisangelaccio added inline comments.
src/filemetadataprovider.cpp
397

Note that this is a string change and will need approval from the i18n team before landing on 18.04

Does this change the string that's displayed in the UI? If so, maybe just "Comments" or "Notes"

michaelh added a comment.EditedApr 8 2018, 6:25 AM

Does this change the string that's displayed in the UI? If so, maybe just "Comments" or "Notes"

It does. Currently it is:

UIinternal name
CommentuserComment
Commentcomment

We should not use a plural here, because because both are single-value properties. And there is some singular/plural confusion already present with e.g. Artist, Language an so on. see D10803.

Additional note:
For ODF, MSOffice docs and ebooks kfilemetadata translates the dc:description field to Property::Comment.

so comment is an extracted property, and userComment is the thing that you can set in Dolphin?

so comment is an extracted property, and userComment is the thing that you can set in Dolphin?

Yep, comment is extracted, userComment is in xattr.

OK, I like your last idea, Michael. I'd be okay with this:

It does. Currently it is:

UIinternal name
CommentuserComment
Descriptioncomment

As long as that doesn't conflict with a potential real "description" tag, of course.

bruns added a comment.Apr 8 2018, 8:05 PM

Additional note:
For ODF, MSOffice docs and ebooks kfilemetadata translates the dc:description field to Property::Comment.

So for dc:description "Description" is obviously a good fit, and we are just tunneling it through a badly name Property. Which other file/metadata tags fill in this property?

On second thought I think it is cleaner to do D12114 and to rename userComment from "Comment" to "Notes"

bruns added a comment.May 9 2018, 10:55 PM

If the current use of Property::Comment for dc::description is changed to Property::Description (see D12114), there no longer is a name clash with Comment

I have checked for other users of user.xdg.comment, apparently only KDE supports it.

I have checked DublinCore, there is (currently) no clash with a hypothetical "dc:note" or "dc:comment" property.

My vote is on doing D12114 and using Property::Comment resp. "Comment" (UI) for xdg.user.comment.