Skip to content

Commit

Permalink
Merge branch 'master' into i/8640
Browse files Browse the repository at this point in the history
  • Loading branch information
Reinmar committed Mar 8, 2021
2 parents bef0dd2 + bdc9425 commit 9e65219
Show file tree
Hide file tree
Showing 12 changed files with 10 additions and 131 deletions.
18 changes: 8 additions & 10 deletions docs/builds/guides/development/dll-builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,22 @@ DLL builds are based on the [DLL webpack](https://webpack.js.org/plugins/dll-plu

Currently, CKEditor 5 does not come with a ready-to-use DLL build. Using this integration method requires creating it on your own, based on the tools available in the {@link framework/guides/contributing/development-environment CKEditor 5 development environment}.

Follow the [Ship CKEditor 5 DLLs](https://github.com/ckeditor/ckeditor5/issues/9145) issue for updates (and add 👍 ).
Follow the [Ship CKEditor 5 DLLs](https://github.com/ckeditor/ckeditor5/issues/9145) issue for updates (and add 👍 if you are interested in this functionality).

## Anatomy of a DLL build

A DLL build of the editor consists of two parts:

* **Base DLL build**. It is a single JavaScript file that combines contents of several core CKEditor 5 packages: utils, core, engine, ui, clipboard, enter, paragraph, select-all, typing, undo, upload, and widget. These packages are either the framework core, or are features used by nearly all editor installations.
* **DLL-compatible package builds**. Every package that is not part of the Base DLL build is built into a DLL-compatible JavaScript file.
* **Base DLL build**. It is a single JavaScript file that combines the contents of several core CKEditor 5 packages: `utils`, `core`, `engine`, `ui`, `clipboard`, `enter`, `paragraph`, `select-all`, `typing`, `undo`, `upload`, and `widget`. These packages are either the framework core, or are features used by nearly all editor installations.
* **DLL-compatible package builds**. Every package that is not part of the base DLL build is built into a DLL-compatible JavaScript file.

In order to load an editor you need to use the base DLL build plus several DLL-compatible package builds. You will see how to do that later on.
In order to load an editor, you need to use the base DLL build plus several DLL-compatible package builds. You will see how to do that later on.

## Creating a DLL build

In order to create your own base DLL build and DLL-compatible packages builds, all you need to is:
In order to create your own base DLL build and DLL-compatible packages builds, all you need to do is:

1. Setup the {@link framework/guides/contributing/development-environment CKEditor 5 development environment} locally.
1. Set up the {@link framework/guides/contributing/development-environment CKEditor 5 development environment} locally.
2. Run `npm run dll:build`.

The base DLL build can be found in `./build/ckeditor5-dll.js`.
Expand All @@ -49,7 +49,7 @@ This is it.

The exact way to use a DLL build will depend on your system. Presented in this guide is the simplest method that uses the `<script>` tags.

In order to run the editor you need to load the necessary files (base DLL + editor creator + features). These files expose their content in the `CKEditor5` global, using the following format:
In order to run the editor, you need to load the necessary files (base DLL + editor creator + features). These files expose their content in the `CKEditor5` global, using the following format:

```
CKEditor5.packageName.moduleName
Expand All @@ -59,7 +59,7 @@ For example:

```html
<!-- Base DLL build. -->
<!-- Note: it includes ckeditor5-paragraph too. -->
<!-- Note: It includes ckeditor5-paragraph too. -->
<script src="path/to/ckeditor5/build/ckeditor5-dll.js"></script>

<!-- DLL-compatible build of ckeditor5-editor-classic. -->
Expand All @@ -85,8 +85,6 @@ For example:
CKEditor5.basicStyles.Bold,
CKEditor5.basicStyles.Italic,
CKEditor5.autoformat.Autoformat,
CKEditor5.basicStyles.Bold,
CKEditor5.basicStyles.Italic,
CKEditor5.blockQuote.BlockQuote,
CKEditor5.essentials.Essentials,
CKEditor5.heading.Heading,
Expand Down
2 changes: 1 addition & 1 deletion docs/builds/guides/migration/migration-to-26.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Listed below are the most important changes that require your attention when upg

## Soft requirements

While [allowing to extend builds](https://github.com/ckeditor/ckeditor5/issues/8395) with additional plugins without rebuilding the bundle (a concept also called "DLLs"), certain sets of plugins had to be decoupled. This has lead to the introduction of the "soft requirements".
While [allowing to extend builds](https://github.com/ckeditor/ckeditor5/issues/8395) with additional plugins without rebuilding the bundle (a concept also called {@link builds/guides/development/dll-builds "DLLs"}), certain sets of plugins had to be decoupled. This has lead to the introduction of the "soft requirements".

Before, each plugin had its direct requirements that would be automatically loaded by the editor before the plugin is loaded. These plugins were specified in the `static get() {}` callback of a plugin class in the form of plugin constructors (dependencies).

Expand Down
Binary file added docs/features/resource.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 0 additions & 32 deletions packages/ckeditor-cloud-services-core/CHANGELOG.md

This file was deleted.

4 changes: 0 additions & 4 deletions packages/ckeditor-cloud-services-core/CONTRIBUTING.md

This file was deleted.

17 changes: 0 additions & 17 deletions packages/ckeditor-cloud-services-core/LICENSE.md

This file was deleted.

14 changes: 0 additions & 14 deletions packages/ckeditor-cloud-services-core/README.md

This file was deleted.

28 changes: 0 additions & 28 deletions packages/ckeditor-cloud-services-core/package.json

This file was deleted.

10 changes: 0 additions & 10 deletions packages/ckeditor-cloud-services-core/tests/index.js

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<textarea id="snippet-link-decorators">
&lt;p>
An &lt;a href="https://ckeditor.com">external page&lt;/a> and a
&lt;a download="download" href&#61;"image.png">downloadable resource&lt;/a>.
&lt;a download="download" href="resource.png">downloadable resource&lt;/a>.
&lt;/p>
</textarea>

Expand Down
10 changes: 0 additions & 10 deletions scripts/docs/getrealimportpath.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,6 @@

/* eslint-env node */

const NON_CKEDITOR5_PACKAGES = {
'cloud-services-core': 'ckeditor-cloud-services-core'
};

module.exports = function getRealImportPath( modulePath ) {
for ( const shortPkgName of Object.keys( NON_CKEDITOR5_PACKAGES ) ) {
if ( modulePath.startsWith( shortPkgName ) ) {
return modulePath.replace( new RegExp( '^' + shortPkgName ), `@ckeditor/${ NON_CKEDITOR5_PACKAGES[ shortPkgName ] }/src` );
}
}

return modulePath.replace( /^([^/]+)\//, '@ckeditor/ckeditor5-$1/src/' );
};
4 changes: 0 additions & 4 deletions scripts/release/changelog.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,6 @@ Promise.resolve()
return 'https://www.npmjs.com/search?q=keywords%3Ackeditor5-build%20maintainer%3Ackeditor';
}

if ( name === 'cloud-services-core' ) {
return 'https://www.npmjs.com/package/@ckeditor/ckeditor-cloud-services-core';
}

return 'https://www.npmjs.com/package/@ckeditor/ckeditor5-' + name;
},
externalRepositories: [
Expand Down

0 comments on commit 9e65219

Please sign in to comment.