Skip to content

Update Cms Module README Content #34442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions app/code/Magento/Cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,45 @@

The CMS module provides the create, edit, and manage functionality on pages for different content types.

## UI components

### Wysiwyg

The Wysiwyg UI component is a customizable and configurable TinyMCE editor.

The default implementation has the following customizations:

* Magento Media Library support

### Layouts

The module interacts with the following layout handles:

`view/base/layout` directory:
The module interacts with the following layout handles:

`view/adminhtml/layout` directory:
- `cms_block_edit.xml`
- `cms_block_index.xml`
- `cms_block_new.xml`
- `cms_page_edit.xml`
- `cms_page_index.xml`
- `cms_page_new.xml`
- `cms_wysiwyg_images_contents.xml`
- `cms_wysiwyg_images_index.xml`

The module interacts with the following layout handles in the `view/frontend/layout` directory:
- `cms_index_defaultindex.xml`
- `cms_index_defaultnoroute.xml`
- `cms_index_index.xml`
- `cms_index_nocookies.xml`
- `cms_noroute_index.xml`
- `cms_page_view.xml`
- `default.xml`
- `print.xml`

### UI components
This module extends following ui components located in the `view/base/ui_component` directory:
This module extends following ui components located in the `view/adminhtml/ui_component` directory:
- `cms_block_form.xml`
- `cms_block_listing.xml`
- `cms_page_form.xml`
- `cms_page_listing.xml`