[Rt-devel] [PATCH] Add new configuration HelpURL to provide local documentation to users

Dominic Hargreaves dominic.hargreaves at oucs.ox.ac.uk
Tue Mar 30 12:59:16 EDT 2010


This URL gets included as a 'Help' link in the main RT navigation menu.
---
 etc/RT_Config.pm.in      |    7 +++++++
 share/html/Elements/Tabs |    6 ++++++
 2 files changed, 13 insertions(+), 0 deletions(-)

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 4ad1411..b8252d4 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -1748,6 +1748,13 @@ Hide links/portlets related to Reminders by setting this to 0
 
 Set($EnableReminders,1);
 
+=item C<$HelpURL>
+
+Set this to a URL providing user documentation on your RT instance
+
+=cut
+
+Set($HelpURL, '');
 
 =item C<@Plugins>
 
diff --git a/share/html/Elements/Tabs b/share/html/Elements/Tabs
index 0e0ab97..ad5e5ee 100755
--- a/share/html/Elements/Tabs
+++ b/share/html/Elements/Tabs
@@ -100,6 +100,12 @@ if ($session{'CurrentUser'}->HasRight( Right => 'ShowApprovalsTab',
             };
 }
 
+if ( RT->Config->Get('HelpURL') ) {
+    $basetabs->{X} = { title => loc('Help'),
+                       path => RT->Config->Get('HelpURL')
+             };
+}
+
 if (!defined $toptabs) {
    $toptabs = $basetabs;
 }
-- 
1.5.6.5



More information about the rt-devel mailing list