Skip to content

Commit

Permalink
Merge branch 'master' into i/4600
Browse files Browse the repository at this point in the history
  • Loading branch information
mlewand committed Oct 19, 2020
2 parents ec5b8b7 + 608baa9 commit bd97c26
Show file tree
Hide file tree
Showing 66 changed files with 2,457 additions and 306 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Other than that, we focused on bug fixes and stability improvements. Some highli

Please note that there are some **major breaking changes**. Be sure to review them before upgrading.

<!-- TODO: Add a link to the blog post. -->
Read more in the blog post: https://ckeditor.com/blog/CKEditor-5-v23.0.0-with-pagination-feature-list-styles-and-improved-image-upload/

### Collaboration features

Expand Down
2 changes: 1 addition & 1 deletion docs/builds/guides/integration/advanced-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ index c57e371..04fc9fe 100644
Once you changed the `src/ckeditor.js` and `webpack.config.js` files it is time to rebuild the build:

```bash
yarn run build
npm run build
```

Finally, when webpack finishes compiling your super build, you can change the `samples/index.html` file to test both editors:
Expand Down
2 changes: 2 additions & 0 deletions docs/features/image-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ The software that makes the image upload possible is called an **upload adapter*
* [**Official upload adapters**](#official-upload-adapters) &ndash; There are several features providing upload adapters developed and maintained by the CKEditor team. Pick the best one for your integration and let it handle the image upload in your project.
* [**Custom upload adapters**](#implementing-your-own-upload-adapter) &ndash; Create your own upload adapter from scratch using the open API architecture of CKEditor 5.

Read our comprehensive blog post about [Managing images with CKEditor 5](https://ckeditor.com/blog/managing-images-with-ckeditor-5/) to find out more details about image upload and management and to compare the available options.

<info-box>
If you want to get a better look under the hood and learn more about the upload process, you can check out the {@link framework/guides/deep-dive/upload-adapter "Custom image upload adapter" deep dive guide} covering that topic.
</info-box>
Expand Down
4 changes: 2 additions & 2 deletions docs/features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ The number of features available for CKEditor 5 is constantly growing. Plenty of
Each rich-text editor feature is presented on a separate page, with one or more working demos showcasing a feature along with some customization ideas that you can use in your implementation.

<info-box>
**In most demos the number of features enabled is limited** to make the currently highlighted piece of functionality stand out more. However, in your CKEditor 5 WYSIWYG editor implementation you are free to choose and combine any features you like from those available.
</info-box>
**In most demos the number of features enabled is limited** to make the currently highlighted piece of functionality stand out more. However, in your CKEditor 5 WYSIWYG editor implementation you are free to choose and combine any features you like from those available. This can be easily and conveniently done in the [CKEditor 5 online builder](https://ckeditor.com/ckeditor-5/online-builder/).
</info-box>

## Looking for more?

Expand Down
12 changes: 9 additions & 3 deletions docs/framework/guides/contributing/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,15 @@ This task accepts the following arguments:

* `--skip-api` &ndash; Skips building the API documentation (which takes the majority of the total time).
* `--skip-snippets` &ndash; Skips building live snippets.
* `--snippets=snippet-name` &ndash; Snippets to build (accepts glob patterns). If a snippet that you want to build uses another snippet as a source that provides an editor instance, you need to specify both snippets. See examples:
- `--snippets=features/*` - all snippets that starts with `features/` in their names will be built,
- `--snippets=classic-editor,build-classic-source` - all snippets that contains the specified strings in their names will be built.
* `--snippets=snippet-name` &ndash; Snippets to build. Accepts glob patterns that are matched against snippet names used in `{@snippet ...}` tags. Examples:

```
--snippets=image // matches roughly {@snippet *image*}
--snippets="features/*" // matches roughly {@snippet *features/*}
--snippets=classic-editor,build-classic-source
```

Note: If a snippet that you want to build uses another snippet as a source that provides an editor instance, you need to specify both snippets (e.g. `--files=features/default-headings,build-classic-source`).
* `--skip-validation` &ndash; Skips the final link validation.
* `--watch` &ndash; Runs the documentation generator in a watch mode. It covers guides but it does not cover API docs.
* `--production` &ndash; Minifies the assets and performs other actions which are unnecessary during CKEditor 5 development.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ meta-description: Learn how to install, integrate, configure and develop CKEdito
<dl><dt>{@link builds/guides/overview CKEditor 5 Builds documentation}</dt><dd>Learn how to install, integrate and configure CKEditor 5 Builds. More complex aspects, like creating custom builds, are explained here, too.</dd>
<dt>{@link framework/guides/overview CKEditor 5 Framework documentation}</dt><dd>Learn how to work with CKEditor 5 Framework, customize it, create your own plugins and custom editors, change the UI or even bring your own UI to the editor.</dd>
<dt>{@link examples/index CKEditor 5 Examples}</dt><dd>Try out all CKEditor 5 Builds. See some of the possible customizations of CKEditor.</dd>
<dt>{@link features/index CKEditor 5 Features}</dt><dd>Learn about selected features included in CKEditor 5 Builds.</dd>
<dt>{@link features/index CKEditor 5 Features}</dt><dd>Learn about the features available for CKEditor 5 &mdash; both the ones included in Builds and a plethora of others.</dd>
<dt>{@link api/index CKEditor 5 API Reference}</dt><dd>A complete API documentation.</dd></dl>

## Contribute
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@
"http-server": "^0.12.3",
"husky": "^4.2.5",
"lint-staged": "^10.2.6",
"marked": "^1.1.1",
"mini-css-extract-plugin": "^0.9.0",
"minimatch": "^3.0.4",
"mkdirp": "^1.0.4",
Expand Down
9 changes: 9 additions & 0 deletions packages/ckeditor5-alignment/docs/features/text-alignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ The {@link module:alignment/alignment~Alignment} feature enables support for tex

{@snippet features/text-alignment}

## Related features

There are more CKEditor 5 features that can help you organize your content:
* {@link features/title Document title} &ndash; Clearly divide your content into a title and body.
* {@link features/headings Headings} &ndash; Split your content into logical sections.
* {@link features/indent Block indentation} &ndash; Organize your content into visually separated blocks, indent crucial paragraphs, etc.
* {@link features/block-quote Block quote} &ndash; Include block quotations or pull quotes in the rich-text content.
* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.

## Configuring alignment options

It is possible to configure which alignment options are available in the editor by setting the {@link module:alignment/alignment~AlignmentConfig#options `alignment.options`} configuration option. You can choose from `'left'`, `'right'`, `'center'` and `'justify'`.
Expand Down
11 changes: 10 additions & 1 deletion packages/ckeditor5-basic-styles/docs/features/basic-styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ category: features

{@snippet features/build-basic-styles-source}

The {@link api/basic-styles basic styles} package provides text formatting features such as bold, italic, underline, strikethrough, subscript, superscript, and code.
The {@link api/basic-styles basic styles} feature allows you to apply the most frequently used formatting indispensable for content creation. This package provides essential text styling features such as bold, italic, underline, strikethrough, subscript, superscript, and code. Coupled with more [formatting features](#related-features), these serve as a base for any WYSIWYG editor toolset.

<info-box info>
All basic text styles can be removed with the {@link features/remove-format remove format} feature.
Expand All @@ -15,6 +15,15 @@ The {@link api/basic-styles basic styles} package provides text formatting featu

{@snippet features/basic-styles}

## Related features

Check out also these CKEditor 5 features to gain better control over your content style and format:
* {@link features/font Font styles} &ndash; Easily and efficiently control the font {@link features/font#configuring-the-font-family-feature family}, {@link features/font#configuring-the-font-size-feature size}, {@link features/font#configuring-the-font-color-and-font-background-color-features text or background color}.
* {@link features/text-alignment Text alignment} &ndash; Because it does matter whether the content is left, right, centered or justified.
* {@link features/code-blocks Code blocks} &ndash; Insert longer, multiline code listings, expanding the inline code style greatly.
* {@link features/highlight Highlight} &ndash; Mark important words and passages, aiding a review or drawing attention to specific parts of content.
* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.

## Available text styles

| Style feature | {@link framework/guides/architecture/core-editor-architecture#commands Command} name | {@link builds/guides/integration/configuration#toolbar-setup Toolbar} component name | Output element |
Expand Down
5 changes: 3 additions & 2 deletions packages/ckeditor5-block-quote/docs/features/block-quote.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ Use the editor below to see the block quote plugin in action.

Here are some other CKEditor 5 features that you can use similarly to the block quote plugin to structure your text better:

* The {@link features/indent block indentation feature} allows you to set indentation for text blocks such as paragraphs or lists.
* The {@link features/code-blocks code block feature} allows for insertion of various code listings.
* {@link features/indent Block indentation} &ndash; Set indentation for text blocks such as paragraphs or lists.
* {@link features/code-blocks Code block} &ndash; Insert longer, multiline code listings.
* {@link features/text-alignment Text alignment} &ndash; Align your content left, right, center it or justify.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion packages/ckeditor5-ckfinder/docs/features/ckfinder.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This feature can be used in the rich-text editor in two different ways:

### Image upload only

This demo shows the integration where the file manager's server connector handles [the image upload](#configuring-the-full-integration) only:
This demo shows the integration where the file manager's server connector handles [the image upload](#configuring-the-image-upload-only) only:

* Paste the image directly into the rich-text editor content and it will be automatically uploaded using the server-side connector.
* Use the "Insert image" button in the toolbar to insert an image.
Expand Down
7 changes: 7 additions & 0 deletions packages/ckeditor5-code-block/docs/features/code-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ The {@link module:code-block/codeblock~CodeBlock} feature allows inserting and e

{@snippet features/code-block}

## Related features

Here are some CKEditor 5 features that you may find helpfully similar:
* {@link features/basic-styles Basic text styles} &ndash; Use the `code` formatting for short inline code chunks.
* {@link features/block-quote Block quote} &ndash; Include block quotations or pull quotes in your rich-text content.
* {@link features/indent Block indentation} &ndash; Set indentation for text blocks such as paragraphs or lists.

## Configuring code block languages

Each code block can be assigned a programming language. The language of the code block is represented as a CSS class of the `<code>` element, both when editing and in the editor data:
Expand Down
8 changes: 3 additions & 5 deletions packages/ckeditor5-core/src/plugincollection.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
* @module core/plugincollection
*/

/* globals console */

import CKEditorError, { attachLinkToDocumentation } from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
import CKEditorError, { logError } from '@ckeditor/ckeditor5-utils/src/ckeditorerror';

import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
import mix from '@ckeditor/ckeditor5-utils/src/mix';
Expand Down Expand Up @@ -207,7 +205,7 @@ export default class PluginCollection {
const errorId = 'plugincollection-plugin-not-found';

// Log the error, so it's more visible on the console. Hopefully, for better DX.
console.error( attachLinkToDocumentation( errorId ), { plugins: missingPlugins } );
logError( errorId, { plugins: missingPlugins } );

return Promise.reject( new CKEditorError( errorId, context, { plugins: missingPlugins } ) );
}
Expand Down Expand Up @@ -249,7 +247,7 @@ export default class PluginCollection {
* @error plugincollection-load
* @param {String} plugin The name of the plugin that could not be loaded.
*/
console.error( attachLinkToDocumentation( 'plugincollection-load' ), { plugin: PluginConstructor } );
logError( 'plugincollection-load', { plugin: PluginConstructor } );

throw err;
} );
Expand Down
1 change: 1 addition & 0 deletions packages/ckeditor5-engine/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"@ckeditor/ckeditor5-table": "^23.0.0",
"@ckeditor/ckeditor5-theme-lark": "^23.0.0",
"@ckeditor/ckeditor5-typing": "^23.0.0",
"@ckeditor/ckeditor5-ui": "^23.0.0",
"@ckeditor/ckeditor5-undo": "^23.0.0",
"@ckeditor/ckeditor5-widget": "^23.0.0"
},
Expand Down
Loading

0 comments on commit bd97c26

Please sign in to comment.