From b8223a994b8830c0f172b295ccbc089e749ac092 Mon Sep 17 00:00:00 2001 From: bcanini <canini.16@osu.edu> Date: Fri, 1 Mar 2019 11:43:45 -0500 Subject: [PATCH] new module - ckeditor_indentblock: integrates the CKEditor IndentBlock plugin with the CKEditor in Drupal 8 core --- composer.json | 1 + composer.lock | 57 ++- vendor/composer/installed.json | 56 +++ web/modules/ckeditor_indentblock/LICENSE.txt | 339 ++++++++++++++++++ web/modules/ckeditor_indentblock/README.txt | 37 ++ .../ckeditor_indentblock.info.yml | 16 + .../ckeditor_indentblock.install | 39 ++ .../ckeditor_indentblock.libraries.yml | 5 + .../ckeditor_indentblock.module | 16 + .../ckeditor_indentblock/composer.json | 25 ++ .../indentblock/ckeditor.indentblock.css | 36 ++ .../src/Plugin/CKEditorPlugin/IndentBlock.php | 123 +++++++ 12 files changed, 749 insertions(+), 1 deletion(-) create mode 100644 web/modules/ckeditor_indentblock/LICENSE.txt create mode 100644 web/modules/ckeditor_indentblock/README.txt create mode 100644 web/modules/ckeditor_indentblock/ckeditor_indentblock.info.yml create mode 100644 web/modules/ckeditor_indentblock/ckeditor_indentblock.install create mode 100644 web/modules/ckeditor_indentblock/ckeditor_indentblock.libraries.yml create mode 100644 web/modules/ckeditor_indentblock/ckeditor_indentblock.module create mode 100644 web/modules/ckeditor_indentblock/composer.json create mode 100644 web/modules/ckeditor_indentblock/css/plugins/indentblock/ckeditor.indentblock.css create mode 100644 web/modules/ckeditor_indentblock/src/Plugin/CKEditorPlugin/IndentBlock.php diff --git a/composer.json b/composer.json index 6cf4d6d98e..dba36b34ce 100644 --- a/composer.json +++ b/composer.json @@ -80,6 +80,7 @@ "drupal/block_permissions": "^1.0", "drupal/block_region_permissions": "^1.2", "drupal/bootstrap": "3.16", + "drupal/ckeditor_indentblock": "^1.0@beta", "drupal/config_direct_save": "^1.0", "drupal/config_ignore": "^2.1", "drupal/config_installer": "^1.0", diff --git a/composer.lock b/composer.lock index 0dd0fe6f7a..34c2d9ad4b 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], - "content-hash": "412cdee216390390463e9758c73ddff2", + "content-hash": "24aed79b1c402975953b673070fe8a7e", "packages": [ { "name": "alchemy/zippy", @@ -1899,6 +1899,60 @@ "irc": "irc://irc.freenode.org/drupal-bootstrap" } }, + { + "name": "drupal/ckeditor_indentblock", + "version": "1.0.0-beta1", + "source": { + "type": "git", + "url": "https://git.drupal.org/project/ckeditor_indentblock", + "reference": "8.x-1.0-beta1" + }, + "dist": { + "type": "zip", + "url": "https://ftp.drupal.org/files/projects/ckeditor_indentblock-8.x-1.0-beta1.zip", + "reference": "8.x-1.0-beta1", + "shasum": "3841d9e9f15d6e143715aa518dd92033febf6443" + }, + "require": { + "drupal/ckeditor": "*", + "drupal/core": "^8.1.0", + "drupal/libraries": "*" + }, + "type": "drupal-module", + "extra": { + "branch-alias": { + "dev-1.x": "1.x-dev" + }, + "drupal": { + "version": "8.x-1.0-beta1", + "datestamp": "1507249143", + "security-coverage": { + "status": "not-covered", + "message": "Project has not opted into security advisory coverage!" + } + } + }, + "notification-url": "https://packages.drupal.org/8/downloads", + "license": [ + "GPL-2.0+" + ], + "authors": [ + { + "name": "Christian Meilinger (meichr)", + "homepage": "https://www.drupal.org/u/meichr", + "role": "Maintainer" + } + ], + "description": "Provides integration of the CKEditor IndentBlock plugin with the Drupal 8 CKEditor.", + "homepage": "https://www.drupal.org/project/ckeditor_indentblock", + "keywords": [ + "Drupal" + ], + "support": { + "source": "http://cgit.drupalcode.org/ckeditor_indentblock/", + "issues": "https://www.drupal.org/project/issues/ckeditor_indentblock" + } + }, { "name": "drupal/config_direct_save", "version": "1.0.0", @@ -10958,6 +11012,7 @@ "stability-flags": { "drupal/bigmenu": 15, "drupal/block_field": 15, + "drupal/ckeditor_indentblock": 10, "drupal/entity_clone": 10, "drupal/libraries": 15, "drupal/migrate_devel": 20, diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json index c700614698..3b6483fb1c 100644 --- a/vendor/composer/installed.json +++ b/vendor/composer/installed.json @@ -1962,6 +1962,62 @@ "irc": "irc://irc.freenode.org/drupal-bootstrap" } }, + { + "name": "drupal/ckeditor_indentblock", + "version": "1.0.0-beta1", + "version_normalized": "1.0.0.0-beta1", + "source": { + "type": "git", + "url": "https://git.drupal.org/project/ckeditor_indentblock", + "reference": "8.x-1.0-beta1" + }, + "dist": { + "type": "zip", + "url": "https://ftp.drupal.org/files/projects/ckeditor_indentblock-8.x-1.0-beta1.zip", + "reference": "8.x-1.0-beta1", + "shasum": "3841d9e9f15d6e143715aa518dd92033febf6443" + }, + "require": { + "drupal/ckeditor": "*", + "drupal/core": "^8.1.0", + "drupal/libraries": "*" + }, + "type": "drupal-module", + "extra": { + "branch-alias": { + "dev-1.x": "1.x-dev" + }, + "drupal": { + "version": "8.x-1.0-beta1", + "datestamp": "1507249143", + "security-coverage": { + "status": "not-covered", + "message": "Project has not opted into security advisory coverage!" + } + } + }, + "installation-source": "dist", + "notification-url": "https://packages.drupal.org/8/downloads", + "license": [ + "GPL-2.0+" + ], + "authors": [ + { + "name": "Christian Meilinger (meichr)", + "homepage": "https://www.drupal.org/u/meichr", + "role": "Maintainer" + } + ], + "description": "Provides integration of the CKEditor IndentBlock plugin with the Drupal 8 CKEditor.", + "homepage": "https://www.drupal.org/project/ckeditor_indentblock", + "keywords": [ + "Drupal" + ], + "support": { + "source": "http://cgit.drupalcode.org/ckeditor_indentblock/", + "issues": "https://www.drupal.org/project/issues/ckeditor_indentblock" + } + }, { "name": "drupal/config_direct_save", "version": "1.0.0", diff --git a/web/modules/ckeditor_indentblock/LICENSE.txt b/web/modules/ckeditor_indentblock/LICENSE.txt new file mode 100644 index 0000000000..d159169d10 --- /dev/null +++ b/web/modules/ckeditor_indentblock/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/web/modules/ckeditor_indentblock/README.txt b/web/modules/ckeditor_indentblock/README.txt new file mode 100644 index 0000000000..4b217e710e --- /dev/null +++ b/web/modules/ckeditor_indentblock/README.txt @@ -0,0 +1,37 @@ +CKEditor IndentBlock +==================== + +Description +=========== +The CKEditor IndentBlock plugin adds the functionality of indenting text paragraphs using CKEditor. The plugin doesn't +come with its own buttons, but uses the same buttons as the built-in CKEditor Indent plugin. The configuration allows +to enable/disable the CKEditor IndentBlock plugin individually for each text format. + +Installation +============ +1. Download the plugin from http://ckeditor.com/addon/indentblock +2. Place the plugin in the root libraries folder (/libraries). +3. Enable the CKEditor IndentBlock module in the Drupal admin menu 'Extend >> List'. + +Adding paragraph indentation to a text format +============================================= +1. Go to admin menu 'Configuration >> Text formats and editors'. +2. Click on the Configuration button of the text format (i.e. Simple HTML). +3. If not already in the toolbar, drag the buttons with the title tags indent and outdent into it, which enables the + built-in CKEditor Indent plugin for lists. +4. Open the vertical tab 'Indent Block' and make sure the plugin is enabled. +5. Make sure, the tag <p class> is added to the field 'Allowed HTM tags', otherwise the 'Indent' and 'Outdent' buttons + will not become active for paragraphs despite the IndentBlock plugin being enabled. + +Dependencies +============ +This module requires the core CKEditor module and the contributed Libraries module. + +Uninstallation +============== +1. Uninstall the module from the admin menu 'Extend >> Uninstall'. + + +MAINTAINERS +============ +Christian Meilinger - https://www.drupal.org/u/meichr diff --git a/web/modules/ckeditor_indentblock/ckeditor_indentblock.info.yml b/web/modules/ckeditor_indentblock/ckeditor_indentblock.info.yml new file mode 100644 index 0000000000..42dce146eb --- /dev/null +++ b/web/modules/ckeditor_indentblock/ckeditor_indentblock.info.yml @@ -0,0 +1,16 @@ +name: CKEditor IndentBlock +type: module +description: 'Provides integration of the CKEditor IndentBlock plugin with the Drupal 8 CKEditor.' +package: CKEditor +# core: 8.x + +dependencies: + - libraries:libraries + - drupal:ckeditor + - drupal:system (>= 8.1) + +# Information added by Drupal.org packaging script on 2017-10-06 +version: '8.x-1.0-beta1' +core: '8.x' +project: 'ckeditor_indentblock' +datestamp: 1507249145 diff --git a/web/modules/ckeditor_indentblock/ckeditor_indentblock.install b/web/modules/ckeditor_indentblock/ckeditor_indentblock.install new file mode 100644 index 0000000000..1ed569d08f --- /dev/null +++ b/web/modules/ckeditor_indentblock/ckeditor_indentblock.install @@ -0,0 +1,39 @@ +<?php + +/** + * @file + * CKEditor IndentBlock install file. + */ + +/** + * Implements hook_requirements(). + */ +function ckeditor_indentblock_requirements($phase) { + $requirements = []; + + if ($phase == 'install' || $phase == 'runtime') { + if (!function_exists('libraries_get_path')) { + module_load_include('module', 'libraries'); + } + $plugin_path = libraries_get_path('indentblock') . '/plugin.js'; + $plugin_detected = file_exists($plugin_path); + + if ($plugin_detected) { + $requirements['indentblock'] = [ + 'title' => t('CKEditor IndentBlock'), + 'value' => t('Plugin detected'), + 'severity' => REQUIREMENT_OK, + ]; + } + else { + $requirements['indentblock'] = [ + 'title' => t('CKEditor IndentBlock'), + 'value' => t('Plugin not detected'), + 'severity' => REQUIREMENT_ERROR, + 'description' => t('You will need to install the "Indent Block" CKEditor plugin under the libraries path before enabling this module. <a href=":plugin_url">Get the plugin from CKEditor.com</a>.', [':plugin_url' => 'http://ckeditor.com/addon/indentblock']), + ]; + } + } + + return $requirements; +} diff --git a/web/modules/ckeditor_indentblock/ckeditor_indentblock.libraries.yml b/web/modules/ckeditor_indentblock/ckeditor_indentblock.libraries.yml new file mode 100644 index 0000000000..0b6ad09469 --- /dev/null +++ b/web/modules/ckeditor_indentblock/ckeditor_indentblock.libraries.yml @@ -0,0 +1,5 @@ +indentblock: + version: 1.x + css: + theme: + css/plugins/indentblock/ckeditor.indentblock.css: {} diff --git a/web/modules/ckeditor_indentblock/ckeditor_indentblock.module b/web/modules/ckeditor_indentblock/ckeditor_indentblock.module new file mode 100644 index 0000000000..7bf6e5d3eb --- /dev/null +++ b/web/modules/ckeditor_indentblock/ckeditor_indentblock.module @@ -0,0 +1,16 @@ +<?php + +/** + * @file + * Adds a hook for attaching a css file with indentation information to each page. + */ + + +/** + * Implements hook_page_attachments(). + * + * Adds the ckeditor.indentblock.css with indentation css to each page. + */ +function ckeditor_indentblock_page_attachments(array &$page) { + $page['#attached']['library'][] = 'ckeditor_indentblock/indentblock'; +} diff --git a/web/modules/ckeditor_indentblock/composer.json b/web/modules/ckeditor_indentblock/composer.json new file mode 100644 index 0000000000..68981e7196 --- /dev/null +++ b/web/modules/ckeditor_indentblock/composer.json @@ -0,0 +1,25 @@ +{ + "name": "drupal/ckeditor_indentblock", + "type": "drupal-module", + "description": "Provides integration of the CKEditor IndentBlock plugin with the Drupal 8 CKEditor.", + "keywords": ["Drupal"], + "license": "GPL-2.0+", + "homepage": "https://www.drupal.org/project/ckeditor_indentblock", + "minimum-stability": "dev", + "authors": [ + { + "name": "Christian Meilinger (meichr)", + "homepage": "https://www.drupal.org/u/meichr", + "role": "Maintainer" + } + ], + "support": { + "issues": "https://www.drupal.org/project/issues/ckeditor_indentblock", + "source": "http://cgit.drupalcode.org/ckeditor_indentblock/" + }, + "require": { + "drupal/core": "^8.1.0", + "drupal/ckeditor": "*", + "drupal/libraries": "*" + } +} diff --git a/web/modules/ckeditor_indentblock/css/plugins/indentblock/ckeditor.indentblock.css b/web/modules/ckeditor_indentblock/css/plugins/indentblock/ckeditor.indentblock.css new file mode 100644 index 0000000000..482ca9f379 --- /dev/null +++ b/web/modules/ckeditor_indentblock/css/plugins/indentblock/ckeditor.indentblock.css @@ -0,0 +1,36 @@ +@charset "UTF-8"; +/** + * Elements + * - set css for block indent. + ============================================================================ */ +p.Indent1 { + margin-left: 2em; +} +p.Indent2 { + margin-left: 4em; +} +p.Indent3 { + margin-left: 6em; +} +p.Indent4 { + margin-left: 8em; +} +p.Indent5 { + margin-left: 10em; +} +p.Indent6 { + margin-left: 12em; +} +p.Indent7 { + margin-left: 14em; +} +p.Indent8 { + margin-left: 16em; +} +p.Indent9 { + margin-left: 18em; +} +p.Indent10 { + margin-left: 20em; +} + diff --git a/web/modules/ckeditor_indentblock/src/Plugin/CKEditorPlugin/IndentBlock.php b/web/modules/ckeditor_indentblock/src/Plugin/CKEditorPlugin/IndentBlock.php new file mode 100644 index 0000000000..8bccb0b792 --- /dev/null +++ b/web/modules/ckeditor_indentblock/src/Plugin/CKEditorPlugin/IndentBlock.php @@ -0,0 +1,123 @@ +<?php + +namespace Drupal\ckeditor_indentblock\Plugin\CKEditorPlugin; + +use Drupal\ckeditor\CKEditorPluginBase; +use Drupal\ckeditor\CKEditorPluginConfigurableInterface; +use Drupal\ckeditor\CKEditorPluginContextualInterface; +use Drupal\ckeditor\CKEditorPluginCssInterface; +use Drupal\Core\Form\FormStateInterface; +use Drupal\editor\Entity\Editor; + +/** + * Defines the "Indent Block" plugin. + * + * NOTE: The plugin ID ('id' key) corresponds to the CKEditor plugin name. + * It is the first argument of the CKEDITOR.plugins.add() function in the + * plugin.js file. + * + * @CKEditorPlugin( + * id = "indentblock", + * label = @Translation("Indent Block") + * ) + */ +class IndentBlock extends CKEditorPluginBase implements CKEditorPluginContextualInterface, CKEditorPluginConfigurableInterface, CKEditorPluginCssInterface { + + /** + * {@inheritdoc} + */ + public function getCssFiles(Editor $editor) { + return [ + drupal_get_path('module', 'ckeditor_indentblock') . '/css/plugins/indentblock/ckeditor.indentblock.css', + ]; + } + + /** + * {@inheritdoc} + * + * NOTE: The keys of the returned array corresponds to the CKEditor button + * names. They are the first argument of the editor.ui.addButton() or + * editor.ui.addRichCombo() functions in the plugin.js file. + */ + public function getButtons() { + return []; + } + + /** + * {@inheritdoc} + */ + public function getFile() { + return libraries_get_path('indentblock') . '/plugin.js'; + } + + /** + * {@inheritdoc} + */ + public function isEnabled(Editor $editor) { + // Enable this plugin, if it is configured as being enabled and at least one + // of the buttons, Indent or Outdent, is enabled. + $settings = $editor->getSettings(); + if (isset($settings['plugins']['indentblock']) && $settings['plugins']['indentblock']['enable']) { + foreach ($settings['toolbar']['rows'] as $row) { + foreach ($row as $group) { + foreach ($group['items'] as $button) { + if ($button === 'Indent' || $button === 'Outdent') { + return TRUE; + } + } + } + } + } + return FALSE; + } + + /** + * {@inheritdoc} + */ + public function isInternal() { + return FALSE; + } + + /** + * {@inheritdoc} + */ + public function getDependencies(Editor $editor) { + // The Indent plugin is internal for Drupal 8 CKEditor and thus can't be + // defined as a dependency. + return []; + } + + /** + * {@inheritdoc} + */ + public function getLibraries(Editor $editor) { + return []; + } + + /** + * {@inheritdoc} + */ + public function getConfig(Editor $editor) { + return [ + 'indentClasses' => ['Indent1', 'Indent2', 'Indent3', 'Indent4', 'Indent5', 'Indent6', 'Indent7', 'Indent8', 'Indent9', 'Indent10'], + 'indentOffset' => 2, + 'indentUnit' => 'em', + ]; + } + + /** + * {@inheritdoc} + */ + public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) { + $settings = $editor->getSettings(); + + $form['enable'] = array( + '#type' => 'checkbox', + '#title' => $this->t('Enable indentation on paragraphs'), + '#default_value' => !empty($settings['plugins']['indentblock']) && $settings['plugins']['indentblock']['enable'] === 1 ? $settings['plugins']['indentblock']['enable'] : 0, + ); + + return $form; + } + +} -- GitLab