Extend docs to include macOs options access #217
Conversation
config/configuration.rst
Outdated
| a new window with the option groups listed in a tree format on the left hand side, and the individual | ||
| settings on the right hand side. This is where the majority of Picard's customization is performed. | ||
| The option settings are found under the :menuselection:`"Options --> Options..."` item on the menu bar. Whereas in the MacOs ,the option | ||
| settings are found under the :menuselection:`"Python --> Preferences ..."` item on the menu bar . This will open a new window with |
There was a problem hiding this comment.
I don't think there should be a space between "Preferences" and the three periods that follow. At some point, I plan to replace all occurrences of three periods with a proper ellipsis, so you can do that here if you like (but not necessary).
|
okay , adding this as a note seperately does make more sense . I'll make that change and put up the pr .I'll also make changes to the macOs part as well in it along with the smaller space changes . |
|
@phw , @rdswift I have put up a new commit addressing the issues in the review . The PR addresses the following issues :
kindly review the new commit as well . |
|
@phw I have added the change to guide the user running the downloaded version of the application to the options menu . as for the "MusicBrainz Picard" v/s "Picard" issue , its kind both in Mac actually . when the application starts, as long as the application is in the phase where it displays the warning dialog box , it says Picard in the bar , however once the files / folder are uploaded the bar starts saying MusicBrainz Picard . I am attaching the images for both the cases below : 
img 1. illustration of the bar saying "Picard" when the app is first opened with the dialog box 
img 2 . illustration of the bar saying "MusicBrainz Picard" once files are uploaded . My last commit adds the guide with reference to MusicBrainz , however should you want me to change that , I'll gladly comply . |
rdswift
changed the title
config/configuration.rst
Outdated
| format on the left hand side, and the individual settings on the right hand side. This is where the majority of Picard's | ||
| customization is performed. | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
This is a really minor item, but for consistency can you please remove one of the spaces between ".." and "note::"? Thanks,
| .. note:: | |
| .. note:: |
I think the rest of the content is okay, but I've never used a mac in my life, so I can't speak to the way it handles the menu bar.
@sambhavnoobcoder, looking at your original images again it appears that the "Options" link appears to the right of "MusicBrainz Picard". What happens if you click on this item? Does it provide a sub-menu with an item to open the option settings window? If so, what is the difference between this and using "MusicBrainz Picard --> Preferences..."?
There was a problem hiding this comment.
Does it provide a sub-menu with an item to open the option settings window?
No, on macOS that item is under the menu with the application name. Hence this clarification
|
@rdswift , the option link that you are seeing seems to be housing other features like move files , rename files , save tags , etc . I am attaching a screenshot of the option tab below : 
img . options tab in macOS I have also fixed the note whitespacing that you mentioned in the review above . kindly review that as well and merge if all is okay . |
|
CI reports some Sphinx incompatibility, but seems unrelated to this PR and rather is likely some issue with updated Python packages. Seems to be because of this recent update of https://pypi.org/project/sphinxcontrib-applehelp/1.0.8/ :
We probably should follow and update to use Sphinx 5.0. Not sure what it involves. This will not block us merging the PR, though. But I'll have @rdswift take a final look on the changes here. |
@sambhavnoobcoder This is actually interesting. I'd count this as a bug in Picard, but unsure how and even if this can be resolved (Qt takes care of most of the handling for the global menu bar). But maybe application name is updated later on or something. It might also be because of the dialog itself. The global menu bar is a bit special, as it can change with dialogs. |
your welcome . in that case Ig once @rdswift ,looks at it , if its all fine we can merge the pr .
I think I may try to update to use Sphinx 5.0. Not sure what it involves either , but I'll give it a try and if I am able to do it , I'll raise a pr for the same .
I'll see what can be done for the menu bar as well , and if I manage to make a breakthrough , I'll raise a ticket or pr for that as well . |
Summary
This is a…
Reason for the Change
I was trying to address was how to access the plugins for Picard , which was discussed in the thread here : https://community.metabrainz.org/t/how-to-run-plugins-on-picard-as-a-developer/674175 .I think that clearly mentioning the access to plugins or options menu to MacOs users would be more intuitive and useful .
Jira Ticket (optional) - PICARD-2818
Description of the Change
I essentially added the path of action which would lead to the user reaching the plugins selection via the options menu in a MacOs environment , extending the guide to the windows based systems . adjoining with the pr are screenshots demonstrating the working of the pathway updated in the pr .
img 1 . Python --> Preferences
img 2. plugins selection
Additional Action Required
No Additional Action Required .