https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |veron@veron.ch |ity.org | Status|NEW |ASSIGNED -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |18472 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18472 [Bug 18472] Add system preference CustomOnlineHelpStaff to hide / select custom online help system -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #62576|0 |1 is obsolete| | --- Comment #2 from Marc Véron <veron@veron.ch> --- Created attachment 62577 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62577&action=edit Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system can be used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). The display can be managed with a system preference (Bug 18472: Add system preference CustomOnlineHelpStaff to hide / select custom online help system). This patch is a first draft. It is not yet ready for testing or sign-off. Amended to resolve minor conflicts with Bug 18472 -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #62579|0 |1 is obsolete| | --- Comment #4 from Marc Véron <veron@veron.ch> --- Created attachment 62648 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62648&action=edit Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system can be used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). The display can be managed with a system preference (Bug 18472: Add system preference CustomOnlineHelpStaff to hide / select custom online help system). This patch is a first draft. It is not yet ready for testing or sign-off. Amended to resolve minor conflicts with Bug 18472 Amended to expand sysprefs from Bug 18472 Amended to add permissions -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #62705|0 |1 is obsolete| | --- Comment #6 from Marc Véron <veron@veron.ch> --- Created attachment 62718 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62718&action=edit Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system can be used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). The display can be managed with a system preference (Bug 18472: Add system preference CustomOnlineHelpStaff to hide / select custom online help system). This patch is a first draft. It is not yet ready for testing or sign-off. Amended to resolve minor conflicts with Bug 18472 Amended to expand sysprefs from Bug 18472 Amended to add permissions Amended for visibility of edit buttons Amended for updatedb fixes -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #62804|0 |1 is obsolete| | --- Comment #8 from Marc Véron <veron@veron.ch> --- Created attachment 62812 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62812&action=edit Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system can be used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). The display can be managed with a system preference (Bug 18472: Add system preference CustomOnlineHelpStaff to hide / select custom online help system). This patch is work in progress. It is not yet ready for testing or sign-off. Amended to resolve minor conflicts with Bug 18472 Amended to expand sysprefs from Bug 18472 Amended to add permissions Amended for visibility of edit buttons Amended for updatedb fixes Amended for managing permissions Amended to use news manging page as popup, needs Bug 13835 to test (not to apply) -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #62812|0 |1 is obsolete| | --- Comment #9 from Marc Véron <veron@veron.ch> --- Created attachment 62892 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62892&action=edit Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system can be used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). The display can be managed with a system preference (Bug 18472: Add system preference CustomOnlineHelpStaff to hide / select custom online help system). This patch is work in progress. It is not yet ready for testing or sign-off. Amended to resolve minor conflicts with Bug 18472 Amended to expand sysprefs from Bug 18472 Amended to add permissions Amended for visibility of edit buttons Amended for updatedb fixes Amended for managing permissions Amended to use news manging page as popup, needs Bug 13835 to test (not to apply) -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 --- Comment #11 from Marc Véron <veron@veron.ch> --- (In reply to M. Tompsett from comment #10)

Comment on attachment 62892 [details] [review] Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system

Review of attachment 62892 [details] [review]: -----------------------------------------------------------------

Thanks for testing and for your comments, I really appreciate! Yes, there seems to be a scoping issue with [% USE Koha %] in includes. If the parent of an include has [% USE Koha %], it is visible for the include. If the parent does not have [% USE Koha %], it is not visible for the include (even if a precedent sibling include has [% USE Koha %]). I had a similar problem with Bug 18472 (see there comments #2 and #12). BTW the patch is still work in progress. It is not yet ready for sign-off. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #62898|0 |1 is obsolete| | --- Comment #13 from Marc Véron <veron@veron.ch> --- Created attachment 62899 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62899&action=edit Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system can be used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). The display can be managed with a system preference (Bug 18472: Add system preference CustomOnlineHelpStaff to hide / select custom online help system). This patch is work in progress. It is not yet ready for testing or sign-off. Amended to resolve minor conflicts with Bug 18472 Amended to expand sysprefs from Bug 18472 Amended to add permissions Amended for visibility of edit buttons Amended for updatedb fixes Amended for managing permissions Amended to use news managing page as popup, needs Bug 13835 to test (not to apply) Amended to make it apply again on 18472 Amended for better cycle through popup Still work in progress, not yet ready to test. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #62900|0 |1 is obsolete| | --- Comment #15 from Marc Véron <veron@veron.ch> --- Created attachment 62901 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62901&action=edit Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system is used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). Du to the need of this user permissen, a user permission for editing news is implemented as well. Display can be managed with a system preference (Bug 18472: Add system preference to manage online help system). Preferences default to legacy (fiele based) help. To test: - Apply patch on top of Bug 18472, restart memcached and plack - Update database (Alternative: fresh install) - Log in as superlibrarian (later we test the permisisons) - Verify that news behave as before - Verify that legacy help works as before - Locate system preferences 'EnableEditingFilebasedHelp' and 'Help system' - For our tests, set 'EnableEditingFilebasedHelp' to 'No' - In 'HelpSystem', uncheck 'File based' (none selected) - Refresh any page and verify that 'Help' Link in the main menu has vanished - Check both 'File based' and 'News based' - Verify that 'Help appears again in top menu - Click 'Help' for any page, verify that, above the 'classic' filebased help, you see a title 'Help for (library name) and two buttons 'Add help for this page' and 'Add help for all pages' - Close the help page - Go back to system preferences, select 'News based' only for 'HelpSystem' - Open Help again for any page - Verify that the text from file based help no longer displays, you should have a title and buttons only at the moment. - Click 'Add help for this page'. You are taken to the form you already know from editing 'News' - Click 'Cancel'. You should be taken back to the help page as before - Again click 'Add help for this page' and add an easyly identifiable title and some text, like you would do with news. - Leave the new field 'Help key' unchanged. - Submit. You should be taken back to the help you just created should appear - Close help page and open it again to verify that the text persists (for this page) - Go to an other page and verify that the help you added for the first page does not appear. - Add a help entry using the button 'Add help for all pages' - Go back to the first page you entered help for and verify, that it displays it's own help text and the text for all pages - Edit one of the texts, verify that it saves correctly - Add some more entries and verify that they appear as expected - Go to More > Tools (in an other tab) - Verify that the menu entry for News appears/disappears and changes text depending on the settings of system preference 'HelpSystem' - Open 'News' rsp. 'Help', verify that entries appear depending on the settings of syspref 'HelpSystem' - Verify that the filter for 'Display location' works - Verify that in the 'Location' column a hint about the page appears the entry was created for - Edit a staff help entry, verify that submit or close takes you back to the list - Bonus test: Edit a staff help entry, change the key to 'all', verify that the entry now appears for all pages. Change the key to 'help/admin/preferences' and verify that it appears now for the preferences page - Create a staff user with following permisisons only: catalogue (for login), edit_help and edit_news - Test visibility of news / help editing functionality depending on the edit_ permissions - Run QA tools -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=10232 -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |18515 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18515 [Bug 18515] Use news based help system for OPAC -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |18516 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18516 [Bug 18516] Add possibility to import text from file based help system as news based help system item -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Josef Moravec <josef.moravec@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #62901|0 |1 is obsolete| | --- Comment #18 from Josef Moravec <josef.moravec@gmail.com> --- Created attachment 62952 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=62952&action=edit [SIGNED-OFF] Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system is used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). Du to the need of this user permissen, a user permission for editing news is implemented as well. Display can be managed with a system preference (Bug 18472: Add system preference to manage online help system). Preferences default to legacy (fiele based) help. To test: - Apply patch on top of Bug 18472, restart memcached and plack - Update database (Alternative: fresh install) - Log in as superlibrarian (later we test the permisisons) - Verify that news behave as before - Verify that legacy help works as before - Locate system preferences 'EnableEditingFilebasedHelp' and 'Help system' - For our tests, set 'EnableEditingFilebasedHelp' to 'No' - In 'HelpSystem', uncheck 'File based' (none selected) - Refresh any page and verify that 'Help' Link in the main menu has vanished - Check both 'File based' and 'News based' - Verify that 'Help appears again in top menu - Click 'Help' for any page, verify that, above the 'classic' filebased help, you see a title 'Help for (library name) and two buttons 'Add help for this page' and 'Add help for all pages' - Close the help page - Go back to system preferences, select 'News based' only for 'HelpSystem' - Open Help again for any page - Verify that the text from file based help no longer displays, you should have a title and buttons only at the moment. - Click 'Add help for this page'. You are taken to the form you already know from editing 'News' - Click 'Cancel'. You should be taken back to the help page as before - Again click 'Add help for this page' and add an easyly identifiable title and some text, like you would do with news. - Leave the new field 'Help key' unchanged. - Submit. You should be taken back to the help you just created should appear - Close help page and open it again to verify that the text persists (for this page) - Go to an other page and verify that the help you added for the first page does not appear. - Add a help entry using the button 'Add help for all pages' - Go back to the first page you entered help for and verify, that it displays it's own help text and the text for all pages - Edit one of the texts, verify that it saves correctly - Add some more entries and verify that they appear as expected - Go to More > Tools (in an other tab) - Verify that the menu entry for News appears/disappears and changes text depending on the settings of system preference 'HelpSystem' - Open 'News' rsp. 'Help', verify that entries appear depending on the settings of syspref 'HelpSystem' - Verify that the filter for 'Display location' works - Verify that in the 'Location' column a hint about the page appears the entry was created for - Edit a staff help entry, verify that submit or close takes you back to the list - Bonus test: Edit a staff help entry, change the key to 'all', verify that the entry now appears for all pages. Change the key to 'help/admin/preferences' and verify that it appears now for the preferences page - Create a staff user with following permisisons only: catalogue (for login), edit_help and edit_news - Test visibility of news / help editing functionality depending on the edit_ permissions - Run QA tools Signed-off-by: Josef Moravec <josef.moravec@gmail.com> -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 --- Comment #20 from Marc Véron <veron@veron.ch> --- Still applies on current master -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 --- Comment #22 from Marc Véron <veron@veron.ch> --- Created attachment 66852 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=66852&action=edit Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system Koha's staff client has a file based help system with an edit function for customising. However, the edited files have to be saved and restored with each release. Otherwise they are overwritten. As an enhancement or alternative, the existing news system is used to implement a complementing help system. Similar to the news, the text can be created for all branches or for individual branches. Help is context sensitive (based on the existing help system), and it can be created / edited directly from the help page (based on a user permission). Du to the need of this user permissen, a user permission for editing news is implemented as well. Display can be managed with a system preference (Bug 18472: Add system preference to manage online help system). Preferences default to legacy (fiele based) help. To test: - Apply patch on top of Bug 18472, restart memcached and plack - Update database (Alternative: fresh install) - Log in as superlibrarian (later we test the permisisons) - Verify that news behave as before - Verify that legacy help works as before - Locate system preferences 'EnableEditingFilebasedHelp' and 'Help system' - For our tests, set 'EnableEditingFilebasedHelp' to 'No' - In 'HelpSystem', uncheck 'File based' (none selected) - Refresh any page and verify that 'Help' Link in the main menu has vanished - Check both 'File based' and 'News based' - Verify that 'Help appears again in top menu - Click 'Help' for any page, verify that, above the 'classic' filebased help, you see a title 'Help for (library name) and two buttons 'Add help for this page' and 'Add help for all pages' - Close the help page - Go back to system preferences, select 'News based' only for 'HelpSystem' - Open Help again for any page - Verify that the text from file based help no longer displays, you should have a title and buttons only at the moment. - Click 'Add help for this page'. You are taken to the form you already know from editing 'News' - Click 'Cancel'. You should be taken back to the help page as before - Again click 'Add help for this page' and add an easyly identifiable title and some text, like you would do with news. - Leave the new field 'Help key' unchanged. - Submit. You should be taken back to the help you just created should appear - Close help page and open it again to verify that the text persists (for this page) - Go to an other page and verify that the help you added for the first page does not appear. - Add a help entry using the button 'Add help for all pages' - Go back to the first page you entered help for and verify, that it displays it's own help text and the text for all pages - Edit one of the texts, verify that it saves correctly - Add some more entries and verify that they appear as expected - Go to More > Tools (in an other tab) - Verify that the menu entry for News appears/disappears and changes text depending on the settings of system preference 'HelpSystem' - Open 'News' rsp. 'Help', verify that entries appear depending on the settings of syspref 'HelpSystem' - Verify that the filter for 'Display location' works - Verify that in the 'Location' column a hint about the page appears the entry was created for - Edit a staff help entry, verify that submit or close takes you back to the list - Bonus test: Edit a staff help entry, change the key to 'all', verify that the entry now appears for all pages. Change the key to 'help/admin/preferences' and verify that it appears now for the preferences page - Create a staff user with following permisisons only: catalogue (for login), edit_help and edit_news - Test visibility of news / help editing functionality depending on the edit_ permissions - Run QA tools Signed-off-by: Josef Moravec <josef.moravec@gmail.com> (Amended to resolve minor merge conflict. 2017-09-05 mv) -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=15003 -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|P5 - low |P4 -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |kyle@bywatersolutions.com Status|Signed Off |Passed QA --- Comment #24 from Kyle M Hall <kyle@bywatersolutions.com> --- I'm a bit on the fence about this feature. I *really* like the concept. Piggybacking on the news feature has got me a bit iffy. It would be better if it were independent, but that would require a lot of duplicate code for better or worse. Jonathan, what do you think? -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 --- Comment #26 from Marc Véron <veron@veron.ch> --- (In reply to Jonathan Druart from comment #25)

I still think it is not a good idea to hijack the news feature for the help editing.

It is not hijacking, it is a reuse of an existing module. It works nicely, and the libraries are able to add *library specific help* to Koha. As I wrote in comment #21, adding library specific help is a long outstandig issue (the first time we were asked for was in 2012 !). - Should we wait another 5 years to implement a library specific help system?

We are currently working on the manual and its translation. We already thought a bit about how we can stop duplicating the manual (the website and the help files inside Koha). An idea would be to link to the k-c.org manual from Koha (with the ability to link to a local git repository, a syspref/config would link to a local path). We could then imagine an editor to update the manual, inside Koha (the changes could be made adding commits to the git repository for the local changes a library made).

- That is a great idea, but it is about connecting and/or contributing to a localized Koha manual, and not about adding library specific help. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18483 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|In Discussion |RESOLVED Resolution|--- |WONTFIX --- Comment #27 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I think this would probably need a rewrite now since we have made substantial changes to the help system and the news editor. * We no longer have file based help files other content could be included in. We have replaced the help files with links to the manual. * We have extended the news feature and there are now also HTML customizatons and Pages. I believe pages would lend themselves to this even a bit better than the news. Overall I think after almost 6 years, this would need a fresh approach based on current version's functionality. Please feel free to re-open or open a new bug! -- You are receiving this mail because: You are watching all bug changes.