Skip to content

Commit 620f9cc

Browse files
committed
Add documentation for Cluster and Album pane filtering
1 parent 9c3d156 commit 620f9cc

File tree

4 files changed

+32
-19
lines changed

4 files changed

+32
-19
lines changed

appendices/keyboard_shortcuts.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ View
5353

5454
"Toggle file browser", :kbd:`Ctrl+B`, :kbd:`+B`
5555
"Toggle metadata view", :kbd:`Ctrl+Shift+M`, :kbd:`++M`
56+
"Toggle filter view", :kbd:`Ctrl+Shift+F`, :kbd:`++F`
5657

5758
Options
5859
+++++++
28.8 KB
Loading
14.7 KB
Loading

getting_started/screen_main.rst

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,27 @@
1414

1515
1. **Menu Bar**: This provides the pull-down menu of actions that Picard can perform.
1616

17-
2. **Tool Bar**: This provides quick links to the main functions performed by Picard. This can
18-
be customized by the user in the :doc:`User Interface Options </config/options_interface>` settings.
17+
2. **Tool Bar**: This provides quick links to the main functions performed by Picard. This can be customized by the user in the :doc:`User Interface Options </config/options_interface>` settings.
1918

2019
3. **File Browser**: This provides a browser for selecting files and directories for processing.
2120

22-
4. **Cluster Pane**: Often referred to as the "left-hand pane", this section allows the user to select
23-
and cluster files for scanning, lookup or matching.
21+
4. **Cluster Pane**: Often referred to as the "left-hand pane", this section allows the user to select and cluster files for scanning, lookup or matching. There is an option in the "View" portion of the Main Menu to allow filtering of the items in this section. Please see the section on :ref:`Filtering<main_screen_filter>` below for more information.
2422

25-
5. **Album Pane**: Often referred to as the "right-hand pane", this section displays the albums
26-
retrieved from MusicBrainz. This is the section where files are matched to downloaded track
27-
information.
23+
5. **Album Pane**: Often referred to as the "right-hand pane", this section displays the albums retrieved from MusicBrainz. This is the section where files are matched to downloaded track information. There is an option in the "View" portion of the Main Menu to allow filtering of the items in this section. Please see the section on :ref:`Filtering<main_screen_filter>` below for more information.
2824

29-
6. **Metadata Pane**: This section is a three-column table of the tag metadata for the album or track
30-
currently selected in the Album Pane. The first column shows the tag name, the second shows the
31-
original value found in the file, and the third column shows the new value that will be written.
25+
6. **Metadata Pane**: This section is a three-column table of the tag metadata for the album or track currently selected in the Album Pane. The first column shows the tag name, the second shows the original value found in the file, and the third column shows the new value that will be written.
3226

33-
7. **Cover Art**: This shows the new cover art image that will be written to the selected album or
34-
track, along with the original cover art image found in the files matched to the selected album or
35-
track.
27+
7. **Cover Art**: This shows the new cover art image that will be written to the selected album or track, along with the original cover art image found in the files matched to the selected album or track.
3628

3729
8. **Player**: The built-in player that can be used to play selected audio files.
3830

39-
9. **Status Bar**: The bar at the bottom of the screen shows information about the current operation
40-
of Picard, including such items as number of files, albums, and pending downloads. |nl|
31+
9. **Status Bar**: The bar at the bottom of the screen shows information about the current operation of Picard, including such items as number of files, albums, and pending downloads. |nl|
4132

4233
.. .. raw:: latex
4334
4435
.. \clearpage
4536
46-
Picard is available for different operating systems. And while Picard's functionality is overall
47-
the same the specific look of the user interface can be slightly different based on the operating
48-
system. Throughout the documentation screenshots taken on different operating systems are used.
49-
Below you find a selection of screenshots of Picard's main screen on different systems:
37+
Picard is available for different operating systems. And while Picard's functionality is overall the same the specific look of the user interface can be slightly different based on the operating system. Throughout the documentation screenshots taken on different operating systems are used. Below you find a selection of screenshots of Picard's main screen on different systems:
5038

5139

5240
.. |win10light| image:: images/mainscreen-windows10-light.png
@@ -106,3 +94,27 @@ Below you find a selection of screenshots of Picard's main screen on different s
10694
.. raw:: latex
10795

10896
\clearpage
97+
98+
.. _main_screen_filter:
99+
100+
:index:`Filtering the Main Screen <user interface; main screen filtering>`
101+
--------------------------------------------------------------------------
102+
103+
The items displayed in the Cluster Pane and the Album Pane can be filtered to allow for quickly reviewing selected information. The filter bars can be displayed or hidden from the :menuselection:`"View"` menu, or using the keyboard shortcut :kbd:`Ctrl+Shift+F`.
104+
105+
.. image:: images/main_window_filter_bars.png
106+
:width: 100 %
107+
108+
To filter the items in one of the panes, simply select one or more filters and enter the filter text to use for that pane. The items will be displayed or hidden based on the filter criteria entered.
109+
110+
When the :guilabel:`Filters` button is clicked, a dialog will be displayed to allow to you to select the filters to use for that pane.
111+
112+
.. image:: images/filter_selection_dialog.png
113+
114+
When filtering is applied, items will only be displayed if:
115+
116+
- no filters are selected or no filter text has been entered;
117+
- no tags are found that match the selected filters;
118+
- a tag is found that matches one of the selected filters and the filter text is found within the tag value.
119+
120+
Items will not be displayed if one or more tags were found in the selected filters and the filter text was not found in any values of those tags.

0 commit comments

Comments
 (0)