Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation about DDL incorrect? #281

Closed
mattfordham opened this issue Aug 20, 2024 · 4 comments
Closed

Documentation about DDL incorrect? #281

mattfordham opened this issue Aug 20, 2024 · 4 comments
Labels

Comments

@mattfordham
Copy link

Description

In attempting to get the Clipboard plugin working, I've been following the documentation about "Adding CKEditor Plugins". The documentation states the following....

If you’re including one of CKEditor’s first-party packages, it will already include a build directory with a DLL-compatible package inside it.

Unless I am misunderstanding something, I have not found this not to be true. For example, the Clipboard plugin is here, and only contains a "src" directory:

https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-clipboard

Am I misunderstanding, or has something changed?

Steps to reproduce

N/A

Additional info

N/A

@mattfordham
Copy link
Author

After a bit more digging on the matter, it seems the documentation here is not "incorrect", just out of date, as the DDL builds have been deprecated:

https://ckeditor.com/docs/ckeditor5/latest/getting-started/legacy/advanced/alternative-setups/dll-builds.html

@ryanirelan
Copy link

After a bit more digging on the matter, it seems the documentation here is not "incorrect", just out of date, as the DDL builds have been deprecated:

https://ckeditor.com/docs/ckeditor5/latest/getting-started/legacy/advanced/alternative-setups/dll-builds.html

AFAIK, you still need a DLL-compatible file to add a plugin to the Craft CMS CKEditor because we're not rebuilding the CKEditor just linking the plugin code.

@i-just
Copy link
Contributor

i-just commented Sep 5, 2024

Hi, thanks for reaching out!

The short answer is yes, you still need a DLL-compatible file(s).

The longer answer is:
We are aware of the changes to the installation methods and are working on migrating away from DLLs. The change was introduced in CKEditor 5 v42.0.0. As per the documentation, the DLLs are deprecated but should still be supported until the end of 2025.

You will not find the build directory if you look in the CKEditor’s repo, but here’s a good explanation of how to get it: #119 (comment).
The only thing I’d add is that Craft’s CKEditor plugin currently uses v41.0.0, so you might want to start with v41 of the plugin you’re after (for example, to get a specific version of the highlight plugin, you could use npm pack @ckeditor/[email protected]).

I hope this helps!

I’ll close this now, but feel free to reach out if anything’s unclear.

@i-just i-just closed this as completed Sep 5, 2024
@Joorren
Copy link

Joorren commented Dec 23, 2024

@mattfordham did you manage to find a DLL for the Clipboard plugin?
I cannot seem to find a version of the plugin that does include the build folder, only a few versions that do include a dist folder that don't look particularly optimised to use as DLLs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants