change installation documentation
This commit is contained in:
parent
772ccfef19
commit
64ddda7825
GPG Key ID:
6A513E13AEE66170
@ -6,27 +6,11 @@ title: Changelog
|
||||
|
||||
---
|
||||
|
||||
## 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)
|
||||
## 1.0.0.0 - (2020-07-10)
|
||||
|
||||
#### Added
|
||||
- Angepasst für Shopversion 6.x, Installation via Composer
|
||||
- Framework zur Erstellung unterschiedlichster PDF Dokumente
|
||||
- ermöglicht Generierung von Rechnungen und Lieferscheinen für Bestellungen aus dem Adminbereich
|
||||
- enthält Templates und Basislayouts für Rechnungen und Lieferscheine
|
||||
- enthält Registries (Dokumentenlisten) für Bestellungen im Adminbereich sowie für Auftragsmanager-Aktionen
|
||||
- kann als vollwertiger Ersatz für Invoice-PDF-Modul verwendet werden
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
{
|
||||
"title": "<i class='fab fa-d3 d3fa-color-blue'></i> MODULNAME",
|
||||
"moduleversion": "5.0.0.0",
|
||||
"title": "<i class='fab fa-d3 d3fa-color-blue'></i> PDF Dokumente",
|
||||
"moduleversion": "1.0.0.0",
|
||||
"titledesc": "für den Oxid eShop",
|
||||
"author": "D³ Data Development",
|
||||
"moduledate": "17.04.2018",
|
||||
"editors": "XX/YY",
|
||||
"moduledate": "10.07.2020",
|
||||
"editors": "",
|
||||
"tagline": "",
|
||||
"image": "",
|
||||
"ignore": {
|
||||
@ -32,7 +32,6 @@
|
||||
"powered_by": ""
|
||||
},
|
||||
"languages": {
|
||||
"editions": "Editionen",
|
||||
"installation": "Installation",
|
||||
"manual": "Handbuch",
|
||||
"changelog": "Changelog",
|
||||
@ -62,11 +61,11 @@
|
||||
}
|
||||
},
|
||||
"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"
|
||||
"modulename" : "<i class='fab fa-d3 d3fa-color-blue'></i> PDF Dokumente",
|
||||
"menutitle" : "<i class='fab fa-d3 d3fa-color-blue'></i> PDF Dokumente",
|
||||
"modulefolder" : "pdfdocuments",
|
||||
"modcfgident" : "d3pdfdocuments",
|
||||
"composerident" : "d3/pdfdocuments"
|
||||
},
|
||||
"versionselector": false,
|
||||
"versiondirectoryindex": 2
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
---
|
||||
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 |
|
||||
|
||||
@ -3,7 +3,7 @@ title: Installation / Update / Deinstallation
|
||||
---
|
||||
|
||||
* [Anforderungen](installation/010_Anforderungen/010_Systemanforderungen.md)
|
||||
* [Neuinstallation](installation/020_Neuinstallation/005_Vorbereitung.md)
|
||||
* [Neuinstallation](installation/020_Neuinstallation/020_Modul_hinzufuegen.md)
|
||||
* [Update](installation/030_Update/005_Updatedefinition.md)
|
||||
* [Deinstallation](installation/060_Deinstallation/010_Modulerweiterungen_deaktivieren_und_entfernen.md)
|
||||
|
||||
|
||||
@ -3,21 +3,14 @@ title: Systemanforderungen
|
||||
---
|
||||
|
||||
* PHP Version
|
||||
* 5.6.x bis 7.3.x
|
||||
* PHP Decoder
|
||||
* installierter ionCube Loader
|
||||
* 7.0.x bis 7.4.x
|
||||
* 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
|
||||
* Diese Modul bindet sich nicht in Frontendthemes ein und ist daher davon unabhängig
|
||||
* Template-Engine
|
||||
* Smarty
|
||||
* 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.
|
||||
|
||||
@ -2,4 +2,4 @@
|
||||
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.
|
||||
Das „Modul“ integriert sich auch in die Erweiterung "Auftragsmanager" von (D3) Data Development, sofern dieses im Shop installiert wurde. Diese Integration wurde für die Version 4.0.0.0 des "Auftragsmanager"-Moduls entwickelt.
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
title: beiliegende Bibliotheken
|
||||
---
|
||||
|
||||
Dem Modul liegt eine Kopie der **XYZ**-Bibliothek bei. Bitte beachten Sie auch deren folgende Lizenzhinweise:
|
||||
|
||||
- Lizenzhinweis #1
|
||||
- Lizenzhinweis #2
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -1,7 +0,0 @@
|
||||
---
|
||||
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/).
|
||||
@ -1,14 +0,0 @@
|
||||
---
|
||||
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/).
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -2,8 +2,6 @@
|
||||
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 ].
|
||||
Leeren Sie das Verzeichnis `tmp` Ihres Shops.
|
||||
|
||||
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.
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
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>
|
||||
```
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -2,8 +2,6 @@
|
||||
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 ].
|
||||
Leeren Sie das Verzeichnis Ihres Shops.
|
||||
|
||||
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.
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
|
||||
@ -1,5 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -9,21 +9,5 @@ Um die erfolgreiche Installation zu prüfen, können Sie die folgende(n) Checkli
|
||||
### 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
|
||||
* Modul zeigt unter [ Bestellungen verwalten ] -> [ Bestellungen ] -> [ Übersicht ] einen eigenen Bereich für PDF-Exporte
|
||||
|
||||
### 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
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -1,31 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -2,8 +2,6 @@
|
||||
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 ].
|
||||
Leeren Sie das Verzeichnis Ihres Shops.
|
||||
|
||||
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.
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user