adjust README

This commit is contained in:
Daniel Seifert 2020-07-07 23:02:20 +02:00
parent 2296007906
commit e4a9c8d323
Signed by: DanielS
GPG Key ID: 6A513E13AEE66170
2 changed files with 46 additions and 4 deletions

View File

@ -1,3 +1,46 @@
# pdfdocs_oxid_compat # PDF-Dokumente - Kompatibilitätsschicht
Kompatibilitätslayer für PDF Dokumente Modul zum OXID InvoicePDF Modul Kompatibilitätslayer für PDF Dokumente Modul zum OXID InvoicePDF Modul
Diese Anpassung ermöglicht dritten Modulen, die sonst das OXID InvoicePdf-Modul für eigene Zwecke verwenden, anstelle mit dem D3 PDF Dokumente Modul zu verwenden.
Den Generierungsaufruf der Standarddokumente (Rechnung, Lieferschein) zur Generierung durchs PDF Dokument Modul geroutet.
Wurden weitere Dokumente hinzugefügt, muss das Routing dorthin ergänzt werden.
Das Adminformular zur Dokumentengenerierung wird hierin nicht nachgebaut, da dieses in ähnlicher Form schon im PDF Dokumente Modul enthalten ist. Anpassungen (z.B. Templateblocküberladungen) sollten darauf angepasst werden.
## Systemanforderungen:
- installierter OXID eShop in Version 6
- D3 PDF Dokumente Modul (wird ggf. nachinstalliert)
- PHP-Version, für die Installationspakete verfügbar sind (PHP 7)
- Installation via Composer
## Kompatibilität:
Das Modul enthält die selbe Funktionalität wie das `OXID Invoice-PDF`-Modul. Da es dessen Funktion ersetzen soll, wird das OXID-Modul deinstalliert.
## Installation
Deaktivieren Sie das OXID InvoicePDF Modul im Adminbereich Ihres Shops.
```bash
composer require d3/pdfdocuments_compat --update-no-dev
```
Löschen Sie die Dateien des OXID InvoicePDF Moduls.
## Support:
- D3 Data Development (Inh. Thomas Dartsch)
- Home: [www.d3data.de](https://www.d3data.de)
- E-Mail: support@shopmodule.com
## Lizenz / License
**de:** Dieses Modul wird unter der GPL v3 Lizenz vertrieben. Für weitere Informationen siehe die ./LICENSE Datei.
**en:** This module is distributed under the GPL v3 License. For more information see the ./LICENSE file.
Copyright by D3 Data Development (Inh. Thomas Dartsch)

View File

@ -24,8 +24,7 @@
"extra": { "extra": {
"oxideshop": { "oxideshop": {
"blacklist-filter": [ "blacklist-filter": [
"composer.json", "composer.json"
"docs/**/*.*"
], ],
"target-directory": "d3/pdfdocuments_compat" "target-directory": "d3/pdfdocuments_compat"
} }