Bug 32964 - OPACResultsMaxItemsUnavailable description is misleading
Summary: OPACResultsMaxItemsUnavailable description is misleading
Status: RESOLVED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: System Administration (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low trivial (vote)
Assignee: Caroline Cyr La Rose
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-02-14 21:38 UTC by Caroline Cyr La Rose
Modified: 2023-12-28 20:44 UTC (History)
6 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
23.05.00,22.11.05


Attachments
Bug 32964: OPACResultsMaxItemsUnavailable description is misleading (2.71 KB, patch)
2023-02-14 22:08 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 32964: OPACResultsMaxItemsUnavailable description is misleading (2.78 KB, patch)
2023-03-08 19:49 UTC, ByWater Sandboxes
Details | Diff | Splinter Review
Bug 32964: OPACResultsMaxItemsUnavailable description is misleading (2.85 KB, patch)
2023-03-24 08:51 UTC, Jonathan Druart
Details | Diff | Splinter Review
Bug 32964: (follow-up) Additional rewording for XSLT item display (2.43 KB, patch)
2023-03-28 12:59 UTC, Marcel de Rooy
Details | Diff | Splinter Review
Bug 32964: (follow-up) Additional rewording for XSLT item display (2.46 KB, patch)
2023-03-29 13:44 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Caroline Cyr La Rose 2023-02-14 21:38:50 UTC
Currently, the description for OPACResultsMaxItemsUnavailable is

"show no more than X (unavailable) individual items for categories like Checked out, Damaged, On Hold, but only when you group them by branch."

My problem is with the part "but only when you group them by branch."

The options for OPACResultsUnavailableGroupingBy are 
- branch and substatus
- branch only
- substatus only

If you don't know the values in the database for each of these, "but only when you group them by branch" seems to say either "branch only" or "branch and substatus" could work since they both group by branch.

However, OPACResultsMaxItemsUnavailable only works if OPACResultsUnavailableGroupingBy is set to 'branch and substatus'. The two other options disable OPACResultsMaxItemsUnavailable completely.

I think we should change this last part of the sentence by

"but only if OPACResultsUnavailableGroupingBy is set to 'branch and substatus'.
Comment 1 Caroline Cyr La Rose 2023-02-14 21:48:02 UTC
Terminology also says we should use 'library' instead of 'branch'.

https://wiki.koha-community.org/wiki/Terminology#B
Comment 2 Caroline Cyr La Rose 2023-02-14 22:08:16 UTC
Created attachment 146655 [details] [review]
Bug 32964: OPACResultsMaxItemsUnavailable description is misleading

This patch rephrases the last part of the description of the
OPACResultsMaxItemsUnavailable system preference to clarify the link
to the OPACResultsUnavailableGroupingBy option.

It also changes some terminology to follow the guidelines
(capitalization, library instead of branch).

To test:
1. Apply patch
2. Go to Administration > Global system preferences
3. Search for OPACResultsMaxItems
4. Read the sentence for OPACResultsMaxItemsUnavailable, make sure it
makes sense, the grammar and spelling are ok, respects terminology
and capitalization guidelines
5. Try the link in the description, make sure it goes to the correct
syspref
6. Read the sentence and options for OPACResultsUnavailableGroupingBy,
make sure it makes sense, the grammar and spelling are ok, respects
terminology and capitalization guidelines
7. Optionally, try the various options, they should still work as
intended
Comment 3 Laura Escamilla 2023-03-06 18:28:43 UTC
(In reply to Caroline Cyr La Rose from comment #2)
> Created attachment 146655 [details] [review] [review]
> Bug 32964: OPACResultsMaxItemsUnavailable description is misleading
> 
> This patch rephrases the last part of the description of the
> OPACResultsMaxItemsUnavailable system preference to clarify the link
> to the OPACResultsUnavailableGroupingBy option.
> 
> It also changes some terminology to follow the guidelines
> (capitalization, library instead of branch).
> 
> To test:
> 1. Apply patch
> 2. Go to Administration > Global system preferences
> 3. Search for OPACResultsMaxItems
> 4. Read the sentence for OPACResultsMaxItemsUnavailable, make sure it
> makes sense, the grammar and spelling are ok, respects terminology
> and capitalization guidelines
> 5. Try the link in the description, make sure it goes to the correct
> syspref
> 6. Read the sentence and options for OPACResultsUnavailableGroupingBy,
> make sure it makes sense, the grammar and spelling are ok, respects
> terminology and capitalization guidelines
> 7. Optionally, try the various options, they should still work as
> intended

The terminology and grammar makes sense to me. 

Signed-off-by: Laura Escamilla <laura.escamilla@bywatersolutions.com>
Comment 4 ByWater Sandboxes 2023-03-08 19:49:36 UTC
Created attachment 147983 [details] [review]
Bug 32964: OPACResultsMaxItemsUnavailable description is misleading

This patch rephrases the last part of the description of the
OPACResultsMaxItemsUnavailable system preference to clarify the link
to the OPACResultsUnavailableGroupingBy option.

It also changes some terminology to follow the guidelines
(capitalization, library instead of branch).

To test:
1. Apply patch
2. Go to Administration > Global system preferences
3. Search for OPACResultsMaxItems
4. Read the sentence for OPACResultsMaxItemsUnavailable, make sure it
makes sense, the grammar and spelling are ok, respects terminology
and capitalization guidelines
5. Try the link in the description, make sure it goes to the correct
syspref
6. Read the sentence and options for OPACResultsUnavailableGroupingBy,
make sure it makes sense, the grammar and spelling are ok, respects
terminology and capitalization guidelines
7. Optionally, try the various options, they should still work as
intended

Signed-off-by: Laura Escamilla <laura.escamilla@bywatersolutions.com>
Comment 5 Jonathan Druart 2023-03-24 08:51:41 UTC
Created attachment 148637 [details] [review]
Bug 32964: OPACResultsMaxItemsUnavailable description is misleading

This patch rephrases the last part of the description of the
OPACResultsMaxItemsUnavailable system preference to clarify the link
to the OPACResultsUnavailableGroupingBy option.

It also changes some terminology to follow the guidelines
(capitalization, library instead of branch).

To test:
1. Apply patch
2. Go to Administration > Global system preferences
3. Search for OPACResultsMaxItems
4. Read the sentence for OPACResultsMaxItemsUnavailable, make sure it
makes sense, the grammar and spelling are ok, respects terminology
and capitalization guidelines
5. Try the link in the description, make sure it goes to the correct
syspref
6. Read the sentence and options for OPACResultsUnavailableGroupingBy,
make sure it makes sense, the grammar and spelling are ok, respects
terminology and capitalization guidelines
7. Optionally, try the various options, they should still work as
intended

Signed-off-by: Laura Escamilla <laura.escamilla@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Comment 6 Tomás Cohen Arazi 2023-03-27 10:47:38 UTC
Pushed to master for 23.05.

Nice work everyone, thanks!
Comment 7 Marcel de Rooy 2023-03-28 12:03:17 UTC
Intrigued by this report. I have the impression that you found a bug in the group by library option. As it once worked differently :)
We are now renaming according to current behavior. Digging a bit furthere here.
Comment 8 Marcel de Rooy 2023-03-28 12:57:44 UTC
(In reply to Marcel de Rooy from comment #7)
> Intrigued by this report. I have the impression that you found a bug in the
> group by library option. As it once worked differently :)
> We are now renaming according to current behavior. Digging a bit furthere
> here.

No, I must be wrong. The comments in the XSLT code are clear enough. But the description on the pref is confusing indeed.

Caroline: What do you think of the additional rewording in the follow-up?
Comment 9 Marcel de Rooy 2023-03-28 12:59:09 UTC
Created attachment 148821 [details] [review]
Bug 32964: (follow-up) Additional rewording for XSLT item display

Test plan:
Check OPAC preferences, OPACResultsMaxItems and siblings.

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Comment 10 Marcel de Rooy 2023-03-29 13:29:29 UTC
<caroline> marcelr, the diff looks good to me, I'll sign off
Comment 11 Caroline Cyr La Rose 2023-03-29 13:44:22 UTC
Created attachment 148919 [details] [review]
Bug 32964: (follow-up) Additional rewording for XSLT item display

Test plan:
Check OPAC preferences, OPACResultsMaxItems and siblings.

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com>
Comment 12 Caroline Cyr La Rose 2023-03-29 13:45:31 UTC
I signed off the followup, but I can't change the status back to Signed off. I'm not sure what the correct procedure is here.

Thanks again Marcel!

Caroline
Comment 13 Marcel de Rooy 2023-03-29 14:04:16 UTC
(In reply to Caroline Cyr La Rose from comment #12)
> I signed off the followup, but I can't change the status back to Signed off.
> I'm not sure what the correct procedure is here.
> 
> Thanks again Marcel!
> 
> Caroline

This is fine. Thanks. I added the additional work keyword to alert the RM.
Comment 14 Tomás Cohen Arazi 2023-03-30 10:26:48 UTC
Follow-up pushed to master. Thanks everyone.
Comment 15 Matt Blenkinsop 2023-04-11 10:47:17 UTC
Nice work everyone!

Pushed to stable for 22.11.x