Skip to content

Commit ac3a5d8

Browse files
committed
Adjust Readme and Changelog
1 parent c0b4539 commit ac3a5d8

File tree

6 files changed

+42
-14
lines changed

6 files changed

+42
-14
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7-
## [Unreleased]
7+
## [1.0.0] - 2020-11-27
88
### Added
9-
### Changed
10-
### Removed
11-
### Fixed
9+
10+
- Configuration settings for icons and buttons of WYSIWYG editors
11+
- Support for PageBuilder (Magento Commerce)

README.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# IntegerNet_ConfigurableWysiwyg Magento Module
1+
# IntegerNet_ConfigurableWysiwyg Magento 2 Module
22
<div align="center">
33

44
[![Latest Version on Packagist][ico-version]][link-packagist]
@@ -14,6 +14,10 @@
1414

1515
Configure the Magento 2 WYSIWYG Editors: Remove buttons, adjust headings, ...
1616

17+
## Requirements
18+
19+
- Magento 2.3.x or 2.4.x
20+
1721
## Installation
1822

1923
1. Install it into your Magento 2 project with composer:
@@ -28,8 +32,40 @@ Configure the Magento 2 WYSIWYG Editors: Remove buttons, adjust headings, ...
2832
2933
## Configuration
3034
35+
You can find all configuration settings for this module in Store -> Configuration -> General -> Content Management:
36+
37+
![Menu](doc/img/menu.png)
38+
39+
These are the new fields and their default settings:
40+
41+
![Configuration fields](doc/img/config_fields.png)
42+
43+
### Toolbar Elements
44+
45+
This defines which icons will be available in the WYSIWYG editors. By default it looks like this:
46+
47+
![Default icons](doc/img/icons_default.png)
48+
49+
If you deselect some of the entries, it can look as follows:
50+
51+
![Reduced Icons](doc/img/icons_reduced.png)
52+
53+
### Show "Insert Variable" button
54+
55+
This button is used to insert variable values into content, like the store name. It's not used very often so it's probably safe to disable that button.
56+
57+
### Show "Insert Widget" button
58+
59+
You only need that button if you are using Widgets (i.e. for inserting product lists, dynamic links or static blocks) in Magento CMS.
60+
61+
### Show "Insert Image" button
62+
63+
You might want to disable this button if you don't want to insert images directly into WYSIWYG fields.
64+
3165
## Usage
3266
67+
If you change anything on the configuration page and click "Save Config", the settings will be applied to all WYSIWYG fields from then on.
68+
3369
## Changelog
3470
3571
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
@@ -38,17 +74,9 @@ Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed re
3874
3975
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
4076
41-
## Testing
42-
43-
### Unit Tests
44-
45-
```
46-
vendor/bin/phpunit tests/unit
47-
```
48-
4977
## Security
5078
51-
If you discover any security related issues, please email avs@integer-net.de instead of using the issue tracker.
79+
If you discover any security related issues, please email security@integer-net.de instead of using the issue tracker.
5280
5381
## Credits
5482

doc/img/config_fields.png

31.3 KB
Loading

doc/img/icons_default.png

5.04 KB
Loading

doc/img/icons_reduced.png

2.26 KB
Loading

doc/img/menu.png

31.2 KB
Loading

0 commit comments

Comments
 (0)