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 ]******************/
88 <table width
="95%" align
="center" cellpadding
="2" cellspacing
="2" border
="0">
90 <td bgcolor
="<?php echo $color[0] ?>">
91 <center
><b
><?php
echo _("Help") ?
></b
></center
>
96 <?php
do_hook("help_top") ?
>
98 <table width
="90%" cellpadding
="0" cellspacing
="10" border
="0" align
="center">
102 if (isset($HTTP_REFERER)) {
103 $ref = strtolower($HTTP_REFERER);
104 if (strpos($ref, 'src/compose')){
105 $context = 'compose';
106 } else if (strpos($ref, 'src/addr')){
107 $context = 'address';
108 } else if (strpos($ref, 'src/folders')){
109 $context = 'folders';
110 } else if (strpos($ref, 'src/options')){
111 $context = 'options';
112 } else if (strpos($ref, 'src/right_main')){
114 } else if (strpos($ref, 'src/read_body')){
116 } else if (strpos($ref, 'src/search')){
121 if (!isset($squirrelmail_language)) {
122 $squirrelmail_language = 'en';
126 * This harebrained solution is here because it produces the
127 * smallest patchfile.
128 * The real solution would be to either:
129 * a) move all locales into full-name locale names, like they
130 * really should be according to the ISO docs (e.g. en -> en_US,
131 * es -> es_ES, ru -> ru_RU), since it's standard to have a language
132 * name + undescore + country name.
133 * b) Provide a $languages['ru_RU']['HELPALIAS'] = 'ru';
135 * Konstantin Riabitsev
138 while (list($key, $val) = each($languages)){
139 if ($val['ALIAS'] == $squirrelmail_language){
140 $squirrelmail_language = $key;
145 if (file_exists("../help/$squirrelmail_language")) {
147 $user_language = $squirrelmail_language;
148 } else if (file_exists('../help/en')) {
150 echo "<center><font color=\"$color[2]\">";
151 printf (_("The help has not been translated to %s. It will be displayed in English instead."), $languages[$squirrelmail_language]['NAME']);
152 echo '</font></center><br>';
153 $user_language = 'en';
155 $help_exists = false;
156 echo "<br><center><font color=\"$color[2]\">";
157 echo _("Some or all of the help documents are not present!");
158 echo '</font></center>';
159 echo '</td></tr></table>';
160 /* this is really silly, because there may be some
161 * footers. What about them.
162 * TODO: Fix this so it's not just "exit".
167 if ($help_exists == true) {
168 if (!isset($context)){
171 if ($context == 'compose'){
173 } else if ($context == 'address'){
175 } else if ($context == 'folders'){
177 } else if ($context == 'options'){
179 } else if ($context == 'index'){
181 } else if ($context == 'read'){
183 } else if ($context == 'search'){
187 if (!isset($chapter)) {
188 echo '<table cellpadding="0" cellspacing="0" border="0"
189 align="center"><tr><td>';
190 echo '<b><center>' . _("Table of Contents") . '</center></b><br>';
191 do_hook('help_chapter');
193 for ($i=0; $i < count($helpdir); $i++
) {
194 $doc = file("../help/$user_language/$helpdir[$i]");
195 $help_info = get_info($doc, 0);
196 echo '<li><a href="../src/help.php?chapter=' . ($i+
1)
197 . '">' . $help_info[0] . '</a>';
198 echo '<ul>' . $help_info[2] . '</ul>';
201 echo '</td></tr></table>';
203 $doc = file("../help/$user_language/" . $helpdir[$chapter-1]);
204 $help_info = get_info($doc, 0);
205 echo '<small><center>';
207 echo '<font color="' . $color[9] . '">' . _("Previous")
210 echo '<a href="../src/help.php?chapter=' . ($chapter-1)
211 . '">' . _("Previous") . '</a> | ';
213 echo '<a href="../src/help.php">' . _("Table of Contents") . '</a>';
214 if ($chapter >= count($helpdir)){
215 echo ' | <font color="$color[9]">' . _("Next") . '</font>';
217 echo ' | <a href="../src/help.php?chapter=' . ($chapter+
1)
218 . '">' . _("Next") . '</a>';
220 echo '</center></small><br>';
222 echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0]
223 . '</b></font><br><br>';
224 if (isset($help_info[1])){
227 echo '<p>' . $help_info[2] . '</p>';
231 for ($n = $help_info[3]; $n < count($doc); $n++
) {
233 $help_info = get_info($doc, $n);
234 echo "<b>$chapter.$section - $help_info[0]</b>";
241 echo '<br><center><a href="#pagetop">' . _("Top") . '</a></center>';
244 do_hook('help_bottom');
246 <tr
><td bgcolor
="<?php echo $color[0] ?>"> 
;</td
></tr
></table
>