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

Docs: Added Image upload guide and links to iit.

Piotrek Koszuliński 8 лет назад
Родитель
Сommit
ea1929d587

+ 4 - 0
docs/builds/guides/development/plugins.md

@@ -32,7 +32,11 @@ Common use cases for plugins are:
 
 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:
 
+<!--
 * The {@linkTODO framework/guides/creating-plugin Plugin development guide} in the {@link framework/index CKEditor 5 Framework} documentation.
+-->
+
+* The {@link framework/guides/quick-start Quick start guide} in the {@link framework/index CKEditor 5 Framework} documentation.
 * {@link builds/guides/development/custom-builds Creating custom builds} which is necessary to have your plugin included inside a CKEditor 5 build.
 
 A good understanding of the {@link framework/index CKEditor 5 Framework} is also very welcome when it comes to creating plugins.

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

@@ -38,12 +38,12 @@ npm install --save @ckeditor/ckeditor5-build-inline
 npm install --save @ckeditor/ckeditor5-build-balloon
 ```
 
-CKEditor will then be available at `node_modules/ckeditor5-build-[name]/ckeditor.js`.
+CKEditor will then be available at `node_modules/ckeditor5-build-[name]/build/ckeditor.js`. It can also be imported directly to your code by `require( '@ckeditor/ckeditor5-build-[name]' )`.
 
 ### Zip download
 
 <info-box warning>
-This download method is not available yet.
+	This download method is not available yet.
 </info-box>
 
 Go to the [CKEditor 5 builds download page](https://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.

+ 2 - 2
docs/builds/guides/migrate.md

@@ -34,14 +34,14 @@ Therefore, it is worth spending some time analyzing required features.
 CKEditor 5 was designed with focus on creating quality content. There are thus good reasons for it to not support some old features. You should take this chance to rethink the features available in your application and in turn perhaps switch the approach towards a more modern reasoning.
 
 <info-box>
-Features like fonts, colors and alignment will be added in the future, when new types of builds will be introduced with the purpose of satisfying document editing scenarios.
+	Features like fonts, colors and alignment will be added in the future, when new types of builds will be introduced with the purpose of satisfying document editing scenarios.
 </info-box>
 
 ## Image upload
 
 Image upload is handled differently with CKEditor 5, bringing a much better user experience. Solutions used with CKEditor 4 may not be compatible any more and therefore another solution needs to be found.
 
-CKEditor 5 Builds come with {@link features/image#Image-upload Easy Image} available out of the box. It is a super simple to {@linkTODO enable image upload with it}.
+CKEditor 5 Builds come with {@link features/image-upload#Easy-Image Easy Image} available out of the box. It is a super simple to {@link features/image-upload#Easy-Image enable image upload with it}.
 
 ## Plugins
 

+ 1 - 1
docs/builds/guides/support/license-and-legal.md

@@ -24,7 +24,7 @@ You are not required to, but if you want to explicitly declare the license you h
 
 Where not otherwise indicated, all CKEditor 5 Builds content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
 
-The {@link features/image#Image-upload Easy Image} feature, present in {@link builds/index CKEditor 5 Builds}, integrates with the [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services), if configured to do so. CKEditor Cloud Services is an external "Software as a Service" solution, delivered through its own license terms and conditions.
+The {@link features/image-upload#Easy-Image Easy Image} feature, present in {@link builds/index CKEditor 5 Builds}, integrates with the [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services), if configured to do so. CKEditor Cloud Services is an external "Software as a Service" solution, delivered through its own license terms and conditions.
 
 ## Trademarks
 

+ 1 - 1
docs/builds/guides/whats-new.md

@@ -26,7 +26,7 @@ The outdated concept of image alignment was dropped in favor of {@link features/
 
 [ TODO Animated GIF of styles ]
 
-When integrated with {@link features/image#Image-upload EasyImage}, uploading, resizing and producing different images sizes for responsive design is all automated.
+When integrated with {@link features/image-upload#Easy-Image Easy Image}, uploading, resizing and producing different images sizes for responsive design is all automated.
 
 [ TODO Animated GIF of image being inserted and how it looks like in a smartphone and desktop ]
 

+ 64 - 0
docs/features/image-upload.md

@@ -0,0 +1,64 @@
+---
+category: features
+---
+
+# Image upload
+
+Inserting images in content created with CKEditor is a very common task. In CKEditor 5, a totally new way of handling images has been introduced, with strong focus on the end user experience. The goal is making this an effortless and intuitive task.
+
+In a properly configured editor, there are several ways for the end user to insert images:
+
+* Pasting it from the clipboard.
+* Dragging a file from the file system.
+* Selecting it through a file system dialog.
+* Selecting it from a media management tool in your application.
+
+Excluding the last option, all other ways require the image to be uploaded to a server, which will be the one responsible for giving the image URL used by CKEditor to display the image in the contents.
+
+The image insertion, therefore, is made of a few steps, which are transparent to the end user:
+
+1. User inserts an image.
+2. Temporary image is inserted.
+3. Image is being uploaded.
+4. Server returns the image URL.
+5. Temporary image is replaced with the definitive one.
+
+<!-- TODO [ Drawing: workflow ( User Inserts Image ) -> ( Temporary Image Inserted ) -> ( Image Uploaded ) -> ( URL Returned ) -> ( Temporary Image Replaced with Definitive ) ] -->
+
+The enable the above process, an image upload plugin must be available. Such plugin will handle both the upload and URL returning steps in the above workflow.
+
+## Responsive images
+
+Another great feature introduced with CKEditor 5 is the ability of having responsive images in the content. With a single image upload, several optimized versions of that image are created after upload, for different size of displays. All this is totally transparent to the end user who uploaded the image.
+
+Be sure to use image upload plugins with support for responsive images to enjoin this important additional benefit. [Easy Image](#Easy-Image) has out of the box support for responsive images as well.
+
+## Easy Image
+
+To make enabling image upload in CKEditor 5 a breeze, all builds include by default the {@link module:easy-image/easyimage~EasyImage `EasyImage` plugin}, which integrates with the Easy Image service provided by the [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/). Enabling it is very easy and the results are immediate:
+
+<info-box warning>
+	The CKEditor Cloud Services is in private beta. [Contact us](https://ckeditor.com/contact/) to learn more.
+</info-box>
+
+1. Create an account in the CKEditor Cloud Services (CS).
+2. Create an API key in your CS account.
+3. Create a security token entry point in your application.
+4. Configure CKEditor to use the above security token entry point:
+
+	```js
+	ClassicCreator
+		.create( document.querySelector( '#editor' ), {
+			cloudServices: {
+				token: 'token-retrieved-from-the-cs-token-server'
+			}
+		} )
+		.then( ... )
+		.catch( ... );
+	```
+
+That is all. At this point, image upload will be automatically enabled in your application.
+
+## What's next?
+
+See the {@link features/image Image feature} guide to learn more about the image feature and its options.

+ 2 - 1
docs/framework/guides/overview.md

@@ -53,4 +53,5 @@ To start using the framework refer to:
 
 * The {@link framework/guides/quick-start Quick start} guide.
 * The {@link framework/guides/architecture/intro Introduction to the framework architecture} guide.
-* The {@linkTODO framework/guides/creating-plugin Creating a plugin} guide.
+
+<!-- * The {@linkTODO framework/guides/creating-plugin Creating a plugin} guide. -->

+ 1 - 1
docs/framework/guides/support/license-and-legal.md

@@ -24,7 +24,7 @@ You are not required to, but if you want to explicitly declare the license you h
 
 Where not otherwise indicated, all CKEditor 5 Framework content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
 
-The {@link features/image#Image-upload Easy Image} feature, present in {@link builds/index CKEditor 5 Builds}, integrates with the [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services), if configured to do so. CKEditor Cloud Services is an external "Software as a Service" solution, delivered through its own license terms and conditions.
+The {@link features/image-upload#Easy-Image Easy Image} feature, present in {@link builds/index CKEditor 5 Builds}, integrates with the [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services), if configured to do so. CKEditor Cloud Services is an external "Software as a Service" solution, delivered through its own license terms and conditions.
 
 ## Trademarks