Item2276: document the groupby=none option from MakeSEARCHResultParti…

…tioningByWebOptional

git-svn-id: http://svn.foswiki.org/trunk@7028 0b4bb1d4-4e5a-0410-9cc4-b2b747904278

core/data/System/VarSEARCH.txt

@@ -34,6 +34,7 @@
      | =recurse="on"= | Recurse into subwebs, if subwebs are enabled. | =off= |
      | =separator=", "= | Line separator _between_ search hits (only used when format= is set) | ="$n"= (Newline) |
      | =newline="%<nop>BR%"= | Line separator _within_ a search hit. Useful if you want to put multi-line content into a table cell, for example if the format="" parameter contains a $pattern() that captures more than one line, or contains a $formfield() that returns a multi-line textfield. | ="$n"= (Newline) |
+     | =groupby="none"= | _Warning: this option is liable to change dramatically (and potentially incompatibly) in the next major release of foswiki._ Setting to ="none"= applies only to multi-web SEARCHs, and means the =header= and =footer= are only output _once_ - at the beginning and end of the list of results, and the =order= parameter is applied over the entire set of results (this setting removes the legacy that results are always partitioned by web) see %SYSTEMWEB%.SiteChanges for an example. | ="web"= |
    * Example: =%<nop>SEARCH{"wiki" web="%USERSWEB%" scope="topic"}%=
    * Example with format: =%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"}%= _(displays results in a table with header - [[FormattedSearch][details]])_
    * %T% If the Foswiki:Extensions.TablePlugin is installed, you may put a =%<nop>TABLE{}%= macro just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: =%<nop>TABLE{ tablewidth="90%" }%=