Documentation updates.
authorMichael M Slusarz <slusarz@curecanti.org>
Mon, 14 Dec 2009 19:00:44 +0000 (12:00 -0700)
committerMichael M Slusarz <slusarz@curecanti.org>
Mon, 14 Dec 2009 19:23:12 +0000 (12:23 -0700)
imp/config/servers.php.dist
imp/js/ViewPort.js

index f1a1e6e..8534ecc 100644 (file)
  *                        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 ***
index 2cb6ce1..8492774 100644 (file)
  * ------------------------------------------------
  * 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