Bug 19817: Make the location of the manual configurable - KohaManualBaseURL
authorJonathan Druart <jonathan.druart@bugs.koha-community.org>
Mon, 18 Dec 2017 19:21:25 +0000 (16:21 -0300)
committerNick Clemens <nick@bywatersolutions.com>
Thu, 6 Sep 2018 17:32:27 +0000 (17:32 +0000)
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

help.pl
installer/data/mysql/atomicupdate/bug_19817.sql [new file with mode: 0644]
installer/data/mysql/sysprefs.sql
koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/enhanced_content.pref

diff --git a/help.pl b/help.pl
index f1a273c..0c500b6 100755 (executable)
--- a/help.pl
+++ b/help.pl
@@ -36,9 +36,12 @@ if ( $help_version =~ m|^(\d+)\.(\d{2}).*$| ) {
     $help_version = "$version.$major";
 }
 
-# FIXME remote url must be a pref
 # FIXME /en/ must be configurable (or guessed)
-our $base_url = 'http://koha-community.org/manual/' . $help_version . '/en/html';
+my $KohaManualBaseURL = C4::Context->preference('KohaManualBaseURL') || 'http://koha-community.org/manual';
+if ( $KohaManualBaseURL =~ m|^/| ) {
+    $KohaManualBaseURL = C4::Context->preference('staffClientBaseURL') . $KohaManualBaseURL;
+}
+our $base_url = $KohaManualBaseURL . '/' . $help_version . '/en/html';
 our $mapping = {
     'about'                                    => '/14_plugins.html#about-koha',
     'acqui/acqui-home'                         => '/09_acquisitions.html',
diff --git a/installer/data/mysql/atomicupdate/bug_19817.sql b/installer/data/mysql/atomicupdate/bug_19817.sql
new file mode 100644 (file)
index 0000000..b2409eb
--- /dev/null
@@ -0,0 +1,2 @@
+INSERT IGNORE INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `type` )
+VALUES ('KohaManualBaseURL','http://koha-community.org/manual/','','Where is the Koha manual/documentation located?','Free');
index dab6b6b..682433a 100644 (file)
@@ -242,6 +242,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `
 ('itemBarcodeInputFilter','','whitespace|T-prefix|cuecat|libsuite8|EAN13','If set, allows specification of a item barcode input filter','Choice'),
 ('itemcallnumber','082ab',NULL,'The MARC field/subfield that is used to calculate the itemcallnumber (Dewey would be 082ab or 092ab; LOC would be 050ab or 090ab) could be 852hi from an item record','free'),
 ('KohaAdminEmailAddress','root@localhost','','Define the email address where patron modification requests are sent','free'),
+('KohaManualBaseURL','http://koha-community.org/manual/','','Where is the Koha manual/documentation located?','Free'),
 ('LabelMARCView','standard','standard|economical','Define how a MARC record will display','Choice'),
 ('language','en',NULL,'Set the default language in the staff client.','Languages'),
 ('LetterLog','1',NULL,'If ON, log all notices sent','YesNo'),
index 8f7b6e3..ddf0116 100644 (file)
@@ -380,3 +380,11 @@ Enhanced Content:
                 aws: Amazon Web Services
                 gb: Google Books
                 ol: Open Library
+
+    Manual:
+        -
+            - Location of the Koha manual
+            - pref: KohaManualBaseURL
+            - You can specify the location of the Koha manual to use. By default it is http://koha-community.org/manual/
+            - If starts with '/',  the value of staffClientBaseURL will be used as a prefix.
+            - Note that it will be suffixed by the version / the language / the format (/17.11/en/html)