From c3f15c7e28ba6ed015f10ac3fe2f1126433def18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20V=C3=A9ron?= Date: Sun, 23 Apr 2017 00:22:51 +0200 Subject: [PATCH] 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 (Amended to resolve minor merge conflict. 2017-09-05 mv) Signed-off-by: Kyle M Hall --- edithelp.pl | 13 +- help.pl | 53 +++++++- ...dd_system_preference_CustomOnlineHelpStaff.perl | 2 +- .../bug_18483_news-driven-help-system.perl | 17 +++ installer/data/mysql/sysprefs.sql | 2 +- installer/data/mysql/userpermissions.sql | 1 + .../intranet-tmpl/prog/en/includes/header.inc | 2 +- .../intranet-tmpl/prog/en/includes/help-bottom.inc | 15 ++- .../intranet-tmpl/prog/en/includes/help-top.inc | 54 +++++--- .../intranet-tmpl/prog/en/includes/permissions.inc | 1 + .../prog/en/modules/admin/preferences/admin.pref | 1 + .../intranet-tmpl/prog/en/modules/help/mainpage.tt | 5 +- .../prog/en/modules/help/nohelptext.tt | 2 + .../prog/en/modules/tools/koha-news.tt | 144 +++++++++++++-------- .../prog/en/modules/tools/tools-home.tt | 14 +- tools/koha-news.pl | 48 ++++++- 16 files changed, 267 insertions(+), 107 deletions(-) create mode 100644 installer/data/mysql/atomicupdate/bug_18483_news-driven-help-system.perl create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/nohelptext.tt diff --git a/edithelp.pl b/edithelp.pl index dca61b1..e2ec5f4 100755 --- a/edithelp.pl +++ b/edithelp.pl @@ -18,6 +18,7 @@ # along with Koha; if not, see . use Modern::Perl; +use C4::Koha; use C4::Output; use C4::Templates; use C4::Auth; @@ -45,17 +46,7 @@ my ( $template, $loggedinuser, $cookie ) = get_template_and_user( query => $input, type => "intranet", authnotrequired => 0, - flagsrequired => { - catalogue => 1, - circulate => 1, - parameters => 1, - borrowers => 1, - permissions => 1, - reserveforothers => 1, - reserveforself => 1, - editcatalogue => 1, - updatecharges => 1, - }, + flagsrequired => { tools => 'edit_help' }, debug => 1, } ); diff --git a/help.pl b/help.pl index ad86a2d..4d13684 100755 --- a/help.pl +++ b/help.pl @@ -21,7 +21,8 @@ use strict; use warnings; use C4::Templates; use C4::Output; -# use C4::Auth; +use C4::NewsChannels; # GetNewsToDisplay +use C4::Auth; use C4::Context; use CGI qw ( -utf8 ); @@ -43,28 +44,72 @@ my $query = new CGI; # This is usually set by get_template_and_user C4::Context->interface('intranet'); +my $helpsys = C4::Context->preference('HelpSystem'); + # find the script that called the online help using the CGI referer() our $refer = $query->param('url'); $refer = $query->referer() if !$refer || $refer eq 'undefined'; +# replace referer if we come back from news edit popup +$refer = $query->param('popupreferer') if defined $query->param('popupreferer') ; + my $from = _help_template_file_of_url($refer); +my $helpkey = substr( $from, 0, rindex( $from, q{.} ) ); my $htdocs = C4::Context->config('intrahtdocs'); -# +#Template for 'classic' Koha help text (filebased) if needed, otherwise no text + # checking that the help file exist, otherwise, display nohelp.tt page -# my ( $theme, $lang ) = C4::Templates::themelanguage( $htdocs, $from, "intranet", $query ); + unless ( -e "$htdocs/$theme/$lang/modules/$from" ) { $from = "help/nohelp.tt"; ( $theme, $lang ) = C4::Templates::themelanguage( $htdocs, $from, "intranet", $query ); } -my $template = C4::Templates::gettemplate($from, 'intranet', $query); +# Classic Koha help text not used +if ( $helpsys eq 'newsbased' ) { + #Template without classic Koha help text + $from = "help/nohelptext.tt"; + ( $theme, $lang ) = C4::Templates::themelanguage( $htdocs, $from, "intranet", $query ); +} + +#my $template = C4::Templates::gettemplate($from, 'intranet', $query); + +my ( $template, $borrowernumber, $cookie ) = get_template_and_user( + { + template_name => $from, + query => $query, + type => "intranet", + authnotrequired => 0, + } +); + + + + $template->param( referer => $refer, + helpkey => $helpkey, intranetstylesheet => C4::Context->preference("intranetstylesheet"), intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"), + helpsystem => $helpsys, ); +if ( index($helpsys,'newsbased') != -1 || index ($helpsys,'filebased') != -1 ) { + + my $homebranch; + if (C4::Context->userenv) { + $homebranch = C4::Context->userenv->{'branch'}; + } + my $help_from_news = &GetNewsToDisplay('staffhelp', $homebranch); + my $help_from_news_count = scalar @$help_from_news; + $template->param( + help_from_news => $help_from_news, + help_from_news_count => $help_from_news_count, + homebranch => $homebranch + ); +} + my $help_version = C4::Context->preference("Version"); if ( $help_version =~ m|^(\d+)\.(\d{2}).*$| ) { my $version = $1; diff --git a/installer/data/mysql/atomicupdate/bug_18472-Add_system_preference_CustomOnlineHelpStaff.perl b/installer/data/mysql/atomicupdate/bug_18472-Add_system_preference_CustomOnlineHelpStaff.perl index ce31d2d..a523c76 100644 --- a/installer/data/mysql/atomicupdate/bug_18472-Add_system_preference_CustomOnlineHelpStaff.perl +++ b/installer/data/mysql/atomicupdate/bug_18472-Add_system_preference_CustomOnlineHelpStaff.perl @@ -1,7 +1,7 @@ $DBversion = 'XXX'; # will be replaced by the RM if( CheckVersion( $DBversion ) ) { # you can use $dbh here like: - $dbh->do("INSERT IGNORE INTO systempreferences (`variable`, `value`, `options`, `explanation`, `type`) VALUES ('HelpSystem', 'filebased', 'filebased', 'Select online help system.', 'multiple')" ); + $dbh->do("INSERT IGNORE INTO systempreferences (`variable`, `value`, `options`, `explanation`, `type`) VALUES ('HelpSystem', 'filebased', 'filebased|newsbased', 'Select online help system.', 'multiple')" ); $dbh->do("INSERT IGNORE INTO systempreferences (`variable`, `value`, `options`, `explanation`, `type`) VALUES ('EnableEditingFilebasedHelp', '1', '', 'Enable editing of file based Koha help.', 'yesno')" ); # or perform some test and warn diff --git a/installer/data/mysql/atomicupdate/bug_18483_news-driven-help-system.perl b/installer/data/mysql/atomicupdate/bug_18483_news-driven-help-system.perl new file mode 100644 index 0000000..c00c8dc --- /dev/null +++ b/installer/data/mysql/atomicupdate/bug_18483_news-driven-help-system.perl @@ -0,0 +1,17 @@ +$DBversion = 'XXXX'; # will be replaced by the RM +if( CheckVersion( $DBversion ) ) { + # you can use $dbh here like: + $dbh->do( "UPDATE systempreferences SET VALUE = 'filebased', OPTIONS = 'filebased|newsbased' where variable = 'HelpSystem'" ); + + $dbh->do( "ALTER TABLE opac_news ADD COLUMN helpkey varchar(250) AFTER lang "); + $dbh->do( "INSERT IGNORE INTO permissions (module_bit, code, description) VALUES (13, 'edit_help', 'Edit custom help');" ); + + # or perform some test and warn + # if( !column_exists( 'biblio', 'biblionumber' ) ) { + # warn "There is something wrong"; + # } + + # Always end with this (adjust the bug info) + SetVersion( $DBversion ); + print "Upgrade to $DBversion done (Bug 18483 - Customised help: Enhance staff client with news based, easily editable help system)\n"; +} diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql index e0f2c74..2a0541b 100644 --- a/installer/data/mysql/sysprefs.sql +++ b/installer/data/mysql/sysprefs.sql @@ -115,7 +115,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, ` ('CronjobLog','0',NULL,'If ON, log information from cron jobs.','YesNo'), ('CumulativeRestrictionPeriods',0,NULL,'Cumulate the restriction periods instead of keeping the highest','YesNo'), ('CurrencyFormat','US','US|FR|CH','Determines the display format of currencies. eg: \'36000\' is displayed as \'360 000,00\' in \'FR\' or \'360,000.00\' in \'US\'.','Choice'), -('HelpSystem', 'filebased', 'filebased', 'Select online help system.', 'multiple'), +('HelpSystem', 'filebased', 'filebased|newsbased', 'Select online help system.', 'multiple'), ('EnableEditingFilebasedHelp', '1', '', 'Enable editing of file based Koha help.', 'yesno'), ('dateformat','us','metric|us|iso|dmydot','Define global date format (us mm/dd/yyyy, metric dd/mm/yyy, ISO yyyy-mm-dd, dmydot dd.mm.yyyy)','Choice'), ('DebugLevel','2','0|1|2','Define the level of debugging information sent to the browser when errors are encountered (set to 0 in production). 0=none, 1=some, 2=most','Choice'), diff --git a/installer/data/mysql/userpermissions.sql b/installer/data/mysql/userpermissions.sql index 172f4c6..ce41cc8 100644 --- a/installer/data/mysql/userpermissions.sql +++ b/installer/data/mysql/userpermissions.sql @@ -30,6 +30,7 @@ INSERT INTO permissions (module_bit, code, description) VALUES (11, 'budget_manage_all', 'Manage all budgets'), (11, 'edi_manage', 'Manage EDIFACT transmissions'), (13, 'edit_news', 'Write news for the OPAC and staff interfaces'), + (13, 'edit_help', 'Edit custom help'), (13, 'label_creator', 'Create printable labels and barcodes from catalog and patron data'), (13, 'edit_calendar', 'Define days when the library is closed'), (13, 'moderate_comments', 'Moderate patron comments'), diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc index 1bce93f..6a80b57 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc @@ -99,7 +99,7 @@ [% INCLUDE 'langmenu-staff-top.inc' %] - [% IF Koha.Preference('HelpSystem') == 'filebased' %] + [% IF Koha.Preference('HelpSystem').match('filebased|newsbased') %]
  • Help
    • diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/help-bottom.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/help-bottom.inc index 0ed2086..8d8f706 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/help-bottom.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/help-bottom.inc @@ -1,10 +1,15 @@ +[% USE Koha %] +
    -
    - [% IF (Koha.Preference('HelpSystem') == 'filebased') && (Koha.Preference('EnableEditingFilebasedHelp') ) %] - +
    + -
    - [% END %] + [% IF ( Koha.Preference('HelpSystem').match('filebased') && Koha.Preference('EnableEditingFilebasedHelp') && CAN_user_tools_edit_help ) %] + + + [% END %] +
    + diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/help-top.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/help-top.inc index ff6aeb8..b914d0e 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/help-top.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/help-top.inc @@ -1,21 +1,43 @@ [% USE Koha %] +[% USE Branches %] [% INCLUDE 'doc-head-open.inc' %] Online help - - - - -[% INCLUDE intranetstylesheet.inc %] -[% IF ( bidi ) %] - -[% END %] - - - - - - - - +[% USE Koha %] +[% INCLUDE 'doc-head-close.inc' %] + + +[% IF Koha.Preference('HelpSystem').match('newsbased') %] +
    +

    Help for [% Branches.GetName( homebranch ) %]

    + [% FOREACH helpitem IN help_from_news %] + [% IF (helpitem.helpkey == helpkey) || (helpitem.helpkey == 'all') %] +
    +

    [% helpitem.title %]

    +
    [% helpitem.content %]
    +
    [% helpitem.newdate %]
    +
    + [% IF CAN_user_tools_edit_help %] + + Edit + [% END %] +
    +
    + [% END %] + [% END %] + [% IF CAN_user_tools_edit_help %] +
    +

    + Add help for this page + Key is: [% helpkey %]

    +

    + Add help for all pages + Key is: all

    +
    +

    Note: You can manage and / or delete help entries in More › Tools

    + [% END %] +
    +[% END %] + +
    diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/permissions.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/permissions.inc index 7c6275a..7d6beac 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/permissions.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/permissions.inc @@ -57,6 +57,7 @@ [%- CASE 'batch_upload_patron_images' -%]Upload patron images in a batch or one at a time [%- CASE 'delete_anonymize_patrons' -%]Delete old borrowers and anonymize circulation history (deletes borrower reading history) [%- CASE 'edit_calendar' -%]Define days when the library is closed + [%- CASE 'edit_help' -%]Edit custom help [%- CASE 'edit_news' -%]Write news for the OPAC and staff interfaces [%- CASE 'edit_notice_status_triggers' -%]Set notice/status triggers for overdue items [%- CASE 'edit_notices' -%]Define notices diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref index 592994a..2401963 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref @@ -432,6 +432,7 @@ Administration: default: filebased multiple: filebased: "File based (staff client)" + newsbased: "News based" - - "Enable editing of file based Koha help: " - pref: EnableEditingFilebasedHelp diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/mainpage.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/mainpage.tt index ace8a28..a8354f9 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/mainpage.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/mainpage.tt @@ -2,7 +2,6 @@ [% INCLUDE 'help-top.inc' %]

    Welcome to Koha

    -

    If this is your first time logging into Koha, you should now go to Koha Administration and set up all system preferences, patron categories, item types and libraries. You should also review the other settings found in Administration.

    Once you have set up patron categories, you should create a new user in the Patrons module with superlibrarian permissions. Once that user is created, you should log in as that user rather than the root user which is set up as part of installation.

    @@ -18,7 +17,8 @@
  • Chat with Koha users and developers
    • -[% IF ( Koha.Preference('HelpSystem') == 'filebased' ) %] + [% IF Koha.Preference('HelpSystem').match('filebased') && (Koha.Preference('EnableEditingFilebasedHelp') && CAN_user_tools_edit_help ) %] +

    Can I edit the online help?

    You can edit the online help through the Koha Staff Client by clicking the "Edit Help" button. This feature has been designed so that library workflow and policies can be documented within Koha.

    @@ -26,6 +26,7 @@

    IMPORTANT: Your online help will be overwritten by the new Help when there is an upgrade. If you want to keep a copy of your online help, you should instruct your System Administrator to upgrade the Online Help directory in the Koha file tree.

    The online help directory is: 

    [% themelang %]/modules/help

    +

    Note: Files in help directory must be writeable to make this feature work. Additionally, system preference 'EnableEditingFilebasedHelp' must be set to 'Yes'.

    [% END %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/nohelptext.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/nohelptext.tt new file mode 100644 index 0000000..ea6af02 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/nohelptext.tt @@ -0,0 +1,2 @@ +[% INCLUDE 'help-top.inc' %] +[% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt index dd1ae84..9d73c22 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt @@ -1,3 +1,4 @@ +[% USE Koha %] [% USE KohaDates %] [% USE Branches %] [% INCLUDE 'doc-head-open.inc' %] @@ -72,11 +73,14 @@ tinyMCE.init({ -[% INCLUDE 'header.inc' %] -[% INCLUDE 'cat-search.inc' %] - [% END %] +
  • + [% IF ( Koha.Preference('HelpSystem').match('newsbased') && CAN_user_tools_edit_help ) %] + + [% IF ( new_detail.helpkey ) %] + + [% ELSIF ( helpkey ) %] + + [% ELSE %] + + [% END %] + Used for staff help. Will be populated for individual page when creating a new entry from 'Help'. Example: 'help/circ/circulation'. Use 'all' for all pages. + [% END %] + +
    • - -
    Cancel
    + +
    + [% IF popup_window %] + + Cancel + [% ELSE %] + + Cancel + [% END %] +
    [% ELSE %]
    - - + + [% INCLUDE langoptions %] +