new feature : online HELP
authortipaul <tipaul>
Thu, 3 Jun 2004 10:20:52 +0000 (10:20 +0000)
committertipaul <tipaul>
Thu, 3 Jun 2004 10:20:52 +0000 (10:20 +0000)
On each template, a "HELP" link has been added.
it opens a popup, filled with an help template.
the help template is in the help/ directory.
The help.pl files builds the online help using the name of the caller page (referer).

If the user clic on "help" when on page "admin/itemtypes.pl", the "help/admin/itemtypes.tmpl" is opened.
If the "help/admin/itemtypes.tmpl" does not exists, a default "sorry, no help on this topic" page is shown.

Works fine, but now, the big work has to be done : create the online help pages...

help.pl [new file with mode: 0755]
koha-tmpl/intranet-tmpl/default/en/help/admin/itemtypes.tmpl [new file with mode: 0644]
koha-tmpl/intranet-tmpl/default/en/help/nohelp.tmpl [new file with mode: 0644]

diff --git a/help.pl b/help.pl
new file mode 100755 (executable)
index 0000000..f06d7aa
--- /dev/null
+++ b/help.pl
@@ -0,0 +1,45 @@
+#!/usr/bin/perl
+use HTML::Template;
+use strict;
+require Exporter;
+use C4::Output;  # contains gettemplate
+use C4::Interface::CGI::Output;
+# use C4::Auth;
+use C4::Context;
+use CGI;
+
+my $query = new CGI;
+
+# find the script that called the online help using the CGI referer()
+
+my $refer  = $query->referer();
+$refer =~ /.*koha\/(.*)\.pl.*/;
+my $from = "help/$1.tmpl";
+
+my $template = gethelptemplate($from,"intranet");
+# my $template
+output_html_with_http_headers $query, "", $template->output;
+
+
+sub gethelptemplate {
+       my ($tmplbase) = @_;
+
+       my $htdocs;
+               $htdocs = C4::Context->config('intrahtdocs');
+       my ($theme, $lang) = themelanguage($htdocs, $tmplbase, "intranet");
+       unless (-e "$htdocs/$theme/$lang/$tmplbase") {
+               $tmplbase="help/nohelp.tmpl";
+               my ($theme, $lang) = themelanguage($htdocs, $tmplbase, "intranet");
+       }
+       my $template = HTML::Template->new(filename      => "$htdocs/$theme/$lang/$tmplbase",
+                                  die_on_bad_params => 0,
+                                  global_vars       => 1,
+                                  path              => ["$htdocs/$theme/$lang/includes"]);
+
+       # XXX temporary patch for Bug 182 for themelang
+       $template->param(themelang => '/intranet-tmpl' . "/$theme/$lang",
+                                                       interface => '/intranet-tmpl',
+                                                       theme => $theme,
+                                                       lang => $lang);
+       return $template;
+}
diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/itemtypes.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/itemtypes.tmpl
new file mode 100644 (file)
index 0000000..9bada1f
--- /dev/null
@@ -0,0 +1,9 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+       <h1>Item types</h1>
+       <p>You can define as many itemtypes as you want.</p>
+       <p>Item types are useful for many things :</p>
+       <ul>
+               <li>Borrowers can search on itemtypes</li>
+               <li>Issuing rules are set for item types (and for borrower types / branches)</li>
+       </ul>
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/default/en/help/nohelp.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/nohelp.tmpl
new file mode 100644 (file)
index 0000000..de8eefa
--- /dev/null
@@ -0,0 +1,4 @@
+<!-- TMPL_INCLUDE name="help-top.inc" -->
+       <h1>Online Help</h1>
+       <p>Sorry, no help on this topic</p>
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file