Skip to content

Commit

Permalink
Showing 5 changed files with 95 additions and 18 deletions.
8 changes: 4 additions & 4 deletions docs/builds/guides/development/custom-builds.md
Original file line number Diff line number Diff line change
@@ -106,12 +106,12 @@ module.exports = {
'../relative/path/to/some/othercustomplugin'
],

// UI language. Language codes follow the https://en.wikipedia.org/wiki/ISO_639-1 format.
language: 'en',

// Editor configuration.
config: {
toolbar: [ 'headings', 'bold', 'italic', 'custombutton' ]
toolbar: [ 'headings', 'bold', 'italic', 'custombutton' ],

// UI language. Language codes follow the https://en.wikipedia.org/wiki/ISO_639-1 format.
language: 'en'
}
};
```
8 changes: 2 additions & 6 deletions docs/builds/guides/integration/advanced-setup.md
Original file line number Diff line number Diff line change
@@ -11,18 +11,14 @@ In this guide, we would like to show you ways to closer integrate CKEditor with

## Bundler

CKEditor 5 is currently built using [webpack](https://webpack.js.org) (>=2.x.x). All builds, examples and demos are generated using this bundler. It should also be possible to build CKEditor using other bundlers (if they are configured properly), such as [Rollup](https://github.com/rollup/rollup) or [Browserify](http://browserify.org/) but these setups are not officially supported yet. Also, the [`@ckeditor/ckeditor5-dev-webpack-plugin`](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-webpack-plugin) that allows to localize the editor is only available for webpack. More work on this subject will be done after v1.0.0.
CKEditor 5 is currently built using [webpack](https://webpack.js.org) (>=3.x.x). All builds, examples and demos are generated using this bundler. It should also be possible to build CKEditor using other bundlers (if they are configured properly), such as [Rollup](https://github.com/rollup/rollup) or [Browserify](http://browserify.org/) but these setups are not officially supported yet. Also, the [`@ckeditor/ckeditor5-dev-webpack-plugin`](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-webpack-plugin) that allows to localize the editor is only available for webpack. More work on this subject will be done after v1.0.0.

Therefore, **a prerequisite to this guide is that you are using webpack as your build tool**.

## Scenario 1: Integrating existing builds

This is the simplest scenario. It assumes that you want to use {@link builds/guides/overview#Available-builds one of the existing builds} "as-is" (you can, of course, still {@link builds/guides/integration/configuration configure the editor}). It also gives the fastest build times.

<info-box>
At the current stage, builds are only available in English. {@link features/ui-language Setting editor UI language} requires rebuilding the editor which means that this scenario is quite limited.
</info-box>

First, install the build of your choice {@link builds/guides/integration/installation#npm from npm}:

```bash
@@ -119,7 +115,7 @@ module.exports = {

new CKEditorWebpackPlugin( {
// See https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/features/ui-language.html
languages: [ 'pl' ]
language: 'pl'
} )
],

93 changes: 87 additions & 6 deletions docs/features/ui-language.md
Original file line number Diff line number Diff line change
@@ -13,9 +13,60 @@ See the demo of the editor in German:

{@snippet features/ui-language}

## Loading additional languages from CDN, npm and zip file

You can load additional languages using:
* [CDN](#CDN),
* [npm](#npm),
* [Zip download](#Zip).

Next, configure the editor to use chosen language:

```js
ClassicEditor
.create( document.querySelector( '#editor' ), {
language: 'de'
} )
.then( editor => {
console.log( editor );
} )
.catch( error => {
console.error( error );
} );
```

### CDN

To use different language than default one (English), you need to load the editor together with the preferred language:

```html
<script src="https://cdn.ckeditor.com/ckeditor5/[version.number]/[distribution]/ckeditor.js"></script>
<script src="https://cdn.ckeditor.com/ckeditor5/[version.number]/[distribution]/lang/de.js"></script>
```

See {@link builds/guides/integration/installation#CDN CDN installation guides} for more information.

### npm

After installing the build from npm, languages will be available at `node_modules/@ckeditor/ckeditor5-build-[name]/build/lang/[lang].js`.
Single language can be loaded directly to your code by importing `'@ckeditor/ckeditor5-build-[name]/build/lang/de.js'`.

See {@link builds/guides/integration/installation#npm npm installation guides} for more information.

### Zip

All additional languages are included in `.zip` file. You need to include `ckeditor.js` file together with language file:

```js
<script src="[ckeditor-path]/ckeditor.js"></script>
<script src="[ckeditor-path]/lang/de.js"></script>
```

See {@link builds/guides/integration/installation#Zip-download zip installation guides} for more information.

## Building the editor using a specific language

Currently, it is only possible to change the UI language at the build stage. A single build of the editor supports only the language which was defined in the [CKEditor 5 webpack plugin](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-webpack-plugin)'s configuration.
Currently, it is possible to change the UI language at the build stage and after the build. A single build of the editor supports the language which was defined in the [CKEditor 5 webpack plugin](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-webpack-plugin)'s configuration. See the whole translation process to see how you can change the language later.

If you use one of the {@link builds/index predefined editor builds}, refer to {@link builds/guides/development/custom-builds Creating custom builds} to learn how to change the language of your build.

@@ -37,19 +88,49 @@ If you build CKEditor from scratch or integrate it directly into your applicatio
// Define webpack plugins ...
plugins: [
new CKEditorWebpackPlugin( {
// Note: The plugin is currently able to build just one language at a time.
languages: [ 'pl' ]
// Main language that will be built in to the main bundle.
language: 'en',

// Additional languages that will be emitted to the `outputDirectory`.
// This option can be set to array of language codes or `'all'` to build all found languages.
// The bundle is optimized for one language when this option is omitted.
additionalLanguages: 'all',

// outputDirectory - optional directory for emitted translations, `'lang'` by default, relative to the webpack's output.

// strict - will cause the building process to fail if an error is found during the building process.

// verbose - will cause logging all warnings into the console
} ),

// Other webpack plugins...
]
// ...
```

3. Run webpack. The CKEditor plugin for webpack will replace the {@link module:utils/locale~Locale#t `t()`} function calls used in the source code with localized language strings.
3. Run webpack. If the `additionalLanguages` option is not set, the CKEditor plugin for webpack will replace the {@link module:utils/locale~Locale#t `t()`} function call parameters used in the source code with localized language strings. Otherwise the CKEditor plugin for webpack will replace the {@link module:utils/locale~Locale#t `t()`} function call parameters with short ids and emit the translation files that should land in the `'lang'` directory (or different, if the `outputDirectory` option is specified).

4. If you want to change the language after the build ends, you will need to edit the `index.html` file, add the translation file and set the UI language to the target one.

```html
<script src="../build/ckeditor.js"></script>
<script src="../build/lang/pl.js"></script>
<script>
ClassicEditor
.create( document.querySelector( '#editor' ), {
language: 'pl'
} )
.then( editor => {
window.editor = editor;
} )
.catch( err => {
console.error( err.stack );
} );
</script>
```

<info-box>
We are aware that the current localization method is not sufficient for all needs. It neither supports different bundlers (e.g. Rollup or Browserify) nor building multiple languages (to make it possible to pick one at runtime). We will be extending the localization possiblities in the near future.
We are aware that the current localization method is not sufficient for all needs. It doesn't support different bundlers (e.g. Rollup or Browserify). We will be extending the localization possibilities in the future.

You can read more about the used techniques and future plans in the ["Implement translation services" issue](https://github.com/ckeditor/ckeditor5/issues/387).
You can read more about the used techniques in the ["Implement translation services" issue](https://github.com/ckeditor/ckeditor5/issues/387) and ["Implement translation services v2" issue](https://github.com/ckeditor/ckeditor5/issues/624).
</info-box>
2 changes: 1 addition & 1 deletion scripts/docs/snippet-adapter/package.json
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
"name": "ckeditor5-snippet-adapter",
"private": true,
"dependencies": {
"@ckeditor/ckeditor5-dev-webpack-plugin": "^2.0.18",
"@ckeditor/ckeditor5-dev-webpack-plugin": "^3.0.0",
"babel-minify-webpack-plugin": "^0.2.0",
"css-loader": "^0.28.7",
"extract-text-webpack-plugin": "^3.0.0",
2 changes: 1 addition & 1 deletion scripts/docs/snippet-adapter/snippetadapter.js
Original file line number Diff line number Diff line change
@@ -88,7 +88,7 @@ function getWebpackConfig( config ) {
const plugins = [
new ExtractTextPlugin( 'snippet.css' ),
new CKEditorWebpackPlugin( {
languages: [ config.language || 'en' ]
language: config.language || 'en'
} ),
new webpack.BannerPlugin( {
banner: bundler.getLicenseBanner(),

0 comments on commit 0a97bbe

Please sign in to comment.