[TASK] Add documentation

Port from e009edb

Author: dkd-kaehm

Documentation/Configuration/Index.rst

@@ -0,0 +1,28 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _conf-index:
+
+
+.. raw:: latex
+
+    \newpage
+
+.. raw:: pdf
+
+   PageBreak
+
+Configuration Reference
+=======================
+
+
+.. toctree::
+	:maxdepth: 5
+	:glob:
+
+	./Reference/TxSolrGrouping

Documentation/Configuration/Reference/TxSolrGrouping.rst

@@ -0,0 +1,76 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+.. raw:: latex
+
+    \newpage
+
+.. raw:: pdf
+
+   PageBreak
+
+
+.. _conf-tx-solr-general:
+
+tx_solr.search.grouping
+=======================
+
+This section defines all available settings for grouping.
+
+.. contents::
+    :local:
+
+
+grouping.numberOfGroups
+-----------------------
+
+:Type: Integer
+:TS Path: plugin.tx_solr.search.grouping.numberOfGroups
+:Default: 5
+:Since: 1.0
+
+grouping.numberOfResultsPerGroup
+--------------------------------
+
+:Type: Integer
+:TS Path: plugin.tx_solr.search.grouping.numberOfResultsPerGroup
+:Default: 5
+:Since: 1.0
+
+
+grouping.allowGetParameterSwitch
+--------------------------------
+
+:Type: Boolean
+:TS Path: plugin.tx_solr.search.grouping.allowGetParameterSwitch
+:Default: 0
+:Since: 1.0
+
+
+grouping.groups.[groupName].field
+---------------------------------
+
+:Type: String
+:TS Path: plugin.tx_solr.search.grouping.[groupName].field
+:Default: empty
+:Since: 1.0
+
+Defines the solr field where a group should be build on.
+
+Note: Use either field or queries no mix. Groups with field are field groups, groups with queries are query groups.
+
+grouping.groups.[groupName].queries
+-----------------------------------
+
+:Type: Array
+:TS Path: plugin.tx_solr.search.grouping.[groupName].queries
+:Default: empty
+:Since: 1.0
+
+Defines an array of queries to group the results in.
+
+Note: Use either field or queries no mix. Groups with field are field groups, groups with queries are query groups.

Documentation/Introduction/Index.rst

@@ -0,0 +1,52 @@
+Introduction
+============
+
+What does it do?
+----------------
+
+Solrfluidgrouping can be used to group documents based on a solr field or a set of solr queries.
+
+The following example shows show to group documents based on the "type" field:
+
+.. code-block:: typoscript
+
+    plugin.tx_solr {
+        search {
+            grouping = 1
+            grouping {
+                numberOfGroups = 5
+                numberOfResultsPerGroup = 5
+                allowGetParameterSwitch = 0
+                groups {
+                    typeGroup {
+                        field = type
+                    }
+                }
+            }
+        }
+    }
+
+
+The next example shows how to group documents based on queries:
+
+.. code-block:: typoscript
+
+    plugin.tx_solr {
+        search {
+            grouping = 1
+            grouping {
+                numberOfGroups = 5
+                numberOfResultsPerGroup = 5
+                allowGetParameterSwitch = 0
+                groups {
+                    pidQuery {
+                        queries {
+                            lessThenTen = pid:[0 TO 10]
+                            lessThen30 = pid:[11 TO 30]
+                            rest = pid:[30 TO *]
+                        }
+                    }
+                }
+            }
+        }
+    }