Problem/Motivation

Some of the descriptions of the facet settings are not quite clear for users who don't yet know what these facets do, or could be shorter.

Proposed resolution

Edit the descriptions to make them more concise and consistent, and where possible use different wording then what is already used in the labels.

Remaining tasks

Make a patch with different wording

User interface changes

This is a UI text change, but does not change the UI otherwise.

API changes

none

Data model changes

none

CommentFileSizeAuthor
#3 2872305-facet-settings-UI-texts-3.patch14.15 KBifrik
#6 interdiff-2872305-3-6.txt2.13 KBifrik
#6 2872305-facet-settings-UI-text-6.patch14.79 KBifrik

Comments

ifrik created an issue. See original summary.

ifrik’s picture

ifrik
she/her
commented

I'm working on that today.

ifrik’s picture

ifrik
she/her
commented
Status: Active » Needs review
StatusFileSize
new 2872305-facet-settings-UI-texts-3.patch14.15 KB

I've worked through the UI texts of the Facet settings, with the exception of the "non-narrowing results" which are already in another patch.

I've tried to make the wording more concise so that users get the important bit of the description.
I've also made it more consistent:

  • all the descriptions are in the same kind of of voice, such as "Do this", "Display that", Thereby talking to the user directly.
  • Descriptions are full sentences that end with a ".", labels don't. (very nitpicky... )
  • the capitalisation of ID and URL

Status: Needs review » Needs work

The last submitted patch, 3: 2872305-facet-settings-UI-texts-3.patch, failed testing.

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented 
  1. +++ b/src/Plugin/facets/processor/ExcludeSpecifiedItemsProcessor.php
@@ -13,7 +13,7 @@ use Drupal\facets\Processor\ProcessorPluginBase;
- *   description = @Translation("Excludes items by node id or title."),
+ *   description = @Translation("Exclude items depending on their node ID or title."),

    Actually, this is wrong. This works for all kinds of results. Not just nodes.

    So I think something like: "Exclude items depending on their raw or display value."

    Not sure if raw/display value is something that we use in other parts of the UI, but it's what we call those things in code. ID/Title is too restrictive as this can be use on all kinds of data types (including booleans where you could filter on 0/Yes).

    I realise that this was wrong before as well, but since we're updating it, let's make it correct. 

  2. +++ b/src/Plugin/facets/processor/TranslateEntityProcessor.php
@@ -17,8 +17,8 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
+ *   description = @Translation("Display the entity label instead of its ID (for expamle the term name instead of the taxonomy term ID)."),

    /s/expamle/example/

ifrik’s picture

ifrik
she/her
commented
Status: Needs work » Needs review
StatusFileSize
new 2872305-facet-settings-UI-text-6.patch14.79 KB
new interdiff-2872305-3-6.txt2.13 KB

Thanks,
I fixed the two comments, and also changed the test that failed because I had edited an error message.

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented
Status: Needs review » Fixed

Committed, thanks so much for this. It's really nice to have help for this, having these descriptions now should make it easier to keep new labels/descriptions better.

  • borisson_ committed 5d62cfb on 8.x-1.x authored by ifrik 
    Issue #2872305 by ifrik: Edit descriptions of facet settings
ifrik’s picture

ifrik
she/her
commented

I'm happy to help out with issues like this in future as well. Just ping me if there's any UI texts to look at.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.