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

Docs: related features tier 2. [skip ci]

godai78 5 лет назад
Родитель
Сommit
84ea866bb9

+ 10 - 7
packages/ckeditor5-alignment/docs/features/text-alignment.md

@@ -11,6 +11,16 @@ The {@link module:alignment/alignment~Alignment} feature enables support for tex
 
 {@snippet features/text-alignment}
 
+## Related features
+
+There are more CKEditor 5 features that can help you organize your content:
+* {@link features/basic-styles Basic font styles} – The essentials, like **bold**, *italic* and others.
+* {@link features/headings Headings} – Divide your content into sections.
+* {@link features/title Document title} – Clearly divide your content into a title and body.
+* {@ features/indent Block indentation} – Organize your contents into clearly visually divided blocks, indent crucial paragraphs etc.
+* {@link features/block-quote Block quote} – Include block quotations or pull quotes in the rich-text content.
+
+
 ## Configuring alignment options
 
 It is possible to configure which alignment options are available in the editor by setting the {@link module:alignment/alignment~AlignmentConfig#options `alignment.options`} configuration option. You can choose from `'left'`, `'right'`, `'center'` and `'justify'`.
@@ -54,13 +64,6 @@ ClassicEditor
 
 {@snippet features/custom-text-alignment-toolbar}
 
-## Related features
-
-There are more CKEditor 5 features that can help you control your content:
-* {@link features/basic-styles Basic font styles} – The essentials, like **bold**, *italic* and others.
-* {@link features/headings Headings} – Divide your content into sections.
-* {@link features/title Document title} – Clearly divide your content into a title and body.
-
 ## Installation
 
 To add this feature to your editor, install the [`@ckeditor/ckeditor5-alignment`](https://www.npmjs.com/package/@ckeditor/ckeditor5-alignment) package:

+ 14 - 12
packages/ckeditor5-basic-styles/docs/features/basic-styles.md

@@ -5,7 +5,7 @@ category: features
 
 {@snippet features/build-basic-styles-source}
 
-The {@link api/basic-styles basic styles} package provides text essential formatting features such as bold, italic, underline, strikethrough, subscript, superscript, and code. Thi set allows you to start editing right away with all the most used formatting styles inevitable for content creation. Coupled with more formatting features, these serve as a base for any WYSIWYG editor tool set.
+The {@link api/basic-styles basic styles} allows you to start editing right away with all the most used formatting styles inevitable for content creation. This package provides essential text formatting features such as bold, italic, underline, strikethrough, subscript, superscript, and code. Coupled with more [formatting features](#related-features), these serve as a base for any WYSIWYG editor tool set.
 
 <info-box info>
 	All basic text styles can be removed with the {@link features/remove-format remove format} feature.
@@ -15,6 +15,19 @@ The {@link api/basic-styles basic styles} package provides text essential format
 
 {@snippet features/basic-styles}
 
+## Related features
+
+Check out also these CKEditor 5 features to gain better control over your content style and format:
+* {@link features/font Font styles} &ndash; Easily and efficiently control the font {@link features/font#configuring-the-font-family-feature family}, {@link features/font#configuring-the-font-size-feature size}, {@link features/font#configuring-the-font-color-and-font-background-color-features text or background color}.
+* {@link features/text-alignment Text alignment} &ndash; Because it does matter whether the content is left, right, centered or justified.
+* {@link features/code-blocks Code block feature}  &ndash; Allows for insertion of various code listings, expanding the 'code' style greatly.
+* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
+
+And be sure to get familiar with these, too:
+* {@link features/title Document title} &ndash; Clearly divide your content into a title and body.
+* {@link features/headings Headings} &ndash; Divide your content into sections.
+* {@link features/highlight Highlight} &ndash; Mark important words and passages, aiding a review or drawing attention to specific parts of content.
+
 ## Available text styles
 
 | Style feature | {@link framework/guides/architecture/core-editor-architecture#commands Command} name | {@link builds/guides/integration/configuration#toolbar-setup Toolbar} component name | Output element |
@@ -59,17 +72,6 @@ CKEditor 5 allows for typing both at inner and outer boundaries of code to make
 
 {@img assets/img/typing-after-code.gif 770 The animation showing typing after the code element in CKEditor 5 rich text editor.}
 
-## Related features
-
-* {@link features/font Font styles} &ndash; Easily and efficiently control the font {@link features/font#configuring-the-font-family-feature family}, {@link features/font#configuring-the-font-size-feature size}, {@link features/font#configuring-the-font-color-and-font-background-color-features text or background color}.
-* {@link features/text-alignment Text alignment} &ndash; Because it does matter whether the content is left, right, centered or justified.
-* {@link features/headings Headings} &ndash; Divide your content into sections.
-* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
-
-And be sure to get familiar with these, too:
-* {@link features/title Document title} &ndash; Clearly divide your content into a title and body.
-* {@link features/highlight Highlight} &ndash; Mark important words and passages, aiding a review or drawing attention to specific parts of content.
-
 ## Installations
 
 To add the basic styles features to your editor install the [`@ckeditor/ckeditor5-basic-styles`](https://www.npmjs.com/package/@ckeditor/ckeditor5-basic-styles) package:

+ 3 - 2
packages/ckeditor5-block-quote/docs/features/block-quote.md

@@ -17,8 +17,9 @@ Use the editor below to see the block quote plugin in action.
 
 Here are some other CKEditor 5 features that you can use similarly to the block quote plugin to structure your text better:
 
-* The {@link features/indent block indentation feature} allows you to set indentation for text blocks such as paragraphs or lists.
-* The {@link features/code-blocks code block feature} allows for insertion of various code listings.
+* {@link features/indent Block indentation feature}  &ndash; Allows you to set indentation for text blocks such as paragraphs or lists.
+* {@link features/code-blocks Code block feature}  &ndash; Allows for insertion of various code listings.
+* {@link features/text-alignment Text alignment} &ndash; Because it does matter whether the content is left, right, centered or justified.
 
 ## Installation
 

+ 4 - 0
packages/ckeditor5-code-block/docs/features/code-blocks.md

@@ -16,6 +16,10 @@ The {@link module:code-block/codeblock~CodeBlock} feature allows inserting and e
 
 {@snippet features/code-block}
 
+Here are some features that you may find helpfully similar:
+* {@link features/block-quote Block quote} &ndash; Include block quotations or pull quotes in your rich-text content.
+* {@link features/indent Block indentation feature} &ndash; Allows you to set indentation for text blocks such as paragraphs or lists.
+
 ## Configuring code block languages
 
 Each code block can be assigned a programming language. The language of the code block is represented as a CSS class of the `<code>` element, both when editing and in the editor data:

+ 10 - 10
packages/ckeditor5-font/docs/features/font.md

@@ -5,7 +5,7 @@ category: features
 
 {@snippet features/build-font-source}
 
-The {@link module:font/font~Font} plugin enables the following features in the rich-text editor:
+The {@link module:font/font~Font} plugin provides extended formatting of the document content. It enables the following features in the rich-text editor:
 * {@link module:font/fontfamily~FontFamily} &ndash; Allows to change the font family by applying inline `<span>` elements with a `font-family` in the `style` attribute.
 * {@link module:font/fontsize~FontSize} &ndash; Allows to control the font size by applying inline `<span>` elements that either have a CSS class or a `font-size` in the `style` attribute.
 * {@link module:font/fontcolor~FontColor} &ndash; Allows to control the font color by applying inline `<span>` elements with a `color` in the `style` attribute.
@@ -19,6 +19,15 @@ The {@link module:font/font~Font} plugin enables the following features in the r
 
 {@snippet features/font}
 
+## Related features
+
+Here are some more CKEditor 5 features that can help you format your content:
+* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
+* {@link features/text-alignment Text alignment} &ndash; Because it does matter whether the content is left, right, centered or justified.
+* {@link features/headings Headings} &ndash; Divide your content into sections.
+* {@link features/highlight Highlight} &ndash; Mark important words and passages, aiding a review or drawing attention to specific parts of content.
+* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
+
 ## Configuring the font family feature
 
 It is possible to configure which font family options are supported by the WYSIWYG editor. Use the {@link module:font/fontfamily~FontFamilyConfig#options `config.fontFamily.options`} configuration option to do so.
@@ -335,15 +344,6 @@ ClassicEditor
 	.catch( ... );
 ```
 
-## Related features
-
-There are more CKEditor 5 features that can help you control your content:
-* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
-* {@link features/text-alignment Text alignment} &ndash; Because it does matter whether the content is left, right, centered or justified.
-* {@link features/headings Headings} &ndash; Divide your content into sections.
-* {@link features/highlight Highlight} &ndash; Mark important words and passages, aiding a review or drawing attention to specific parts of content.
-* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
-
 ## Installation
 
 To add this feature to your rich-text editor, install the [`@ckeditor/ckeditor5-font`](https://www.npmjs.com/package/@ckeditor/ckeditor5-font) package:

+ 11 - 8
packages/ckeditor5-heading/docs/features/headings.md

@@ -26,6 +26,17 @@ By default, when your editor build does not include the title plugin, a `<h1>` e
 	You can read more about why the editor should not create `<h1>` elements for content headings in the [Headings section of Editor Recommendations](http://ckeditor.github.io/editor-recommendations/features/headings.html).
 </info-box>
 
+## Demo
+
+{@snippet features/custom-heading-levels}
+
+## Related features
+
+There are more CKEditor 5 features that can help you format your content:
+* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
+* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
+* {@link features/title Document title} &ndash; Clearly divide your content into a title and body.
+
 ### Configuring heading levels
 
 It is, of course, possible to configure which heading levels the editor should support and how they should be named in the Headings dropdown. Use the {@link module:heading/heading~HeadingConfig#options `heading.options`} configuration option to do so.
@@ -109,14 +120,6 @@ ClassicEditor
 
 {@snippet features/custom-heading-elements}
 
-## Related features
-
-There are more CKEditor 5 features that can help you control your content:
-* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
-* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
-* {@link features/title Document title} &ndash; Clearly divide your content into a title and body.
-
-
 ## Installation
 
 <info-box info>

+ 7 - 9
packages/ckeditor5-heading/docs/features/title.md

@@ -15,6 +15,13 @@ Use the editor below to create a document with clearly separated title and body
 
 {@snippet features/title}
 
+## Related features
+
+There are more CKEditor 5 features that can help you control your document:
+* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
+* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
+* {@link features/headings Headings} &ndash; Divide your content into sections.
+
 ## Keyboard navigation
 
 The title plugin lets you move from the title to the body element using the <kbd>Tab</kbd> key, providing form-like experience. When the selection is at the beginning of the first body element, you can go back to the title element using <kbd>Shift</kbd>+<kbd>Tab</kbd>. You can also use <kbd>Enter</kbd> and <kbd>Backspace</kbd> keys to move the caret between the title and the body.
@@ -38,15 +45,6 @@ ClassicEditor
     .catch( ... );
 ```
 
-## Related features
-
-There are more CKEditor 5 features that can help you control your content:
-* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
-* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
-* {@link features/headings Headings} &ndash; Divide your content into sections.
-
-
-
 ## Installation
 
 To add this feature to your editor, install the [`@ckeditor/ckeditor5-heading`](https://www.npmjs.com/package/@ckeditor/ckeditor5-heading) package:

+ 7 - 7
packages/ckeditor5-highlight/docs/features/highlight.md

@@ -14,6 +14,13 @@ The highlight plugin always comes with a predefined and limited number of availa
 
 {@snippet features/highlight}
 
+## Related features
+
+There are more CKEditor 5 features that can help you style your content:
+* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
+* {@link features/font Font styles} &ndash; Easily and efficiently control the font {@link features/font#configuring-the-font-family-feature family}, {@link features/font#configuring-the-font-size-feature size}, {@link features/font#configuring-the-font-color-and-font-background-color-features text or background color}.
+* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
+
 ## Configuring the highlight options
 
 ### Dropdown
@@ -159,13 +166,6 @@ Then, update the classes in the stylesheet so the content corresponds to the UI
 
 {@snippet features/custom-highlight-colors-inline}
 
-## Related features
-
-There are more CKEditor 5 features that can help you control your content:
-* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
-* {@link features/font Font styles} &ndash; Easily and efficiently control the font {@link features/font#configuring-the-font-family-feature family}, {@link features/font#configuring-the-font-size-feature size}, {@link features/font#configuring-the-font-color-and-font-background-color-features text or background color}.
-* {@link features/remove-format Remove format} &ndash; Easily clean basic text formatting.
-
 ## Installation
 
 To add this feature to your editor install the [`@ckeditor/ckeditor5-highlight`](https://www.npmjs.com/package/@ckeditor/ckeditor5-highlight) package:

+ 7 - 0
packages/ckeditor5-indent/docs/features/indent.md

@@ -15,6 +15,13 @@ The block indentation feature allows you to set indentation for text blocks such
 
 {@snippet features/indent}
 
+## Related features
+
+Here are some features that may aid structuring your content better:
+* {@link features/block-quote Block quote} &ndash; Include block quotations or pull quotes in your rich-text content.
+* {@link features/code-blocks Code block feature} &ndash; Allows for insertion of various code listings.
+* {@link features/text-alignment Text alignment} &ndash; Because it does matter whether the content is left, right, centered or justified.
+
 ## Configuring the block indentation feature
 
 This feature offers a few configuration options that can be used to adjust the text block indentation behavior.

+ 7 - 5
packages/ckeditor5-list/docs/features/lists.md

@@ -4,7 +4,7 @@ category: features
 
 # Lists
 
-The {@link module:list/list~List list} feature allows creating ordered (numbered) and unordered (bulleted) lists in the editor.
+The {@link module:list/list~List list} feature allows creating ordered (numbered) and unordered (bulleted) lists in the editor aimed at better structuring adn presenting specific content as well as serving special purposes, like tables of content or {@link features/todo-lists to-do lists}.
 
 <info-box info>
 	The feature is enabled by default in all CKEditor 5 WYSIWYG editor builds.
@@ -34,6 +34,12 @@ Use the editor below to see the list style plugin in action.
 
 {@snippet features/lists-style}
 
+## Related features
+
+These features also provide similar functionality:
+* {@link features/todo-lists To-do lists} &ndash; This feature lets you create a list of interactive checkboxes with labels.
+* {@link features/indent Block indentation feature} &ndash; Allows you to set indentation for text blocks such as paragraphs or headings and lists.
+
 ### Installation
 
 To add this feature to your editor, install the [`@ckeditor/ckeditor5-list`](https://www.npmjs.com/package/@ckeditor/ckeditor5-list) package:
@@ -68,10 +74,6 @@ ClassicEditor
 
 Refer to the {@link features/indent Indenting lists} section of the Block indentation feature guide.
 
-## To-do list
-
-You can read more about the feature in the {@link features/todo-lists To-do lists} feature guide.
-
 ## Common API
 
 The {@link module:list/list~List} plugin registers:

+ 6 - 6
packages/ckeditor5-remove-format/docs/features/remove-format.md

@@ -16,6 +16,12 @@ Select the content you want to clean up and press the "Remove Format" button in
 
 {@snippet features/remove-format}
 
+## Related features
+
+There are more CKEditor 5 features that can help you format your content:
+* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
+* {@link features/font Font styles} &ndash; Easily and efficiently control the font {@link features/font#configuring-the-font-family-feature family}, {@link features/font#configuring-the-font-size-feature size}, {@link features/font#configuring-the-font-color-and-font-background-color-features text or background color}.
+
 ## Configuring the remove format feature
 
 This feature has no integration–level configuration. Once enabled, it works out–of–the–box with all {@link features/index core editor features}.
@@ -61,12 +67,6 @@ ClassicEditor
 
 From now on, the the "Remove Format" button should also remove links in the content. {@link module:engine/model/schema~Schema#setAttributeProperties Learn more about attribute properties.}
 
-## Related features
-
-There are more CKEditor 5 features that can help you control your content:
-* {@link features/basic-styles Basic font styles} &ndash; The essentials, like **bold**, *italic* and others.
-* {@link features/font Font styles} &ndash; Easily and efficiently control the font {@link features/font#configuring-the-font-family-feature family}, {@link features/font#configuring-the-font-size-feature size}, {@link features/font#configuring-the-font-color-and-font-background-color-features text or background color}.
-
 ## Installation
 
 To add this feature to your rich-text editor, install the [`@ckeditor/ckeditor5-remove-format`](https://www.npmjs.com/package/@ckeditor/ckeditor5-remove-format) package: