You are here

README.txt in CKEditor Accordion 8

Same filename and directory in other branches
  1. 7 README.txt
README.txt
==========

Allows users to create & display content in an accordion.
------------------------
Requires - Drupal 8


Overview:
--------
Adds a new button to Drupal 8's built in CKEditor which allows the user
to create & display any type of content in an accordion format.

The styling is minimal blue and easily over writeable by developers.

Once the Accordion has been created, "ckeditorAccordionAttached" event
gets triggered on the accordion element.


INSTALLATION:
--------
1. Install & Enable the module
2. Open Administration > Configuration > Content authoring >
   Text formats and editors (admin/config/content/formats)
3. Edit a text format's settings (usually Basic HTML)
4. Drag n Drop the Add Accordion -button to the toolbar to show it to the users
5. Scroll down to the bottom to the input Allowed HTML tags
6. Find and replace <dl> with <dl class>
   This ensures CKEditor doesn't remove the class name that the accordion uses.
7. If you would like the Accordion tabs to be closed by default,
	 you can change this setting at: /admin/config/content/ckeditor-accordion

File

README.txt
View source
  1. README.txt
  2. ==========
  3. Allows users to create & display content in an accordion.
  4. ------------------------
  5. Requires - Drupal 8
  6. Overview:
  7. --------
  8. Adds a new button to Drupal 8's built in CKEditor which allows the user
  9. to create & display any type of content in an accordion format.
  10. The styling is minimal blue and easily over writeable by developers.
  11. Once the Accordion has been created, "ckeditorAccordionAttached" event
  12. gets triggered on the accordion element.
  13. INSTALLATION:
  14. --------
  15. 1. Install & Enable the module
  16. 2. Open Administration > Configuration > Content authoring >
  17. Text formats and editors (admin/config/content/formats)
  18. 3. Edit a text format's settings (usually Basic HTML)
  19. 4. Drag n Drop the Add Accordion -button to the toolbar to show it to the users
  20. 5. Scroll down to the bottom to the input Allowed HTML tags
  21. 6. Find and replace
    with
  22. This ensures CKEditor doesn't remove the class name that the accordion uses.
  23. 7. If you would like the Accordion tabs to be closed by default,
  24. you can change this setting at: /admin/config/content/ckeditor-accordion