Bug 35152 - Convert RoutingListNote system preference to additional contents
Summary: Convert RoutingListNote system preference to additional contents
Status: Signed Off
Alias: None
Product: Koha
Classification: Unclassified
Component: Serials (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Owen Leonard
QA Contact: Testopia
URL:
Keywords:
Depends on: 31383 35151
Blocks: 26050 35153
  Show dependency treegraph
 
Reported: 2023-10-25 17:23 UTC by Owen Leonard
Modified: 2024-04-19 17:17 UTC (History)
2 users (show)

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


Attachments
Bug 35152: Convert RoutingListNote system preference to additional contents (10.09 KB, patch)
2023-11-09 15:35 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 35152: Convert RoutingListNote system preference to additional contents (10.14 KB, patch)
2023-12-11 20:11 UTC, David Nind
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Owen Leonard 2023-10-25 17:23:01 UTC
Building on 22318, the RoutingListNote system preference should be converted to an HTML customization option.
Comment 1 Owen Leonard 2023-11-09 15:35:55 UTC
Created attachment 158747 [details] [review]
Bug 35152: Convert RoutingListNote system preference to additional contents

This patch moves the RoutingListNote system preference into HTML
customizations, making it possible to have language- and
library-specific content.

To test you should have some content in the RoutingListNote
system preference before applying the patch. Apply the patch and run
the database update process.

- In the staff client, go to Tools -> HTML customizations and verify
  that the content from RoutingListNote is now stored there.
- The HTML customization entry form should offer RoutingListNote
  as a choice under "Display location."
- Update and reinstall active translations (for instance fr-FR):
  - perl misc/translator/translate update fr-FR
  - perl misc/translator/translate install fr-FR
- Enable the translation if necessary under Administration -> System
  preferences -> language.
- Edit the RoutingListNote HTML customization and add unique
  content to the "fr-FR" tab.

- Go to Serials and create a subscription if necessary.
- From the subscription detail page, click "Create routing list" in the
  left-hand sidebar.
- Add one or more recipients to the list and click "Save".
- On the "Preview routing list" page click "Save and preview routing
  slip".
- In the pop-up window with the routing list preview you should see the
  content you added to the RoutingListNote HTML customization.
- Switch to your updated translation and confirm that the content you
  added for your translation shows up correctly.
- Go to Administration -> System preferences and search for
  "RoutingListNote." It should return no results.

NOTE: This patch does not keep the default content which was stored by
the RoutingListNote system preference. Having a default value for that
kind of preference is not standard. Instead I have updated the
description of the RoutingSerials preference to add a mention of the
RoutingListNote HTML customization option.
Comment 2 David Nind 2023-12-11 20:11:34 UTC
Created attachment 159718 [details] [review]
Bug 35152: Convert RoutingListNote system preference to additional contents

This patch moves the RoutingListNote system preference into HTML
customizations, making it possible to have language- and
library-specific content.

To test you should have some content in the RoutingListNote
system preference before applying the patch. Apply the patch and run
the database update process.

- In the staff client, go to Tools -> HTML customizations and verify
  that the content from RoutingListNote is now stored there.
- The HTML customization entry form should offer RoutingListNote
  as a choice under "Display location."
- Update and reinstall active translations (for instance fr-FR):
  - perl misc/translator/translate update fr-FR
  - perl misc/translator/translate install fr-FR
- Enable the translation if necessary under Administration -> System
  preferences -> language.
- Edit the RoutingListNote HTML customization and add unique
  content to the "fr-FR" tab.

- Go to Serials and create a subscription if necessary.
- From the subscription detail page, click "Create routing list" in the
  left-hand sidebar.
- Add one or more recipients to the list and click "Save".
- On the "Preview routing list" page click "Save and preview routing
  slip".
- In the pop-up window with the routing list preview you should see the
  content you added to the RoutingListNote HTML customization.
- Switch to your updated translation and confirm that the content you
  added for your translation shows up correctly.
- Go to Administration -> System preferences and search for
  "RoutingListNote." It should return no results.

NOTE: This patch does not keep the default content which was stored by
the RoutingListNote system preference. Having a default value for that
kind of preference is not standard. Instead I have updated the
description of the RoutingSerials preference to add a mention of the
RoutingListNote HTML customization option.

Signed-off-by: David Nind <david@davidnind.com>
Comment 3 Julian Maurice 2024-02-23 08:26:22 UTC
I can see one minor issue: if RoutingListNote preference still have its default value (which is: To change this note edit <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=RoutingListNote#jumped">RoutingListNote</a> system preference.)
it's copied over to the HTML customization and it now contains a link to a removed preference.

I'm not sure of what should be done about it. Should we rewrite it in the db update ? Should we remove it ?
Comment 4 Julian Maurice 2024-02-23 08:41:21 UTC
Is this bug really dependent on bug 35151 ?
Comment 5 Owen Leonard 2024-02-23 19:17:58 UTC
(In reply to Julian Maurice from comment #3)
> I can see one minor issue: if RoutingListNote preference still have its
> default value

Did the database update not take care of this?

(In reply to Julian Maurice from comment #4)
> Is this bug really dependent on bug 35151 ?

Probably not... I was trying to make each one of these HTML customization patches dependent on the previous one to avoid conflicts.
Comment 6 Julian Maurice 2024-02-26 07:57:14 UTC
(In reply to Owen Leonard from comment #5)
> (In reply to Julian Maurice from comment #3)
> > I can see one minor issue: if RoutingListNote preference still have its
> > default value
> 
> Did the database update not take care of this?
The database update moves RoutingListNote preference content to a new HTML customization, but does nothing to detect if it still has its default value
Comment 7 Katrin Fischer 2024-04-19 17:17:14 UTC
Please QA - it's blocking other dependent bugs!