The "help" link in the new preservation module needs to point to the new preservation module chapter in the manual.
Created attachment 159456 [details] [review] WIP adding preservation links
Added bug 33346 to the see also as an example of how vue module help works.. hope it helps.
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
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
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.
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. :-)
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
Forget 1, it's a "starting with". Looks good then.
(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
(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.
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.
Created attachment 159564 [details] [review] Bug 35463: perltidy formatting corrections
The window open for other help links is found in https://git.koha-community.org/Koha-community/Koha/src/commit/b6f350e27598ff68d930880fddc7dcb6c08719fd/koha-tmpl/intranet-tmpl/prog/js/staff-global.js. I think for the Vue equivalent we'll 2ant to adapt the Vue component, https://git.koha-community.org/Koha-community/Koha/src/commit/5a188651e484517f28367e44183b680fa77ad77b/koha-tmpl/intranet-tmpl/prog/js/vue/components/Help.vue
Oops, must read full pay he's including follow-ups before posting.. sorry for the noise.
243 'preservation/trains/' => '/preservation.html#trains', Shouldn't it link to /preservation.html#show-train?
Everything is perfect, thanks a lot!
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>
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>
Created attachment 159584 [details] [review] Bug 35463: perltidy formatting corrections Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Great work, signing off
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)
(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.
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>
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>
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>
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>
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>
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>
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>
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>
Passing QA here.. two independent testers now and it's all looking good to me.
Pushed for 24.05! Well done everyone, thank you!
Pushed to 23.11.x for 23.11.02
Missing dependencies for 23.05.08, no backport.
There is nothing to add to the manual for this bug.