X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=src%2Fhelp.php;h=2c0798c7d9cd671e8d5912ef17698e5b1b5adc42;hb=7571d218b25f4c8a701ed63a5c070e3f2a72f67b;hp=8e59f3182e0163b8a830dcae0baf6b59ad87f402;hpb=39bfea8fa9fd939da9766a79381f68ea4b725c23;p=squirrelmail.git
diff --git a/src/help.php b/src/help.php
index 8e59f318..2c0798c7 100644
--- a/src/help.php
+++ b/src/help.php
@@ -3,25 +3,18 @@
/**
* help.php
*
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
* Displays help for the user
*
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
*/
/**
- * Path for SquirrelMail required files.
- * @ignore
+ * Include the SquirrelMail initialization file.
*/
-define('SM_PATH','../');
-
-/* SquirrelMail required files. */
-require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/global.php');
-require_once(SM_PATH . 'functions/display_messages.php');
+require('../include/init.php');
displayPageHeader($color, 'None' );
@@ -51,8 +44,8 @@ function get_info($doc, $pos) {
for ($n=$pos; $n < $cntdoc; $n++) {
if (trim(strtolower($doc[$n])) == ''
|| trim(strtolower($doc[$n])) == '') {
- for ($n++; $n < $cntdoc
- && (trim(strtolower($doc[$n])) != '')
+ for ($n++; $n < $cntdoc
+ && (trim(strtolower($doc[$n])) != '')
&& (trim(strtolower($doc[$n])) != ''); $n++) {
if (trim(strtolower($doc[$n])) == '') {
$n++;
@@ -60,7 +53,7 @@ function get_info($doc, $pos) {
}
if (trim(strtolower($doc[$n])) == '<description>') {
$ary[1] = '';
- for ($n++;$n < $cntdoc
+ for ($n++;$n < $cntdoc
&& (trim(strtolower($doc[$n])) != '</description>');
$n++) {
$ary[1] .= $doc[$n];
@@ -68,8 +61,8 @@ function get_info($doc, $pos) {
}
if (trim(strtolower($doc[$n])) == '<summary>') {
$ary[2] = '';
- for ($n++; $n < $cntdoc
- && (trim(strtolower($doc[$n])) != '</summary>');
+ for ($n++; $n < $cntdoc
+ && (trim(strtolower($doc[$n])) != '</summary>');
$n++) {
$ary[2] .= $doc[$n];
}
@@ -82,13 +75,13 @@ function get_info($doc, $pos) {
$ary[1] = $ary[0];
$ary[2] = $ary[0];
}
- return( $ary );
+ return( $ary );
} else if (!trim(strtolower($doc[$n]))) {
- $ary[0] = '';
- $ary[1] = '';
- $ary[2] = '';
- $ary[3] = $n;
- }
+ $ary[0] = '';
+ $ary[1] = '';
+ $ary[2] = '';
+ $ary[3] = $n;
+ }
}
$ary[0] = _("ERROR: Help files are not in the right format!");
$ary[1] = $ary[0];
@@ -99,10 +92,9 @@ function get_info($doc, $pos) {
/**************[ END HELP FUNCTIONS ]******************/
-
echo html_tag( 'table',
html_tag( 'tr',
- html_tag( 'td','<center><b>' . _("Help") .'</b></center>', 'center', $color[0] )
+ html_tag( 'td','<div style="text-align: center;"><b>' . _("Help") .'</b></div>', 'center', $color[0] )
) ,
'center', '', 'width="95%" cellpadding="1" cellspacing="2" border="0"' );
@@ -119,12 +111,14 @@ if (!isset($squirrelmail_language)) {
if (file_exists("../help/$squirrelmail_language")) {
$user_language = $squirrelmail_language;
} else if (file_exists('../help/en_US')) {
- echo "<center><font color=\"$color[2]\">";
- printf (_("The help has not been translated to %s. It will be displayed in English instead."), $languages[$squirrelmail_language]['NAME']);
- echo '</font></center><br />';
+ error_box(_("Help is not available in the selected language. It will be displayed in English instead."));
+ echo '<br />';
$user_language = 'en_US';
} else {
- error_box( _("Some or all of the help documents are not present!"), $color );
+ error_box( _("Help is not available. Please contact your system administrator for assistance."));
+ echo '</td></tr></table>';
+ // Display footer (closes HTML tags) and stop script execution.
+ $oTemplate->display('footer.tpl');
exit;
}
@@ -151,24 +145,69 @@ if ( sqgetGlobalVar('chapter', $temp, SQ_GET) ) {
}
if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) {
+ // Initialise the needed variables.
+ $toc = array();
+
+ // Get the chapter numbers, title and decriptions.
+ for ($i=0, $cnt = count($helpdir); $i < $cnt; $i++) {
+ if (file_exists("../help/$user_language/$helpdir[$i]")) {
+ // First try the selected language.
+ $doc = file("../help/$user_language/$helpdir[$i]");
+ $help_info = get_info($doc, 0);
+ $toc[] = array($i+1, $help_info[0], $help_info[2]);
+ } elseif (file_exists("../help/en_US/$helpdir[$i]")) {
+ // If the selected language can't be found, try English.
+ $doc = file("../help/en_US/$helpdir[$i]");
+ $help_info = get_info($doc, 0);
+ $toc[] = array($i+1, $help_info[0],
+ _("This chapter is not available in the selected language. It will be displayed in English instead.") .
+ '<br />' . $help_info[2]);
+ } else {
+ // If English can't be found, the chapter went MIA.
+ $toc[] = array($i+1, _("This chapter is missing"),
+ sprintf(_("For some reason, chapter %s is not available."), $i+1));
+ }
+ }
+
+ // Write the TOC header
echo html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' ) .
- html_tag( 'tr' ) .
- html_tag( 'td' ) .
- '<b><center>' . _("Table of Contents") . '</center></b><br />';
+ html_tag( 'tr' ) .
+ html_tag( 'td' ) .
+ '<div style="text-align: center;"><b>' . _("Table of Contents") . '</b></div><br />';
echo html_tag( 'ol' );
- for ($i=0, $cnt = count($helpdir); $i < $cnt; $i++) {
- $doc = file("../help/$user_language/$helpdir[$i]");
- $help_info = get_info($doc, 0);
- echo '<li><a href="../src/help.php?chapter=' . ($i+1)
- . '">' . $help_info[0] . '</a>' .
- html_tag( 'ul', $help_info[2] );
+
+ // Write the TOC chapters.
+ // FIXME: HTML code is not compliant.
+ for ($i=0, $cnt = count($toc); $i < $cnt; $i++) {
+ echo '<li><a href="../src/help.php?chapter=' . $toc[$i][0]. '">' .
+ $toc[$i][1] . '</a>' . html_tag( 'ul', $toc[$i][2] );
}
+
+ // Provide hook for external help scripts.
do_hook('help_chapter');
+
+ // Write the TOC footer.
echo '</ol></td></tr></table>';
} else {
- $doc = file("../help/$user_language/" . $helpdir[$chapter-1]);
- $help_info = get_info($doc, 0);
- echo '<small><center>';
+ // Initialise the needed variables.
+ $display_chapter = TRUE;
+
+ // Get the chapter.
+ if (file_exists("../help/$user_language/" . $helpdir[$chapter-1])) {
+ // First try the selected language.
+ $doc = file("../help/$user_language/" . $helpdir[$chapter-1]);
+ } elseif (file_exists("../help/en_US/" . $helpdir[$chapter-1])) {
+ // If the selected language can't be found, try English.
+ $doc = file("../help/en_US/" . $helpdir[$chapter-1]);
+ error_box(_("This chapter is not available in the selected language. It will be displayed in English instead."));
+ echo '<br />';
+ } else {
+ // If English can't be found, the chapter went MIA.
+ $display_chapter = FALSE;
+ }
+
+ // Write the chpater header.
+ echo '<div style="text-align: center;"><small>';
if ($chapter <= 1){
echo '<font color="' . $color[9] . '">' . _("Previous")
. '</font> | ';
@@ -183,33 +222,45 @@ if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) {
echo ' | <a href="../src/help.php?chapter=' . ($chapter+1)
. '">' . _("Next") . '</a>';
}
- echo '</center></small><br />';
+ echo '</small></div><br />';
- echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0]
- . '</b></font><br /><br />';
+ // Write the chapter.
+ if ($display_chapter) {
+ // If there is a valid chapter, display it.
+ $help_info = get_info($doc, 0);
+ echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0]
+ . '</b></font><br /><br />';
+
+ if (isset($help_info[1]) && $help_info[1]) {
+ echo $help_info[1];
+ } else {
+ echo html_tag( 'p', $help_info[2], 'left' );
+ }
- if (isset($help_info[1]) && $help_info[1]) {
- echo $help_info[1];
+ $section = 0;
+ for ($n = $help_info[3], $cnt = count($doc); $n < $cnt; $n++) {
+ $section++;
+ $help_info = get_info($doc, $n);
+ echo "<b>$chapter.$section - $help_info[0]</b>" .
+ $help_info[1];
+ $n = $help_info[3];
+ }
+
+ echo '<br /><div style="text-align: center;"><a href="#pagetop">' . _("Top") . '</a></div>';
} else {
- echo html_tag( 'p', $help_info[2], 'left' );
- }
-
- $section = 0;
- for ($n = $help_info[3], $cnt = count($doc); $n < $cnt; $n++) {
- $section++;
- $help_info = get_info($doc, $n);
- echo "<b>$chapter.$section - $help_info[0]</b>" .
- html_tag( 'ul', $help_info[1] );
- $n = $help_info[3];
+ // If the help file went MIA, display an error message.
+ error_box(sprintf(_("For some reason, chapter %s is not available."), $chapter));
}
-
- echo '<br /><center><a href="#pagetop">' . _("Top") . '</a></center>';
}
do_hook('help_bottom');
echo html_tag( 'tr',
html_tag( 'td', ' ', 'left', $color[0] )
- ).
- '</table></body></html>';
+ );
+
+?>
+</table>
+<?php
+$oTemplate->display('footer.tpl');
?>
\ No newline at end of file