Terminology is inconsistent

Problem/Motivation

The terminology used in the user interface on the facet edit page is inconsistent and can be confusing. This makes the module more difficult to use than necessary.

The term "facet" sometimes refers to a facet, sometimes to the facet widget, and sometimes to the individual facet values.

A facet value may be referred to as a facet item, or a result, or a result item, or simply as an item.

The term "results" may refer to the number of occurrences of a facet value, or may refer to the facet values themselves. The number of occurrences of a facet value might also be referred to as the count.

Some of the settings available on the facet edit page have very similar names (e.g. soft limit, hard limit, count limit), and it is difficult to use them correctly if the terminology used to describe them is inconsistent. (I wasted several hours wondering why my most popular terms were not being displayed because I misunderstood the Count Limit option.)

I've confined myself to looking at the facet edit page, but possibly there are inconsistencies in terminology elsewhere (e.g. in the code).

Steps to reproduce

Look at the edit page for any facet.

Proposed resolution

Decide on the terminology, and update the UI and code to use them consistently.

Provisionally, I suggest:

• Facet - an entity attribute which can be used for search filtering, as configured on the /admin/config/search/facets page
• Facet Item, or just item - a value of a facet found in a search.
• Item Count - the number of occurrences of a facet item found in a search.
• Results or Result Set - a set of facet items found in a search.
• Result count - the number of facet items in a set of results.
• Facet Widget - a block which displays the results and allows the user to select/deselect facet items.

Remaining tasks

Agree terminology. Implement changes to to UI.

Optionally: identify places within the code where terms are used inconsistently, and update those too.

User interface changes

Revise the following wording on the facet edit page:

"Array with Raw Results Settings", "Dropdown settings", "List of Checkboxes settings" and "List of links settings" > help text: "Show the amount of results" should be "Show the number of occurrences of each facet item found in a search"

"List of Checkboxes settings" and "List of links settings" > "Soft Limit" > help text: "Limit the number of displayed facets via JavaScript.". This should be "Limit the number of displayed facet items via Javascript".

"Facet Settings": Might be better renamed to "Facet Widget Settings"

"Facet Settings" > "Combine Facets" > help text: "The raw value of a result item is used to identify a results item." Change to "Facet items are identified by their raw value."

"Facet Settings" > "Count Limit": Rename to "Item count limit".

"Facet Settings" > "Count Limit" > help text : "Show or hide depending on the number of results." Change to "Show or hide a facet item depending on the number of occurrences found in the search."

"Facet Settings" > "Count Limit" > "Count Limit settings" > Minimum items > help text: "Hide block if the facet contains less than this number of results." Change to "Hide the facet item if the search found fewer than this number of occurrences." Similarly for Maximum items.

"Facet Settings" > "Granularity item processor" > help text: "List of numbers grouped in steps.". Change to "For facets with numeric values, aggregate facet items together in groups."

"Facet Settings" > "Granularity item processor" > "Granularity" > help text: "The numeric size of the steps to group the result facets in." Change to "The numeric size of the steps to group the facet items in."

"Facet Settings" > "Hide facet when facet source is not rendered". I'm not sure what this does. Does it hide the whole facet widget, or just specific facet items? Change the text to make this clear.

"Facet Settings" > "Ensure that only one result can be displayed". The label is contradicted by the help text ("Check this to ensure that only one result at a time can be selected for this facet. "). Change label to "Ensure that only one item can be selected". Change the help text to "Check this to ensure that only one item at a time can be selected for this facet."

"Facet Settings" > "Empty facet behaviour". Rename to "Empty result set behaviour".

"Facet Settings" > "Exclude" > help text: "Exclude the selected facets from the search result instead of restricting it to them." Change to "Exclude the selected facet items from the search result instead of restricting it to them."

"Facet Settings" > "Minimum Count" > help text: "Only display the results if there is this minimum amount of results." Change to "Only display the facet item if there is this minimum number of occurrences."

"Facet sorting": Rename to "Facet Item sorting"

"Facet sorting" > "Sort by count": Rename to "Sort by item count".

API changes

None.

Data model changes

None.