Installationsanleitung - D3

1
erweiterte Suche
Data Development
erweiterte Suche
Installation und Schnellstart
Stand: 01.06.2012,
Modulversion: 3.12.0
Bearbeiter: DS
D³ Data Development, Inh.: Thomas Dartsch, Stollberger Straße 23, 09380 Thalheim / Erzgeb.
Telefon: 03721 – 268090, Fax: 03721 – 265234
http://www.shopmodule.com, Mail: [email protected]
2
erweiterte Suche
Inhalt
Inhalt .................................................................................................................................................2
Konventionen ................................................................................................................................... 3
Mindestanforderungen .................................................................................................................... 4
Beiliegende Bibliotheken................................................................................................................. 4
Vorbereitung .................................................................................................................................... 4
Neuinstallation .................................................................................................................................5
1.
Dateien kopieren ...................................................................................................................5
2.
Dateien anpassen ..................................................................................................................5
3.
Verwendung eigener Themes ...............................................................................................5
4.
Moduleinträge setzen ...........................................................................................................5
bis Shopversion 4.5.X: ...............................................................................................................5
ab Shopversion 4.6.X ................................................................................................................5
5.
Datenbankänderungen installieren ..................................................................................... 6
6.
Datenbank vervollständigen ................................................................................................ 6
7.
TMP leeren ........................................................................................................................... 6
8.
Modul konfigurieren ............................................................................................................ 6
9.
Updatefähigkeit .................................................................................................................... 6
Update ...............................................................................................................................................7
1.
Connector kontrollieren .......................................................................................................7
2.
Dateien kopieren ...................................................................................................................7
3.
Angepasste Dateien kontrollieren ........................................................................................7
4.
Datenbankänderungen installieren ......................................................................................7
5.
Moduleinträge setzen ...........................................................................................................7
Schnellstart ...................................................................................................................................... 9
Hilfe und Support ........................................................................................................................... 10
3
erweiterte Suche
Konventionen
In diesem Dokument verwenden wir die folgenden typografischen Konventionen:
Reguläre Proportionalschrift
 Quelltext und Eingabetext
„Kursive Proportionalschrift“
 Pfad- und Dateiangaben
[Proportionalschrift in Klammern]
 Menüpunkte und Buttons
Dunkelrote Fettschrift
 Wichtige Hinweise und Warnungen
4
erweiterte Suche
Mindestanforderungen
-
PHP Version 5 bis 5.2.X (mit installiertem Zend Optimizer) oder
ab PHP 5.3 (mit installiertem Zend Guard Loader)
-
passende OXID eShop-Edition (PE bzw. EE) in Version 4.2.0 oder höher (mit dazu
passender Revisionsnummer)
-
D³-Modul-Connector:
Modulkonfiguration ab Version 2.14.6 (kostenfrei bei D³ erhältlich)
Beachten Sie, dass die Ihnen vorliegende Modulversion entsprechend für PHP 5.2 oder PHP 5.3
kompatibel ist. Im Zweifelsfall kontaktieren Sie uns und nennen die für Ihren Shop genutzte
PHP-Version.
Kontrollieren Sie bitte auch, ob diese Modulversion für die von Ihnen eingesetzte Shopedition
(Professional Edition (PE) oder Enterprise Edition (EE)) ausgelegt ist.
Beiliegende Bibliotheken
Dem Modul liegt eine Kopie der OpenThesaurus-Datenbank bei. Bitte beachten Sie auch deren
Lizenzhinweise im "setup+doku"-Ordner.
Vorbereitung
Installieren Sie bitte zuerst unseren Modul-Connector in der erforderlichen Version. Ob dies
evtl. schon geschehen ist, können Sie im Adminbereich Ihres Shops prüfen. Existiert der Punkt
[D3 Module] -> [Modul-Connector], können Sie die installierte Version ablesen. Fehlt
dieser Eintrag, laden Sie den Connector kostenfrei von unserer Homepage
http://www.oxidmodule.com/Connector/.
Klicken Sie auf den Reiter [Download] und dort auf den Link [Download
Erstinstallation Modul-Connector].
5
erweiterte Suche
Neuinstallation
1. Dateien kopieren
Kopieren Sie bitte die im Verzeichnis „copy_this“ liegenden Dateien in den Shop.
Behalten Sie die Verzeichnisstruktur bei!
Wichtig: Achten Sie darauf, dass speziell die PHP-Dateien im Binär-Modus
übertragen werden.
2. Dateien anpassen
Im Verzeichnis „changed_full“ finden Sie, nach Shopversionen getrennt, die
Standard-Templates, die für das Modul geändert werden müssen. Die entsprechenden
Absätze sind markiert. Übernehmen Sie diese bitte in Ihre Shoptemplates. Wenn Sie in
Ihrem Shop die unveränderten Standardtemplates des Original Oxid-Shops verwenden,
können Sie diese Modul-Templates so übernehmen.
3. Verwendung eigener Themes
Verwenden Sie in Ihrem Shop ein angepasstes Verzeichnis für Ihre Templates (neues
Theme oder CustomTheme), kopieren Sie die Templates und / oder die CSS-Dateien in
die neuen Ordner. Dies betrifft die Dateien aus dem „copy_this“- und dem
„changed_full“-Ordner.
4. Moduleinträge setzen
bis Shopversion 4.5.X:
Aktivieren Sie das Modul über den Shopadmin [Admin]  [D3 Module] 
[Modul-Connector]  [Systemeinstellungen]  Tab
[Moduleinträge]  Textfeld [Neueinträge]. Tragen Sie hier Folgendes ein:
article_list => d3_ext_search/admin/d3_article_list_extsearch
details => d3_ext_search/views/d3_details_extsearch
oxarticle => d3_ext_search/core/d3_oxarticle_phonetic
oxarticlelist => d3_ext_search/core/d3_oxarticlelist_extsearch
oxcmp_basket => d3_ext_search/views/d3_oxcmp_basket_extsearch
oxcmp_utils => d3_ext_search/views/d3_oxcmp_utils_extsearch
oxlocator => d3_ext_search/views/d3_oxlocator_extsearch
oxrssfeed => d3_ext_search/core/d3_oxrssfeed_extsearch
oxsearch => d3_ext_search/core/d3_oxsearch_extsearch
search => d3_ext_search/views/d3_ext_search
Über [Vorschau generieren] können Sie die Einträge vorab prüfen. Speichern Sie
die Änderungen danach mit [Modulliste speichern].
ab Shopversion 4.6.X
Aktivieren Sie das Modul über den Shopadmin [Admin]  [Erweiterungen]
[Module]. Klicken Sie nach Auswahl von „D³ Erweiterte Suche“ auf den
Button [Aktivieren].
6
erweiterte Suche
5. Datenbankänderungen installieren
Liegt dem Modul eine Datei „install.sql“ bei, führen Sie diese bitte im
Adminbereich unter [Service]  [Tools] aus.
Für bestimmte Shopversionen liegen dem Modul speziell benannte SQL-Dateien bei
(z.B. „install_451-452.sql“ für alle Shopversionen von 4.5.1 bis 4.5.2). Führen Sie
die für Ihren Shop passende Datei (sofern vorhanden) zusätzlich wie beschrieben aus.
Wichtig für Enterprise-Shops (EE): In den Datenbankdateien liegen
Änderungen im Normalfall bis zum 3. Mandanten vor. Setzen Sie zusätzliche
Mandanten ein, tragen Sie die Änderungen dafür bitte manuell nach.
6. Datenbank vervollständigen
Für die Verwendung der semantischen Suche führen Sie bitte die beiliegende Datei
„semantic_de.sql“ (gepackt in „semantic_de.sql.zip“) in der Shopdatenbank
aus.
7. TMP leeren
Leeren Sie das Verzeichnis „tmp“ über [Admin]  [D3 Module]  [ModulConnector]  [TMP leeren]. Markieren Sie [komplett leeren] und klicken
auf [TMP leeren].
Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch
(außer PE / CE bis 4.4.8).
8. Modul konfigurieren
Starten Sie für die Einrichtung des Moduls die Konfigurationsoberfläche im AdminBereich Ihres Shops unter [D3 Module] und speichern Sie alle Einstellungen noch
einmal. Aktivieren Sie Ihr neues Modul dort ebenfalls noch.
9. Updatefähigkeit
Bei Änderungen des Moduls in der CSS-Datei bzw. den Sprach-Dateien empfehlen wir,
jeweils eine separate Datei dafür zu verwenden. So erhalten Sie sich die
Updatefähigkeit des Moduls.
7
erweiterte Suche
Update
1. Connector kontrollieren
Kontrollieren Sie bitte die Version unseres Modul-Connectors im Adminbereich unter
[D3 Module]  [Modul-Connector] auf Updates.
2. Dateien kopieren
Überschreiben Sie alle Moduldateien mit denen im „copy_this“-Verzeichnis.
Wichtig: Achten Sie darauf, dass speziell die PHP-Dateien im Binär-Modus
übertragen werden.
3. Angepasste Dateien kontrollieren
Im Verzeichnis „changed_full“ liegen, nach Shopversionen getrennt, die
modulspezifischen Templates. Haben Sie diese angepasst, gleichen Sie Ihre Version
bitte mit den neuen Fassungen ab.
4. Datenbankänderungen installieren
Im Ordner „setup+doku“ finden Sie die „update.sql“. Diese enthält alle
Datenbank-Änderungen. Welche Zeilen Sie benötigen, erkennen Sie an der genannten
Versionsnummer. Suchen Sie sich den Eintrag Ihrer bisherigen Modulversion und
kopieren Sie ab dort alle SQL-Einträge bis zum Ende der Datei und führen diese in
Ihrer Shopdatenbank aus.
Für bestimmte Shopversionen liegen dem Modul speziell benannte SQL-Dateien bei
(z.B. „update_451-452.sql“ für alle Shopversionen von 4.5.1 bis 4.5.2). Führen Sie
die für Ihren Shop passende Datei (sofern vorhanden) zusätzlich wie beschrieben aus.
Wichtig für Enterprise-Shops (EE): In den Datenbankdateien liegen
Änderungen im Normalfall bis zum 3. Mandanten vor. Setzen Sie zusätzliche
Mandanten ein, tragen Sie die Änderungen dafür bitte manuell nach.
5. Moduleinträge setzen
Vergleichen Sie bitte die oben genannte Liste der Moduleinträge mit Ihrem Shop, ob
hier Änderungen vorliegen und tragen Sie diese bitte nach. Im Modulmanager des
Connectors können Sie die Modulliste auch einfach einfügen. Dopplungen vermeidet
dieser Assistent automatisch.
Beim Update von Modulversion 3.10.2 und kleiner Version 3.10.3 und höher wird
im Modul der Dateiname von
modules/d3_ext_search/core/d3_oxSearch_extsearch.php
zu
modules/d3_ext_search/core/d3_oxsearch_extsearch.php
geändert. Es wurde also der Großbuchstabe zum Kleinbuchstaben gewandelt.
8
erweiterte Suche
Auf Systemen, die im Dateisystem zwischen Groß- und Kleinschreibung unterscheiden
(z.B. Linux) ist es wichtig, dass Sie bitte vorhandene Moduleinträge ebenfalls auf die
Kleinschreibung ändern:
oxsearch => d3_ext_search/core/d3_oxsearch_extsearch
Die ursprünglich großgeschriebene Moduldatei kann vom Server entfernt werden.
9
erweiterte Suche
Schnellstart
Die „erweiterte Suche“ bringt einen umfangreichen Adminbereich mit, in dem Sie die
Konfigurationseinstellungen des Moduls setzen können. Über das Menü [D3 Module] 
[Erweiterte Suche]  [Einstellungen] erreichen Sie die Einstellseiten. Arbeiten
Sie idealerweise die Optionen einmal durch. Hinweise zu den einzelnen Einstellungen finden
Sie in dem dahinter stehenden Fragezeichenfeld. Durch einen Klick darauf öffnet sich der
Hinweistext.
Die meisten Optionen sind zusätzlich im Handbuch zum Modul (als PDF im „setup+doku“Ordner) umfangreicher beschrieben.
Nach Abschluss der Einstellungen ist es notwendig, den Suchindex der eingepflegten Artikel
zu generieren. Die Option dafür finden Sie ebenfalls im Adminbereich zum Modul im Tab
[Grundeinstellungen]. Lesen Sie für weitere Informationen zur Indexgenerierung auch
den Abschnitt im Modulhandbuch.
Im Frontend des Shops werden Sie die Installation des Moduls durch verbesserte Reaktionen
des Shops bemerken. Je nach Einstellung öffnet sich bei der Eingabe des Suchwortes das
Fenster der Schnellsuche. Senden Sie die Suchanfrage ab, werden zu den Treffern zusätzliche
Filtermöglichkeiten angeboten. Kontrollieren Sie die geänderten Reaktionen der Shopsuche,
bevor Sie diese für die Shopbesucher aktivieren.
10
erweiterte Suche
Hilfe und Support
Bei Bedarf bieten wir Ihnen auch gern die Installation des Moduls in Ihrem Shop an. Geben Sie
uns bitte unter den unten genannten Kontaktdaten Bescheid.
Haben Sie Fragen oder Unklarheiten in Verbindung mit diesem Modul oder dessen
Installation, stehen Ihnen Hilfetexte in unserer Modul-FAQ (http://faq.oxidmodule.com/) zur
Verfügung. Finden Sie darin die benötigten Antworten nicht, kontaktieren Sie uns bitte unter
den folgenden Möglichkeiten:
-
per E-Mail: [email protected] oder
über das Kontaktformular auf http://www.oxidmodule.com/ oder
per Telefon: (+49) 37 21 – 26 80 90 zu unseren Bürozeiten
Geben Sie bitte an, wo und wie wir gegebenenfalls vorhandene Schwierigkeiten nachvollziehen
können. Sind Ihre Fragen shopspezifisch, benötigen wir möglicherweise Zugangsdaten zum
betreffenden Shop.
Wir wünschen Ihnen mit Ihrem Shop und dem Modul viel Erfolg!
Ihr D³-Team.