8
0
Просмотр исходного кода

Merge branch 'master' into t/553

Aleksander Nowodzinski 8 лет назад
Родитель
Сommit
6b4fe11fb9

+ 1 - 0
CHANGELOG.md

@@ -7,6 +7,7 @@ BREAKING CHANGES:
 
 
 * `@ckeditor/ckeditor5-build-balloon-toolbar` was renamed to `@ckeditor/ckeditor5-build-balloon`.
 * `@ckeditor/ckeditor5-build-balloon-toolbar` was renamed to `@ckeditor/ckeditor5-build-balloon`.
 * `@ckeditor/ckeditor5-editor-balloon-toolbar` was renamed to `@ckeditor/ckeditor5-editor-balloon`.
 * `@ckeditor/ckeditor5-editor-balloon-toolbar` was renamed to `@ckeditor/ckeditor5-editor-balloon`.
+* `@ckeditor/ckeditor5-presets` was renamed to `@ckeditor/ckeditor5-essentials` and the `Article` preset plugin was made a development util. See [ckeditor/ckeditor5-essentials#1](https://github.com/ckeditor/ckeditor5-presets/issues/1).
 
 
 
 
 ## [0.11.0](https://github.com/ckeditor/ckeditor5/compare/v0.10.0...v0.11.0) (2017-09-03)
 ## [0.11.0](https://github.com/ckeditor/ckeditor5/compare/v0.10.0...v0.11.0) (2017-09-03)

+ 18 - 1
docs/api/index.md

@@ -3,4 +3,21 @@ title: API documentation
 category: api-reference
 category: api-reference
 ---
 ---
 
 
-What could we have here?
+Use the navigation tree on the left to navigate through CKEditor API.
+
+## Popular API pages
+
+ * {@link module:core/editor/editorconfig~EditorConfig Configuration Reference} - CKEditor configuration settings explained.
+ * {@link module:editor-classic/classiceditor~ClassicEditor `ClassicEditor`} - The entry point for the Classic editor integration.
+ * {@link module:editor-inline/inlineeditor~InlineEditor `InlineEditor`} - The entry point for the Inline editor integration.
+ * {@link module:editor-balloon/ballooneditor~BalloonEditor `BalloonEditor`} - The entry point for the Balloon editor integration.
+ 
+## Documentation 
+
+ * {@link framework/index CKEditor 5 Framework} – Learn how to develop with CKEditor 5 Framework, customize it and create plugins.
+ * {@link builds/guides/overview CKEditor 5 Builds} – Learn how to install, integrate and configure CKEditor 5 Builds. More complex aspects, like creating custom builds are explained here, too.
+ * {@link features/index Features} – Learn about some of the features included in CKEditor 5 Builds.
+
+## Contribute
+
+CKEditor is an Open Source project and your contribution is most welcome. Feel free to {@link builds/guides/reporting-issues report bugs} or improve the code on [GitHub](https://github.com/ckeditor/ckeditor5). Since CKEditor is localized, you can also help [to translate it](https://www.transifex.com/ckeditor/ckeditor5/). You do not need to be a programmer to contribute to the project!

+ 0 - 0
docs/assets/img/editor-balloon-toolbar.png → docs/assets/img/editor-balloon.png


+ 1 - 1
docs/builds/guides/development/custom-builds.md

@@ -92,7 +92,7 @@ module.exports = {
 
 
 	// Plugins to include in the build.
 	// Plugins to include in the build.
 	plugins: [
 	plugins: [
-		'@ckeditor/ckeditor5-presets/src/essentials',
+		'@ckeditor/ckeditor5-essentials/src/essentials',
 
 
 		'@ckeditor/ckeditor5-autoformat/src/autoformat',
 		'@ckeditor/ckeditor5-autoformat/src/autoformat',
 		'@ckeditor/ckeditor5-basic-styles/src/bold',
 		'@ckeditor/ckeditor5-basic-styles/src/bold',

+ 27 - 2
docs/builds/guides/integration/basic-api.md

@@ -29,7 +29,7 @@ In your HTML page add an element that CKEditor should replace:
 </textarea>
 </textarea>
 ```
 ```
 
 
-Then call {@link module:editor-classic/classiceditor~ClassicEditor#create `ClassicEditor.create()`} to replace `<textarea>` with a {@link builds/guides/overview#Classic-editor Classic editor}:
+Then call {@link module:editor-classic/classiceditor~ClassicEditor#create `ClassicEditor.create()`} to **replace** `<textarea>` with a {@link builds/guides/overview#Classic-editor Classic editor}:
 
 
 ```js
 ```js
 ClassicEditor
 ClassicEditor
@@ -54,7 +54,7 @@ Similarly to the previous example, add an element where CKEditor should initiali
 </div>
 </div>
 ```
 ```
 
 
-Then call {@link module:editor-inline/inlineeditor~InlineEditor#create `InlineEditor.create()`} to attach {@link builds/guides/overview#Inline-editor Inline editor} to a `<div>` element:
+Then call {@link module:editor-inline/inlineeditor~InlineEditor#create `InlineEditor.create()`} to **attach** {@link builds/guides/overview#Inline-editor Inline editor} to a `<div>` element:
 
 
 ```js
 ```js
 InlineEditor
 InlineEditor
@@ -67,6 +67,31 @@ InlineEditor
 	} );
 	} );
 ```
 ```
 
 
+### Example – Balloon editor
+
+The procedure is the same as for Inline editor, the only difference is that we will use {@link module:editor-balloon/ballooneditor~BalloonEditor#create `BalloonEditor.create()`}.
+
+Add an element where CKEditor should initialize (as with ):
+
+```html
+<div id="editor">
+	&lt;p&gt;Here goes the initial content of the editor.&lt;/p&gt;
+</div>
+```
+
+Then call {@link module:editor-balloon/ballooneditor~BalloonEditor#create `BalloonEditor.create()`} to **attach** {@link builds/guides/overview#Balloon-editor Balloon editor} to a `<div>` element:
+
+```js
+BalloonEditor
+	.create( document.querySelector( '#editor' ) )
+	.then( editor => {
+		console.log( editor );
+	} )
+	.catch( error => {
+		console.error( error );
+	} );
+```
+
 <info-box tip>
 <info-box tip>
 	Every editor class may accept different parameters in the `create()` method and may handle initialization differently. For instance, the classic editor will replace a given element with an editor, while the inline editor will use the given element to initialize the editor on it. See each editor's documentation to learn the details.
 	Every editor class may accept different parameters in the `create()` method and may handle initialization differently. For instance, the classic editor will replace a given element with an editor, while the inline editor will use the given element to initialize the editor on it. See each editor's documentation to learn the details.
 
 

+ 1 - 1
mgit.json

@@ -16,13 +16,13 @@
     "@ckeditor/ckeditor5-editor-inline": "ckeditor/ckeditor5-editor-inline",
     "@ckeditor/ckeditor5-editor-inline": "ckeditor/ckeditor5-editor-inline",
     "@ckeditor/ckeditor5-engine": "ckeditor/ckeditor5-engine",
     "@ckeditor/ckeditor5-engine": "ckeditor/ckeditor5-engine",
     "@ckeditor/ckeditor5-enter": "ckeditor/ckeditor5-enter",
     "@ckeditor/ckeditor5-enter": "ckeditor/ckeditor5-enter",
+    "@ckeditor/ckeditor5-essentials": "ckeditor/ckeditor5-essentials",
     "@ckeditor/ckeditor5-heading": "ckeditor/ckeditor5-heading",
     "@ckeditor/ckeditor5-heading": "ckeditor/ckeditor5-heading",
     "@ckeditor/ckeditor5-image": "ckeditor/ckeditor5-image",
     "@ckeditor/ckeditor5-image": "ckeditor/ckeditor5-image",
     "@ckeditor/ckeditor5-link": "ckeditor/ckeditor5-link",
     "@ckeditor/ckeditor5-link": "ckeditor/ckeditor5-link",
     "@ckeditor/ckeditor5-list": "ckeditor/ckeditor5-list",
     "@ckeditor/ckeditor5-list": "ckeditor/ckeditor5-list",
     "@ckeditor/ckeditor5-markdown-gfm": "ckeditor/ckeditor5-markdown-gfm",
     "@ckeditor/ckeditor5-markdown-gfm": "ckeditor/ckeditor5-markdown-gfm",
     "@ckeditor/ckeditor5-paragraph": "ckeditor/ckeditor5-paragraph",
     "@ckeditor/ckeditor5-paragraph": "ckeditor/ckeditor5-paragraph",
-    "@ckeditor/ckeditor5-presets": "ckeditor/ckeditor5-presets",
     "@ckeditor/ckeditor5-theme-lark": "ckeditor/ckeditor5-theme-lark",
     "@ckeditor/ckeditor5-theme-lark": "ckeditor/ckeditor5-theme-lark",
     "@ckeditor/ckeditor5-typing": "ckeditor/ckeditor5-typing",
     "@ckeditor/ckeditor5-typing": "ckeditor/ckeditor5-typing",
     "@ckeditor/ckeditor5-ui": "ckeditor/ckeditor5-ui",
     "@ckeditor/ckeditor5-ui": "ckeditor/ckeditor5-ui",

+ 1 - 1
package.json

@@ -22,13 +22,13 @@
     "@ckeditor/ckeditor5-editor-inline": "^0.2.0",
     "@ckeditor/ckeditor5-editor-inline": "^0.2.0",
     "@ckeditor/ckeditor5-engine": " v0.11.0",
     "@ckeditor/ckeditor5-engine": " v0.11.0",
     "@ckeditor/ckeditor5-enter": "^0.10.0",
     "@ckeditor/ckeditor5-enter": "^0.10.0",
+    "@ckeditor/ckeditor5-essentials": "^0.3.0",
     "@ckeditor/ckeditor5-heading": "^0.10.0",
     "@ckeditor/ckeditor5-heading": "^0.10.0",
     "@ckeditor/ckeditor5-image": "^0.7.0",
     "@ckeditor/ckeditor5-image": "^0.7.0",
     "@ckeditor/ckeditor5-link": "^0.8.0",
     "@ckeditor/ckeditor5-link": "^0.8.0",
     "@ckeditor/ckeditor5-list": "^0.7.0",
     "@ckeditor/ckeditor5-list": "^0.7.0",
     "@ckeditor/ckeditor5-markdown-gfm": "^0.4.4",
     "@ckeditor/ckeditor5-markdown-gfm": "^0.4.4",
     "@ckeditor/ckeditor5-paragraph": "^0.9.0",
     "@ckeditor/ckeditor5-paragraph": "^0.9.0",
-    "@ckeditor/ckeditor5-presets": "^0.3.0",
     "@ckeditor/ckeditor5-theme-lark": "^0.9.0",
     "@ckeditor/ckeditor5-theme-lark": "^0.9.0",
     "@ckeditor/ckeditor5-typing": "^0.10.0",
     "@ckeditor/ckeditor5-typing": "^0.10.0",
     "@ckeditor/ckeditor5-ui": "^0.10.0",
     "@ckeditor/ckeditor5-ui": "^0.10.0",