Bug 35463 - Link preservation module help to the manual
Summary: Link preservation module help to the manual
Status: RESOLVED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Preservation (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low normal (vote)
Assignee: Caroline Cyr La Rose
QA Contact: Martin Renvoize
URL:
Keywords: rel_23_11_candidate
Depends on: 30708
Blocks:
  Show dependency treegraph
 
Reported: 2023-12-01 14:19 UTC by Caroline Cyr La Rose
Modified: 2024-01-04 21:14 UTC (History)
5 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
This patch links the various pages of the preservation module to each specific section of the preservation module chapter in the manual.
Version(s) released in:
24.05.00,23.11.02


Attachments
WIP adding preservation links (1.73 KB, patch)
2023-12-01 15:37 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 35463: Link preservation module help to the manual (4.30 KB, patch)
2023-12-01 21:47 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 35463: Open erm and preservation help in new tab (1.01 KB, patch)
2023-12-04 22:25 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 35463: perltidy formatting corrections (2.07 KB, patch)
2023-12-04 22:44 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 35463: Link preservation module help to the manual (4.31 KB, patch)
2023-12-05 14:21 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35463: Open erm and preservation help in new tab (1.08 KB, patch)
2023-12-05 14:21 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35463: perltidy formatting corrections (1.44 KB, patch)
2023-12-05 14:21 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35463: More preservation manual links (2.12 KB, patch)
2023-12-05 14:52 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 35463: Link preservation module help to the manual (4.36 KB, patch)
2023-12-07 13:01 UTC, Philip Orr
Details | Diff | Splinter Review
Bug 35463: Open erm and preservation help in new tab (1.12 KB, patch)
2023-12-07 13:01 UTC, Philip Orr
Details | Diff | Splinter Review
Bug 35463: perltidy formatting corrections (1.49 KB, patch)
2023-12-07 13:01 UTC, Philip Orr
Details | Diff | Splinter Review
Bug 35463: More preservation manual links (2.17 KB, patch)
2023-12-07 13:01 UTC, Philip Orr
Details | Diff | Splinter Review
Bug 35463: Link preservation module help to the manual (4.42 KB, patch)
2023-12-19 15:14 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35463: Open erm and preservation help in new tab (1.19 KB, patch)
2023-12-19 15:14 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35463: perltidy formatting corrections (1.56 KB, patch)
2023-12-19 15:14 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35463: More preservation manual links (2.24 KB, patch)
2023-12-19 15:14 UTC, Martin Renvoize
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-12-01 14:19:49 UTC
The "help" link in the new preservation module needs to point to the new preservation module chapter in the manual.
Comment 1 Caroline Cyr La Rose 2023-12-01 15:37:22 UTC
Created attachment 159456 [details] [review]
WIP adding preservation links
Comment 2 Martin Renvoize 2023-12-01 15:42:33 UTC
Added bug 33346 to the see also as an example of how vue module help works.. hope it helps.
Comment 3 Caroline Cyr La Rose 2023-12-01 21:47:22 UTC
Created attachment 159485 [details] [review]
Bug 35463: Link preservation module help to the manual

This patch links the various pages of the preservation module to each
specific section of the preservation module chapter in the manual.

To test:
1.  Enable the PreservationModule system preference
2.  Go to the Preservation module
3.  Click "help" in the top right corner
    --> You are brought to the manual, but not a specific page
4.  Apply patch
5.  Click "Help" in the top right corner
    --> You are brought to the Preservation chapter of the manual
6.  Click "Settings"
7.  Click "Help" in the top right corner
    --> You are brought to the Settings section of the Preservation chapter of the manual
8.  Choose a not for loan status for items added to the waiting list (the mandatory field) and submit
9.  Click "Add a new processing"
10. Click "Help" in the top right corner
    --> You are brought to the Add a new processing section of the Preservation chapter of the manual
11. Fill out the form to create the processing and submit
12. Click "Edit this processing"
13. Click "Help" in the top right corner
    --> You are brought to the Add a new processing section of the Preservation chapter of the manual (there is no edit a processing section)
14.  Click "Waiting list"
15. Click "Help" in the top right corner
    --> You are brought to the Waiting list section of the Preservation chapter of the manual
16. Add items to the waiting list
17. Click "Trains"
18. Click "Help" in the top right corner
    --> You are brought to the Trains section of the Preservation chapter of the manual
19. Click "New train"
20. Click "Help" in the top right corner
    --> You are brought to the New train section of the Preservation chapter of the manual
21. Fill out the form to create a new train and submit
22. Click "Add items"
23. Click "Help" in the top right corner
    --> You are brought to the Add items section of the Preservation chapter of the manual

24. Also check ERM help links to make sure nothing is broken

Bug 35463: Link preservation module help to the manual
Comment 4 Caroline Cyr La Rose 2023-12-01 21:48:34 UTC
I hope I did everything OK. There was a lot of new stuff here for me, and I even had to ask chatgpt for help with perl lol!

Let me know if I need to change something
Comment 5 Philip Orr 2023-12-04 11:00:38 UTC
Setting this to Failed QA for only one reason: all links open the manual in the same tab. AFAIK in Koha links to the manual usually open in a new tab.

By the way the "Help" links in the ERM module have the same problem, they should open in a new tab as well. Should I open a bug for that?

As for the links themselves as detailed in the test plan, they are all correct!
I also checked the ERM Module: "data providers" and "reports" both link to the manual mainpage. All other links in ERM module are correct.
Comment 6 Philip Orr 2023-12-04 11:01:29 UTC
Oh, and one more thing: qa says the manual is now less tidy after the patch.

 WARN   Koha/Manual.pm
   WARN   tidiness
                The file is less tidy than before (bad/messy lines before: 27, now: 28)

...Don't know if that's important. :-)
Comment 7 Jonathan Druart 2023-12-04 14:17:42 UTC
1. Why the following 2 lines?

+    'preservation/trains'                      => '/preservation.html#trains',
+    'preservation/trains/'                     => '/preservation.html#trains',

Same for settings.

2. Doubled /
preservation/trains//items/add
Comment 8 Jonathan Druart 2023-12-04 14:19:02 UTC
Forget 1, it's a "starting with". Looks good then.
Comment 9 Caroline Cyr La Rose 2023-12-04 14:21:53 UTC
(In reply to Jonathan Druart from comment #7)

> 
> 2. Doubled /
> preservation/trains//items/add

The part at the bottom says to remove the digits. I figured if the digit was removed in 

preservation/trains/1/items/add

the the resulting string would be

preservation/trains//items/add
Comment 10 Caroline Cyr La Rose 2023-12-04 17:50:27 UTC
(In reply to Philip Orr from comment #5)
> Setting this to Failed QA for only one reason: all links open the manual in
> the same tab. AFAIK in Koha links to the manual usually open in a new tab.
> 
> By the way the "Help" links in the ERM module have the same problem, they
> should open in a new tab as well. Should I open a bug for that?
> 
> As for the links themselves as detailed in the test plan, they are all
> correct!
> I also checked the ERM Module: "data providers" and "reports" both link to
> the manual mainpage. All other links in ERM module are correct.

I don't see any "target" or "blank" in the Koha/Manual.pm file nor in the help.pl file. I wonder if it's managed elsewhere.

For the erm data providers and reports, I think it's due to those things being new in this version and we haven't had time to create/write the sections in the manual.
Comment 11 Caroline Cyr La Rose 2023-12-04 22:25:35 UTC
Created attachment 159563 [details] [review]
Bug 35463: Open erm and preservation help in new tab

This patch adds target="_blank" to the Vue help file so that the manual opens in a new tab when clicking on the help link in the erm and preservation modules.
Comment 12 Caroline Cyr La Rose 2023-12-04 22:44:20 UTC
Created attachment 159564 [details] [review]
Bug 35463: perltidy formatting corrections
Comment 14 Martin Renvoize 2023-12-05 06:57:31 UTC
Oops, must read full pay he's including follow-ups before posting.. sorry for the noise.
Comment 15 Jonathan Druart 2023-12-05 08:37:13 UTC
243     'preservation/trains/'                     => '/preservation.html#trains',

Shouldn't it link to /preservation.html#show-train?
Comment 16 Jonathan Druart 2023-12-05 08:37:25 UTC
Everything is perfect, thanks a lot!
Comment 17 Martin Renvoize 2023-12-05 14:21:49 UTC
Created attachment 159582 [details] [review]
Bug 35463: Link preservation module help to the manual

This patch links the various pages of the preservation module to each
specific section of the preservation module chapter in the manual.

To test:
1.  Enable the PreservationModule system preference
2.  Go to the Preservation module
3.  Click "help" in the top right corner
    --> You are brought to the manual, but not a specific page
4.  Apply patch
5.  Click "Help" in the top right corner
    --> You are brought to the Preservation chapter of the manual
6.  Click "Settings"
7.  Click "Help" in the top right corner
    --> You are brought to the Settings section of the Preservation chapter of the manual
8.  Choose a not for loan status for items added to the waiting list (the mandatory field) and submit
9.  Click "Add a new processing"
10. Click "Help" in the top right corner
    --> You are brought to the Add a new processing section of the Preservation chapter of the manual
11. Fill out the form to create the processing and submit
12. Click "Edit this processing"
13. Click "Help" in the top right corner
    --> You are brought to the Add a new processing section of the Preservation chapter of the manual (there is no edit a processing section)
14.  Click "Waiting list"
15. Click "Help" in the top right corner
    --> You are brought to the Waiting list section of the Preservation chapter of the manual
16. Add items to the waiting list
17. Click "Trains"
18. Click "Help" in the top right corner
    --> You are brought to the Trains section of the Preservation chapter of the manual
19. Click "New train"
20. Click "Help" in the top right corner
    --> You are brought to the New train section of the Preservation chapter of the manual
21. Fill out the form to create a new train and submit
22. Click "Add items"
23. Click "Help" in the top right corner
    --> You are brought to the Add items section of the Preservation chapter of the manual

24. Also check ERM help links to make sure nothing is broken

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 18 Martin Renvoize 2023-12-05 14:21:52 UTC
Created attachment 159583 [details] [review]
Bug 35463: Open erm and preservation help in new tab

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 19 Martin Renvoize 2023-12-05 14:21:54 UTC
Created attachment 159584 [details] [review]
Bug 35463: perltidy formatting corrections

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 20 Martin Renvoize 2023-12-05 14:22:59 UTC
Great work, signing off
Comment 21 Caroline Cyr La Rose 2023-12-05 14:52:48 UTC
Created attachment 159586 [details] [review]
Bug 35463: More preservation manual links

This patch adds some missing links from the preservation module to the manual.

To test:
1. Go to Preservation > Trains
2. Click on a train name
   --> You are brought to the Show train section of the Preservation chapter of the manual
3. Click Edit next to an item
   --> You are brought to the Add items section of the Preservation chapter of the manual (there is no section specific to editing items, but the form to edit is the same as the form to add)
4. Go back to the trains list, and click the Edit button next to one of the trains
   --> You are brought to the Trains section of the Preservation chapter of the manual (there is no section specific to editing trains yet)
Comment 22 Caroline Cyr La Rose 2023-12-05 14:53:51 UTC
(In reply to Jonathan Druart from comment #15)
> 243     'preservation/trains/'                     =>
> '/preservation.html#trains',
> 
> Shouldn't it link to /preservation.html#show-train?

I added a new patch for this (as well as a couple of other pages).

I set the bug back to Needs Signoff.
Comment 23 Philip Orr 2023-12-07 13:01:36 UTC
Created attachment 159644 [details] [review]
Bug 35463: Link preservation module help to the manual

This patch links the various pages of the preservation module to each
specific section of the preservation module chapter in the manual.

To test:
1.  Enable the PreservationModule system preference
2.  Go to the Preservation module
3.  Click "help" in the top right corner
    --> You are brought to the manual, but not a specific page
4.  Apply patch
5.  Click "Help" in the top right corner
    --> You are brought to the Preservation chapter of the manual
6.  Click "Settings"
7.  Click "Help" in the top right corner
    --> You are brought to the Settings section of the Preservation chapter of the manual
8.  Choose a not for loan status for items added to the waiting list (the mandatory field) and submit
9.  Click "Add a new processing"
10. Click "Help" in the top right corner
    --> You are brought to the Add a new processing section of the Preservation chapter of the manual
11. Fill out the form to create the processing and submit
12. Click "Edit this processing"
13. Click "Help" in the top right corner
    --> You are brought to the Add a new processing section of the Preservation chapter of the manual (there is no edit a processing section)
14.  Click "Waiting list"
15. Click "Help" in the top right corner
    --> You are brought to the Waiting list section of the Preservation chapter of the manual
16. Add items to the waiting list
17. Click "Trains"
18. Click "Help" in the top right corner
    --> You are brought to the Trains section of the Preservation chapter of the manual
19. Click "New train"
20. Click "Help" in the top right corner
    --> You are brought to the New train section of the Preservation chapter of the manual
21. Fill out the form to create a new train and submit
22. Click "Add items"
23. Click "Help" in the top right corner
    --> You are brought to the Add items section of the Preservation chapter of the manual

24. Also check ERM help links to make sure nothing is broken

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Philip Orr <philip.orr@lmscloud.de>
Comment 24 Philip Orr 2023-12-07 13:01:43 UTC
Created attachment 159645 [details] [review]
Bug 35463: Open erm and preservation help in new tab

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Philip Orr <philip.orr@lmscloud.de>
Comment 25 Philip Orr 2023-12-07 13:01:46 UTC
Created attachment 159646 [details] [review]
Bug 35463: perltidy formatting corrections

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Philip Orr <philip.orr@lmscloud.de>
Comment 26 Philip Orr 2023-12-07 13:01:49 UTC
Created attachment 159647 [details] [review]
Bug 35463: More preservation manual links

This patch adds some missing links from the preservation module to the manual.

To test:
1. Go to Preservation > Trains
2. Click on a train name
   --> You are brought to the Show train section of the Preservation chapter of the manual
3. Click Edit next to an item
   --> You are brought to the Add items section of the Preservation chapter of the manual (there is no section specific to editing items, but the form to edit is the same as the form to add)
4. Go back to the trains list, and click the Edit button next to one of the trains
   --> You are brought to the Trains section of the Preservation chapter of the manual (there is no section specific to editing trains yet)

Signed-off-by: Philip Orr <philip.orr@lmscloud.de>
Comment 27 Martin Renvoize 2023-12-19 15:14:39 UTC
Created attachment 160013 [details] [review]
Bug 35463: Link preservation module help to the manual

This patch links the various pages of the preservation module to each
specific section of the preservation module chapter in the manual.

To test:
1.  Enable the PreservationModule system preference
2.  Go to the Preservation module
3.  Click "help" in the top right corner
    --> You are brought to the manual, but not a specific page
4.  Apply patch
5.  Click "Help" in the top right corner
    --> You are brought to the Preservation chapter of the manual
6.  Click "Settings"
7.  Click "Help" in the top right corner
    --> You are brought to the Settings section of the Preservation chapter of the manual
8.  Choose a not for loan status for items added to the waiting list (the mandatory field) and submit
9.  Click "Add a new processing"
10. Click "Help" in the top right corner
    --> You are brought to the Add a new processing section of the Preservation chapter of the manual
11. Fill out the form to create the processing and submit
12. Click "Edit this processing"
13. Click "Help" in the top right corner
    --> You are brought to the Add a new processing section of the Preservation chapter of the manual (there is no edit a processing section)
14.  Click "Waiting list"
15. Click "Help" in the top right corner
    --> You are brought to the Waiting list section of the Preservation chapter of the manual
16. Add items to the waiting list
17. Click "Trains"
18. Click "Help" in the top right corner
    --> You are brought to the Trains section of the Preservation chapter of the manual
19. Click "New train"
20. Click "Help" in the top right corner
    --> You are brought to the New train section of the Preservation chapter of the manual
21. Fill out the form to create a new train and submit
22. Click "Add items"
23. Click "Help" in the top right corner
    --> You are brought to the Add items section of the Preservation chapter of the manual

24. Also check ERM help links to make sure nothing is broken

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Philip Orr <philip.orr@lmscloud.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 28 Martin Renvoize 2023-12-19 15:14:42 UTC
Created attachment 160014 [details] [review]
Bug 35463: Open erm and preservation help in new tab

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Philip Orr <philip.orr@lmscloud.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 29 Martin Renvoize 2023-12-19 15:14:44 UTC
Created attachment 160015 [details] [review]
Bug 35463: perltidy formatting corrections

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Philip Orr <philip.orr@lmscloud.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 30 Martin Renvoize 2023-12-19 15:14:47 UTC
Created attachment 160016 [details] [review]
Bug 35463: More preservation manual links

This patch adds some missing links from the preservation module to the manual.

To test:
1. Go to Preservation > Trains
2. Click on a train name
   --> You are brought to the Show train section of the Preservation chapter of the manual
3. Click Edit next to an item
   --> You are brought to the Add items section of the Preservation chapter of the manual (there is no section specific to editing items, but the form to edit is the same as the form to add)
4. Go back to the trains list, and click the Edit button next to one of the trains
   --> You are brought to the Trains section of the Preservation chapter of the manual (there is no section specific to editing trains yet)

Signed-off-by: Philip Orr <philip.orr@lmscloud.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 31 Martin Renvoize 2023-12-19 15:15:22 UTC
Passing QA here.. two independent testers now and it's all looking good to me.
Comment 32 Katrin Fischer 2023-12-20 14:15:09 UTC
Pushed for 24.05!

Well done everyone, thank you!
Comment 33 Fridolin Somers 2024-01-03 15:31:14 UTC
Pushed to 23.11.x for 23.11.02
Comment 34 Lucas Gass 2024-01-04 20:57:21 UTC
Missing dependencies for 23.05.08, no backport.
Comment 35 Caroline Cyr La Rose 2024-01-04 21:14:19 UTC
There is nothing to add to the manual for this bug.