Bug 2326 - Help should be diff for each of the sys pref tabs
Summary: Help should be diff for each of the sys pref tabs
Status: Patch doesn't apply
Alias: None
Product: Koha
Classification: Unclassified
Component: System Administration (show other bugs)
Version: master
Hardware: All All
: P3 enhancement (vote)
Assignee: Aleisha Amohia
QA Contact:
URL:
Keywords:
: 2886 (view as bug list)
Depends on:
Blocks:
 
Reported: 2008-07-09 09:00 UTC by Nicole C. Engard
Modified: 2021-10-19 14:50 UTC (History)
6 users (show)

See Also:
Change sponsored?: Sponsored
Patch complexity: Large patch
Text to go in the release notes:
Version(s) released in:


Attachments
Bug 2326: Individual help pages for every tab in system preferences (292.77 KB, patch)
2017-02-13 22:19 UTC, Aleisha Amohia
Details | Diff | Splinter Review
Bug 2326: Individual help pages for every tab in system preferences (292.77 KB, patch)
2017-02-20 22:04 UTC, Aleisha Amohia
Details | Diff | Splinter Review
Bug 2326: Individual help pages for every tab in system preferences (292.77 KB, patch)
2017-02-21 23:31 UTC, Aleisha Amohia
Details | Diff | Splinter Review
Bug 2326: Individual help pages for every tab in system preferences (293.09 KB, patch)
2017-02-22 05:40 UTC, Marc Véron
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Cormack 2010-05-21 00:49:53 UTC


---- Reported by nengard@gmail.com 2008-07-09 09:00:18 ----

When on Global System Preference the help button should correspond to the tab you're on instead of to a complete list of preferences regardless of the tab you're on.


PER CHAT:

 <nengard> i'm going to assume the answer is no - but i want to ask just in case - is there any way to have the help link on the system preferences page different for each tab on the page?  right now it's all system preferences - but it's not really all system preferences - so it's silly
 <atz> nengard: yeah, that part is crappy.  it should be possible to do something extra there
 <nengard> atz should i submit as enhancement or is that a quick fix we could do so i can update the help to match my documentation?
 <atz> enhancement



--- Bug imported by chris@bigballofwax.co.nz 2010-05-21 00:49 UTC  ---

This bug was previously known as _bug_ 2326 at http://bugs.koha.org/cgi-bin/bugzilla3/show_bug.cgi?id=2326

Actual time not defined. Setting to 0.0
CC member bchurch@ptfs.com does not have an account here
CC member jmf@liblime.com does not have an account here
CC member joe.atzberger@liblime.com does not have an account here

Comment 1 Paul Poulain 2011-08-02 13:39:08 UTC
*** Bug 2886 has been marked as a duplicate of this bug. ***
Comment 2 Owen Leonard 2012-08-30 17:19:49 UTC
Digging this up again, it seems like it would be simple to implement from the script side of things. We'd have to create a special case for admin/preferences where the query string was processed. After that, create separate preferences help files based on a simple pattern like "help/admin/preferences_staff_client.tt"

Is isolating the query string a matter of a good regular expression, or might there be some existing URL-crunching code to use?
Comment 3 Aleisha Amohia 2017-02-13 22:19:51 UTC
Created attachment 60166 [details] [review]
Bug 2326: Individual help pages for every tab in system preferences

To test:
1) Apply patch
2) Confirm that when not on any particular tab, the general help shows
as usual
3) Confirm that when on a specific tab, the help that shows up is
correct
4) Confirm that all links in the help file work correctly
5) Confirm this works for every tab

Sponsored-by: Catalyst IT
Comment 4 Marc Véron 2017-02-17 10:08:29 UTC
I went through all tabs, works OK. However I did not read everything.
Found one small typo in a title: 
"Patorns System Preferences"
Comment 5 Aleisha Amohia 2017-02-20 22:04:24 UTC
Created attachment 60482 [details] [review]
Bug 2326: Individual help pages for every tab in system preferences

To test:
1) Apply patch
2) Confirm that when not on any particular tab, the general help shows
as usual
3) Confirm that when on a specific tab, the help that shows up is
correct
4) Confirm that all links in the help file work correctly
5) Confirm this works for every tab

Sponsored-by: Catalyst IT
Comment 6 Marc Véron 2017-02-20 22:21:23 UTC
Re-tested. QA tools found 2 issues (sorry, I was not aware of with my previous test):
-----------------------

 FAIL	koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_circulation.tt
   OK	  forbidden patterns
   OK	  git manipulation
   FAIL	  spelling
		 adminstration  ==> administration
		 everytime  ==> every time
   OK	  tt_valid
   OK	  valid_template


--------------------------

 FAIL	koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_opac.tt
   FAIL	  forbidden patterns
		forbidden pattern: opac-tmpl should certainly replaced with [% interface %] (line 376)
		forbidden pattern: opac-tmpl should certainly replaced with [% interface %] (line 110)
Comment 7 Aleisha Amohia 2017-02-21 23:31:47 UTC
Created attachment 60537 [details] [review]
Bug 2326: Individual help pages for every tab in system preferences

To test:
1) Apply patch
2) Confirm that when not on any particular tab, the general help shows
as usual
3) Confirm that when on a specific tab, the help that shows up is
correct
4) Confirm that all links in the help file work correctly
5) Confirm this works for every tab

Sponsored-by: Catalyst IT
Comment 8 Aleisha Amohia 2017-02-21 23:33:23 UTC
(In reply to Marc Véron from comment #6)
> Re-tested. QA tools found 2 issues (sorry, I was not aware of with my
> previous test):
> -----------------------
> 
>  FAIL
> koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_circulation.tt
>    OK	  forbidden patterns
>    OK	  git manipulation
>    FAIL	  spelling
> 		 adminstration  ==> administration
> 		 everytime  ==> every time
>    OK	  tt_valid
>    OK	  valid_template
> 
> 
> --------------------------
I have fixed these in latest patch.

> 
>  FAIL	koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_opac.tt
>    FAIL	  forbidden patterns
> 		forbidden pattern: opac-tmpl should certainly replaced with [% interface
> %] (line 376)
> 		forbidden pattern: opac-tmpl should certainly replaced with [% interface
> %] (line 110)
I did not fix these because the instances of 'opac-tmpl' in the patch are examples of paths to css files, not actual URLs. Anyway, if i used [% interface %] in their place, it would change to intranet-tmpl and incorrect.
Comment 9 Marc Véron 2017-02-22 05:40:35 UTC
Created attachment 60540 [details] [review]
Bug 2326: Individual help pages for every tab in system preferences

To test:
1) Apply patch
2) Confirm that when not on any particular tab, the general help shows
as usual
3) Confirm that when on a specific tab, the help that shows up is
correct
4) Confirm that all links in the help file work correctly
5) Confirm this works for every tab

Sponsored-by: Catalyst IT

Followed testplan, works as expected. For QA tools not passing
with "forbidden pattern: opac-tmpl should certainly replaced
with [% interface %]" for file preferences_opac.tt see comment #8
Signed-off-by: Marc Véron <veron@veron.ch>
Comment 10 Jonathan Druart 2017-02-22 11:48:23 UTC
I have the feeling that with this patch we are introducing another hard-to-keep-updated thing.
I am wondering if a link to the online manual would not be better/enough. Otherwise we need a script + tests to make sure the help files are updated.

For instance the patch is already wrong, it lists 'Persona' whereas it has been removed.
Comment 11 Owen Leonard 2021-10-19 14:50:46 UTC
This bug predates the switch to using the online manual for help, but it makes me wonder if we could do more to link people to the relevant section of the online manual.