You are here

Home » API reference » CKEditor Description List 2.0.x

README.txt in CKEditor Description List 2.0.x

Same filename and directory in other branches
  1. 8 README.txt
CONTENTS OF THIS FILE
=====================

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * Uninstallation
 * Maintainers


INTRODUCTION
============

This modules adds description list plugin into the WYSIWYG editor,
that provides the ability to create a definition list such as dl,
dt and dd html tags.

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

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


REQUIREMENTS
============

This module requires the following core, module and plugin:

* Drupal core ^8.8 || ^9
* CKEditor Module - core
* Description list plugin:
   https://github.com/Reinmar/ckeditor-plugin-descriptionlist


RECOMMENDED MODULES
===================

This module requires no modules outside of Drupal core.


INSTALLATION
============

1. Download the plugin from https://github.com/Reinmar/ckeditor-plugin-descriptionlist

2. Place the plugin in the root libraries folder (/libraries/ckeditor-plugin-descriptionlist).

3. Install/Enable the ckeditor_descriptionlist module as you would normally
install a contributed Drupal module.

* Visit (https://www.drupal.org/node/1897420) for further information.
* We recommend that you install the module using composer:
   composer require 'drupal/ckeditor_descriptionlist:^2.0'

4. Configure your WYSIWYG toolbar to include description list buttons.


CONFIGURATION
=============

Go to the Text formats and editors settings 'Admin -> Configuration -> Content -> Formats'
add the buttons : Tag dl, Tag dd, Tag dt to any CKEditor-enabled text format you want.


UNINSTALLATION
==============

Uninstall the module from 'Administer -> Modules'.


MAINTAINERS
===========

Current maintainers:
* Tsymi (https://www.drupal.org/u/tsymi)

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. =====================

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Recommended modules

  7.  * Installation

  8.  * Configuration

  9.  * Uninstallation

  10.  * Maintainers

  11. 

  12. 

  13. INTRODUCTION

  14. ============

  15. 

  16. This modules adds description list plugin into the WYSIWYG editor,

  17. that provides the ability to create a definition list such as dl,

  18. dt and dd html tags.

  19. 

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

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

  22. 

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

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

  25. 

  26. 

  27. REQUIREMENTS

  28. ============

  29. 

  30. This module requires the following core, module and plugin:

  31. 

  32. * Drupal core ^8.8 || ^9

  33. * CKEditor Module - core

  34. * Description list plugin:

  35.    https://github.com/Reinmar/ckeditor-plugin-descriptionlist

  36. 

  37. 

  38. RECOMMENDED MODULES

  39. ===================

  40. 

  41. This module requires no modules outside of Drupal core.

  42. 

  43. 

  44. INSTALLATION

  45. ============

  46. 

  47. 1. Download the plugin from https://github.com/Reinmar/ckeditor-plugin-descriptionlist

  48. 

  49. 2. Place the plugin in the root libraries folder (/libraries/ckeditor-plugin-descriptionlist).

  50. 

  51. 3. Install/Enable the ckeditor_descriptionlist module as you would normally

  52. install a contributed Drupal module.

  53. 

  54. * Visit (https://www.drupal.org/node/1897420) for further information.

  55. * We recommend that you install the module using composer:

  56.    composer require 'drupal/ckeditor_descriptionlist:^2.0'

  57. 

  58. 4. Configure your WYSIWYG toolbar to include description list buttons.

  59. 

  60. 

  61. CONFIGURATION

  62. =============

  63. 

  64. Go to the Text formats and editors settings 'Admin -> Configuration -> Content -> Formats'

  65. add the buttons : Tag dl, Tag dd, Tag dt to any CKEditor-enabled text format you want.

  66. 

  67. 

  68. UNINSTALLATION

  69. ==============

  70. 

  71. Uninstall the module from 'Administer -> Modules'.

  72. 

  73. 

  74. MAINTAINERS

  75. ===========

  76. 

  77. Current maintainers:

  78. * Tsymi (https://www.drupal.org/u/tsymi)