changeset 356:918af8ce7507

CollectLists: improved comments
author Reimar Bauer <rb.proj AT googlemail DOT com>
date Thu, 05 Feb 2009 11:16:36 +0100
parents 5be8fa5a1ff6
children d54642e890e3
files data/plugin/macro/CollectLists.py
diffstat 1 files changed, 13 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/data/plugin/macro/CollectLists.py	Thu Feb 05 11:07:44 2009 +0100
+++ b/data/plugin/macro/CollectLists.py	Thu Feb 05 11:16:36 2009 +0100
@@ -1,17 +1,22 @@
 # -*- coding: iso-8859-1 -*-
 """
-    MoinMoin - macro to collect data from definition lists from subpages pages
+    MoinMoin - macro to collect data from definition lists from subpages
     into a databrowser widget table
 
     <<CollectLists>>
     will create a table column for every subpage of the current page and fills in
-    the data from each key value pair
-    optional you can give the template page the definition list page depends on
-    or the column_heading. In the latter case the order is used. Also it can optionally use
-    another pagename. By setting optional a parser one can use e.g. wikimarkup. By
-    filter_selection you can optional use the filter method of the databrowser widget.
-    By using a different filter_column_value than '', eg. name:: Cohen  you get only rows shown where that
-    name was found.
+    the data from each key value pair of a definition list.
+    Optional you can give the template page the definition list page depends on
+    or the column_heading. In the latter case the order is used.
+    Also it can optionally use definition list from another pagename.
+    By setting optional a parser one can use e.g. wikimarkup from a different
+    parser than moinmoin.
+    By filter_selection you can optional use the filter method of the databrowser
+    widget (this needs javascript enabled).
+    By using a different filter_column_value than the default, eg. name:: Cohen  you
+    get only rows shown where that name was found.
+    By using the keyword transpose the table is shown transposed. Until transpose is not part
+    of the databrowser widget itselfs we don't support filter_selection by transpose=True.
 
     @copyright: 2006 by michael cohen <scudette@users.sourceforge.net> (PageDicts)
     @copyright: 2008-2009 by MoinMoin:ReimarBauer (completly rewritten)