[D8] CKEditor Accordion [#2751677]

Project description

CKEditor Accordion project adds a new button to the built in CKEditor's toolbar allowing users to display their content in an accordion format.

On installation the module creates a new button to CKEditor that the developer can enable in the text editor settings page for the desired input format like Basic HTML (admin/config/content/formats)

When adding a new accordion, the CKEditor plugin creates a

structure for the accordion which is then made dynamic using Javascript found in ckeditor_accordion/js/ckeditor-accordion.js

The HTML is then styled using ckeditor_accordion/css/ckeditor-accordion.css

The project page & installation instructions can be found at the project's sandbox page here https://www.drupal.org/sandbox/j-vee/2751669

GIT clone command

git clone --branch 8.x-1.x https://git.drupal.org/sandbox/j-vee/2751669.git ckeditor_accordion
cd ckeditor_accordion

Installation instructions

Install & Enable the module
Open Administration > Configuration > Content authoring > Text formats and editors (admin/config/content/formats)
Edit a text format's settings (usually Basic HTML)
Drag n Drop the Add Accordion -button to the toolbar to show it to the users
Scroll down to the bottom to the input Allowed HTML tags
Find and replace <dl> with <dl class>
This makes sure CKEditor doesn't remove the class name that the accordion uses.

This is my first module release so can't provide links to previous applications now.

Comment	File	Size	Author
#4	accordion.png	18.21 KB	j-vee
	accordion-editor.png	32.34 KB	j-vee
	accordion.png	17.55 KB	j-vee

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

19 June 2016 at 08:51

j-vee created an issue. See original summary.

Comment #2

PA robot CreditAttribution: PA robot commented 19 June 2016 at 10:23

Status:

Needs review

» Needs work

There are some errors reported by automated review tools, did you already check them? See http://pareview.sh/pareview/httpsgitdrupalorgsandboxj-vee2751669git

We are currently quite busy with all the project applications and we prefer projects with a review bonus. Please help reviewing and put yourself on the high priority list, then we will take a look at your project right away :-)

Also, you should get your friends, colleagues or other community members involved to review this application. Let them go through the review checklist and post a comment that sets this issue to "needs work" (they found some problems with the project) or "reviewed & tested by the community" (they found no major flaws).

I'm a robot and this is an automated message from Project Applications Scraper.

Comment #3

j-vee CreditAttribution: j-vee as a volunteer commented 19 June 2016 at 23:06

Status:

Needs work

» Needs review

Went through the list generated by pareview.sh and fixed styling problems.

String concat is not required here; use a single string instead
This "error" is still there but I left the strings on multiple lines for readability purposes. It's a piece of code that create HTML elements so they are better to have on multiple lines so they can be viewed in an indented format.

Namespaced classes, interfaces and traits should not begin with a file doc comment
This error is still around but I've looked at many modules where there is a file doc comment in the same plugin files. So I left the comment in for now.

Comment #4

j-vee CreditAttribution: j-vee as a volunteer commented 19 June 2016 at 23:07

File	Size
accordion.png	18.21 KB

1 file was hidden/shown/deleted

File	Size
accordion.png	17.55 KB

Comment #5

j-vee CreditAttribution: j-vee as a volunteer commented 20 June 2016 at 05:17

Issue summary:

View changes

Comment #6

JeroenT

Dutch

🇧🇪

CreditAttribution: JeroenT at iO commented 4 August 2016 at 16:26

Automated Review

http://pareview.sh/pareview/httpsgitdrupalorgsandboxj-vee2751669git

All code styling issues are currently fixed.

Manual review

Individual user account: Yes: Follows the guidelines for individual user accounts.
No duplication: Yes: Does not cause module duplication and/or fragmentation.
Master Branch: Yes: Follows the guidelines for master branch.
Licensing: Yes: Follows the licensing requirements.
3rd party assets/code: Yes: follows the guidelines for 3rd party assets/code.
README.txt/README.md: Yes: Follows the guidelines for in-project documentation and/or the README Template.
Code long/complex enough for review: [Yes: Follows / No: Does not follow] the guidelines for project length and complexity.
Secure code: Yes: Meets the security requirements.
Coding style & Drupal API usage: Didn't found any issues.
I was able to install the module, add the button to CKEditor and make an accordion.

Comment #7

JeroenT

Dutch

🇧🇪

CreditAttribution: JeroenT at iO commented 4 August 2016 at 19:33

Status:

Needs review

» Reviewed & tested by the community

Comment #8

MiSc CreditAttribution: MiSc as a volunteer commented 6 October 2016 at 20:08

Status:

Reviewed & tested by the community

» Fixed

Thanks for your contribution, j-vee!

I updated your account so you can promote this to a full project and also create new projects as either a sandbox or a "full" project.

Here are some recommended readings to help with excellent maintainership:

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and stay involved!

Thanks, also, for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

Thanks to the dedicated reviewer(s) as well.