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.

Sign up for GitHub

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

Align docs to the new Translation Service #694

Merged
merged 8 commits into from
Nov 30, 2017
Merged

Align docs to the new Translation Service #694

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
541f111
Aligned docs to the new Translation Service.
ma2ciek Nov 28, 2017
e4a6e10
Docs fixes.
ma2ciek Nov 28, 2017
0f688c1
Changed `lang` to `languages` in docs.
ma2ciek Nov 28, 2017
2e7b446
Changes to 'Setting the UI language' feature documentation.
szymonkups Nov 29, 2017
876826d
Removed npm-debug.log.
ma2ciek Nov 29, 2017
ad88199
Docs improvements.
ma2ciek Nov 29, 2017
7816c4d
Docs improvements.
ma2ciek Nov 29, 2017
b776391
Bumped up `ckeditor5-dev-webpack-plugin`.
ma2ciek Nov 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions docs/features/ui-language.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,57 @@ 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, you need to load the editor together with the preferred language:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can specify, that English will be the main language at CDN.


```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/`.
Single language can be imported directly to your code by `'@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 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This guide needs to be pretty much rewritten rather than patched. Since the whole picture changed dramatically we need to put focus on different things.

  1. The current intro can stay.

  2. But then we should explain how to initialize the editor from CDN/zip/npm with a different language. This is what most people will want to do. Please also review other guides like installation.md and other places where we list files available in a build because that list needs to be updated (and perhaps link to the ui-language.md guide):

    image

  3. Then we can provide a few more details on what other options people have:

    • compiling an optimised editor (single language case),
    • compiling a subset of languages (TBH, I'm not sure what's the use case for that – perhaps speeding up the process and reducing the number of files – but let's mention it anyway),
    • handling multiple entry points scenario (as @ma2ciek noticed that has certain limitations)

  4. At the end we can mention that compiling editor translations is only available for Webpack and we will be extending support for other bundlers in the future. If we want to mention those tickets about translations services we should explain why we mention them. Something like – if you'd like to tinker with one of the bundlers you can read about CKEditor 5's translation service here and here.

Expand Down
45 changes: 45 additions & 0 deletions npm-debug.log
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
0 info it worked if it ends with ok
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dunno why I was reading this commit but this caught my attention :): npm-debug.log

1 verbose cli [ '/usr/local/bin/node', '/usr/local/bin/npm', 'run', 'docs' ]
2 info using npm@3.10.10
3 info using node@v6.10.0
4 verbose run-script [ 'predocs', 'docs', 'postdocs' ]
5 info lifecycle ckeditor5@1.0.0-alpha.2~predocs: ckeditor5@1.0.0-alpha.2
6 silly lifecycle ckeditor5@1.0.0-alpha.2~predocs: no script for predocs, continuing
7 info lifecycle ckeditor5@1.0.0-alpha.2~docs: ckeditor5@1.0.0-alpha.2
8 verbose lifecycle ckeditor5@1.0.0-alpha.2~docs: unsafe-perm in lifecycle true
9 verbose lifecycle ckeditor5@1.0.0-alpha.2~docs: PATH: /usr/local/lib/node_modules/npm/bin/node-gyp-bin:/home/szymon/projects/ckeditor5/node_modules/.bin:/home/szymon/bin:/home/szymon/.local/bin:/home/szymon/bin:/home/szymon/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
10 verbose lifecycle ckeditor5@1.0.0-alpha.2~docs: CWD: /home/szymon/projects/ckeditor5
11 silly lifecycle ckeditor5@1.0.0-alpha.2~docs: Args: [ '-c', 'node ./scripts/docs/build-docs.js' ]
12 silly lifecycle ckeditor5@1.0.0-alpha.2~docs: Returned: code: 1 signal: null
13 info lifecycle ckeditor5@1.0.0-alpha.2~docs: Failed to exec docs script
14 verbose stack Error: ckeditor5@1.0.0-alpha.2 docs: `node ./scripts/docs/build-docs.js`
14 verbose stack Exit status 1
14 verbose stack at EventEmitter.<anonymous> (/usr/local/lib/node_modules/npm/lib/utils/lifecycle.js:255:16)
14 verbose stack at emitTwo (events.js:106:13)
14 verbose stack at EventEmitter.emit (events.js:191:7)
14 verbose stack at ChildProcess.<anonymous> (/usr/local/lib/node_modules/npm/lib/utils/spawn.js:40:14)
14 verbose stack at emitTwo (events.js:106:13)
14 verbose stack at ChildProcess.emit (events.js:191:7)
14 verbose stack at maybeClose (internal/child_process.js:877:16)
14 verbose stack at Process.ChildProcess._handle.onexit (internal/child_process.js:226:5)
15 verbose pkgid ckeditor5@1.0.0-alpha.2
16 verbose cwd /home/szymon/projects/ckeditor5
17 error Linux 4.13.0-17-generic
18 error argv "/usr/local/bin/node" "/usr/local/bin/npm" "run" "docs"
19 error node v6.10.0
20 error npm v3.10.10
21 error code ELIFECYCLE
22 error ckeditor5@1.0.0-alpha.2 docs: `node ./scripts/docs/build-docs.js`
22 error Exit status 1
23 error Failed at the ckeditor5@1.0.0-alpha.2 docs script 'node ./scripts/docs/build-docs.js'.
23 error Make sure you have the latest version of node.js and npm installed.
23 error If you do, this is most likely a problem with the ckeditor5 package,
23 error not with npm itself.
23 error Tell the author that this fails on your system:
23 error node ./scripts/docs/build-docs.js
23 error You can get information on how to open an issue for this project with:
23 error npm bugs ckeditor5
23 error Or if that isn't available, you can get their info via:
23 error npm owner ls ckeditor5
23 error There is likely additional logging output above.
24 verbose exit [ 1, true ]