Abschnitt: Bereichssuche: Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (hat „Abschnitt: Suche (Abstrakt)“ nach „Abschnitt: Bereichssuche“ verschoben)
 
(Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt)
Zeile 1: Zeile 1:
 
==Beschreibung==
 
==Beschreibung==
Der Suchabschnitt ist abstrakt. Das heißt das dieser Abschnitt nicht direkt verwendet wird. Der Suchabschnitt stell mehrere Blöcke bereit die je nach spezialisiertem Suchabschnitt aktiviert werden können. Der Suchabschnitt wird für den Anwendungsfall konfiguriert. Aus diesem konfiguriertem Suchabschnitt entsteht ein neue Suchabschnitt der dann direkt verwendet werden kann.
+
Der Abschnitt der Bereichssuche ist abstrakt. Das heißt, dass dieser Abschnitt nicht direkt verwendet werden soll!
  
;Index-Konfiguration:
+
Der Suchabschnitt stell mehrere Blöcke bereit die je nach spezialisiertem Suchabschnitt aktiviert, deaktiviert und/oder mit vordefinierten Werten konfiguriert werden können. Der konkret Suchabschnitt wird für den Anwendungsfall konfiguriert. Aus dieser konfiguriertem Bereichssuche entsteht ein neue Suchabschnitt der dann direkt verwendet werden kann. Mit Hilfe der Konfiguration kann eine redaktionelle Überarbeitung überflüssig werden, da alle Einstellungen für den konkreten Suchabschnitt bereits in der Konfiguration angegeben sind. In dem Fall würden auch die Eingabe-Möglichkeiten stark reduziert sein.
Der Name des Solr-Core, also des Index, auf dem die Volltextsuche stattfinden soll, entspricht in der Regel dem Anker des Publikationsbereiches. Mit diesem Konfigurations-Block ist es möglich Einfluß auf den zu verwendenden Core zu nehmen.
 
  
;Sprache:
 
Auswahl einer Sprache, um nur Treffer in dieser Sprache zurück zu liefern.
 
  
;Erweiterte Suche:
+
===Block: Core-Konfiguration===
Bei Aktivierung der erweiterten Such wird auf der Web-Seite ein Formular dargestellt, mit der die Suche vom Besucher der Web-Seite eingeschränkt werden kann.
+
Der Name des Solr-Core, also des Index, auf dem die Volltextsuche stattfinden soll, entspricht in der Regel dem Anker des Publikationsbereiches. Mit diesem Konfigurations-Block ist es möglich Einfluß auf den zu verwendenden Core zu nehmen und den Wert ggf. manuelle einzugeben.  
  
;Darstellung der Suchergebnisse:
 
Über diese Konfigurations-Block kann Einfluß auf die Darstellung der Suchergebnisse genommen werden. Folgende Einstellungen sind möglich
 
:* Die Suche bereits beim Seitenaufruf ausführen
 
:* Anzahl der Treffer pro Seite
 
:* Position für das Paging
 
:* Sortierung
 
:* Darstellung als Liste oder Teaserliste
 
:* Filter. Index-Feldname und Wert um zusätzliche Filter zu definieren.
 
  
;Vordefinierte Such-Filter:
+
===Block: Ausgabe der Suchergebnisse===
 +
In diesem Block kann redaktionell angegeben werden wie die Ergebnisse aufgelistet werden solle. Angegeben werden können die Anzahl der Ergebnisse pro Seite, ob und wo ein Paging ausgegeben werden soll, wie die Ergebnisse sortiert werden können (Gewichtung, Name, Datum) und wie die einzelnen Items dargestellt werden sollen (Link-Liste, Teaser-Liste, Teaser ohne Bild). Außerdem kann angegeben werden, ob beim Aufruf der Webseite die Suche initial ausgeführt werden soll, so dass die ersten Ergebnisse direkt aufgelistet werden. Zur Einschränkung kann ein/mehrere fest definierte/r Filter eingegeben werden, um die Ergebnismenge genauer zu definieren.
 +
 
 +
Der gesamte Block ist als Iterator umgesetzt. Dadurch können auf der Ergebnisseite mehrere Surchergebnis-Listen ausgegeben werden (Beispiel Veranstaltungen).
 +
 
 +
 
 +
===Block: Vordefinierte Such-Filter===
 
Es können hier verschiedenen Filter definieren werden, die bei der Suche stets gesetzt werden. Dadurch können spezielle Kontextbezogenen Recherche für diesen Artikel vor definieren werden. Ein Formular für eine manuelle Suche ist daher nicht zwingend notwendig.
 
Es können hier verschiedenen Filter definieren werden, die bei der Suche stets gesetzt werden. Dadurch können spezielle Kontextbezogenen Recherche für diesen Artikel vor definieren werden. Ein Formular für eine manuelle Suche ist daher nicht zwingend notwendig.
:;Filter nach Artikel-Strukturen:
 
:Auswahl einen oder mehrere Artikel-Pools, auf deren Inhalt/e sich die Suche beschränken soll. Sollten Sie mehrere Pools auswählen, werden diese bei der Filterung 'ODER' verknüpft.
 
:;Volltext-Filter:
 
:Text (z.B: Spielplatz, der bei jeder Suche versteckt angewandt wird.
 
:;Kategorie-Filter:
 
::* nur gesetzte Filter - die Kategoriebäume werden soweit aufgeklappt, bis die gesetzten Filter zusehen sind.
 
::* aufklappen - alle Kategoriebäume werden vollständing aufgeklappt.
 
::* zuklappen - alle Kategoriebäume werden zugeklappt.
 
::* alle löschen - löscht alle gesetzten Kategorie-Filter.
 
:;Einschränkung nach Datum:
 
:Wenn die Suche NUR Ergebnisse liefern soll, die beispielsweise in den letzten X Tagen oder in einem bestimmten Zeitraum von Relevanz sind, können diese konfigurieren werden.
 
  
;Such-Formular auf der Webseite:
+
Möglich ist die Eingabe eines Begriffs für die Volltextsuche sowie die Einschränkung auf einen oder die Inhalte eines oder mehrere Artikel-Pools.<br>
Es ist nicht nötig ein Formular für die Suche auf der Webseite zur Verfügung zu stellen, wenn alle nötigen Filter bereits konfiguriert sind. Anderenfalls gibt es die möglichen Eingabefelder für das Suchformular auf der Webseite festzulegen.
+
Sofern vorhanden können auch Kategorien ausgewählt werden, denen die Ergebnisse zugewiesen sein müssen.<br>
:;Volltextsuche:
+
Wenn die Suche NUR Ergebnisse liefern soll, die beispielsweise in den letzten 30 Tagen oder in einem bestimmten Zeitraum von Relevanz sind, können diese auch mit Hilfe eines definierten Datum-Filters gefiltert werden.
:Es kann angegeben werden, ob der Besucher der Webseite mit Hilfe eines Freitext-Feldes innerhalb der Daten recherchieren kann.
 
:;Kategorien:
 
:Auch die Einschränkung mit Hilfe der Kategorie-Bäume kann auf dem Webseite ermöglich werden. Bei verschachtelten Strukturen wird in der Webseite ggf. eine weitere Select-Box zur Auswahl dargestellt. Sollte eine verschachtelte Unterkategorie als vorselektierte Kategorie gewählt worden sein, kann zusätzlich angeben werden, ob der übergeordnete Kategoriebaum für eine Auswahl auf der Webseite NICHT zur Verfügung gestellt werden soll.
 
:;Zeiträume:
 
:Dem Besucher kann auch ermöglicht werden, innerhalb der von ihm eingegeben Zeiträumen nach Datum zu recherchieren.
 
Zusätzlich können vordefinierte Werte wie 'aus der letzten Woche' oder 'in dem kommenden Monat' für eine Auswahlbox konfiguriert werden. Die zeitliche Angabe bezieht sich immer auf 'Tage'.
 
  
;Facetten:
+
===Block: Such-Formular auf der Webseite===
Definition von Facetten. Diese sind in der Regel alle Homepages (inkl. Mircosites). Es ist aber mögliche auch eigene Facetten zu definieren.
+
Bei Aktivierung einer Komponente für die Web-Suche wird auf der Web-Seite ein Formular dargestellt, mit der die Suche vom Besucher der Web-Seite eingeschränkt werden kann. In dieser Konfiguration kann definiert werden, welche Eingaben und Filter der Besucher der Webseite nutzen kann.  
 +
Beispielsweise ein Feld für eine Volltextsuche, die Möglichkeit zu Einschränkung über Kategorien, oder die Angabe eine Datum oder Datum-Bereiches, dem die Artikel entsprechen müssen.  
  
 
==Konfiguration==
 
==Konfiguration==
 +
 +
Hier die Vollständigen Options-Parameter des SectionTypes 'search'. Die konkreten Such-Abschnitte muss diese entsprechen ihren Anforderungen anpassen.
 +
 +
 +
<source lang="javascript">
 +
{
 +
"sectionTypes" : {
 +
...,
 +
"[newSectionId]" : {
 +
":sectionTypes" : "search",
 +
"id" :  "[newSectionId]",
 +
"name" : "[newSectionName]",
 +
"options" : {
 +
                                "solrCore" : false,
 +
                                "hideInputSections" : false,
 +
                                "resultset" : {
 +
                                        "configurable" : true,
 +
 +
                                        "enableHeadline" : false,
 +
                                        "enableMulitResultList" : false,
 +
                                        "enableHitsPerPage" : true,
 +
                                        "enablePaging" : false,
 +
                                        "enableSorting" : true,
 +
 +
                                        "enableListTypeSelector" : true,
 +
                                        "listTypeSelectorWithoutSearch" : true,
 +
                                        "listTypeSelectorIfDisabled" : "list",
 +
 +
                                        "initialSearch" : false,
 +
                                        "initialSearchExecuteIfDisabled" : true
 +
 +
                                        "enableFilter" : false,
 +
                                        "fixFilterIfDisabled" : [
 +
                                                {
 +
                                                        "field" : "sp_source",
 +
                                                        "value" : "[sourceKey]"
 +
                                                }
 +
                                        ]
 +
                                },
 +
 +
                                "filter" : {
 +
                                        "articlePool" : true,
 +
 +
                                        "articlePoolStartPoolsQuery": "from informationpool where groupType = 'eventsCalendar-eventGroup'",
 +
                                        "fixArticlePoolsIfDisabled": [
 +
                                                {
 +
                                                        "poolAnchor" : "informationpool.app.newsdesk.publications.root",
 +
                                                        "excludeArchive" : false
 +
                                                }
 +
                                        ],
 +
                                        "fixArticlePoolQueryIfDisabled": "",
 +
                                        "articlePoolUseChildPools" : true,
 +
                                        "articlePoolsAsCheckbox" : false,
 +
 +
                                        "fulltext" : true,
 +
                                        "category" : true,
 +
                                        "date" : true,
 +
                                        "scheduling" : false,
 +
                                        "schedulingIfDisabled" : "TODO"
 +
                                },
 +
 +
                                "form" : {
 +
                                        "fulltext" : false,
 +
                                        "archive" : false,
 +
                                        "category" : false,
 +
                                        "date" : false
 +
                                },
 +
                                "textDefinitions" : false
 +
                        }
 +
 +
},
 +
...
 +
}
 +
}
 +
</source>
 +
 +
 
===IES Optionen===
 
===IES Optionen===
  
 
{| class="prettytable"
 
{| class="prettytable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
! Name || Type || Beschreibung
+
! Name || || Default || Type || Beschreibung
 
|-
 
|-
 
| <code>sectionTypes.[sectionId].options.solrCore</code>
 
| <code>sectionTypes.[sectionId].options.solrCore</code>
 +
|
 +
| false
 
| [[Boolean]]
 
| [[Boolean]]
| Index-Konfiguration anzeigen.
+
| Index-Konfiguration anzeigen, damit diese von Redakteuren geändert werden kann.
 
|-
 
|-
| <code>sectionTypes.[sectionId].options.initialSearch</code>
+
| <code>sectionTypes.[sectionId].options.hideInputSections</code>
 +
|
 +
| false
 
| [[Boolean]]
 
| [[Boolean]]
 +
| Anzeige differenzierter Eingabe-Blöcke für die verschiedenen Bereiche der Konfiguration
 +
 +
|-
 +
| <code>sectionTypes.[sectionId].options.resultset</code>
 +
|
 +
|
 +
| [[ARRAY]]
 
| Vordefinierte Such-Filter.
 
| Vordefinierte Such-Filter.
 
|-
 
|-
| <code>sectionTypes.[sectionId].options.enableLanguage</code>
+
| <code>sectionTypes.[sectionId].options.initialSearch</code>
 +
|
 +
| true
 
| [[Boolean]]
 
| [[Boolean]]
| Sprache
+
| Vordefinierte Such-Filter.
 +
 
 +
 
 +
 
 
|-
 
|-
 
| <code>sectionTypes.[sectionId].options.enableAdvancedSearch</code>
 
| <code>sectionTypes.[sectionId].options.enableAdvancedSearch</code>
 +
|
 +
| true
 
| [[Boolean]]
 
| [[Boolean]]
 
| Such-Formular auf der Webseite
 
| Such-Formular auf der Webseite
 
|-
 
|-
 
| <code>sectionTypes.[sectionId].options.resultset.configurable</code>
 
| <code>sectionTypes.[sectionId].options.resultset.configurable</code>
 +
|
 +
| true
 
| [[Boolean]]
 
| [[Boolean]]
 
| Darstellung der Suchergebnisse
 
| Darstellung der Suchergebnisse
 
|}
 
|}
  
<source lang="javascript">
 
{
 
"sectionTypes" : {
 
...,
 
"[sectionId]" : {
 
"id" : "[sectionId]",
 
"name" : "[sectionName]",
 
"template": { "module" : "sitekit-module", "uri" : "/templates/sectionTypes/search.spml" },
 
"aggregator" : { "module": "sitekit-module", "uri" : "/aggregator/sectionTypes/search.spml" },
 
"options" : {
 
 
"solrCore" : true,
 
 
"initialSearch" : true,
 
 
"enableLanguage" : true,
 
  
"enableAdvancedSearch" : true,
 
  
"resultset" : {
 
"configurable" : true,
 
"enableMulitResultList" : true,
 
"enableListTypeSelector" : true,
 
"listType" : "list",
 
"enablePaging" : true,
 
"enableFilter" : true
 
},
 
  
"articlePoolFilter" : true,
 
"fulltextFilter" : true,
 
"selectCategoryFilter" : true,
 
"dateFilter" : true,
 
  
"fulltextSearch" : true,
 
"categorySearch" : true,
 
"dateSearch" : true
 
}
 
},
 
...
 
}
 
}
 
</source>
 
  
 
===PHP Optionen===
 
===PHP Optionen===

Aktuelle Version vom 17. Oktober 2016, 16:08 Uhr

Beschreibung

Der Abschnitt der Bereichssuche ist abstrakt. Das heißt, dass dieser Abschnitt nicht direkt verwendet werden soll!

Der Suchabschnitt stell mehrere Blöcke bereit die je nach spezialisiertem Suchabschnitt aktiviert, deaktiviert und/oder mit vordefinierten Werten konfiguriert werden können. Der konkret Suchabschnitt wird für den Anwendungsfall konfiguriert. Aus dieser konfiguriertem Bereichssuche entsteht ein neue Suchabschnitt der dann direkt verwendet werden kann. Mit Hilfe der Konfiguration kann eine redaktionelle Überarbeitung überflüssig werden, da alle Einstellungen für den konkreten Suchabschnitt bereits in der Konfiguration angegeben sind. In dem Fall würden auch die Eingabe-Möglichkeiten stark reduziert sein.


Block: Core-Konfiguration

Der Name des Solr-Core, also des Index, auf dem die Volltextsuche stattfinden soll, entspricht in der Regel dem Anker des Publikationsbereiches. Mit diesem Konfigurations-Block ist es möglich Einfluß auf den zu verwendenden Core zu nehmen und den Wert ggf. manuelle einzugeben.


Block: Ausgabe der Suchergebnisse

In diesem Block kann redaktionell angegeben werden wie die Ergebnisse aufgelistet werden solle. Angegeben werden können die Anzahl der Ergebnisse pro Seite, ob und wo ein Paging ausgegeben werden soll, wie die Ergebnisse sortiert werden können (Gewichtung, Name, Datum) und wie die einzelnen Items dargestellt werden sollen (Link-Liste, Teaser-Liste, Teaser ohne Bild). Außerdem kann angegeben werden, ob beim Aufruf der Webseite die Suche initial ausgeführt werden soll, so dass die ersten Ergebnisse direkt aufgelistet werden. Zur Einschränkung kann ein/mehrere fest definierte/r Filter eingegeben werden, um die Ergebnismenge genauer zu definieren.

Der gesamte Block ist als Iterator umgesetzt. Dadurch können auf der Ergebnisseite mehrere Surchergebnis-Listen ausgegeben werden (Beispiel Veranstaltungen).


Block: Vordefinierte Such-Filter

Es können hier verschiedenen Filter definieren werden, die bei der Suche stets gesetzt werden. Dadurch können spezielle Kontextbezogenen Recherche für diesen Artikel vor definieren werden. Ein Formular für eine manuelle Suche ist daher nicht zwingend notwendig.

Möglich ist die Eingabe eines Begriffs für die Volltextsuche sowie die Einschränkung auf einen oder die Inhalte eines oder mehrere Artikel-Pools.
Sofern vorhanden können auch Kategorien ausgewählt werden, denen die Ergebnisse zugewiesen sein müssen.
Wenn die Suche NUR Ergebnisse liefern soll, die beispielsweise in den letzten 30 Tagen oder in einem bestimmten Zeitraum von Relevanz sind, können diese auch mit Hilfe eines definierten Datum-Filters gefiltert werden.

Block: Such-Formular auf der Webseite

Bei Aktivierung einer Komponente für die Web-Suche wird auf der Web-Seite ein Formular dargestellt, mit der die Suche vom Besucher der Web-Seite eingeschränkt werden kann. In dieser Konfiguration kann definiert werden, welche Eingaben und Filter der Besucher der Webseite nutzen kann. Beispielsweise ein Feld für eine Volltextsuche, die Möglichkeit zu Einschränkung über Kategorien, oder die Angabe eine Datum oder Datum-Bereiches, dem die Artikel entsprechen müssen.

Konfiguration

Hier die Vollständigen Options-Parameter des SectionTypes 'search'. Die konkreten Such-Abschnitte muss diese entsprechen ihren Anforderungen anpassen.


{
	"sectionTypes" : {
		...,
		"[newSectionId]" : {
			":sectionTypes" : "search",
			"id" :   "[newSectionId]",
			"name" : "[newSectionName]",
			"options" : {
                                "solrCore" : false,
                                "hideInputSections" : false,
                                "resultset" : {
                                        "configurable" : true,

                                        "enableHeadline" : false,
                                        "enableMulitResultList" : false,
                                        "enableHitsPerPage" : true,
                                        "enablePaging" : false,
                                        "enableSorting" : true,

                                        "enableListTypeSelector" : true,
                                        "listTypeSelectorWithoutSearch" : true,
                                        "listTypeSelectorIfDisabled" : "list",

                                        "initialSearch" : false,
                                        "initialSearchExecuteIfDisabled" : true

                                        "enableFilter" : false,
                                        "fixFilterIfDisabled" : [
                                                {
                                                        "field" : "sp_source",
                                                        "value" : "[sourceKey]"
                                                }
                                        ]
                                },

                                "filter" : {
                                        "articlePool" : true,

                                        "articlePoolStartPoolsQuery": "from informationpool where groupType = 'eventsCalendar-eventGroup'",
                                        "fixArticlePoolsIfDisabled": [
                                                {
                                                        "poolAnchor" : "informationpool.app.newsdesk.publications.root",
                                                        "excludeArchive" : false
                                                }
                                        ],
                                        "fixArticlePoolQueryIfDisabled": "",
                                        "articlePoolUseChildPools" : true,
                                        "articlePoolsAsCheckbox" : false,

                                        "fulltext" : true,
                                        "category" : true,
                                        "date" : true,
                                        "scheduling" : false,
                                        "schedulingIfDisabled" : "TODO"
                                },

                                "form" : {
                                        "fulltext" : false,
                                        "archive" : false,
                                        "category" : false,
                                        "date" : false
                                },
                                "textDefinitions" : false
                        }

		},
		...
	}
}


IES Optionen

Name Default Type Beschreibung
sectionTypes.[sectionId].options.solrCore false Boolean Index-Konfiguration anzeigen, damit diese von Redakteuren geändert werden kann.
sectionTypes.[sectionId].options.hideInputSections false Boolean Anzeige differenzierter Eingabe-Blöcke für die verschiedenen Bereiche der Konfiguration
sectionTypes.[sectionId].options.resultset ARRAY Vordefinierte Such-Filter.
sectionTypes.[sectionId].options.initialSearch true Boolean Vordefinierte Such-Filter.


sectionTypes.[sectionId].options.enableAdvancedSearch true Boolean Such-Formular auf der Webseite
sectionTypes.[sectionId].options.resultset.configurable true Boolean Darstellung der Suchergebnisse




PHP Optionen

Mehrsprachigkeit

Unterstütz keine Mehrsprachigkeit.

Datenstruktur

IES Datenstruktur

Name Type Beschreibung
sp_search_language String Begrenzung der Suchergebnisse auf eine Sprache

PHP Datenstruktur