|
1
|
Description
|
|
2
|
-----------
|
|
3
|
This module provides a method for filtering modules on the modules page as well
|
|
4
|
as for filtering projects on the update status report.
|
|
5
|
|
|
6
|
The supplied filter is simpler than using your browsers find feature which
|
|
7
|
searches the entire page. The provided filter will filter modules/projects that
|
|
8
|
do not meet your input.
|
|
9
|
|
|
10
|
Along with the filter textfield there are additional
|
|
11
|
checkboxes that help to narrow the search more. The modules page contains four
|
|
12
|
checkboxes: Enabled, Disabled, Required, and Unavailable. While the first two
|
|
13
|
are self-explanatory, the latter two can take an explanation. The Required
|
|
14
|
checkbox affects visibility of modules that are enabled and have other
|
|
15
|
module(s) that require it also enabled. The Unavailable checkbox affects
|
|
16
|
visibility of modules that are disabled and depend on module(s) that are
|
|
17
|
missing.
|
|
18
|
|
|
19
|
The update status report filter also contains four checkboxes: Up-to-Date,
|
|
20
|
Update availabe, Security update, and Unknown. These directly affect the
|
|
21
|
visibilty of each project; whether it is up-to-date, there is an update
|
|
22
|
available, a security update is available, or the status is unknown.
|
|
23
|
|
|
24
|
Installation
|
|
25
|
------------
|
|
26
|
To install this module, do the following:
|
|
27
|
|
|
28
|
1. Extract the tar ball that you downloaded from Drupal.org.
|
|
29
|
|
|
30
|
2. Upload the entire directory and all its contents to your modules directory.
|
|
31
|
|
|
32
|
Configuration
|
|
33
|
-------------
|
|
34
|
To enable and configure this module do the following:
|
|
35
|
|
|
36
|
1. Go to Admin -> Modules, and enable Module Filter.
|
|
37
|
|
|
38
|
2. Go to Admin -> Configuration -> User interface -> Module filter, and make
|
|
39
|
any necessary configuration changes.
|
|
40
|
|
|
41
|
Tabs
|
|
42
|
----
|
|
43
|
By default Module Filter alters the modules page into tabs (Can be disabled on
|
|
44
|
configuration page). In the tabs view, each package is converted to a vertical
|
|
45
|
tab rather than a fieldset which greatly increases the ability to browse them.
|
|
46
|
|
|
47
|
There are several benefits to using the tabs view over the standard view for
|
|
48
|
the modules page. I've listed the key benefits below as well as additional
|
|
49
|
information that pertains to each.
|
|
50
|
|
|
51
|
1. The increased ease of browsing between packages.
|
|
52
|
|
|
53
|
2. Allows all modules to be listed alphabetically outside of their package,
|
|
54
|
making it all the easier to find the module by name rather than package it
|
|
55
|
happens to be in.
|
|
56
|
|
|
57
|
3. The operations for a module are moved within the description column giving
|
|
58
|
the description more "elbow room".
|
|
59
|
|
|
60
|
4. Filtering is restricted to within the active tab or globally when no tab is
|
|
61
|
selected. By default no tab is selected which will list all modules. When a
|
|
62
|
tab is active and you want to get back to the 'all' state click on the
|
|
63
|
active tab to deselect it.
|
|
64
|
|
|
65
|
5. The number of enabled modules per tab is shown on the active tab. (Can be
|
|
66
|
disabled on configuration page)
|
|
67
|
|
|
68
|
6. Nice visual aids become available showing what modules are to be
|
|
69
|
enabled/disabled and the number of matching modules in each tab when
|
|
70
|
filtering. (Can be disabled on configuration page)
|
|
71
|
|
|
72
|
7. The save configuration button becomes more accessible, either staying at
|
|
73
|
the bottom of the window when the tabs exceed past the bottom and at the
|
|
74
|
top when scrolling past the tabs. (Can be disabled on configuration page)
|
|
75
|
|
|
76
|
8. When filtering, tabs that do not contain matches can be hidden. (Can be
|
|
77
|
enabled on configuration page)
|
|
78
|
|
|
79
|
9. Tab states are remembered like individual pages allowing you to move
|
|
80
|
forward and backward within your selections via your browsers
|
|
81
|
forward/backward buttons.
|
|
82
|
|
|
83
|
10. When viewing all modules (no active tab) and mousing over modules it's tab
|
|
84
|
becomes highlighted to signify which tab it belongs to.
|
|
85
|
|
|
86
|
Filter operators
|
|
87
|
----------------
|
|
88
|
The modules page's filter has three filter operators available. Filter
|
|
89
|
operators allow alternative filtering techniques. A filter operator is applied
|
|
90
|
by typing within the filter textfield 'operator:' (where operator is the
|
|
91
|
operator type) followed immediately with the string to pass to the operator
|
|
92
|
function (e.g. 'requires:block'). The available operators are:
|
|
93
|
|
|
94
|
description:
|
|
95
|
Filter based on a module's description.
|
|
96
|
|
|
97
|
requiredBy:
|
|
98
|
Filter based on what a module is required by.
|
|
99
|
|
|
100
|
requires:
|
|
101
|
Filter based on what a module requires.
|
|
102
|
|
|
103
|
Multiple filters (or queries) can be applied by space delimiting. For example,
|
|
104
|
the filter string 'description:ctools views' would filter down to modules with
|
|
105
|
"ctools" in the description and "views" within the module's name. To pass a
|
|
106
|
space within a single query wrap it within double quotes (e.g. 'requires:"chaos
|
|
107
|
tools"' or '"bulk export"').
|
