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 14845 2020-01-07 08:09:34Z pdontthink $
/** This is the help page */
* Include the SquirrelMail initialization file.
require
('../include/init.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 ]******************/
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."));
$user_language =
'en_US';
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');
/* 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]")) {
// First try the selected language.
$doc =
file("../help/$user_language/$helpdir[$i]");
$toc[] =
array($i+
1, $help_info[0], $help_info[2]);
// 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]);
// 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));
// Provide hook for external help scripts.
$a['Summary'] =
trim($ch[2]);
$oTemplate->assign('toc', $new_toc);
$oTemplate->display('help_toc.tpl');
// Initialise the needed variables.
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."));
// If English can't be found, the chapter went MIA.
$display_chapter =
FALSE;
// If there is a valid chapter, display it.
$ch['Chapter'] =
$chapter;
$ch['Title'] =
$help_info[0];
$ch['Summary'] = isset
($help_info[1]) &&
$help_info[1] ?
trim($help_info[1]) :
$help_info[2];
$ch['Sections'] =
array();
for ($n =
$help_info[3], $cnt =
count($doc); $n <
$cnt; $n++
) {
$a['SectionNumber'] =
$section;
$a['SectionTitle'] =
$help_info[0];
$a['SectionText'] = isset
($help_info[1]) ?
trim($help_info[1]) :
'';;
$oTemplate->assign('chapter_number', $chapter);
$oTemplate->assign('chapter_count', count($helpdir));
$oTemplate->assign('chapter_title', $ch['Title']);
$oTemplate->assign('chapter_summary', $ch['Summary']);
$oTemplate->assign('sections', $ch['Sections']);
$oTemplate->assign('error_msg', NULL);
// If the help file went MIA, trigger an error message.
$oTemplate->assign('chapter_number', $chapter);
$oTemplate->assign('chapter_count', count($helpdir));
$oTemplate->assign('chapter_title', '');
$oTemplate->assign('chapter_summary', '');
$oTemplate->assign('sections', array());
$oTemplate->assign('error_msg', sprintf(_("For some reason, chapter %s is not available."), $chapter));
$oTemplate->display('help_chapter.tpl');
$oTemplate->display('footer.tpl');
Documentation generated on Mon, 13 Jan 2020 04:22:41 +0100 by phpDocumentor 1.4.3