Merge commit 'e10952828a3718cf047645ad9acc12a409826151' as 'docs/daux'
This commit is contained in:
commit
cfc3d8104d
2
docs/daux/_index.md
Normal file
2
docs/daux/_index.md
Normal file
@ -0,0 +1,2 @@
|
||||
Weitere Informationen zum Modul **{$modulename}** finden Sie in unserem Shop:
|
||||
[https://www.oxidmodule.com/OXID-eShop/Module/MODULNAME-fuer-Oxid-PE.html](https://www.oxidmodule.com/OXID-eShop/Module/MODULNAME-fuer-Oxid-PE.html)
|
||||
32
docs/daux/changelog/010_Changelog.md
Normal file
32
docs/daux/changelog/010_Changelog.md
Normal file
@ -0,0 +1,32 @@
|
||||
---
|
||||
title: Changelog
|
||||
---
|
||||
|
||||
## noch nicht veröffentlicht
|
||||
|
||||
---
|
||||
|
||||
## 1.1.0.1 - (2019-02-20)
|
||||
|
||||
### Fixed
|
||||
- ...
|
||||
- ...
|
||||
|
||||
---
|
||||
|
||||
## 1.1.0.0 - (2018-05-29)
|
||||
|
||||
**Minor version upgrade notice: there are some backward-incompatible changes to this release.**
|
||||
|
||||
#### Fixed
|
||||
- Einstellungs-Überladung korrigiert - verwendet Einstellungen der Hauptsprache, wenn in aktueller Sprache keine Einstellungen gespeichert wurden
|
||||
|
||||
#### Changed
|
||||
- kleine Textänderungen in der Installationsroutine
|
||||
|
||||
---
|
||||
|
||||
## 1.0.0.0 - (2018-05-15)
|
||||
|
||||
#### Added
|
||||
- Angepasst für Shopversion 6.x, Installation via Composer
|
||||
73
docs/daux/config.json
Normal file
73
docs/daux/config.json
Normal file
@ -0,0 +1,73 @@
|
||||
{
|
||||
"title": "<i class='fab fa-d3 d3fa-color-blue'></i> MODULNAME",
|
||||
"moduleversion": "5.0.0.0",
|
||||
"titledesc": "für den Oxid eShop",
|
||||
"author": "D³ Data Development",
|
||||
"moduledate": "17.04.2018",
|
||||
"editors": "XX/YY",
|
||||
"tagline": "",
|
||||
"image": "",
|
||||
"ignore": {
|
||||
"files": [],
|
||||
"folders": [".idea"]
|
||||
},
|
||||
"live": {
|
||||
"clean_urls": true
|
||||
},
|
||||
"html": {
|
||||
"theme": "d3",
|
||||
"breadcrumbs": true,
|
||||
"breadcrumb_separator": "Chevrons",
|
||||
"toggle_code": false,
|
||||
"date_modified": true,
|
||||
"date_modified_format": "d.m.Y",
|
||||
"float": false,
|
||||
"inherit_index": true,
|
||||
"auto_landing": true,
|
||||
|
||||
"links": {
|
||||
"Shop": "https://www.oxidmodule.com"
|
||||
},
|
||||
|
||||
"powered_by": ""
|
||||
},
|
||||
"languages": {
|
||||
"editions": "Editionen",
|
||||
"installation": "Installation",
|
||||
"manual": "Handbuch",
|
||||
"changelog": "Changelog",
|
||||
"support": "Support"
|
||||
},
|
||||
"processor": "d3processor",
|
||||
"language": "de",
|
||||
"strings": {
|
||||
"de": {
|
||||
"CodeBlocks_title": "Code-Blöcke",
|
||||
"CodeBlocks_hide": "Aus",
|
||||
"CodeBlocks_below": "Unterhalb",
|
||||
"CodeBlocks_inline": "Linear",
|
||||
"CodeBlocks_show": "Code-Blöcke anzeigen",
|
||||
"Search_placeholder": "Suchen...",
|
||||
"Link_previous": "Zurück",
|
||||
"Link_next": "Weiter",
|
||||
"Edit_on": "Bearbeiten bei :name:",
|
||||
"View_on_github": "Bei GitHub anzeigen",
|
||||
"View_documentation": "Dokumentation anzeigen",
|
||||
"Table_of_contents": "Inhaltsverzeichnis",
|
||||
"author": "Autor",
|
||||
"moduledate": "Stand",
|
||||
"version": "Version",
|
||||
"editors": "Bearbeiter",
|
||||
"selectversion": "Version wechseln"
|
||||
}
|
||||
},
|
||||
"variables": {
|
||||
"modulename" : "<i class='fab fa-d3 d3fa-color-blue'></i> MODULNAME",
|
||||
"menutitle" : "<i class='fab fa-d3 d3fa-color-blue'></i> MODULNAME",
|
||||
"modulefolder" : "module_folder",
|
||||
"modcfgident" : "d3modident",
|
||||
"composerident" : "d3/moduleident"
|
||||
},
|
||||
"versionselector": false,
|
||||
"versiondirectoryindex": 2
|
||||
}
|
||||
12
docs/daux/editions/010_Editionen.md
Normal file
12
docs/daux/editions/010_Editionen.md
Normal file
@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Editionen
|
||||
---
|
||||
|
||||
Das Modul **{$modulename}** erhalten Sie in verschiedenen Editionen mit unterschiedlichem Funktionsumfang.
|
||||
|
||||
Definition der Unterschiede:
|
||||
|
||||
| Free-Edition | Standard-Edition | Premium-Edition |
|
||||
|:-------------:|:-----------------:|:-----------------:|
|
||||
| 1 | 2 | 3 |
|
||||
|
||||
10
docs/daux/installation/002_Installation.md
Normal file
10
docs/daux/installation/002_Installation.md
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Installation / Update / Deinstallation
|
||||
---
|
||||
|
||||
* [Anforderungen](installation/010_Anforderungen/010_Systemanforderungen.md)
|
||||
* [Neuinstallation](installation/020_Neuinstallation/005_Vorbereitung.md)
|
||||
* [Update](installation/030_Update/005_Updatedefinition.md)
|
||||
* [Deinstallation](installation/060_Deinstallation/010_Modulerweiterungen_deaktivieren_und_entfernen.md)
|
||||
|
||||
Bei Bedarf bieten wir Ihnen auch gern die Installation des Moduls in Ihrem Shop an. Geben Sie uns bitte unter den unter [Hilfe und Support](support/010_Hilfe-und-Support.md) genannten Kontaktdaten Bescheid.
|
||||
@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Systemanforderungen
|
||||
---
|
||||
|
||||
* PHP Version
|
||||
* 5.6.x bis 7.3.x
|
||||
* PHP Decoder
|
||||
* installierter ionCube Loader
|
||||
* Shopversionen / -editionen
|
||||
* OXID eShop Community Edition (CE), Professional Edition (PE) oder Enterprise Edition (EE) in Compilation Version
|
||||
* 6.0.x
|
||||
* 6.1.x
|
||||
* 6.2.x
|
||||
* Themes
|
||||
* flow
|
||||
* wave
|
||||
* D3 Modul-Connector ([kostenfrei bei D3 erhältlich](https://www.oxidmodule.com/connector/)) ab Version 5.3.0.0
|
||||
* Installation via [Composer](https://getcomposer.org)
|
||||
* mindestens ein freier Cronjob zur automatischen Ausführung der angelegten Aufgaben
|
||||
|
||||
Beachten Sie, dass die Ihnen vorliegende Modulversion entsprechend für **PHP 5.6**, **PHP 7.0**, **PHP 7.1**, **PHP 7.2** oder **PHP 7.3** sowie dem auf Ihrem Server vorhandenen Decoder (**ionCube Loader**) kompatibel ist. Im Zweifelsfall kontaktieren Sie uns und nennen den für Ihren Shop genutzten Decoder und die 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.
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Kompatibilität mit anderen Modulen
|
||||
---
|
||||
|
||||
Das „Modul“ integriert sich auch in die Erweiterung „Visual CMS“ von OXID eSales AG & digidesk - media solutions, sofern diese im Shop installiert wurde. Diese Integration wurde für die Version 3.0.0 des „Visual CMS“-Moduls entwickelt.
|
||||
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: beiliegende Bibliotheken
|
||||
---
|
||||
|
||||
Dem Modul liegt eine Kopie der **XYZ**-Bibliothek bei. Bitte beachten Sie auch deren folgende Lizenzhinweise:
|
||||
|
||||
- Lizenzhinweis #1
|
||||
- Lizenzhinweis #2
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Vorbereitungen
|
||||
---
|
||||
|
||||
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 unter [ Bibliotheksverwaltung ] ablesen. Fehlt dieser Eintrag, installieren Sie den kostenfreien Connector.
|
||||
Informationen zu dessen Installation finden Sie auf unserer [Homepage](https://www.oxidmodule.com/Connector/).
|
||||
|
||||
Klicken Sie auf den Reiter [ Downloads ] und wählen dort das für Ihre Installation passende Paket.
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Vorbereitungen
|
||||
---
|
||||
|
||||
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 unter [ Bibliotheksverwaltung ] ablesen.
|
||||
Fehlt dieser Eintrag, installieren Sie den Modul-Connector bitte vorab. Hinweise zu dessen Installation finden Sie in der [Modul-Connector Dokumentation](https://docs.oxidmodule.com/Modul_Connector/).
|
||||
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Modul zur Installation hinzufügen
|
||||
---
|
||||
|
||||
Führen Sie in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) diesen Befehl aus, um das Modul **{$modulename}** zur Installation hinzuzufügen:
|
||||
|
||||
```bash
|
||||
php composer require {$composerident}:^{$moduleversion} --update-no-dev
|
||||
```
|
||||
|
||||
> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require).
|
||||
@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Verwendung eigener Themes
|
||||
---
|
||||
|
||||
Das Modul ist für die Verwendung mit den folgenden OXID-Themes vorbereitet:
|
||||
|
||||
* Flow
|
||||
* Azure
|
||||
|
||||
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.
|
||||
|
||||
Ähnelt Ihr neues Theme technisch einem der OXID-Originale, können Sie dieses darauf umleiten. Childs von originalen OXID- Themes benötigen keine Umleitung.
|
||||
|
||||
Weitere Informationen zur Umleitung finden Sie in unserer [FAQ](https://faq.d3data.de/oxid-eshop/module-oxid-eshop/anpassungen/template-bloecke-dem-eigenen-theme-zuordnen/).
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Providerspezifische Installation
|
||||
---
|
||||
|
||||
Manche Provider erfordern besondere Einstellungen für installierte Module. Treffen Sie bei der Installation auf spezielle Anforderungen, zu denen Sie Unterstützung benötigen, kontaktieren Sie uns bitte für weiteren Support.
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Modul im Shop aktivieren
|
||||
---
|
||||
|
||||
Aktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ].
|
||||
|
||||
> [!] **Enterprise Editon**: Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen.
|
||||
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Shopanpassungen installieren
|
||||
---
|
||||
|
||||
Direkt nach der Modulaktivierung startet der Assistent, der Sie durch die Shopanpassung führt. Darin können Sie verschiedene Optionen der Installation wählen.
|
||||
|
||||
Den Installationsassistenten finden Sie auch unter den Menüpunkten [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ].
|
||||
|
||||
Bei tiefgreifenden Änderungen an Ihrem Shop (z.B. Hinzufügen weiterer Sprachen oder Mandanten) rufen Sie den Installationsassistenten bitte erneut auf, um dann eventuell notwendige Nacharbeiten für das Modul ausführen zu lassen.
|
||||
|
||||
Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen.
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: TMP-Ordner leeren
|
||||
---
|
||||
|
||||
Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ].
|
||||
|
||||
Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
|
||||
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Lizenzschlüssel eintragen
|
||||
---
|
||||
|
||||
Das Modul verwendet Lizenzschlüssel, um die Lizenzverwaltung für Sie und auch für uns einfacher zu gestalten. Hierbei haben Sie je nach Modul die Wahl zwischen einer kostenfreien Testlizenz und einer Lizenz für den Einsatz im Livebetrieb.
|
||||
|
||||
Speziell **{$modulename}** wird in unterschiedlichen (teilweise kostenfreien) Editionen für den Livebetrieb angeboten. Besuchen Sie unseren [Moduleshop](https://www.oxidmodule.com/), um mehr darüber zu erfahren.
|
||||
|
||||
Rufen Sie zum Anfordern des Lizenzschlüssels die Modulverwaltung im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] auf. Klappen Sie den Eintrag des jeweiligen Moduls aus. Sofern erforderlich, können Sie hier den Lizenzassistenten starten, der schnell und einfach ihr Modul aktiviert.
|
||||
@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Cronjob einrichten
|
||||
---
|
||||
|
||||
Legen Sie den Cronjob für die automatische Bearbeitung der eingerichteten Aufträge an. Die für die Anlage benötigten Daten finden Sie im Adminbereich des Moduls unter [ (D3) Module ] -> [ {$menutitle} ] -> [ Einstellungen ] -> [ Grundeinstellungen ]. Weitere Informationen zum Anlegen von Cronjobs finden Sie in unserer [FAQ](https://faq.d3data.de/technik/wie-werden-cronjobs-angelegt/).
|
||||
|
||||
> [!!] Sie sollten unbedingt den Aufruf von `.sh`-Dateien via Browser verhindern, so dass kein Unbefugter die Datei von außen aufrufen kann. Dazu können Sie z.B. die `.htaccess`-Datei des Shops um folgende Zeilen erweitern:
|
||||
|
||||
```htaccess
|
||||
<Files *.sh>
|
||||
Require all denied
|
||||
</Files>
|
||||
```
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Updatefähigkeit
|
||||
---
|
||||
|
||||
Bei individuellen Änderungen von Moduldateien empfehlen wir, jeweils die Überladungsmöglichkeiten des Shops dafür zu verwenden. So brauchen Sie die originalen Moduldateien nicht verändern und erhalten sich so die Updatefähigkeit des Shops und des Moduls. Beachten Sie, dass Moduldateien bei Updateinstallationen überschrieben werden.
|
||||
|
||||
Weitere Informationen zu den Überladungsmöglichkeiten verschiedener Dateien finden Sie in unserer [FAQ](https://faq.d3data.de/category/oxid-eshop/module-oxid-eshop/anpassungen/).
|
||||
11
docs/daux/installation/020_Neuinstallation/_index.md
Normal file
11
docs/daux/installation/020_Neuinstallation/_index.md
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
Title: Schnellstart per Composer
|
||||
---
|
||||
|
||||
## Schnellstart per Composer
|
||||
|
||||
```bash
|
||||
php composer require {$composerident}:^{$moduleversion} --update-no-dev
|
||||
```
|
||||
|
||||
Detailliertere Angaben zur Installation entnehmen Sie bitte den folgenden Seiten.
|
||||
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Wann kann ein Update ausgeführt werden?
|
||||
---
|
||||
|
||||
Die Updatenaweisungen können verwendet werden, wenn dieses Modul schon früher mit Hilfe von Composer installiert wurde.
|
||||
|
||||
Wurde die Installation bisher noch nicht durchgeführt oder die Installation wurde **nicht** über Composer
|
||||
durchgeführt (weil das Modul dies z.B. früher nicht unterstützte), verwenden Sie bitte die Beschreibung unter [Neuinstallation](../020_Neuinstallation/_index.md).
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Modul deaktivieren
|
||||
---
|
||||
|
||||
Deaktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ].
|
||||
16
docs/daux/installation/030_Update/020_Dateien_erneuern.md
Normal file
16
docs/daux/installation/030_Update/020_Dateien_erneuern.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
title: Dateien erneuern
|
||||
---
|
||||
|
||||
Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres
|
||||
Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Führen Sie dort diesen Befehl aus:
|
||||
|
||||
```bash
|
||||
php composer require {$composerident}:^{$moduleversion} --update-no-dev
|
||||
```
|
||||
|
||||
Im weiteren Ablauf werden Sie gefragt, ob die Moduldateien überschrieben werden sollen. Bestätigen Sie dies für den Eintrag `{$composerident}`.
|
||||
|
||||
> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete.
|
||||
|
||||
> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require).
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Providerspezifische Installation
|
||||
---
|
||||
|
||||
Manche Provider erfordern besondere Einstellungen für installierte Module. Treffen Sie bei der Installation auf spezielle Anforderungen, zu denen Sie Unterstützung benötigen, kontaktieren Sie uns bitte für weiteren Support.
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Modulinformationen aktualisieren
|
||||
---
|
||||
|
||||
Wechseln Sie im Adminbereich zu [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ].
|
||||
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Shopanpassungen installieren
|
||||
---
|
||||
|
||||
Ob Shopanpassungen notwendig sind, ist von der Versionsänderung des Moduls abhängig.
|
||||
|
||||
Möglicherweise sehen Sie nach dem Neuaktivieren des Moduls den Installationsassistent, der Sie durch die Änderungen führt. Folgen Sie dann den einzelnen Schritten. Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen.
|
||||
|
||||
Wird der Assistent nicht gezeigt (Sie sehen wieder die Modulübersicht), waren keine Anpassungen am Shop notwendig.
|
||||
|
||||
Ob erforderliche Updates ausgeführt werden sollen, können Sie jederzeit im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ] prüfen.
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: TMP-Ordner leeren
|
||||
---
|
||||
|
||||
Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ].
|
||||
|
||||
Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
|
||||
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Lizenzschlüssel aktualisieren
|
||||
---
|
||||
|
||||
Wird für die neue Modulversion ein aktualisierter Lizenzschlüssel benötigt, tragen Sie diesen im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] ein. Klappen Sie dazu den Eintrag des jeweiligen Moduls aus und starten den Lizenzassistent.
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Erweiterungen anpassen
|
||||
---
|
||||
|
||||
Haben Sie für dieses Modul eigene Erweiterung entwickelt, gleichen Sie dies bitte mit der neuen Fassung des Moduls ab.
|
||||
29
docs/daux/installation/040_Installationspruefung.md
Normal file
29
docs/daux/installation/040_Installationspruefung.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Installationsprüfung
|
||||
---
|
||||
|
||||
Um die erfolgreiche Installation zu prüfen, können Sie die folgende(n) Checkliste(n) verwenden:
|
||||
|
||||
## Einstellungsunabhängige Prüfungen
|
||||
|
||||
### Backend
|
||||
|
||||
* Modul ist unter [ Erweiterungen ] -> [ Module ] aktiv geschaltet
|
||||
* Modul ist unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] aktiv geschaltet
|
||||
* Modul zeigt unter [ (D3) Module ] -> [ {$menutitle} ] einen eigenen Bereich für Einstellungen
|
||||
* Modul zeigt unter [ Artikel verwalten ] -> [ Artikel ] -> [ Erweitert ] die Einstellung [ Wichtigkeit des Artikels im Sortiment ]
|
||||
* ... um weitere Punkte ergänzen
|
||||
|
||||
### Frontend
|
||||
|
||||
* Punkte einfügen oder Absatz entfernen
|
||||
|
||||
## Einstellungsabhängige Prüfungen
|
||||
|
||||
### Backend
|
||||
|
||||
* Punkte einfügen oder Absatz entfernen
|
||||
|
||||
### Frontend
|
||||
|
||||
* Punkte einfügen oder Absatz entfernen
|
||||
7
docs/daux/installation/050_Schnellstart.md
Normal file
7
docs/daux/installation/050_Schnellstart.md
Normal file
@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Schnellstart
|
||||
---
|
||||
|
||||
Das Modul **{$modulename}** bringt einen umfangreichen Adminbereich mit, in dem Sie die Konfigurationseinstellungen des Moduls setzen können. Über das Menü [ (D3) Module ] -> [{$menutitle}] -> [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](../manual/000_Handbuch.md) umfangreicher beschrieben.
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Modulerweiterungen deaktivieren und entfernen
|
||||
---
|
||||
|
||||
Deaktivieren Sie alle vorhandenen Erweiterungen, die auf dem Modul **{$modulename}** aufbauen und löschen bitte alle Dateien dieser Erweiterungen. Entfernen Sie ebenfalls alle individuellen Templateanpassungen für dieses Modul.
|
||||
@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Modul deaktivieren
|
||||
---
|
||||
|
||||
Deaktivieren Sie das Modul **{$modulename}** über den Shopadmin [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ].
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Modul aus der Installation entfernen
|
||||
---
|
||||
|
||||
Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Führen Sie Sie dort diesen Befehl aus:
|
||||
|
||||
```Bash
|
||||
php composer remove {$composerident} --no-update
|
||||
```
|
||||
|
||||
> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete.
|
||||
|
||||
> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require).
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Dateien löschen
|
||||
---
|
||||
|
||||
Löschen Sie den Ordner `{$modulefolder}` und seine enthaltenen Elemente aus dem Verzeichnis `source/modules/d3` Ihres Shops.
|
||||
Bestätigen Sie anschließend im Shopadmin unter [ Erweiterungen ] -> [ Module ] -> [ Installierte Shop-Module ] die Nachricht:
|
||||
|
||||
> Es gibt registrierte Erweiterungen im eShop, deren Verzeichnis nicht vorhanden ist.
|
||||
> Möchten Sie alle Modulinformationen einschließlich Konfigurationseinstellungen und Blockinformationen für Templates löschen?
|
||||
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Datenbank bereinigen
|
||||
---
|
||||
|
||||
Das Modul legt Informationen in der Datenbank ab. Sofern diese Daten nicht mehr benötigt werden, können diese gelöscht werden.
|
||||
|
||||
> [!] Legen Sie sich vorab bitte unbedingt eine Sicherung an, um die Daten im Zweifelsfall wiederherstellen zu können.
|
||||
|
||||
Für das Modul **{$modulename}** sind dies die folgende Tabellen und Felder:
|
||||
|
||||
* die komplette Tabelle `tablename`
|
||||
* sofern vorhanden: `tablename_setX` *)
|
||||
|
||||
und diese Felder in bestehenden Tabellen:
|
||||
|
||||
* in Tabelle `oxorder`:
|
||||
* das Feld `fieldname1`
|
||||
* das Feld `fieldname2`
|
||||
* in Tabelle `oxuser`:
|
||||
* das Feld `fieldname3`
|
||||
* das Feld `fieldname4`
|
||||
|
||||
sowie diese Einträge in bestehenden Tabellen:
|
||||
|
||||
* in Tabelle `d3_cfg_mod`:
|
||||
* den Eintrag `oxmodid = "{$modcfgident}"` **)
|
||||
|
||||
*) `_setX` ist eine Tabellenliste, die mit `_set1` beginnen und shopabhängig auch Tabellen mit höheren Nummerierungen enthalten kann (z.B. `_set2`, `_set3`, …).
|
||||
Zu einigen dieser Tabellen wurden die Config-Einträge `aMultiLangTables` (bei Enterprise Edition auch `aMultiShopTables`) um entsprechende Einträge ergänzt). Bereinigen Sie diese ebenfalls.
|
||||
|
||||
**) Diesen Eintrag gibt es ggf. für jeden Subshop. Entfernen Sie diesen nur für die Mandanten, in denen das Modul **nicht** mehr installiert ist.
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: TMP-Ordner leeren
|
||||
---
|
||||
|
||||
Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ].
|
||||
|
||||
Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
|
||||
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
1
docs/daux/manual/000_Handbuch.md
Normal file
1
docs/daux/manual/000_Handbuch.md
Normal file
@ -0,0 +1 @@
|
||||
It starts here.
|
||||
4
docs/daux/manual/010_Konfiguration/010_Options.md
Normal file
4
docs/daux/manual/010_Konfiguration/010_Options.md
Normal file
@ -0,0 +1,4 @@
|
||||
---
|
||||
title: Benutzerhandbuch
|
||||
---
|
||||
|
||||
18
docs/daux/manual/015_optischeAnpassungen.md
Normal file
18
docs/daux/manual/015_optischeAnpassungen.md
Normal file
@ -0,0 +1,18 @@
|
||||
---
|
||||
title: optische Anpassungen
|
||||
---
|
||||
|
||||
Die Modulausgaben können durch eigene CSS-Styles angepasst werden. Um die Updatefähigkeit des Moduls zu
|
||||
erhalten, übernehmen Sie die neuen Stylesheets bitte in modulunabhängige Dateien.
|
||||
|
||||
Die mitgelieferten Assets (CSS, JavaScripts) werden von uns über einen vorkonfigurierten Kompilierungstask
|
||||
erstellt. Dieser kann via [Grunt](https://gruntjs.com/) ausgeführt werden. Möchten Sie eigene oder
|
||||
angepasste Inhalte daraus kompilieren lassen, installieren Sie das Modul bitte mit Composer und der
|
||||
`--prefer-source`-Option. Dann stehen Ihnen die Quelldateien im Ordner `src/build` zur Verfügung.
|
||||
|
||||
Diese können direkt aufgerufen werden, um eventuelle Anpassungen im zu Grunde liegenden Theme zu
|
||||
integrieren. Alternativ können Sie die Sources auch in eigene Kompilierungsprozesse einbinden,
|
||||
um projektspezifische Assets zu erstellen.
|
||||
|
||||
Details zur Verwendung des Taskrunners und der Quelldateien entnehmen Sie bitte der `README.md` im
|
||||
oben erwähnten Build-Ordner.
|
||||
16
docs/daux/support/010_Hilfe-und-Support.md
Normal file
16
docs/daux/support/010_Hilfe-und-Support.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
title: 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 unserem [HelpCenter](https://faq.d3data.de/) zur Verfügung. Finden Sie darin die benötigten Antworten nicht, kontaktieren Sie uns bitte unter den folgenden Möglichkeiten:
|
||||
1. per E-Mail: <support@shopmodule.com> oder
|
||||
2. über das Kontaktformular auf [Oxidmodule.com](https://www.oxidmodule.com/) oder
|
||||
3. 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.
|
||||
Loading…
Reference in New Issue
Block a user