You are here

Home » API reference » CKEditor Responsive Plugin 7

README.txt in CKEditor Responsive Plugin 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 2.0.x README.txt
CONTENTS OF THIS FILE
---------------------
   
 * Introduction
 * Requirements
 * Installation
 * Troubleshooting
 * FAQ
 * Maintainers


INTRODUCTION
------------

This module, used on top of CKEditor allows the use of responsive area within 
rich editing textarea. 

Instead of tables, the plugins insert divs with standard responsive css lasses.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/ckeditor_responsive_plugin

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/2424721


REQUIREMENTS
------------
This module requires the following module:

 * CKEditor (https://drupal.org/project/ckeditor)


INSTALLATION
------------

This module requires CKEditor module to be installed
(https://www.drupal.org/project/ckeditor).

Copy the module folder to your module directory, enable it on the admin module
page.

Enable the module, and follow the line to your CKEditor profile for which you
want to enable the plugin. ie : /admin/config/content/ckeditor/edit/Advanced

 1. Under "Editor appearance", section "Plugins", please be sure that
"CKEditor Responsive Plugin : Allow to insert responsive areas" is checked
 2. Drag the button on your toolbar (the button is the one showed in
docs/button.jpg
 3. The text format you are using should allow div to be used within the 
 textarea. (If you are using the "Limit allowed HTML tags" you should add 
 div") in the allowed HTML tags list.
 4. The added css classes are "*col" (onecol, twocol...) and grid-* (grid-1 
 grid-2...) Make sure theses classes are working with your theme. If they 
 don't, have a look to the responsivness.css/responsivness.css file to copy 
 the appropriates classes. 


TROUBLESHOOTING
---------------

 * If the button does not display on the toolbar, check the following:

   - is the CKEditor option "CKEditor Responsive Plugin : Allow to insert 
   responsive areas" is checked ?

   - Is the button is present on CKEditor visual toolbar configuration ?


FAQ
---

Q: Does this module work with WYSIWYG bridge API ?

A: Nothing has been done for it, so I can't answer this question, feel free to 
try it out and report any issue you'll face.


MAINTAINERS
-----------

Current maintainers:
 * Kevin Gautreau (kgaut) - https://drupal.org/user/686336

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.    

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Troubleshooting

  8.  * FAQ

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. This module, used on top of CKEditor allows the use of responsive area within 

  16. rich editing textarea. 

  17. 

  18. Instead of tables, the plugins insert divs with standard responsive css lasses.

  19. 

  20.  * For a full description of the module, visit the project page:

  21.    https://www.drupal.org/project/ckeditor_responsive_plugin

  22. 

  23.  * To submit bug reports and feature suggestions, or to track changes:

  24.    https://www.drupal.org/project/issues/2424721

  25. 

  26. 

  27. REQUIREMENTS

  28. ------------

  29. This module requires the following module:

  30. 

  31.  * CKEditor (https://drupal.org/project/ckeditor)

  32. 

  33. 

  34. INSTALLATION

  35. ------------

  36. 

  37. This module requires CKEditor module to be installed

  38. (https://www.drupal.org/project/ckeditor).

  39. 

  40. Copy the module folder to your module directory, enable it on the admin module

  41. page.

  42. 

  43. Enable the module, and follow the line to your CKEditor profile for which you

  44. want to enable the plugin. ie : /admin/config/content/ckeditor/edit/Advanced

  45. 

  46.  1. Under "Editor appearance", section "Plugins", please be sure that

  47. "CKEditor Responsive Plugin : Allow to insert responsive areas" is checked

  48.  2. Drag the button on your toolbar (the button is the one showed in

  49. docs/button.jpg

  50.  3. The text format you are using should allow div to be used within the 

  51.  textarea. (If you are using the "Limit allowed HTML tags" you should add 

  52.  div") in the allowed HTML tags list.

  53.  4. The added css classes are "*col" (onecol, twocol...) and grid-* (grid-1 

  54.  grid-2...) Make sure theses classes are working with your theme. If they 

  55.  don't, have a look to the responsivness.css/responsivness.css file to copy 

  56.  the appropriates classes. 

  57. 

  58. 

  59. TROUBLESHOOTING

  60. ---------------

  61. 

  62.  * If the button does not display on the toolbar, check the following:

  63. 

  64.    - is the CKEditor option "CKEditor Responsive Plugin : Allow to insert 

  65.    responsive areas" is checked ?

  66. 

  67.    - Is the button is present on CKEditor visual toolbar configuration ?

  68. 

  69. 

  70. FAQ

  71. ---

  72. 

  73. Q: Does this module work with WYSIWYG bridge API ?

  74. 

  75. A: Nothing has been done for it, so I can't answer this question, feel free to 

  76. try it out and report any issue you'll face.

  77. 

  78. 

  79. MAINTAINERS

  80. -----------

  81. 

  82. Current maintainers:

  83.  * Kevin Gautreau (kgaut) - https://drupal.org/user/686336