ddoe/wysiwyg-editor-module

Summernote WYSIWYG Editor for OXID eShop.

v4.0.0 2024-03-12 12:26 UTC

Requires

• php: ^8.1
• ext-gd: *
• oxid-esales/media-library-module: ^1.0.0
• symfony/filesystem: *

Requires (Dev)

• oxid-esales/oxideshop-ce: dev-b-7.1.x
• phpstan/phpstan: ^1.8.11
• phpunit/phpunit: ^10.4
• squizlabs/php_codesniffer: 3.*

proprietary

• OXID eSales AG & digidesk - media solutions

• wysiwyg
• editor
• modules
• eshop
• OXID
• summernote

README

Compatibility

Branches

• b-7.1.x is compatible with OXID eShop b-7.1.x branch, works with Twig engine only
• b-7.0.x is compatible with OXID eShop b-7.0.x branch and supports Legacy Smarty engine
• b-2.x is compatible with OXID eShop compilations: 6.2.x - 6.5.x

Versions

• versions 4.x - compatible with OXID eShop compilation 7.1.x
• versions 3.x - compatible with OXID eShop compilation 7.0.x
• versions 2.x - compatible with OXID eShop compilation 6.0.x - 6.5.x

Module installation via composer

In order to install the module via composer run one of the following commands in commandline in your shop base directory (where the shop's composer.json file resides).

• composer require ddoe/wysiwyg-editor-module:^3.0.0 to install the latest released version compatible with OXID eShop v6.0
• composer require ddoe/wysiwyg-editor-module:dev-b-7.1.x
  to install the specific unreleased branch

Module activation in OXID eShop Admin

After installation, please, activate the module in OXID eShop Admin
EXTENSIONS -> Modules -> "Summernote WYSIWYG Editor for OXID eShop" -> Activate

Development installation

The installation paths in commands below are fitting current SDK. In case of different environment usage, please adjust by your own needs.

# Clone the repository
cd <shopRootPath>
git clone https://github.com/OXID-eSales/ddoe-wysiwyg-editor-module.git --branch=b-7.1.x source/dev-packages/wysiwyg

docker compose exec -T \
  php composer config repositories.ddoe/wysiwyg-editor-module \
  --json '{"type":"path", "url":"./dev-packages/wysiwyg", "options": {"symlink": true}}'
docker compose exec -T php composer require ddoe/wysiwyg-editor-module:* --no-update

# Activate modules
bin/oe-console oe:module:activate ddoemedialibrary
bin/oe-console oe:module:activate ddoewysiwyg

Bugs and Issues

If you experience any bugs or issues, please report them in the section WYSIWYG Editor + Media Gallery of https://bugs.oxid-esales.com.