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

+ 2 - 2
packages/ckeditor5-mention/docs/api/mention.md

@@ -10,11 +10,11 @@ This package implements the mention feature for CKEditor 5. This features provid
 
 ## Demo
 
-Check out the {@link features/mention#demo demo in the Mention feature} guide.
+Check out the {@link features/mentions#demo demo in the Mention feature} guide.
 
 ## Documentation
 
-See the {@link features/mention Mention feature} guide and the {@link module:mention/mention~Mention} plugin documentation.
+See the {@link features/mentions Mention feature} guide and the {@link module:mention/mention~Mention} plugin documentation.
 
 ## Installation
 

+ 8 - 7
packages/ckeditor5-mention/docs/features/mention.md → packages/ckeditor5-mention/docs/features/mentions.md

@@ -1,16 +1,17 @@
 ---
 category: features
+menu-title: Mentions
 ---
 
 {@snippet features/build-mention-source}
 
-# Mention
+# Mentions (autocompletion)
 
 The {@link module:mention/mention~Mention} feature brings support for smart autocompletion based on user input. When a user types a pre-configured marker, such as `@` or `#`, they get autocomplete suggestions in a panel displayed next to the caret. The selected suggestion is then inserted into the content.
 
 ## Demo
 
-You can type the `'@'` character to invoke mention autocomplete UI. The demo below is configured to suggest a static list of names ("Barney", "Lily", "Marshall", "Robin", and "Ted").
+You can type the "@" character to invoke mention autocomplete UI. The demo below is configured to suggest a static list of names ("Barney", "Lily", "Marshall", "Robin", and "Ted").
 
 {@snippet features/mention}
 
@@ -18,7 +19,7 @@ You can type the `'@'` character to invoke mention autocomplete UI. The demo bel
 
 The minimal configuration of the mention feature requires defining a {@link module:mention/mention~MentionFeed `feed`} and a {@link module:mention/mention~MentionFeed `marker`}. You can also define `minimumCharacters` after which the autocomplete panel will show up.
 
-The code snippet below was used to configure the demo above. It defines the list of names that will be autocompleted after the user types the `'@'` character.
+The code snippet below was used to configure the demo above. It defines the list of names that will be autocompleted after the user types the "@" character.
 
 ```js
 ClassicEditor
@@ -45,7 +46,7 @@ Additionally, you can configure:
 
 * How the item is rendered in the autocomplete panel (via setting {@link module:mention/mention~MentionFeed `itemRenderer`}). See ["Customizing the autocomplete list"](#customizing-the-autocomplete-list).
 * How the item is converted during the {@link framework/guides/architecture/editing-engine#conversion conversion}. See ["Customizing the output"](#customizing-the-output).
-* Multiple feeds — in the demo above we used only one feed, which is triggered by the `'@'` character. You can define multiple feeds but they must use different markers. For example, you can use `'@'` for people and `#` for tags.
+* Multiple feeds — in the demo above we used only one feed, which is triggered by the `'@'` character. You can define multiple feeds but they must use different markers. For example, you can use `'@'` for people and `'#'` for tags.
 
 ### Providing the feed
 
@@ -121,7 +122,7 @@ function getFeedItems( queryText ) {
 }
 ```
 
-A full, working demo with all possible customizations and its source code is available {@link features/mention#fully-customized-mention-feed at the end of this section}.
+A full, working demo with all possible customizations and its source code is available {@link features/mentions#fully-customized-mention-feed at the end of this section}.
 
 ### Customizing the autocomplete list
 
@@ -164,7 +165,7 @@ function customItemRenderer( item ) {
 }
 ```
 
-A full, working demo with all possible customizations and its source code is available {@link features/mention#fully-customized-mention-feed at the end of this section}.
+A full, working demo with all possible customizations and its source code is available {@link features/mentions#fully-customized-mention-feed at the end of this section}.
 
 ### Customizing the output
 
@@ -247,7 +248,7 @@ function MentionCustomization( editor ) {
 }
 ```
 
-The full working demo with all customization possible is {@link features/mention#fully-customized-mention-feed  at the end of this section}.
+The full working demo with all customization possible is {@link features/mentions#fully-customized-mention-feed  at the end of this section}.
 
 ### Fully customized mention feed
 

+ 4 - 4
packages/ckeditor5-mention/src/mention.js

@@ -17,7 +17,7 @@ import '../theme/mention.css';
 /**
  * The mention plugin.
  *
- * For a detailed overview, check the {@glink features/mention Mention feature documentation}.
+ * For a detailed overview, check the {@glink features/mentions Mention feature documentation}.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -66,7 +66,7 @@ export default class Mention extends Plugin {
 /**
  * The configuration of the mention feature.
  *
- * Read more about {@glink features/mention#configuration configuring the mention feature}.
+ * Read more about {@glink features/mentions#configuration configuring the mention feature}.
  *
  *		ClassicEditor
  *			.create( editorElement, {
@@ -167,8 +167,8 @@ export default class Mention extends Plugin {
  *
  * When defining a feed item as a plain object, the `id` property is obligatory. The additional properties
  * can be used when customizing the mention feature bahavior
- * (see {@glink features/mention#customizing-the-autocomplete-list "Customizing the autocomplete list"}
- * and {@glink features/mention#customizing-the-output "Customizing the output"} sections).
+ * (see {@glink features/mentions#customizing-the-autocomplete-list "Customizing the autocomplete list"}
+ * and {@glink features/mentions#customizing-the-output "Customizing the output"} sections).
  *
  *		ClassicEditor
  *			.create( editorElement, {