add PAGE_NAME constant to every page under src/.

[squirrelmail.git] / src / help.php

diff --git a/src/help.php b/src/help.php
index 2c0798c7d9cd671e8d5912ef17698e5b1b5adc42..0b3dad8de242665cf5991306d87457a2fa124c4d 100644 (file)
--- a/src/help.php
+++ b/src/help.php
@@ -5,18 +5,21 @@
  *
  * Displays help for the user
  *
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2007 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  */
 
+/** This is the help page */
+define('PAGE_NAME', 'help');
+
 /**
  * Include the SquirrelMail initialization file.
  */
 require('../include/init.php');
 
-displayPageHeader($color, 'None' );
+displayPageHeader($color);
 
 $helpdir[0] = 'basic.hlp';
 $helpdir[1] = 'main_folder.hlp';
@@ -92,17 +95,7 @@ function get_info($doc, $pos) {
 
 /**************[ END HELP FUNCTIONS ]******************/
 
-echo html_tag( 'table',
-        html_tag( 'tr',
-            html_tag( 'td','<div style="text-align: center;"><b>' . _("Help") .'</b></div>', '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' );
+do_hook('help_top', $null);
 
 if (!isset($squirrelmail_language)) {
     $squirrelmail_language = 'en_US';
@@ -169,25 +162,21 @@ if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) {
         }
     }
 
-    // Write the TOC header
-    echo html_tag( 'table', '', 'center', '', 'cellpadding="0" cellspacing="0" border="0"' ) .
-         html_tag( 'tr' ) .
-         html_tag( 'td' ) .
-         '<div style="text-align: center;"><b>' . _("Table of Contents") . '</b></div><br />';
-    echo html_tag( 'ol' );
-
-    // 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.
-    do_hook('help_chapter');
-
-    // Write the TOC footer.
-    echo '</ol></td></tr></table>';
+    do_hook('help_chapter', $null);
+ 
+    $new_toc = array();
+    foreach ($toc as $ch) {
+        $a = array();
+        $a['Chapter'] = $ch[0];
+        $a['Title'] = $ch[1];
+        $a['Summary'] = trim($ch[2]);
+        $new_toc[] = $a;
+    }
+    
+    $oTemplate->assign('toc', $new_toc);
+    
+    $oTemplate->display('help_toc.tpl');
 } else {
     // Initialise the needed variables.
     $display_chapter = TRUE;
@@ -206,61 +195,48 @@ if ( $chapter == 0 || !isset( $helpdir[$chapter-1] ) ) {
         $display_chapter = FALSE;
     }
 
-    // Write the chpater header.
-    echo '<div style="text-align: center;"><small>';
-    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 '</small></div><br />';
-
     // Write the chapter.
     if ($display_chapter) {
         // If there is a valid chapter, display it.
         $help_info = get_info($doc, 0);
-        echo '<font size="5"><b>' . $chapter . ' - ' . $help_info[0]
-            . '</b></font><br /><br />';
-
-        if (isset($help_info[1]) && $help_info[1]) {
-            echo $help_info[1];
-        } else {
-            echo html_tag( 'p', $help_info[2], 'left' );
-        }
-
+        $ch = array();
+        $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();
         $section = 0;
         for ($n = $help_info[3], $cnt = count($doc); $n < $cnt; $n++) {
             $section++;
             $help_info = get_info($doc, $n);
-            echo "<b>$chapter.$section - $help_info[0]</b>" .
-                $help_info[1];
             $n = $help_info[3];
-        }
 
-        echo '<br /><div style="text-align: center;"><a href="#pagetop">' . _("Top") . '</a></div>';
+            $a = array();
+            $a['SectionNumber'] = $section;
+            $a['SectionTitle'] = $help_info[0];
+            $a['SectionText'] = isset($help_info[1]) ? trim($help_info[1]) : '';;
+            
+            $ch['Sections'][] = $a;
+        }
+        
+        $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);
     } else {
-        // If the help file went MIA, display an error message.
-        error_box(sprintf(_("For some reason, chapter %s is not available."), $chapter));
+        // 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');
 }
 
-do_hook('help_bottom');
+do_hook('help_bottom', $null);
 
-echo html_tag( 'tr',
-            html_tag( 'td', '&nbsp;', 'left', $color[0] )
-        );
-
-?>
-</table>
-<?php
 $oTemplate->display('footer.tpl');
-?>
\ No newline at end of file