Source for file help.php
Documentation is available at help.php
* Displays help for the user
* @copyright 1999-2020 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id: help.php 14840 2020-01-07 07:42:38Z pdontthink $
/** This is the help page */
* Path for SquirrelMail required files.
/* 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');
$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';
/****************[ 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.
for ($n=
$pos; $n <
$cntdoc; $n++
) {
$ary[0] =
trim($doc[$n]);
$ary[0] =
_("ERROR: Help files are not in the right format!");
$ary[0] =
_("ERROR: Help files are not in the right format!");
/**************[ END HELP FUNCTIONS ]******************/
html_tag( 'td','<div style="text-align: center;"><b>' .
_("Help") .
'</b></div>', 'center', $color[0] )
'center', '', 'width="95%" cellpadding="1" cellspacing="2" border="0"' );
echo
html_tag( 'table', '', 'center', '', 'width="90%" cellpadding="0" cellspacing="10" border="0"' ) .
if (!isset
($squirrelmail_language)) {
$squirrelmail_language =
'en_US';
$user_language =
$squirrelmail_language;
error_box(_("Help is not available in the selected language. It will be displayed in English instead."), $color);
$user_language =
'en_US';
error_box( _("Help is not available. Please contact your system administrator for assistance."), $color );
echo
'</td></tr></table>';
/* take the chapternumber from the GET-vars,
* else see if we can get a relevant chapter from the referer */
$contexts =
array ( 'src/compose' =>
4, 'src/addr' =>
5,
'src/folders' =>
6, 'src/options' =>
7, 'src/right_main' =>
2,
'src/read_body' =>
3, 'src/search' =>
8 );
foreach($contexts as $path =>
$chap) {
if ( $chapter ==
0 ||
!isset
( $helpdir[$chapter-
1] ) ) {
// Initialise the needed variables.
// Get the chapter numbers, title and decriptions.
for ($i=
0, $cnt =
count($helpdir); $i <
$cnt; $i++
) {
if (file_exists("../help/$user_language/$helpdir[$i]")) {
if (is_readable("../help/$user_language/$helpdir[$i]")) {
// First try the selected language.
$doc =
file("../help/$user_language/$helpdir[$i]");
$toc[] =
array($i+
1, $help_info[0], $help_info[2]);
$toc[] =
array($i+
1, _("This chapter file is not readable"),
sprintf(_("For some reason, the file for chapter %s is not readable."), $i+
1));
// If the selected language can't be found, try English.
$doc =
file("../help/en_US/$helpdir[$i]");
$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]);
$toc[] =
array($i+
1, _("This chapter file is not readable"),
sprintf(_("For some reason, the file for chapter %s is not readable."), $i+
1));
// 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));
echo
html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' ) .
'<div style="text-align: center;"><b>' .
_("Table of Contents") .
'</b></div><br />';
// 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.
echo
'</ol></td></tr></table>';
// Initialise the needed variables.
if (file_exists("../help/$user_language/" .
$helpdir[$chapter-
1])) {
if (is_readable("../help/$user_language/" .
$helpdir[$chapter-
1])) {
// First try the selected language.
$doc =
file("../help/$user_language/" .
$helpdir[$chapter-
1]);
error_box(sprintf(_("For some reason, the file for chapter %s is not readable."), $chapter), $color);
} elseif (file_exists("../help/en_US/" .
$helpdir[$chapter-
1])) {
if (is_readable("../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."), $color);
error_box(sprintf(_("For some reason, the file for chapter %s is not readable."), $chapter), $color);
// If English can't be found, the chapter went MIA.
$display_chapter =
FALSE;
// Write the chapter header.
echo
'<div style="text-align: center;"><small>';
echo
'<font color="' .
$color[9] .
'">' .
_("Previous")
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>';
echo
' | <a href="../src/help.php?chapter=' .
($chapter+
1)
.
'">' .
_("Next") .
'</a>';
echo
'</small></div><br />';
// If there is a valid chapter, display it.
echo
'<font size="5"><b>' .
$chapter .
' - ' .
$help_info[0]
.
'</b></font><br /><br />';
if (isset
($help_info[1]) &&
$help_info[1]) {
echo
html_tag( 'p', $help_info[2], 'left' );
for ($n =
$help_info[3], $cnt =
count($doc); $n <
$cnt; $n++
) {
echo
"<b>$chapter.$section - $help_info[0]</b>" .
echo
'<br /><div style="text-align: center;"><a href="#pagetop">' .
_("Top") .
'</a></div>';
// If the help file went MIA, display an error message.
error_box(sprintf(_("For some reason, chapter %s is not available."), $chapter), $color);
html_tag( 'td', ' ', 'left', $color[0] )
Documentation generated on Mon, 13 Jan 2020 04:24:41 +0100 by phpDocumentor 1.4.3