6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * Displays help for the user
14 require_once('../src/validate.php');
15 require_once('../functions/display_messages.php');
16 require_once('../functions/imap.php');
17 require_once('../functions/array.php');
19 displayPageHeader($color, 'None' );
21 $helpdir[0] = 'basic.hlp';
22 $helpdir[1] = 'main_folder.hlp';
23 $helpdir[2] = 'read_mail.hlp';
24 $helpdir[3] = 'compose.hlp';
25 $helpdir[4] = 'addresses.hlp';
26 $helpdir[5] = 'folders.hlp';
27 $helpdir[6] = 'options.hlp';
28 $helpdir[7] = 'search.hlp';
29 $helpdir[8] = 'FAQ.hlp';
31 /****************[ HELP FUNCTIONS ]********************/
34 * parses through and gets the information from the different documents.
35 * this returns one section at a time. You must keep track of the position
36 * so that it knows where to start to look for the next section.
39 function get_info($doc, $pos) {
40 for ($n=$pos; $n < count($doc); $n++
) {
41 if (trim(strtolower($doc[$n])) == '<chapter>'
42 ||
trim(strtolower($doc[$n])) == '<section>') {
43 for ($n++
;$n < count($doc)
44 && (trim(strtolower($doc[$n])) != '</section>')
45 && (trim(strtolower($doc[$n])) != '</chapter>'); $n++
) {
46 if (trim(strtolower($doc[$n])) == '<title>') {
48 $ary[0] = trim($doc[$n]);
50 if (trim(strtolower($doc[$n])) == '<description>') {
52 for ($n++
;$n < count($doc)
53 && (trim(strtolower($doc[$n])) != '</description>');
58 if (trim(strtolower($doc[$n])) == '<summary>') {
60 for ($n++
; $n < count($doc)
61 && (trim(strtolower($doc[$n])) != '</summary>');
71 $ary[0] = 'ERROR: Help files are not in the right format!';
72 $ary[1] = 'ERROR: Help files are not in the right format!';
73 $ary[2] = 'ERROR: Help files are not in the right format!';
78 $ary[0] = 'ERROR: Help files are not in the right format!';
79 $ary[1] = 'ERROR: Help files are not in the right format!';
83 /**************[ END HELP FUNCTIONS ]******************/
87 echo html_tag( 'table',
89 html_tag( 'td','<center><b>' . _("Help") .'</b></center>', 'center', $color[0] )
91 'center', '', 'width="95%" cellpadding="1" cellspacing="2" border="0"' );
95 echo html_tag( 'table', '', 'center', '', 'width="90%" cellpadding="0" cellspacing="10" border="0"' ) .
99 if (isset($HTTP_REFERER)) {
100 $ref = strtolower($HTTP_REFERER);
101 if (strpos($ref, 'src/compose')){
102 $context = 'compose';
103 } else if (strpos($ref, 'src/addr')){
104 $context = 'address';
105 } else if (strpos($ref, 'src/folders')){
106 $context = 'folders';
107 } else if (strpos($ref, 'src/options')){
108 $context = 'options';
109 } else if (strpos($ref, 'src/right_main')){
111 } else if (strpos($ref, 'src/read_body')){
113 } else if (strpos($ref, 'src/search')){
118 if (!isset($squirrelmail_language)) {
119 $squirrelmail_language = 'en_US';
122 if (file_exists("../help/$squirrelmail_language")) {
124 $user_language = $squirrelmail_language;
125 } else if (file_exists('../help/en_US')) {
127 echo "<center><font color=\"$color[2]\">";
128 printf (_("The help has not been translated to %s. It will be displayed in English instead."), $languages[$squirrelmail_language]['NAME']);
129 echo '</font></center><br>';
130 $user_language = 'en_US';
132 $help_exists = false;
133 echo "<br><center><font color=\"$color[2]\">" .
134 _("Some or all of the help documents are not present!").
136 '</td></tr></table>';
137 /* this is really silly, because there may be some
138 * footers. What about them.
139 * TODO: Fix this so it's not just "exit".
144 if ($help_exists == true) {
145 if (!isset($context)){
148 if ($context == 'compose'){
150 } else if ($context == 'address'){
152 } else if ($context == 'folders'){
154 } else if ($context == 'options'){
156 } else if ($context == 'index'){
158 } else if ($context == 'read'){
160 } else if ($context == 'search'){
164 if (!isset($chapter)) {
165 echo html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' );
168 '<b><center>' . _("Table of Contents") . '</center></b><br>';
169 do_hook('help_chapter');
170 echo html_tag( 'ol' );
171 for ($i=0; $i < count($helpdir); $i++
) {
172 $doc = file("../help/$user_language/$helpdir[$i]");
173 $help_info = get_info($doc, 0);
174 echo '<li><a href="../src/help.php?chapter=' . ($i+
1)
175 . '">' . $help_info[0] . '</a>' .
176 html_tag( 'ul', $help_info[2] );
178 echo '</ol></td></tr></table>';
180 $doc = file("../help/$user_language/" . $helpdir[$chapter-1]);
181 $help_info = get_info($doc, 0);
182 echo '<small><center>';
184 echo '<font color="' . $color[9] . '">' . _("Previous")
187 echo '<a href="../src/help.php?chapter=' . ($chapter-1)
188 . '">' . _("Previous") . '</a> | ';
190 echo '<a href="../src/help.php">' . _("Table of Contents") . '</a>';
191 if ($chapter >= count($helpdir)){
192 echo ' | <font color="$color[9]">' . _("Next") . '</font>';
194 echo ' | <a href="../src/help.php?chapter=' . ($chapter+
1)
195 . '">' . _("Next") . '</a>';
197 echo '</center></small><br>';
199 echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0]
200 . '</b></font><br><br>';
201 if (isset($help_info[1])){
204 echo html_tag( 'p', $help_info[2], 'left' );
208 for ($n = $help_info[3]; $n < count($doc); $n++
) {
210 $help_info = get_info($doc, $n);
211 echo "<b>$chapter.$section - $help_info[0]</b>" .
212 html_tag( 'ul', $help_info[1] );
216 echo '<br><center><a href="#pagetop">' . _("Top") . '</a></center>';
219 do_hook('help_bottom');
222 html_tag( 'td', ' ', 'left', $color[0] )
224 '</table></body></html>';