8
0
فهرست منبع

Docs: Installation, Basic API, Configuration, Plugins reviewed.

Anna Tomanek 8 سال پیش
والد
کامیت
7d6a18c92d

+ 15 - 15
docs/builds/guides/integration/basic-api.md

@@ -9,21 +9,21 @@ order: 20
 
 ## Creators
 
-Each CKEditor 5 build provides a class that handles the creation of editor instances inside a page. For this reason they’re called “creators”. Every creator comes with a static `create()` method.
+Each CKEditor 5 build provides a class that handles the creation of editor instances inside a page. For this reason they are called "creators". Every creator comes with a static `create()` method.
 
 The following are creator class names for each build:
 
-* Classic Editor: {@link module:editor-classic/classiceditor~ClassicEditor}
-* Inline Editor: {@link module:editor-inline/inlineeditor~InlineEditor}
-* Medium-like Editor: {@link module:editor-medium-like/mediumlikeeditor~MediumLikeEditor}
+* Classic Editor – {@link module:editor-classic/classiceditor~ClassicEditor}
+* Inline Editor – {@link module:editor-inline/inlineeditor~InlineEditor}
+* Medium-like Editor – {@link module:editor-medium-like/mediumlikeeditor~MediumLikeEditor}
 
-Most of the examples in the documentation use the `ClassicEditor` class, but things should work in similar way with other creator classes.
+Most of the examples in the documentation use the `ClassicEditor` class, but things should work in a similar way with other creator classes.
 
 Because builds are distributed as [UMD modules](https://github.com/umdjs/umd), these classes can be retrieved:
 
-* by [CommonJS](http://wiki.commonjs.org/wiki/CommonJS) compatible loader (e.g. [Webpack](https://webpack.js.org) or [Browserify](http://browserify.org/)),
+* by a [CommonJS](http://wiki.commonjs.org/wiki/CommonJS)-compatible loader (e.g. [Webpack](https://webpack.js.org) or [Browserify](http://browserify.org/)),
 * by [RequireJS](http://requirejs.org/) (or any other AMD library),
-* from the global namespace if none of the above loaders is not available.
+* from the global namespace if none of the above loaders is available.
 
 For example:
 
@@ -41,13 +41,13 @@ require( '/(ckeditor path)/build/ckeditor.js', ClassicEditor => {
 ClassicEditor.create; // [Function]
 ```
 
-Having the above in mind, depending on which build you’re using, creating an editor in the page is a breeze:
+Depending on which build you are using, creating an editor in the page is then a breeze:
 
-In the HTML:
+In the HTML code:
 
 ```html
 <textarea id="text-editor">
-	&lt;p&gt;Here goes the initial contents of the editor.&lt;/p&gt;
+	&lt;p&gt;Here goes the initial content of the editor.&lt;/p&gt;
 </textarea>
 ```
 
@@ -63,21 +63,21 @@ ClassicEditor.create( document.querySelector( '#text-editor' ) )
 	} );
 ```
 
-In the above case, the `<textarea>` element is hidden and replaced with an editor. The `<textarea>` data is used to initialize the editor contents. A `<div>` element could have been used in the same fashion.
+In the above case, the `<textarea>` element is hidden and replaced with an editor. The `<textarea>` data is used to initialize the editor content. A `<div>` element can be used in the same fashion.
 
 <side-box info>
 	Every creator may accept different parameters and 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.
 
-	The interface of the editor class isn't enforced either. Since different implementations of editors may vary heavily in terms of functionality, the editor class implementers have full freedom regarding the API. Therefore, the examples in this guide may not work with some editor classes.
+	The interface of the editor class is not enforced either. Since different implementations of editors may vary heavily in terms of functionality, the editor class implementers have full freedom regarding the API. Therefore, the examples in this guide may not work with some editor classes.
 </side-box>
 
 ## Interacting with the editor
 
-Once the editor is created, it is possible to interact with it through its API. The `editor` variable, from the above examples, should enable that.
+Once the editor is created, it is possible to interact with it through its API. The `editor` variable from the examples above should enable that.
 
 ### Setting the editor data
 
-To replace the editor contents with new data, just use the `setData` method:
+To replace the editor content with new data, just use the `setData` method:
 
 ```js
 editor.setData( '<p>Some text.</p>' );
@@ -85,7 +85,7 @@ editor.setData( '<p>Some text.</p>' );
 
 ### Getting the editor data
 
-If the editor contents need to be retrieved for any reason, like for the scope of sending it to the server through an Ajax call, simply use the `getData` method:
+If the editor content needs to be retrieved for any reason, like for sending it to the server through an Ajax call, simply use the `getData` method:
 
 ```js
 const data = editor.getData();

+ 8 - 8
docs/builds/guides/integration/configuration.md

@@ -1,7 +1,7 @@
 ---
 # Scope:
 # * Introduction on how to set configurations.
-# * Introduction on the top/must-know configurations.
+# * Introduction to the top and must-know configurations.
 # * Point where to find the list of configuration options.
 
 title: Configuration
@@ -9,7 +9,7 @@ category: builds-integration
 order: 30
 ---
 
-When creating an editor in your page, it is possible to setup configurations that changes many of its aspects. For example:
+When creating an editor in your page, it is possible to set up configurations that change many of its aspects. For example:
 
 ```js
 ClassicEditor
@@ -22,11 +22,11 @@ ClassicEditor
 	} );
 ```
 
-As you can see, configurations are set by a simple JavaScript object passed to the editor creator class. It works in the same fashion when the create method is used instead.
+As you can see, configurations are set by a simple JavaScript object passed to the editor creator class. It works in the same way when the `create()` method is used instead.
 
 ## Enabling features
 
-Builds come with all features included in the distribution package enabled by default. Theyre defined as plugins for CKEditor.
+Builds come with all features included in the distribution package enabled by default. They are defined as plugins for CKEditor.
 
 In some cases, you may need to have different editor setups in your application, all based on the same build. For that purpose, you need to control the plugins available in an editor at runtime. The following are a few examples:
 
@@ -53,7 +53,7 @@ ClassicEditor
 ```
 
 <side-box tip>
-	If a build contains too many or too few features, the best approach is creating a custom build instead of simply using configurations.
+	If a build contains too many or too few features, the best approach is to create a custom build instead of simply using configurations.
 </side-box>
 
 ### List of plugins
@@ -66,9 +66,9 @@ ClassicEditor.build.plugins.map( plugin => plugin.pluginName );
 
 ## Toolbar setup
 
-On builds that contain toolbars, an optimal default configuration is defined for it. You may need a different toolbar arrangement though and this can be achieved through configuration.
+In builds that contain toolbars an optimal default configuration is defined for it. You may need a different toolbar arrangement, though, and this can be achieved through configuration.
 
-Each creator may have a different toolbar configuration scheme, so it is recommended to check the creator API documentation. In any case, the following example may give you a general idea of it:
+Each creator may have a different toolbar configuration scheme, so it is recommended to check the creator API documentation. In any case, the following example may give you a general idea:
 
 ```js
 ClassicEditor
@@ -81,7 +81,7 @@ ClassicEditor
 ```
 
 <side-box tip>
-	The above is a strict UI related configuration. Removing a toolbar item don’t remove the feature from the editor internals. If you goal with the toolbar configuration is removing features, the right solution is removing their relative plugins. Check [Enabling features](#Enabling-features) above for more information.
+	The above is a strict UI-related configuration. Removing a toolbar item does not remove the feature from the editor internals. If your goal with the toolbar configuration is to remove features, the right solution is to remove their relative plugins. Check [Enabling features](#Enabling-features) above for more information.
 </side-box>
 
 <!-- TODO Add section about other configuration options. -->

+ 12 - 12
docs/builds/guides/integration/installation.md

@@ -9,25 +9,25 @@ order: 10
 
 ## Download options
 
-The goal of installing any of the CKEditor 5 builds is enabling you to using its API when integrating it inside your application. For that purpose, several options are available:
+The goal of installing any of the CKEditor 5 builds is to enable you to use its API when integrating it inside your application. For that purpose, several options are available:
 
 * [Zip download](#Zip-download)
 * [CDN](#CDN)
 * [npm](#npm)
 
-Each of the builds have independent release packages. Before starting, you must define which one you’re interested on. Check the Overview page for the list of available builds.
+Each of the builds has independent release packages. Before starting, you must define which one you are interested in. Check the {@link TODO Overview} page for the list of available builds.
 
 ### Zip download
 
-Go to http://ckeditor.com/ckeditor5-builds/download and download the build your prefered build. For example, you may download the `ckeditor5-build.classic-1.0.0.zip` file for the Classic Editor build.
+Go to http://ckeditor.com/ckeditor5-builds/download and download your preferred build. For example, you may download the `ckeditor5-build.classic-1.0.0.zip` file for the Classic Editor build.
 
-Extract the above zip file into a dedicated directory inside your website/application.
+Extract the above `.zip` file into a dedicated directory inside your website or application.
 
-The main entry point script will be then available are `<your-path>/ckeditor/build/ckeditor.js`.
+The main entry point script will then be available at `<your-path>/ckeditor/build/ckeditor.js`.
 
 ### CDN
 
-Builds can be loaded inside pages directly from our CDN, which is optimized for worldwide super-fast speed download.
+Builds can be loaded inside pages directly from our CDN, which is optimized for worldwide super fast download.
 
 Check out the {@link TODO CKEditor 5 Builds CDN website} for a list of URL entry points for the builds API.
 
@@ -35,21 +35,21 @@ Check out the {@link TODO CKEditor 5 Builds CDN website} for a list of URL entry
 
 All builds are released on npm. The following search shows all build packages available there: https://www.npmjs.com/search?q=%40ckeditor%2Fckeditor5-build
 
-Installing a build with npm is as simple as calling the following inside your website/application:
+Installing a build with npm is as simple as calling the following inside your website or application:
 
 ```
 npm install --save @ckeditor/ckeditor5-build-classic
 ```
 
-The script entry point for the build class will be found then at `node_modules/ckeditor5-build-classic/build/ckeditor.js`.
+The script entry point for the build class will then be found at `node_modules/ckeditor5-build-classic/build/ckeditor.js`.
 
-## Included Files
+## Included files
 
 The following are the main files available in all build distributions:
 
-* `build/ckeditor.js`: the main UMD distribution script, containing the editor core and all plugins. Compatible with ECMAScript 6 enabled browsers. A smaller download.
-* `build/ckeditor.compat.js`: the same as the above, for browsers not compatible with ES6.
-* `ckeditor.js`: the source entry point of the build. Can be used for complex bundling and development.
+* `build/ckeditor.js` &ndash; The main UMD distribution script, containing the editor core and all plugins. Compatible with ECMAScript 6 enabled browsers. A smaller download.
+* `build/ckeditor.compat.js` &ndash; The same as the above, for browsers not compatible with ES6.
+* `ckeditor.js`: &ndash; The source entry point of the build. It can be used for complex bundling and development.
 
 ## Loading the API
 

+ 15 - 15
docs/builds/guides/integration/plugins.md

@@ -1,6 +1,6 @@
 ---
 # Scope:
-# * Introduction on plugins.
+# * Introduction to plugins.
 # * Exemplify use cases.
 # * Point to resources to learn plugins development.
 
@@ -9,35 +9,35 @@ category: builds-integration
 order: 40
 ---
 
-Features in CKEditor are introduced by plugins. In fact, without plugins CKEditor is an empty API with no use. The builds provided with CKEditor 5 are actually a predefined collection of plugins, put together to satisfy specific needs.
+Features in CKEditor are introduced by plugins. In fact, without plugins CKEditor is an empty API with no use. The builds provided with CKEditor 5 are actually predefined collections of plugins, put together to satisfy specific needs.
 
-Plugins provided by the CKEditor core team are available in [npm](https://www.npmjs.com/search?q=ckeditor5) (and [GitHub](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=) too) in form of npm packages. A package may contain one or more plugins (e.g. the [`@ckeditor/ckeditor5-image`](https://www.npmjs.com/package/@ckeditor/ckeditor5-image) packages contains several grannular plugins).
+Plugins provided by the CKEditor core team are available in [npm](https://www.npmjs.com/search?q=ckeditor5) (and [GitHub](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=), too) in form of npm packages. A package may contain one or more plugins (e.g. the [`@ckeditor/ckeditor5-image`](https://www.npmjs.com/package/@ckeditor/ckeditor5-image) packages contains several granular plugins).
 
 ## Common use cases
 
-Plugins can be pretty much anything. They’re simply code, initialized by the editor if they’re configured to be loaded. They can use the richness of the CKEditor 5 Framework API to enhance the editor or to better integrate it with your application.
+Plugins can be pretty much anything. They are simply code, initialized by the editor if they are configured to be loaded. They can use the richness of the {@link TODO CKEditor 5 Framework API} to enhance the editor or to better integrate it with your application.
 
 Common use cases for plugins are:
 
-* **Editing features**, like bold, heading, linking or whichever feature that interacts with the user on the manipulation of the contents.
-* **Adding semantic value** to the contents, like annotations or accessibility features.
-* **Third party services integration**, for injecting external resources inside the contents, like videos or social network posts.
+* **Editing features**, like bold, heading, linking or whichever feature that the user can use to manipulate the content.
+* **Adding semantic value** to the content, like annotations or accessibility features.
+* **Third-party services integration**, for injecting external resources inside the content, like videos or social network posts.
 * **Handling image upload** and image manipulation features.
 * **Providing widgets** for easy integration with application structured data.
-* **Injecting analysis tools** that help enhancing the quality of the contents.
-* And other infinite possibilities
+* **Injecting analysis tools** that help enhancing the quality of the content.
+* And other infinite possibilities...
 
 ## Creating plugins
 
 Creating your own plugins is a straightforward task but it requires good knowledge about a few aspects of the CKEditor 5 development environment. The following resources are recommended as a starting point:
 
-* {@link TODO Plugin development guide}, in the CKEditor 5 Framework documentation.
-* {@link TODO Creating custom builds}, which is necessary to have your plugin included inside a CKEditor 5 build.
+* {@link TODO Plugin development guide} in the CKEditor 5 Framework documentation.
+* {@link TODO Creating custom builds} which is necessary to have your plugin included inside a CKEditor 5 build.
 
-A good understanding about the {@link TODO CKEditor 5 Framework} is also very welcome when it comes to creating plugins.
+A good understanding of the {@link TODO CKEditor 5 Framework} is also very welcome when it comes to creating plugins.
 
-## Using 3rd party plugins
+## Using third-party plugins
 
-A great way to enhance your builds with additional features is by using plugins created by the community. Such plugins are generally available as npm packages, so a quick [search on the “ckeditor5” keyword in npm](https://www.npmjs.com/search?q=ckeditor5) should work as a starting point.
+A great way to enhance your builds with additional features is by using plugins created by the community. Such plugins are generally available as npm packages, so a quick [search on the "ckeditor5" keyword in npm](https://www.npmjs.com/search?q=ckeditor5) should work as a starting point.
 
-Once you have plugins to be included, just {@link TODO create a custom build}, configured to include them.
+Once you have plugins to be included, just {@link TODO create a custom build} configured to include them.