X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=src%2Fhelp.php;h=99671fbece74f26eb7b7e3057eb99d7ab0bec777;hb=3a85cfb8d54434a889f7782b0d79985408f965d0;hp=262d2979ee0ee839e4a6e53f82fb5811f5f46303;hpb=2d367c687f9813a45a3d2f1911036cfc0425fdd0;p=squirrelmail.git diff --git a/src/help.php b/src/help.php index 262d2979..99671fbe 100644 --- a/src/help.php +++ b/src/help.php @@ -1,194 +1,235 @@ " || trim(strtolower($doc[$n])) == "
") { - for ($n++;$n < count($doc) && (trim(strtolower($doc[$n])) != "
") && (trim(strtolower($doc[$n])) != ""); $n++) { - if (trim(strtolower($doc[$n])) == "") { - $n++; - $ary[0] = trim($doc[$n]); - } - if (trim(strtolower($doc[$n])) == "<description>") { - $ary[1] = ""; - for ($n++;$n < count($doc) && (trim(strtolower($doc[$n])) != "</description>"); $n++) { - $ary[1] .= $doc[$n]; - } - } - if (trim(strtolower($doc[$n])) == "<summary>") { - $ary[2] = ""; - for ($n++;$n < count($doc) && (trim(strtolower($doc[$n])) != "</summary>"); $n++) { - $ary[2] .= $doc[$n]; - } - } + +/** + * help.php + * + * Copyright (c) 1999-2002 The SquirrelMail Project Team + * Licensed under the GNU GPL. For full terms see the file COPYING. + * + * Displays help for the user + * + * $Id$ + */ + +/* Path for SquirrelMail required files. */ +define('SM_PATH','../'); + +/* SquirrelMail required files. */ +require_once(SM_PATH . 'include/validate.php'); +require_once(SM_PATH . 'functions/display_messages.php'); +require_once(SM_PATH . 'functions/imap.php'); +require_once(SM_PATH . 'functions/array.php'); + +displayPageHeader($color, 'None' ); + +$helpdir[0] = 'basic.hlp'; +$helpdir[1] = 'main_folder.hlp'; +$helpdir[2] = 'read_mail.hlp'; +$helpdir[3] = 'compose.hlp'; +$helpdir[4] = 'addresses.hlp'; +$helpdir[5] = 'folders.hlp'; +$helpdir[6] = 'options.hlp'; +$helpdir[7] = 'search.hlp'; +$helpdir[8] = 'FAQ.hlp'; + +/****************[ HELP FUNCTIONS ]********************/ + +/** + * parses through and gets the information from the different documents. + * this returns one section at a time. You must keep track of the position + * so that it knows where to start to look for the next section. + */ + +function get_info($doc, $pos) { + + for ($n=$pos; $n < count($doc); $n++) { + if (trim(strtolower($doc[$n])) == '<chapter>' + || trim(strtolower($doc[$n])) == '<section>') { + for ($n++;$n < count($doc) + && (trim(strtolower($doc[$n])) != '</section>') + && (trim(strtolower($doc[$n])) != '</chapter>'); $n++) { + if (trim(strtolower($doc[$n])) == '<title>') { + $n++; + $ary[0] = trim($doc[$n]); + } + if (trim(strtolower($doc[$n])) == '<description>') { + $ary[1] = ''; + for ($n++;$n < count($doc) + && (trim(strtolower($doc[$n])) != '</description>'); + $n++) { + $ary[1] .= $doc[$n]; + } + } + if (trim(strtolower($doc[$n])) == '<summary>') { + $ary[2] = ''; + for ($n++; $n < count($doc) + && (trim(strtolower($doc[$n])) != '</summary>'); + $n++) { + $ary[2] .= $doc[$n]; + } + } } if (isset($ary)) { - $ary[3] = $n; - return $ary; + $ary[3] = $n; } else { - $ary[0] = "ERROR: Help files are not in the right format!"; - $ary[1] = "ERROR: Help files are not in the right format!"; - $ary[2] = "ERROR: Help files are not in the right format!"; - return $ary; + $ary[0] = _("ERROR: Help files are not in the right format!"); + $ary[1] = $ary[0]; + $ary[2] = $ary[0]; } - } - } - $ary[0] = "ERROR: Help files are not in the right format!"; - $ary[1] = "ERROR: Help files are not in the right format!"; - return $ary; - } - - /**************[ END HELP FUNCTIONS ]******************/ - -?> - -<br> -<table width=95% align=center cellpadding=2 cellspacing=2 border=0> -<tr><td bgcolor="<?php echo $color[0] ?>"> - <center><b><?php echo _("Help") ?></b></center> -</td></tr></table> - -<?php do_hook("help_top") ?> - -<table width=90% cellpadding=0 cellspacing=10 border=0 align=center><tr><td> -<?php - if ($HTTP_REFERER) { - $ref = strtolower($HTTP_REFERER); - if (strpos($ref, "src/compose")) - $context = "compose"; - else if (strpos($ref, "src/addr")) - $context = "address"; - else if (strpos($ref, "src/folders")) - $context = "folders"; - else if (strpos($ref, "src/options")) - $context = "options"; - else if (strpos($ref, "src/right_main")) - $context = "index"; - else if (strpos($ref, "src/read_body")) - $context = "read"; - else if (strpos($ref, "src/search")) - $context = "search"; - } - - if (!$squirrelmail_language) - $squirrelmail_language = "en"; - - if (file_exists("../help/$squirrelmail_language")) { - $help_exists = true; - $user_language = $squirrelmail_language; - } else if (file_exists("../help/en")) { - $help_exists = true; - 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>"; - $user_language = "en"; - } else { - $help_exists = false; - echo "<br><center><font color=\"$color[2]\">"; - echo _("Some or all of the help documents are not present!"); - echo "</font></center>"; - echo "</td></tr></table>"; - exit; - } - - if ($help_exists) { - if (! isset($context)) - $context = ''; - if ($context == "compose") - $chapter = 4; - else if ($context == "address") - $chapter = 5; - else if ($context == "folders") - $chapter = 6; - else if ($context == "options") - $chapter = 7; - else if ($context == "index") - $chapter = 2; - else if ($context == "read") - $chapter = 3; - else if ($context == "search") - $chapter = 8; - - if (!isset($chapter)) { - echo "<table cellpadding=0 cellspacing=0 border=0 align=center><tr><td>\n"; - echo "<b><center>" . _("Table of Contents") . "</center></b><br>"; - do_hook("help_chapter"); - echo "<ol>\n"; - for ($i=0; $i < count($helpdir); $i++) { + return( $ary ); + } + } + + $ary[0] = _("ERROR: Help files are not in the right format!"); + $ary[1] = $ary[0]; + + return( $ary ); +} + +/**************[ END HELP FUNCTIONS ]******************/ + + + +echo html_tag( 'table', + html_tag( 'tr', + html_tag( 'td','<center><b>' . _("Help") .'</b></center>', 'center', $color[0] ) + ) , + 'center', '', 'width="95%" cellpadding="1" cellspacing="2" border="0"' ); + +do_hook("help_top"); + +echo html_tag( 'table', '', 'center', '', 'width="90%" cellpadding="0" cellspacing="10" border="0"' ) . + html_tag( 'tr' ) . + html_tag( 'td' ); + +if (isset($_SERVER['HTTP_REFERER'])) { + $ref = strtolower($_SERVER['HTTP_REFERER']); + if (strpos($ref, 'src/compose')){ + $context = 'compose'; + } else if (strpos($ref, 'src/addr')){ + $context = 'address'; + } else if (strpos($ref, 'src/folders')){ + $context = 'folders'; + } else if (strpos($ref, 'src/options')){ + $context = 'options'; + } else if (strpos($ref, 'src/right_main')){ + $context = 'index'; + } else if (strpos($ref, 'src/read_body')){ + $context = 'read'; + } else if (strpos($ref, 'src/search')){ + $context = 'search'; + } +} + +if (!isset($squirrelmail_language)) { + $squirrelmail_language = 'en_US'; +} + +if (file_exists("../help/$squirrelmail_language")) { + $help_exists = true; + $user_language = $squirrelmail_language; +} else if (file_exists('../help/en_US')) { + $help_exists = true; + 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>'; + $user_language = 'en_US'; +} else { + $help_exists = false; + echo "<br><center><font color=\"$color[2]\">" . + _("Some or all of the help documents are not present!"). + '</font></center>'. + '</td></tr></table></body></html>'; + /* this is really silly, because there may be some + * footers. What about them. + * TODO: Fix this so it's not just "exit". + */ + exit; +} + +if ($help_exists == true) { + if (!isset($context)){ + $context = ''; + } + if ($context == 'compose'){ + $chapter = 4; + } else if ($context == 'address'){ + $chapter = 5; + } else if ($context == 'folders'){ + $chapter = 6; + } else if ($context == 'options'){ + $chapter = 7; + } else if ($context == 'index'){ + $chapter = 2; + } else if ($context == 'read'){ + $chapter = 3; + } else if ($context == 'search'){ + $chapter = 8; + } else if ( isset( $_GET['chapter'] ) ) { + $chapter = intval( $_GET['chapter']); + } else { + $chapter = 0; + } + + if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) { + 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>'; + do_hook('help_chapter'); + echo html_tag( 'ol' ); + for ($i=0; $i < count($helpdir); $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>\n"; - echo "<ul>$help_info[2]</ul>"; - } - echo "</ol>\n"; - echo "</td></tr></table>\n"; - } else { - $doc = file("../help/$user_language/".$helpdir[$chapter-1]); - $help_info = get_info($doc, 0); - - echo "<small><center>"; - - if ($chapter <= 1) echo "<font color=\"$color[9]\">"._("Previous")."</font> | "; - else echo "<a href=\"../src/help.php?chapter=".($chapter-1)."\">"._("Previous")."</a> | "; - echo "<a href=\"../src/help.php\">"._("Table of Contents")."</a>"; - if ($chapter >= count($helpdir)) echo " | <font color=\"$color[9]\">"._("Next")."</font>"; - else echo " | <a href=\"../src/help.php?chapter=".($chapter+1)."\">"._("Next")."</a>\n"; - echo "</center></small><br>\n"; - - echo "<font size=5><b>$chapter - $help_info[0]</b></font><br><br>\n"; - if (isset($help_info[1])) - echo "$help_info[1]\n"; - else - echo "<p>$help_info[2]</p>\n"; - - $section = 0; - for ($n = $help_info[3]; $n < count($doc); $n++) { + echo '<li><a href="../src/help.php?chapter=' . ($i+1) + . '">' . $help_info[0] . '</a>' . + html_tag( 'ul', $help_info[2] ); + } + echo '</ol></td></tr></table>'; + } else { + $doc = file("../help/$user_language/" . $helpdir[$chapter-1]); + $help_info = get_info($doc, 0); + echo '<small><center>'; + if ($chapter <= 1){ + echo '<font color="' . $color[9] . '">' . _("Previous") + . '</font> | '; + } else { + echo '<a href="../src/help.php?chapter=' . ($chapter-1) + . '">' . _("Previous") . '</a> | '; + } + echo '<a href="../src/help.php">' . _("Table of Contents") . '</a>'; + if ($chapter >= count($helpdir)){ + echo ' | <font color="' . $color[9] . '">' . _("Next") . '</font>'; + } else { + echo ' | <a href="../src/help.php?chapter=' . ($chapter+1) + . '">' . _("Next") . '</a>'; + } + echo '</center></small><br>'; + + echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0] + . '</b></font><br><br>'; + if (isset($help_info[1])){ + echo $help_info[1]; + } else { + echo html_tag( 'p', $help_info[2], 'left' ); + } + + $section = 0; + for ($n = $help_info[3]; $n < count($doc); $n++) { $section++; $help_info = get_info($doc, $n); - echo "<b>$chapter.$section - $help_info[0]</b>"; - echo "<ul>"; - echo "$help_info[1]"; - echo "</ul>"; + echo "<b>$chapter.$section - $help_info[0]</b>" . + html_tag( 'ul', $help_info[1] ); $n = $help_info[3]; - } + } + + echo '<br><center><a href="#pagetop">' . _("Top") . '</a></center>'; + } +} +do_hook('help_bottom'); - echo "<br><center><a href=\"#pagetop\">" . _("Top") . "</a></center>\n"; - } - } - do_hook("help_bottom"); +echo html_tag( 'tr', + html_tag( 'td', ' ', 'left', $color[0] ) + ). + '</table></body></html>'; ?> -<tr><td bgcolor="<?php echo $color[0] ?>"> </td></tr></table> -<td></tr></table> -</body></html> \ No newline at end of file