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

PICARD-2130: Refactor cover art options #1757

Merged
merged 4 commits into from Mar 3, 2021
Merged

Conversation

phw
Copy link
Member

@phw phw commented Mar 3, 2021

Summary

  • This is a…
    • Bug fix
    • Feature addition
    • Refactoring
    • Minor / simple change (like a typo)
    • Other
  • Describe this change in 1-2 sentences:

Problem

The cover art options are currently not quite clear and can be confusing:

  • The option "Use the first image type as the filename." is placed on CAA options, but applies globally
  • Same for the "Save only one front image as separate file"
  • It is not clear how images not affected by "Use the first image type as the filename." are saved, as the image name configuration is done elsewhere
  • Some cover options apply to saving images as files, some for embedding images, but it is not quite clear what does what
  • Inconsistent wording between "Save only one front image as separate file" and "Only embed a front image", even though both are conceptually very similar (one for saving separate files, one for embedding)
  • Add the placeholder text "cover" to the cover_image_filename input. If this input is empty Picard will fall back to use just "cover" as filename, and having this placeholder text helps

Solution

  • Rename the option to caa_image_type_as_filename to image_type_as_filename and move it to the global Cover options
  • Rename the option to caa_save_single_front_image to save_only_one_front_image and move it to the global Cover options. This is consistent with the similar embed_only_one_front_image option.
  • Separate Cover options into those for embedding and those for saving as files. This makes it clear which option actually applies. Also unavailable options are inactive.
  • If save_only_one_front_image is enabled deactivate the image_type_as_filename checkbox, as it no longer applies (no non-front images will be saved)
  • Consistent wording: "Embed only a single front image" and "Save only a single front image as separate file"
  • Add the placeholder text "cover" to the cover_image_filename input. If this input is empty Picard will fall back to use just "cover" as filename, and having this placeholder text helps

grafik

phw added 2 commits March 3, 2021 09:59
…ions

Also refactor the cover options page to be more clear on how settings relate to each other.
@phw
Copy link
Member Author

phw commented Mar 3, 2021

And of course the "Cover Art Archive" option page is now much simpler and really about options related to CAA downloading:

grafik

phw added 2 commits March 3, 2021 11:41
… input

This indicates the default being used if the image filename is not configured.
Copy link
Collaborator

@zas zas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@phw phw merged commit 4f02936 into metabrainz:master Mar 3, 2021
@phw phw deleted the PICARD-2130 branch March 3, 2021 13:27
rdswift added a commit to metabrainz/picard-docs that referenced this pull request Mar 4, 2021
rdswift added a commit to metabrainz/picard-docs that referenced this pull request Mar 4, 2021
)

* Update description of "Use the first image type..." option setting.

* Update description with suggestion by outsidecontext

* Match refactored option screens

Match screens as revised in
metabrainz/picard#1757

* Clarify embedding only a SINGLE front image

* Correction to option title.  Clarify embedding only a single image.
@phw phw removed the Doc update label Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants