浏览代码

Docs: Updated the guide with information concerning the auto–embed sub–feature.

Aleksander Nowodzinski 7 年之前
父节点
当前提交
fc5a8bd80f
共有 1 个文件被更改,包括 13 次插入1 次删除
  1. 13 1
      packages/ckeditor5-media-embed/docs/features/media-embed.md

+ 13 - 1
packages/ckeditor5-media-embed/docs/features/media-embed.md

@@ -10,7 +10,7 @@ The {@link module:media-embed/mediaembed~MediaEmbed} feature brings support for
 
 ## Demo
 
-Example URLs:
+You can use the "Insert media" button in the toolbar to embed media like the following examples. You can also paste the media URL directly into the editor content and it will be [automatically embedded](#automatic-media-embed-on-paste).
 
 * <input class="example-input" type="text" value="https://www.youtube.com/watch?v=H08tGjXNHO4">
 * <input class="example-input" type="text" value="https://open.spotify.com/album/2IXlgvecaDqOeF3viUZnPI?si=ogVw7KlcQAGZKK4Jz9QzvA">
@@ -296,6 +296,18 @@ In this case, the code is almost the same as with the semantic data but you shou
 </script>
 ```
 
+## Automatic media embed on paste
+
+By default, the `'MediaEmbed'` plugin loads the {@link module:media-embed/mediaembed~AutoMediaEmbed `'AutoMediaEmbed'`} as a dependency.
+
+The `AutoMediaEmbed` plugin recognizes media links in the pasted content and embeds them shortly after they are injected into the document to speed up the editing. Just like the "traditional" embedding (i.e. using the button in the toolbar), the automatic embedding works for all media providers specified in the [configuration](#media-providers).
+
+<info-box>
+	The media URL must be the only content pasted to be properly embedded. Multiple links (`"http://media.url http://another.media.url"`) as well as bigger chunks of the content (`"This link http://media.url will not be auto–embedded when pasted."`) are ignored.
+</info-box>
+
+If the automatic embedding was unexpected, for instance when the link was meant to remain in the content as text, simply undo the action. To do that, use the toolbar button or the {@link features/keyboard-support keystroke}.
+
 ## Styling media in editor content
 
 While the editor comes with default styles for popular media providers like Facebook, Instagram or Twitter, you can create additional styles for non-previewable media in your editor content to help users identify them.