From: Michael M Slusarz <slusarz@curecanti.org>
Date: Mon, 14 Dec 2009 19:00:44 +0000 (-0700)
Subject: Documentation updates.
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=6a135beb1c1ae7a039892f956e3fd012bb5f6d9b;p=horde.git

Documentation updates.
---

diff --git a/imp/config/servers.php.dist b/imp/config/servers.php.dist
index f1a1e6e1e..8534ecc04 100644
--- a/imp/config/servers.php.dist
+++ b/imp/config/servers.php.dist
@@ -148,8 +148,17 @@
  *                        everyone.
  *
  * 'debug' - (string) If set, will output debug information from the IMAP
- *                    library.  The value can be any PHP supported wrapper
- *                    that can be opened via fopen().
+ *           library. The value can be any PHP supported wrapper that can be
+ *           opened via fopen(). For example, to output to a file (the default
+ *           PHP wrapper), provide the full path to the file (this file must
+ *           be writable by the PHP process). This setting should not be
+ *           enabled by default on production servers, since the log file will
+ *           quickly grow very large.
+ *
+ *           To restrict logging to a certain user ('foo'), and to log this
+ *           output to the file '/tmp/imaplog', the following can be used:
+ *
+ *             ((Horde_Auth::getAuth() == 'foo') ? '/tmp/imaplog' : false)
  *
  *
  * *** The following options should NOT be set unless you REALLY know what ***
diff --git a/imp/js/ViewPort.js b/imp/js/ViewPort.js
index 2cb6ce114..849277420 100644
--- a/imp/js/ViewPort.js
+++ b/imp/js/ViewPort.js
@@ -110,14 +110,18 @@
  * ------------------------------------------------
  * cacheid: (string) A unique string that changes whenever the viewport
  *          list changes.
- * data: (object) TODO
+ * data: (object) Data for each entry that is passed to the template to create
+ *       the viewable rows. Keys are a unique ID (see also the 'rowlist'
+ *       entry). Values are the data objects. Internal keys for these data
+ *       objects must NOT begin with the string 'vp'.
  * label: (string) The label to use for the current view.
  * metadata [optional]: (object) TODO
  * rangelist: TODO
  * requestid: (string) The request ID sent in the outgoing AJAX request.
  * reset [optional]: (integer) If set, purges all cached data.
  * resetmd [optional]: (integer) If set, purges all user metadata.
- * rowlist: TODO
+ * rowlist: (object) A mapping of unique IDs (keys) to the row numbers
+ *          (values). Row numbers start at 1.
  * rownum [optional]: (integer) The row number to position screen on.
  * totalrows: (integer) Total number of rows in the view.
  * update [optional]: (integer) If set, update the rowlist instead of