README.md 3.44 KB
Newer Older
1
2
3
4
5
6
7
8
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
9
 * FAQ
10
11
 * Maintainers

JULIEN DE NAS DE TOURRIS's avatar
JULIEN DE NAS DE TOURRIS committed
12
13
14
15

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

16
17
18
19
20
21
22
This module integrates the
[dialogadvtab](https://ckeditor.com/cke4/addon/dialogadvtab) CKEditor plugin
with Drupal.

This plugin provides the Advanced dialog window tab to extend some editor dialog
windows. Other plugins don't need to implement the same features for their
dialog windows.
JULIEN DE NAS DE TOURRIS's avatar
JULIEN DE NAS DE TOURRIS committed
23

24
Some of the CKEditor plugins that use the Advanced tab are:
25
26
27
28
29
30
31

 * The [Link](https://ckeditor.com/cke4/addon/link) plugin
 * The [Image](https://ckeditor.com/cke4/addon/image) plugin
 * The [Flash](https://ckeditor.com/cke4/addon/flash) plugin
 * The [Table](https://ckeditor.com/cke4/addon/table) plugin
 * The [IFrame](https://ckeditor.com/cke4/addon/iframe) plugin
 * The [Div](https://ckeditor.com/cke4/addon/div) Container plugin
JULIEN DE NAS DE TOURRIS's avatar
JULIEN DE NAS DE TOURRIS committed
32

33

JULIEN DE NAS DE TOURRIS's avatar
JULIEN DE NAS DE TOURRIS committed
34
35
36
REQUIREMENTS
------------

37
38
39
This module requires the following modules:

* [CKEditor](https://www.drupal.org/docs/8/core/modules/ckeditor)
JULIEN DE NAS DE TOURRIS's avatar
JULIEN DE NAS DE TOURRIS committed
40
41
42
43
44


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

45
46
47
48
49
50
51
52
53
54
55
56
 * Install as you would normally install a contributed Drupal module. Visit
   https://www.drupal.org/node/1897420 for further information.

 * Run `composer require --prefer-dist composer/installers` to ensure you have
   the composer/installers package. This facilitates installation into
   directories other than vendor using Composer.

 * Make sure the "extras/installer-paths" section in the composer.json file has
   an entry for `type:drupal-library`, for example the following one.

   ```json
   {
57
       "libraries/{$name}": ["type:drupal-library"]
58
59
60
61
   }
   ```

 * Add the following lines to the "repositories" section in the composer.json
62
63
   file. The 4.18.0 release of the plugin is the only release that is defined
   compatible with the release of CKEditor used by Drupal 9.x.
64
65
66

   ```json
   {
67
68
69
       "type": "package",
       "package": {
           "name": "ckeditor/dialogadvtab",
70
           "version": "4.14.0",
71
72
73
74
75
           "type": "drupal-library",
           "extra": {
               "installer-name": "ckeditor/plugins/dialogadvtab"
           },
           "dist": {
76
               "url": "https://download.ckeditor.com/dialogadvtab/releases/dialogadvtab_4.14.0.zip",
77
78
79
80
81
               "type": "zip"
           }
       }
   }
   ```
JULIEN DE NAS DE TOURRIS's avatar
JULIEN DE NAS DE TOURRIS committed
82

83
 * Run `composer require 'ckeditor/dialogadvtab:4.14.0'` to download the plugin.
JULIEN DE NAS DE TOURRIS's avatar
JULIEN DE NAS DE TOURRIS committed
84
85


86
87
88
89
CONFIGURATION
-------------

 * Configure the WYSIWYG buttons in
90
  Administration » Configuration » Content authoring » Text formats and editors
91
92
93

   - Drag the advanced icon button to your toolbar and save

94

95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
FAQ
---

Q: Can I use a release of the plugin that is more recent than the one indicated
   by the README.md file?

A: The README file shows how to install the plugin its
   [project page](https://ckeditor.com/cke4/addon/dialogadvtab) defines
   compatible with the release of CKEditor used by the Drupal release required
   by the module. You can install a more recent version, if you find out it's
   compatible with the Drupal release you are using.
   The README.md file will be updated to show how to install the plugin
   compatible with the Drupal release required by the module.


JULIEN DE NAS DE TOURRIS's avatar
JULIEN DE NAS DE TOURRIS committed
110
111
112
MAINTAINERS
-----------

113
114
115
116
117
Current maintainers:
 * Alberto Paderno (apaderno) - https://www.drupal.org/u/apaderno
 * Chris Burge - https://www.drupal.org/u/chris-burge
 * Julien de Nas de Tourris (julien) - https://www.drupal.org/u/julien
 * Stephen Mulvihill (smulvih2) - https://www.drupal.org/u/smulvih2