Summary: | Help should be diff for each of the sys pref tabs | ||
---|---|---|---|
Product: | Koha | Reporter: | Nicole C. Engard <nengard> |
Component: | System Administration | Assignee: | Aleisha Amohia <aleisha> |
Status: | RESOLVED DUPLICATE | QA Contact: | |
Severity: | enhancement | ||
Priority: | P3 | CC: | aleisha, chris, gmcharlt, jonathan.druart, martin.renvoize, nick, veron |
Version: | Main | ||
Hardware: | All | ||
OS: | All | ||
See Also: | https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19817 | ||
GIT URL: | Change sponsored?: | Sponsored | |
Patch complexity: | Large patch | Documentation contact: | |
Documentation submission: | Text to go in the release notes: | ||
Version(s) released in: | Circulation function: | ||
Attachments: |
Bug 2326: Individual help pages for every tab in system preferences
Bug 2326: Individual help pages for every tab in system preferences Bug 2326: Individual help pages for every tab in system preferences Bug 2326: Individual help pages for every tab in system preferences |
Description
Chris Cormack
2010-05-21 00:49:53 UTC
*** Bug 2886 has been marked as a duplicate of this bug. *** 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? 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 I went through all tabs, works OK. However I did not read everything. Found one small typo in a title: "Patorns System Preferences" 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 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) 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 (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. 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> 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. 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. Martin accidentally fixed this one on bug 31465. Patch here would no longer work, as we have removed the help files since in favor of linking to the manual. *** This bug has been marked as a duplicate of bug 31465 *** Excellent [U+1F60A] |