From: Michael M Slusarz <slusarz@curecanti.org>
Date: Mon, 23 Feb 2009 05:59:36 +0000 (-0700)
Subject: Documentation tweaks
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=4ef5206864d44b79c1e8b66feb8f980c51155b9d;p=horde.git

Documentation tweaks
---

diff --git a/imp/README b/imp/README
index 744c0d511..44c3ff86a 100644
--- a/imp/README
+++ b/imp/README
@@ -1,7 +1,7 @@
 What is IMP?
 ============
 
-:Contact:       imp@lists.horde.org
+:Contact: imp@lists.horde.org
 
 .. contents:: Contents
 .. section-numbering::
diff --git a/imp/config/filter.txt.dist b/imp/config/filter.txt.dist
index cb43778b5..7b01f8499 100644
--- a/imp/config/filter.txt.dist
+++ b/imp/config/filter.txt.dist
@@ -1,5 +1,4 @@
 # Enter a list of words that will be filtered.  Only put one word on each
 # line.  Comments are allowed.  A comment starts with a '#' and ends at the
 # end of the line.
-#
 poop
diff --git a/imp/config/header.php.dist b/imp/config/header.php.dist
index a5eae70a7..f60005af5 100644
--- a/imp/config/header.php.dist
+++ b/imp/config/header.php.dist
@@ -1,22 +1,20 @@
 <?php
 /**
- * $Id$
- *
  * This file will allow you to set headers to append to outgoing mail messages.
  *
  * To add a new header item, simply add a new entry to the $_header array.
  * The "key" should be the header name.
  * The "value" should be the header data.
  *
- * Example entries:
- *
- *  // Add the IP of the remote browser
- *  $_header['X-Originating-IP'] = $_SERVER['REMOTE_ADDR'];
- *
- *  // Add the Browser information of the remote browser
- *  $_header['X-Remote-Browser'] = $_SERVER['HTTP_USER_AGENT'];
+ * $Id$
  */
 
 $_header = array();
 
 /* Add your custom entries below this line. */
+
+// Add the IP of the remote browser
+//$_header['X-Originating-IP'] = $_SERVER['REMOTE_ADDR'];
+
+// Add the Browser information of the remote browser
+//$_header['X-Remote-Browser'] = $_SERVER['HTTP_USER_AGENT'];
diff --git a/imp/config/hooks.php.dist b/imp/config/hooks.php.dist
index d79429942..e3be18599 100644
--- a/imp/config/hooks.php.dist
+++ b/imp/config/hooks.php.dist
@@ -1,7 +1,5 @@
 <?php
 /**
- * $Id$
- *
  * IMP Hooks configuration file.
  *
  * THE HOOKS PROVIDED IN THIS FILE ARE EXAMPLES ONLY.  DO NOT ENABLE THEM
@@ -9,6 +7,8 @@
  * TO MATCH YOUR SPECIFIC NEEDS AND SYSTEM ENVIRONMENT.
  *
  * For more information please see the horde/config/hooks.php.dist file.
+ *
+ * $Id$
  */
 
 // Here is an example signature hook function to set the signature from the
diff --git a/imp/config/menu.php.dist b/imp/config/menu.php.dist
index c38361540..f8b2f0306 100644
--- a/imp/config/menu.php.dist
+++ b/imp/config/menu.php.dist
@@ -1,7 +1,5 @@
 <?php
 /**
- * $Id$
- *
  * This file lets you extend IMP's menu with your own items.
  *
  * To add a new menu item, simply add a new entry to the $_menu array.
@@ -36,6 +34,8 @@
  * 'separator'.  It should look like this:
  *
  *  $_menu[] = 'separator';
+ *
+ * $Id$
  */
 
 $_menu = array();
diff --git a/imp/config/mime_drivers.php.dist b/imp/config/mime_drivers.php.dist
index 4d7239274..7c731034b 100644
--- a/imp/config/mime_drivers.php.dist
+++ b/imp/config/mime_drivers.php.dist
@@ -1,7 +1,5 @@
 <?php
 /**
- * $Id$
- *
  * Decide which output drivers you want to activate for the IMP application.
  * Settings in this file override settings in horde/config/mime_drivers.php.
  * All drivers configured in that file, but not configured here, will also
@@ -15,6 +13,10 @@
  *   to download the part.  Don't set the parameter, or set to 0, to disable
  *   this check.
  *
+ * $Id$
+ */
+
+/**
  * The available drivers are:
  * --------------------------
  * alternative    multipart/alternative parts
diff --git a/imp/config/motd.php.dist b/imp/config/motd.php.dist
index 7236a395e..12338dbdd 100644
--- a/imp/config/motd.php.dist
+++ b/imp/config/motd.php.dist
@@ -1,11 +1,15 @@
-<!-- This file contains any "Message Of The Day" Type information -->
-<!-- It will be included below the log-in form on the login page. -->
-
 <?php
 /**
+ * This file contains any "Message Of The Day" Type information.
+ * It will be included below the login form on the login page.
+ *
+ * $Id$
+ */
+
+/**
  * Example code for switching between HTTP and HTTPS.
  * Contributed by: James <james@james-web.net>
- * To use, unncomment and modify these variables:
+ * To use, uncomment and modify these variables:
  *
  * $SERVER_SSL_PORT - Port on which your SSL server listens (Usually 443)
  * $SERVER_HTTP_PORT - Port on which your HTTP server listens (Usually 80)
@@ -23,13 +27,13 @@
 // echo '<br /><div align="center" class="light">';
 //
 // switch ($port) {
-//     case $SERVER_SSL_PORT:
-//         echo _("You are currently using Secure HTTPS<br />");
-//         break;
+// case $SERVER_SSL_PORT:
+//     echo _("You are currently using Secure HTTPS<br />");
+//     break;
 //
-//     case $SERVER_HTTP_PORT:
-//         echo _("You are currently using Standard HTTP<br />");
-//         break;
+// case $SERVER_HTTP_PORT:
+//     echo _("You are currently using Standard HTTP<br />");
+//     break;
 // }
 //
 // echo '<a class="small" href="' . $SERVER_HTTP_URL . '" target="_parent">' . _("Click here for Standard HTTP") . '</a> - <a class="small" href="' . $SERVER_SSL_URL . '" target="_parent">' . _("Click here for Secure HTTPS") . '</a></div>';
diff --git a/imp/config/portal.php.dist b/imp/config/portal.php.dist
index a1ce65eee..fc35863e6 100644
--- a/imp/config/portal.php.dist
+++ b/imp/config/portal.php.dist
@@ -1,7 +1,5 @@
 <?php
 /**
- * $Id$
- *
  * Dynamic portal configuration page.
  *
  * Format: An array named $dimp_block_list
@@ -16,6 +14,8 @@
  *            'domid' => A DOM ID to assign to the containing block
  *            'tag' => A tag name to add to the template array. Allows
  *                     the use of <if:block.tag> in custom template files.
+ *
+ * $Id$
  */
 
 $collection = new Horde_Block_Collection();
diff --git a/imp/config/prefs.php.dist b/imp/config/prefs.php.dist
index 4bc9c280b..32a1e5fb9 100644
--- a/imp/config/prefs.php.dist
+++ b/imp/config/prefs.php.dist
@@ -1,8 +1,8 @@
 <?php
 /**
- * $Id$
- *
  * See horde/config/prefs.php for documentation on the structure of this file.
+ *
+ * $Id$
  */
 
 // Make sure that constants are defined.
diff --git a/imp/config/servers.php.dist b/imp/config/servers.php.dist
index f06cddf3c..530a3ea8d 100644
--- a/imp/config/servers.php.dist
+++ b/imp/config/servers.php.dist
@@ -1,7 +1,5 @@
 <?php
 /**
- * $Id$
- *
  * This file specifies which mail servers people using your installation of
  * IMP can login to.
  *
@@ -200,6 +198,8 @@
  *       IMAP server must support the LANGUAGE extensions for this setting to
  *       have an effect. By default, IMAP messages are output in the IMAP
  *       server default language.
+ *
+ * $Id$
  */
 
 /* Any entries whose key value ('foo' in $servers['foo']) begin with '_'
diff --git a/imp/config/spelling.php.dist b/imp/config/spelling.php.dist
index bd3f8f4f9..70becd51e 100644
--- a/imp/config/spelling.php.dist
+++ b/imp/config/spelling.php.dist
@@ -1,9 +1,9 @@
 <?php
 /**
- * $Id$
- *
  * This file defines a custom list of words that will be added to the spell
  * checker dictionary.
+ *
+ * $Id$
  */
 
 /* Default list (English). */
diff --git a/imp/docs/INSTALL b/imp/docs/INSTALL
index 7285fa287..40b34827b 100644
--- a/imp/docs/INSTALL
+++ b/imp/docs/INSTALL
@@ -2,7 +2,7 @@
  Installing IMP 5.0
 ====================
 
-:Contact:       imp@lists.horde.org
+:Contact: imp@lists.horde.org
 
 .. contents:: Contents
 .. section-numbering::
@@ -27,9 +27,9 @@ Or use the mirror closest to you:
 
    http://www.horde.org/mirrors.php
 
-Bleeding-edge development versions of IMP are available via CVS; see the file
+Bleeding-edge development versions of IMP are available via Git; see the file
 `horde/docs/HACKING`_ in the Horde distribution, or the website
-http://www.horde.org/source/, for information on accessing the Horde CVS
+http://www.horde.org/source/, for information on accessing the Horde Git
 repository.
 
 
diff --git a/imp/docs/TODO b/imp/docs/TODO
index 0f8cbc308..c1cd7609e 100644
--- a/imp/docs/TODO
+++ b/imp/docs/TODO
@@ -2,13 +2,8 @@
  IMP Development TODO List
 ===========================
 
-:Last update:   $Date: 2008/03/22 10:45:36 $
-:Revision:      $Revision: 1.30 $
-:Contact:       imp@lists.horde.org
+:Contact: imp@lists.horde.org
 
-In no particular order:
-
-- Don't render large MIME parts.
 
 - Print all messages in a mailbox.
 
diff --git a/imp/docs/UPGRADING b/imp/docs/UPGRADING
index ebd8d6c80..916e53838 100644
--- a/imp/docs/UPGRADING
+++ b/imp/docs/UPGRADING
@@ -2,9 +2,7 @@
  Upgrading IMP
 ===============
 
-:Last update:   $Date: 2008/10/20 03:54:39 $
-:Revision:      $Revision: 1.33 $
-:Contact:       imp@lists.horde.org
+:Contact: imp@lists.horde.org
 
 
 These are instructions to upgrade from earlier IMP versions.