X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=src%2Fhelp.php;h=316ecfc14f1195d70b8abf933c1a5f590831088b;hb=95e9357118f315822eaea0f35a81e17933736c42;hp=67aa1c0d530ac7dfc0f3dc423f9b4eaecfdabdfe;hpb=ff8a98e7e1d368c57b088522586bddcf68d443a5;p=squirrelmail.git

diff --git a/src/help.php b/src/help.php
index 67aa1c0d..316ecfc1 100644
--- a/src/help.php
+++ b/src/help.php
@@ -1,35 +1,52 @@
 <?php
-   /**
-    **  help.php
-    **
-    **  Copyright (c) 1999-2000 The SquirrelMail development team
-    **  Licensed under the GNU GPL. For full terms see the file COPYING.
-    **
-    **  Displays help for the user
-    **
-    **  $Id$
-    **/
-
-   require_once('../src/validate.php');
-   require_once('../functions/display_messages.php');
-   require_once('../functions/imap.php');
-   require_once('../functions/array.php');
-
-
-   displayPageHeader($color, "None");
-
-	$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";
-	$helpdir[8] = "FAQ.hlp";
+
+/**
+ * help.php
+ *
+ * Copyright (c) 1999-2001 The Squirrelmail Development Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * Displays help for the user
+ *
+ * $Id$
+ */
+
+/*****************************************************************/
+/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
+/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
+/***    + Base level indent should begin at left margin, as    ***/
+/***      the require_once below looks.                        ***/
+/***    + All identation should consist of four space blocks   ***/
+/***    + Tab characters are evil.                             ***/
+/***    + all comments should use "slash-star ... star-slash"  ***/
+/***      style -- no pound characters, no slash-slash style   ***/
+/***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
+/***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
+/***    + Please use ' instead of ", when possible. Note "     ***/
+/***      should always be used in _( ) function calls.        ***/
+/*** Thank you for your help making the SM code more readable. ***/
+/*****************************************************************/
+
+require_once('../src/validate.php');
+require_once('../functions/display_messages.php');
+require_once('../functions/imap.php');
+require_once('../functions/array.php');
+
+
+   displayPageHeader($color, 'None' );
+
+   $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';
+   $helpdir[8] = 'FAQ.hlp';
 
    /****************[ HELP FUNCTIONS ]********************/
-   // parses through and gets the information from the different documents.  
+   // 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.
 
@@ -42,18 +59,18 @@
                   $ary[0] = trim($doc[$n]);
                }
                if (trim(strtolower($doc[$n])) == "<description>") {
-	          $ary[1] = "";
+                  $ary[1] = "";
                   for ($n++;$n < count($doc) && (trim(strtolower($doc[$n])) != "</description>"); $n++) {
                      $ary[1] .= $doc[$n];
                   }
                }
                if (trim(strtolower($doc[$n])) == "<summary>") {
-	          $ary[2] = "";
+                  $ary[2] = "";
                   for ($n++;$n < count($doc) && (trim(strtolower($doc[$n])) != "</summary>"); $n++) {
                      $ary[2] .= $doc[$n];
                   }
                }
-            }   
+            }
             if (isset($ary)) {
                $ary[3] = $n;
                return $ary;
@@ -62,14 +79,14 @@
                $ary[1] = "ERROR: Help files are not in the right format!";
                $ary[2] = "ERROR: Help files are not in the right format!";
                return $ary;
-            }   
+            }
          }
       }
       $ary[0] = "ERROR: Help files are not in the right format!";
       $ary[1] = "ERROR: Help files are not in the right format!";
       return $ary;
    }
-   
+
    /**************[ END HELP FUNCTIONS ]******************/
 
 ?>
@@ -87,21 +104,21 @@
    if ($HTTP_REFERER) {
       $ref = strtolower($HTTP_REFERER);
       if (strpos($ref, "src/compose"))
-         $context = "compose"; 
+         $context = "compose";
       else if (strpos($ref, "src/addr"))
-         $context = "address"; 
+         $context = "address";
       else if (strpos($ref, "src/folders"))
-         $context = "folders"; 
+         $context = "folders";
       else if (strpos($ref, "src/options"))
-         $context = "options"; 
+         $context = "options";
       else if (strpos($ref, "src/right_main"))
-         $context = "index"; 
+         $context = "index";
       else if (strpos($ref, "src/read_body"))
-         $context = "read"; 
+         $context = "read";
       else if (strpos($ref, "src/search"))
-         $context = "search"; 
+         $context = "search";
    }
-   
+
    if (!$squirrelmail_language)
       $squirrelmail_language = "en";
 
@@ -122,7 +139,7 @@
       echo "</td></tr></table>";
       exit;
    }
-   
+
    if ($help_exists) {
       if (! isset($context))
           $context = '';
@@ -170,7 +187,7 @@
          echo "<font size=5><b>$chapter - $help_info[0]</b></font><br><br>\n";
          if (isset($help_info[1]))
             echo "$help_info[1]\n";
-         else   
+         else
             echo "<p>$help_info[2]</p>\n";
 
          $section = 0;
@@ -187,8 +204,8 @@
          echo "<br><center><a href=\"#pagetop\">" . _("Top") . "</a></center>\n";
       }
    }
-   do_hook("help_bottom"); 
+   do_hook("help_bottom");
 ?>
 <tr><td bgcolor="<?php echo $color[0] ?>">&nbsp;</td></tr></table>
 <td></tr></table>
-</body></html>
\ No newline at end of file
+</body></html>