2. Modul "Search"

Das Modul "Search" stellt die ConPresso-Suchfunktion bereit. Dabei findet dieses Modul sowohl im ConPresso-Backend als auch im ConPresso-Frontend Verwendung.

Redaktionell arbeitenden Benutzern stellt das Modul im Backend eine umfangreiche Recherchemöglichkeit nach Artikeln bereit, über die gezielt nach Inhalten gesucht werden kann. Im Frontend haben Besucher des ConPresso-Projekts die Möglichkeit, nach Suchbegriffen in zuvor definierten Bereichen des Projekts zu suchen.

Da es sich bei der Suchfunktion um eine Basisfunktionalität des ConPresso-Backends handelt, ist das Suchmodul seit Version 4.0.5 Bestandteil der Basisinstallation von ConPresso. Das Modul kann jedoch auch manuell nachinstalliert werden (z.B. bei den Versionen ConPresso 4.0.0 bis 4.0.4). Es steht auf der ConPresso-Website zum Download zur Verfügung. Informationen zur Installation erhalten Sie in Abschnitt 2.1, "Installation des Moduls".

Die Suchfunktion in ConPresso ist bewusst als Modul realisiert, da sie auf diese Weise innerhalb des Frontends eines ConPresso-Projekts mehrfach Verwendung finden kann. Unterschiedliche Installationen des Moduls können dabei in Funktion und Erscheinung unterschiedlich konfiguriert werden. Das ist beispielsweise dann notwendig, wenn im ConPresso-Frontend neben einer Standardsuche eine zusätzliche Suchfunktion integriert werden soll, die ausschließlich einen bestimmten Teilbereich des ConPresso-Projekts (z.B. die FAQs) durchsucht.

[Anmerkung]Anmerkung

Eine Registrierung dieses Moduls ist nicht vorgesehen. Das Modul ist sowohl für den nicht-kommeziellen als auch für den kommerziellen Einsatz im Rahmen einer kommerziellen ConPresso-Installation kostenlos verfügbar. Bitte beachten Sie, dass andere Module zum Teil einer Registrierung bedürfen und für den kommerziellen der Erwerb einer "Lizenz zur kommerziellen Nutzung" erforderlich ist.

2.1. Installation des Moduls

Das Modul "Search" ist Bestandteil der Basisinstallation von ConPresso (seit Version 4.0.5). Möchten Sie das Modul bei Verwendung einer älteren ConPresso-Version nachinstallieren, finden Sie hier die wichtigsten Instruktionen zu Modulinstallation.

Auch für den Fall, dass Sie mehrere Suchfunktionen im Frontend eines Projekts anbieten möchten, ist eine Mehrfachinstallation des Moduls notwendig. Um die Installation durchzuführen, gehen Sie in folgenden Schritten vor.

Download des Archivs

Bitte laden Sie von der ConPresso-Website die aktuelle Version des Moduls herunter und speichern Sie das Archiv lokal.

Entpacken des Archivs und Upload des Modulverzeichnisses

Nach dem Download entpacken Sie das Archiv bitte lokal auf Ihrem Rechner und kopieren anschließend das Modulverzeichnis per FTP unter dem gewünschte Namen (z.B. "mod_search", "mod_search_faq", etc.) in das ConPresso-Verzeichnis Ihres Projekts.

[Anmerkung]Anmerkung

Sofern Sie bereits eine Version ab 4.0.5 verwenden und eine zusätzliche Installation des Moduls durchführen, können Sie auch das vorhandene Modulverzeichnis Ihres ConPresso-Projekts herunterladen und eine Kopie unter einem neuem Namen im ConPresso-Verzeichnis verfügbar machen.

Installation und Aktivierung des Moduls

Wechseln Sie nun im ConPresso-Backend in die Ansicht "Module verwalten", die Sie über den Eintrag "Module verwalten" im Menü "Module" erreichen.

Installieren Sie das Modul durch einen Klick auf die Schaltfläche Installieren in der Spalte "Bearbeiten". Im nächsten Schritt aktivieren Sie das Modul duch Anklicken der Schaltfläche Modul aktivieren in der Spalte "Bearbeiten". Weitere Informationen zur Installation, Aktivierung und zur Deinstallation eines Moduls erhalten Sie Abschnitt 1, "Module verwalten".

Nach der Installation des Moduls steht im Backend der Eintrag "Suche" in der Navigation bereit, über den redaktionell arbeitende Benutzer die Suchfunktion des Backends erreichen können.

Moduleinstellungen bearbeiten

Das Suchmodul kann für seine Verwendung im ConPresso-Frontend konfiguriert werden. So kann beispielsweise festgelegt werden, in welchen Rubriken die Suchfunktion suchen soll, wie viele Treffer je Ausgabeseite angezeigt werden sollen und wie die Ausgabe des Suchergebnisses formatiert sein soll.

Die Konfiguration des Moduls findet in der Ansicht "Moduleinstellungen bearbeiten" statt, die Sie erreichen, indem Sie im Menü "Module" den Eintrag "Module verwalten" auswählen und anschließend in der Spalte "Bearbeiten" auf die Schaltfläche Moduleinstellungen bearbeiten klicken.

"Rubrikeneinschränkung"

Über die Einstellung "Rubrikeneinschränkung" können Sie die Suche auf bestimmte Rubriken beschränken. Dies ist sinnvoll, wenn Inhalte bestimmter Rubriken in der Suchfunktion nicht berücksichtigt werden sollen.

Über die Auswahl der Option "einschließen", schließen Sie die unter "Rubriken" ausgewählten Rubriken in die Suchfunktion ein. Über die Auswahl der Option "ausschließen", schließen Sie die unter "Rubriken" ausgewählten Rubriken aus der Suchfunktion aus.

"Rubriken"

Die Einstellung "Rubriken" steht in direktem Zusammenhang zur Einstellung "Rubrikeneinschränkung", in der Sie bestimmen können, ob Sie Rubriken für die Suchfunktion ein- oder ausschliessen wollen.

Markieren Sie daher hier die ein- bzw. auszuschliessenden Rubriken. Eine Mehrfachauswahl erreichen Sie, indem Sie unter Verwendung der Shift- bzw. Steuerungstaste nacheinander mehrere Einträge durch Anklicken auswählen.

"Suchoptionen"

Soll die Suchfunktion um die Suche nach dem Namen des Autors eines Artikels, nach Links, Bildern oder Dateien erweitert werden, so aktivieren Sie bitte die entsprechenden Optionen.

"Titel durchsuchen"

Wählen Sie die Option "Titel durchsuchen", so werden bei der Suche im Frontend Treffer geliefert, bei denen der angegebene Suchbegriff Bestandteil des Titels ist.

"Inhalt durchsuchen" [Standardauswahl]

Wählen Sie die Option "Inhalt durchsuchen", so wird der gesamte Inhalt der Artikel duchsucht. Neben Texten, die auf den Platzhalter-Typen "Text" und "HTML" basieren, werden auch Links, Bild- und Dateibeschreibungen durchsucht.

"Schlüsselwörter durchsuchen" [Standardauswahl]

Wählen Sie die Option "Schlüsselwörter durchsuchen", so werden bei der Suche im Frontend Treffer geliefert, bei denen der Suchbegriff Bestandteil des Feldes "Schüsselwörter" ist. Weitere Informationen zu Schlüsselwörtern erhalten Sie in Abschnitt 1, "Artikel erstellen".

"Autoren durchsuchen"

Wählen Sie die Option "Autoren durchsuchen", so werden bei der Suche im Frontend Treffer geliefert, bei denen der Suchbegriff Bestandteil des Benutzernamens oder des Namens des Artikel-Autors ist.

"Anzahl Treffer je Seite"

Über die Einstellung "Anzahl Treffer je Seite" geben Sie an, wie viele Treffer je Ausgabeseite ausgegeben werden sollen.

"Zeichenmenge"

Die Suche zeigt den eigentlichen Treffer hervorgehoben in seinem textlichen Zusammenhang an. Den Umfang des dargestellten Textes definieren Sie über die Einstellung "Zeichenmenge". Angegeben wird dieser Wert in Anzahl der Zeichen (z.B. 50).

"Datumsformat"

Über die Einstellung "Datumsformat" wird die Ausgabe des Publikationsdatums formatiert, sofern dies als zusätzliche beschreibende Information zusammen mit dem Suchergebnis ausgegeben wird.

"Template"

Über das Template formatieren Sie die Ein- und Ausgabe der Suche. Es stehen die folgenden Platzhalter zur Verfügung.

<!-- START_MOD_SEARCH -->

Definiert den Anfang des Suchtemplates.

<!-- SEARCH_NAV -->

Wird in einem "hidden"-Feld benötigt, damit die Navigation auch nach dem Absenden der Suche passend angezeigt wird.

<!-- SEARCH_PHRASE -->

Enthält den Suchbegriff aus der aktuellen Suche oder einen Leerstring.

<!-- SEARCH_MESSAGE -->

Gibt eventuelle Meldungen aus wie "keine Ergebnisse", "kein Suchbegriff angegeben", etc.

<!-- SEARCH_MATCHES -->

Enthält die Anzahl der Treffer der aktuellen Suche.

<!-- START_SEARCH_MATCH -->

Startet den je Treffer auszugebenden Bereich.

<!-- SEARCH_NUM -->

Enthält die laufende Nummer das aktuellen Ergebnisses.

<!-- SEARCH_LINK -->

Dieser Platzhalter enthält die URL zum gefundenen Artikel und sollte z.B. als "href"-Attribut eines Link-Tags genutzt werden.

<!-- SEARCH_TITLE -->

Enthält den Titel des gefundenen Artikels

<!-- SEARCH_RUBRIC -->

Enthält die Rubrik, in der der Artikel gefunden wurde.

<!-- SEARCH_AUTHOR -->

Entspricht dem Namen des Autors des gefundenen Artikels.

<!-- SEARCH_PUB_DATE -->

Enthält das Publikationsdatum des gefundenen Artikels.

<!-- SEARCH_ARTICLE_ID -->

Enthält die Artikel-Kennziffer des gefundenen Artikels.

<!-- SEARCH_CONTENT -->

Enthält die Umgebung des Treffers im gefundenen Inhalt.

<!-- END_SEARCH_MATCH -->

Beendet den pro Treffer auszugebenden Bereich.

<!-- SEARCH_PAGES -->

Gibt die Navigation zwischen den einzelnen Seiten der Suche aus sobald mehr als eine bestimmte Anzahl an Treffern gefunden wurde.

<!-- END_MOD_SEARCH -->

Definiert das Ende des Suchtemplates

"Hervorhebungs-CSS"

Geben Sie hier die Klasse an, die die Formatierungsanweisungen für die Hervorhebung des Suchgegriffs in den Suchergebnissen enthält.

"Meldung 'kein Suchbegriff'"

Geben Sie hier den Meldungstext an, der ausgegeben werden soll, sofern eine Suche ohne Angabe eines Suchbegriffs gestartet wurde.

"Meldung 'keine Treffer'"

Geben Sie hier den Meldungstext an, der ausgegeben werden soll, sofern eine Suche kein Suchergebnis geliefert hat.

"Meldung 'Treffer'"

Geben Sie hier den Meldungstext an, der der Ausgabe der Suchergebnisse vorangestellt werden soll. Um die Anzahl der Treffer ausgeben zu lassen, verwenden Sie bitte den Platzhalter "%s" an beliebiger Position in der Meldung.

Einbindung des Moduls in das ConPresso-Frontend

Die Einbindung des Suchmoduls in das ConPresso-Frontend kann auf zwei Arten erfolgen.

Bei der ersten Art leiten Sie den Besucher des Frontends auf die Eingabeseite des Suchmoduls. Hierzu integrieren Sie einen Link - sei es bei der Anpassung innerhalb einer Header- oder Footer-Datei oder innerhalb eines Artikels - über den der Besucher die Eingabeseite des Moduls erreichen kann.

Für den Fall, dass Sie ConPresso im Verzeichnis conpresso Ihres Webservers mit der Domain "http://www.example.com" installiert haben und das Modul im Standardverzeichnis mod_search vorhanden ist, verwenden Sie die folgende URL oder passen diese entsprechend an: http://www.example.com/conpresso/mod_search/index.php

Es ist selbstverständlich auch möglich, die Eingabeseite des Suchmoduls in die Navigation des ConPresso-Projektes zu integrieren. Hierzu erzeugen Sie an gewünschter Position in der Navigation ein neues Navigationselement und geben als "externen Link" die oben genannte URL zur Eingabeseite des Suchmoduls ein. Details zur Bearbeitung der Navigation erfahren Sie in Abschnitt 5, "Navigation bearbeiten".

Die grafische Anpassung des Suchfeldes erfolgt - genau wie die Anpassung der Suchausgabe - über die Einstellungen des Moduls unter „Moduleinstellungen bearbeiten“.

Die zweite Art der Integration des Suchmoduls ist das Einfügen des eines Suchfeldes in eine Header- oder Footerdatei. Verwenden Sie dazu einen globalen Header oder Footer, so ist das Suchfeld auf allen durch ConPresso bereitgestellten Seiten verfügbar. Weitere Informationen zu Header- und Footer-Dateien erhalten Sie in Abschnitt 2.1, "Anpassung von Header- und Footer-Dateien".

Benutzen Sie hierzu das folgende Codebeispiel.

Beispiel 13.1. Suchformular für das Backend

<form method="get" action="../mod_search/index.php" >
    <input type="hidden" name="action" value="search" />
    <input type="hidden" name="rubric" value="<?php echo $cpoRubric['id']; ?>" />
    Bitte geben Sie Ihren Suchbegriff ein:<br />
    <input type="text" name="q" value="" />
    <input type="submit" value="Suche">
</form>


[Anmerkung]Anmerkung

Bitte beachten Sie, dass in der ersten "<form>"-Zeile eventuell der Pfad zur Index-Datei des jeweiligen Suchmoduls angepasst werden muss.

2.2. Suche im ConPresso-Backend

Sie erreichen die Suche, indem Sie den Eintrag "Suche" in der ConPresso-Navigation anklicken. ConPresso öffnet daraufhin die Ansicht "Suche" im ConPresso-Arbeitsbereich. Über die Suche können Sie komfortabel Inhalte nach diversen Kriterien suchen, die im Folgenden beschrieben werden sollen.

Sucheingabe

"Suchbegriff"

Geben Sie hier den Suchbegriff an, nach dem Sie suchen möchten.

"Suchoptionen"

Wählen Sie in den Suchoptionen aus, in welchen Elementen Sie suchen möchten.

"Titel durchsuchen" [Standardauswahl]

Wählen Sie die Option "Titel durchsuchen", so werden bei der Suche Treffer (Artikel) geliefert, bei denen der unter "Suchbegriff" angegebene Begriff Bestandteil des Titels ist.

"Inhalt durchsuchen" [Standardauswahl]

Wählen Sie die Option "Inhalt durchsuchen", so wird der gesamte Inhalt der Artikel duchsucht. Neben Texten, die auf den Platzhalter-Typen "Text" und "HTML" basieren, werden auch Links, Bild- und Dateibeschreibungen durchsucht.

"Schlüsselwörter durchsuchen" [Standardauswahl]

Wählen Sie die Option "Schlüsselwörter durchsuchen", so werden bei der Suche Treffer (Artikel) geliefert, bei denen der unter "Suchbegriff" angegebene Begriff Bestandteil des Feldes "Schüsselwörter" ist. Weitere Informationen zu Schlüsselwörtern erhalten Sie in Abschnitt 1, "Artikel erstellen".

"Autoren durchsuchen"

Verwenden Sie die Option "Autoren durchsuchen", um nach Artikeln zu suchen, die von einem bestimmten Autor erstellt wurden. Geben Sie hierzu den Benutzernamen, den Namen oder einen Namensteil als "Suchbegriff" ein und starten Sie die Suche.

"Kommentar durchsuchen"

Wählen Sie die Option "Kommentar durchsuchen", so werden bei der Suche Treffer (Artikel) geliefert, bei denen der unter "Suchbegriff" angegebene Begriff Bestandteil des Feldes "Kommentar" ist. Weitere Informationen zu Kommentaren erhalten Sie in Abschnitt 1, "Artikel erstellen".

"Rubriken"

Wählen Sie hier die Rubriken aus, die bei der Suche nach dem Suchbegriff berücksichtigt werden sollen. Eine Mehrfachauswahl erreichen Sie, indem Sie unter Verwendung der Shift- bzw. Steuerungstaste nacheinander mehrere Einträge durch Anklicken auswählen.

"Freigabestatus"

Unter "Freigabestatus" grenzen Sie die Suche hinsichtlich des Freigabestatus von Artikeln ein.

"Publikationszeitraum"

Unter "Publikationszeitraum" grenzen Sie die Suche hinsichtlich des Publikationszeitraums von Artikeln ein.

Treffen Sie keine Auswahl, so wird sowohl nach Artikeln gesucht, die auf ihre Veröffentlichung warten, sich innerhalb des Publikationszeitraums befinden oder bereits verfallen sind. Dies ist die Standardeinstellung.

"Artikeltemplate"

Verwenden Sie diese Option, um nach Artikeln zu suchen, die ein bestimmtes Artikeltemplate verwenden. Wählen Sie hierzu das gewünschte Artikeltemplate im Drop-Down-Menü aus und starten Sie die Suche.

"Zuletzt bearbeitet von"

Verwenden Sie die Auswahl "Zuletzt bearbeitet von", um nach Artikeln zu suchen, die von einem bestimmten Benutzer zuletzt bearbeitet wurden. Wählen Sie dazu im Drop-Down-Menü den entsprechenden Benutzer aus und starten Sie die Suche.

Suchausgabe

Die Suchausgabe besteht aus einer Meldung, die die Anzahl der gefundenen Treffer ausgibt und einer Listenansicht, die die gefundenen Treffer (Artikel) enthält. Diese Ansicht ist ähnlich zu den in anderen Bereichen bekannten Ansichten zur Auflistung von Artikeln. Über die Listenansicht können Sie die Ansicht "Artikel bearbeiten" der Rubriken öffnen, in deren Artikel der von Ihnen eingegebene Suchbegriff gefunden wurde. Die Listenansicht enthält die folgenden Spalten.

"Titel/Autor"

Die Spalte "Titel/Autor" der Suchausgabe gibt den Titel des Artikels sowie den Namen des Autors und den Namen des Benutzers wieder, der zuletzt an dem Artikel gearbeitet hat. Vor dem Titel befindet sich außerdem entweder ein grünes oder ein orangenes Quadrat. Die Farbe des Quadrats zeigt eindeutig an, ob der Artikel im Frontend des Projekts zu sehen ist oder nicht.

"Rubrik"

Die Spalte "Rubrik" der Suchausgabe zeigt Ihnen, in welcher Rubrik sich der Artikel befindet. Wollen Sie eines der gefundenen Artikel bearbeiten, so müssen Sie zunächst diese Rubrik auswählen.

"Status"

Die Spalte "Status" der Suchausgabe zeigt den Freigabestatus der Artikel an. Informationen zum Freigabestatus erhalten Sie in Abschnitt 2.1, "ConPresso-Freigabeprozess", wo der ConPresso Freigabeprozess ausführlich beschrieben wird.

"Publikation"

Die Spalte "Publikation" der Suchausgabe zeigt den Publikationszeitraum des Artikels an. Weitere Informationen zum Publikationszeitraum von Artikeln erhalten Sie in Abschnitt 2.2, "Publikationszeitraum".

"Fundstelle"

Die Spalte "Fundstelle" zeigt den Suchbegriff (Treffer) in seinem Zusammenhang an.

2.3. Suche im Frontend

Im Frontend eines ConPresso-Projekts wird über das Modul "Search" ein Eingabefeld bereitgestellt, das Besuchern des Projektes die Eingabe eines Suchbegriffs ermöglicht. Je nach Konfiguration des Moduls unter „Moduleinstellungen bearbeiten“ werden die Suchergebnisse anschließend ausgegeben.

Weitere Informationen darüber, wie Sie die Suchfunktion im ConPresso-Frontend verfügbar machen, erhalten Sie unter „Einbindung des Moduls in das ConPresso-Frontend“.

[Anmerkung]Anmerkung

Die Suchfunktion des ConPresso-Frontends berücksichtigt geschlossene Benutzerbereiche und die ConPresso-Personalisierung.

Hierdurch ist sichergestellt, dass Benutzern des Frontends auch über die Suche nur die für Sie bereitgestellten Inhalte ausgegeben werden und nicht etwa Informationen aus geschlossenen Benutzerbereichen, für die der Benutzer keine Zugriffsberechtigung besitzt. Dies führt dazu, dass Besuchern des Frontends mit unterschiedlichen Rechten auch unterschiedliche Inhalte ausgegeben werden können.

Weitere Informationenen erhalten Sie unter Abschnitt 16, "Geschlossene Benutzerbereiche und Personalisierung".