From efe910e5a16dff9b57a048179e65ae799d746256 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20V=C3=A9ron?= Date: Fri, 21 Apr 2017 15:39:56 +0200 Subject: [PATCH] Bug 18472: Add system preferences to manage online help system This patch introduces two new system preferences in section 'Administration' - 'HelpSystem' to select / disable the help system to use. It is designed to allow future expansions (alternative / complementing help system), thats why it is a 'Multiple choice' with one choice - 'EnableEditingFilebasedHelp' is used to toggle on/off the 'Edit' field that appears at the bottom of the durrent help pages. To test: - In staff client, open help on some pages, including help on main page - They have a button 'Edit help'. On main page help, you see a text about 'Can I edit the online help?' - Apply patch, restart memcached and plack - Update database - In staff client, go to Administration > System preferences > Administration - Locate section 'Help system', do not yet schange settings - Verify that the help pages you visited look the same as before - Change syspref 'EnableEditingFilebasedHelp' to 'No' - Visit the help pages again, verify that 'Edit help' button no longer appears. - Set the system preference 'HelpSystem' to none (deselect 'File based (staff client) - Reload any page and verify that the 'Help' link in the page header does no longer display - In syspref 'HelpSystem', check 'File based (staff client)' - Reload any page, verify that the 'Help' link is displayed (Amended to correct wrong line in sysprefs.sql 201-04-29 mv) Signed-off-by: Josef Moravec (Minor change to make it apply on current master 2017-09-05 mv) Signed-off-by: Kyle M Hall --- ...18472-Add_system_preference_CustomOnlineHelpStaff.perl | 15 +++++++++++++++ installer/data/mysql/sysprefs.sql | 2 ++ koha-tmpl/intranet-tmpl/prog/en/includes/header.inc | 9 ++++++--- koha-tmpl/intranet-tmpl/prog/en/includes/help-bottom.inc | 10 ++++++---- koha-tmpl/intranet-tmpl/prog/en/includes/help-top.inc | 1 + .../prog/en/modules/admin/preferences/admin.pref | 15 +++++++++++++++ koha-tmpl/intranet-tmpl/prog/en/modules/help/mainpage.tt | 12 ++++++++---- 7 files changed, 53 insertions(+), 11 deletions(-) create mode 100644 installer/data/mysql/atomicupdate/bug_18472-Add_system_preference_CustomOnlineHelpStaff.perl 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 new file mode 100644 index 0000000..ce31d2d --- /dev/null +++ b/installer/data/mysql/atomicupdate/bug_18472-Add_system_preference_CustomOnlineHelpStaff.perl @@ -0,0 +1,15 @@ +$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 ('EnableEditingFilebasedHelp', '1', '', 'Enable editing of file based Koha help.', 'yesno')" ); + + # 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 18472 - Add system preference CustomOnlineHelpStaff to hide / select custom online help system)\n"; +} diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql index 4647789..e0f2c74 100644 --- a/installer/data/mysql/sysprefs.sql +++ b/installer/data/mysql/sysprefs.sql @@ -115,6 +115,8 @@ 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'), +('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'), ('decreaseLoanHighHolds',NULL,'','Decreases the loan period for items with number of holds above the threshold specified in decreaseLoanHighHoldsValue','YesNo'), diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc index 7573ac2..1bce93f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc @@ -1,3 +1,4 @@ +[% USE Koha %] [% USE Branches %]