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

Docs (font, select-all): Corrected guide and API docs.

This commit restored original ones:
  - https://github.com/ckeditor/ckeditor5-font/commit/6258aaf
  - https://github.com/ckeditor/ckeditor5-select-all/commit/44b297e

During the merge to the mono repository, those commits could be skipped.
Kamil Piechaczek 5 лет назад
Родитель
Сommit
8f0a032e8a

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

@@ -47,7 +47,7 @@ ClassicEditor
 
 {@snippet features/custom-font-family-options}
 
-### Accept all font names
+### Accepting all font names
 
 By default, all `font-family` values that are not specified in the `config.fontFamily.options` are stripped. You can enable support for all font names by using the {@link module:font/fontfamily~FontFamilyConfig#supportAllValues `config.fontFamily.supportAllValues`} option.
 
@@ -169,7 +169,7 @@ ClassicEditor
 
 {@snippet features/custom-font-size-numeric-options}
 
-### Accept all font sizes
+### Accepting all font sizes
 
 By default, all `font-size` values that are not specified in the `config.fontSize.options` are stripped. You can enable support for all font sizes by using the {@link module:font/fontfamily~FontFamilyConfig#supportAllValues `config.fontSize.supportAllValues`} option.
 

+ 5 - 5
packages/ckeditor5-font/src/fontfamily.js

@@ -114,17 +114,17 @@ export default class FontFamily extends Plugin {
  */
 
 /**
- * By default the plugin removes any `font-family` value that does not match to the plugin's configuration. It means if you paste a content
- * with font families that the editor does not understand, the font-family attribute will be removed and the content will be displayed
- * with the font.
+ * By default the plugin removes any `font-family` value that does not match the plugin's configuration. It means that if you paste content
+ * with font families that the editor does not understand, the `font-family` attribute will be removed and the content will be displayed
+ * with the default font.
  *
- * You can preserve pasted font family values by switching the option:
+ * You can preserve pasted font family values by switching the `supportAllValues` option to `true`:
  *
  *		const fontSizeConfig = {
  *			supportAllValues: true
  *		};
  *
- * Now, the font families, not specified in the editor's configuration, won't be removed when pasting the content.
+ * With this configuration font families not specified in the editor configuration will not be removed when pasting the content.
  *
  * @member {Boolean} module:font/fontfamily~FontFamilyConfig#supportAllValues
  */

+ 2 - 2
packages/ckeditor5-font/src/fontfamily/fontfamilyediting.js

@@ -82,8 +82,8 @@ export default class FontFamilyEditing extends Plugin {
 	}
 
 	/**
-	 * Those converters enable keeping any value found as `style="font-family: *"` as a value of an attribute on a text even
-	 * if it isn't defined in the plugin configuration.
+	 * These converters enable keeping any value found as `style="font-family: *"` as a value of an attribute on a text even
+	 * if it is not defined in the plugin configuration.
 	 *
 	 * @private
 	 */

+ 4 - 4
packages/ckeditor5-font/src/fontsize.js

@@ -132,11 +132,11 @@ export default class FontSize extends Plugin {
  */
 
 /**
- * By default the plugin removes any `font-size` value that does not match to the plugin's configuration. It means if you paste a content
- * with font sizes that the editor does not understand, the font-size attribute will be removed and the content will be displayed
+ * By default the plugin removes any `font-size` value that does not match the plugin's configuration. It means that if you paste content
+ * with font sizes that the editor does not understand, the `font-size` attribute will be removed and the content will be displayed
  * with the default size.
  *
- * You can preserve pasted font size values by switching the option:
+ * You can preserve pasted font size values by switching the `supportAllValues` option to `true`:
  *
  *		const fontSizeConfig = {
  *			options: [ 9, 10, 11, 12, 'default', 14, 15 ],
@@ -145,7 +145,7 @@ export default class FontSize extends Plugin {
  *
  * **Note:** This option can only be used with numerical values as font size options.
  *
- * Now, the font sizes, not specified in the editor's configuration, won't be removed when pasting the content.
+ * With this configuration font sizes not specified in the editor configuration will not be removed when pasting the content.
  *
  * @member {Boolean} module:font/fontsize~FontSizeConfig#supportAllValues
  */

+ 2 - 2
packages/ckeditor5-font/src/fontsize/fontsizeediting.js

@@ -86,8 +86,8 @@ export default class FontSizeEditing extends Plugin {
 	}
 
 	/**
-	 * Those converters enable keeping any value found as `style="font-size: *"` as a value of an attribute on a text even
-	 * if it isn't defined in the plugin configuration.
+	 * These converters enable keeping any value found as `style="font-size: *"` as a value of an attribute on a text even
+	 * if it is not defined in the plugin configuration.
 	 *
 	 * @param {Object} definition {@link module:engine/conversion/conversion~ConverterDefinition Converter definition} out of input data.
 	 * @private

+ 1 - 1
packages/ckeditor5-select-all/README.md

@@ -9,7 +9,7 @@ This package implements the select all feature for CKEditor 5.
 
 ## Documentation
 
-See the [`@ckeditor/ckeditor5-select-all` package](https://ckeditor.com/docs/ckeditor5/latest/api/select-all.html) in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
+See the [`@ckeditor/ckeditor5-select-all` package](https://ckeditor.com/docs/ckeditor5/latest/api/select-all.html) as well as the [Select all feature guide](https://ckeditor.com/docs/ckeditor5/latest/features/select-all.html) in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
 
 ## License
 

+ 2 - 2
packages/ckeditor5-select-all/docs/_snippets/features/select-all.html

@@ -1,12 +1,12 @@
 <div id="editor">
 	<h2>The three greatest things you learn from traveling</h2>
 
-	<p>Like all the great things on earth traveling teaches us by example. Here are some of the most precious lessons I’ve learned over the years of traveling.</p>
-
 	<figure class="image image-style-side"><img src="%BASE_PATH%/assets/img/volcano.jpg" alt="A lone wanderer looking at Mount Bromo volcano in Indonesia.">
 		<figcaption>Leaving your comfort zone might lead you to such beautiful sceneries like this one.</figcaption>
 	</figure>
 
+	<p>Like all the great things on earth traveling teaches us by example. Here are some of the most precious lessons I’ve learned over the years of traveling.</p>
+
 	<h3>Appreciation of diversity</h3>
 
 	<p>Getting used to an entirely different culture can be challenging. While it’s also nice to learn about cultures online or from books, nothing comes close to experiencing cultural diversity in person. You learn to appreciate each and every single one of the differences while you become more culturally fluid.</p>

+ 8 - 4
packages/ckeditor5-select-all/docs/api/select-all.md

@@ -2,21 +2,25 @@
 category: api-reference
 ---
 
-# CKEditor 5 Select all feature
+# CKEditor 5 select all feature
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-select-all.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-select-all)
 
-This package implements Select all feature for CKEditor 5.
+This package implements the select all feature for CKEditor 5.
+
+## Demo
+
+Check out the {@link features/select-all#demo demo in the Select all feature} guide.
 
 ## Documentation
 
-See the {@link module:select-all/selectall~SelectAll} plugin documentation.
+See the {@link features/select-all Select all feature} guide and the {@link module:select-all/selectall~SelectAll} plugin documentation.
 
 This plugin is usually enabled by the {@link module:essentials/essentials~Essentials} plugin from the {@link api/essentials `@ckeditor/ckeditor5-essentials`} package (which also enables other fundamental editing features).
 
 ## Installation
 
-```bash
+```
 npm install --save @ckeditor/ckeditor5-select-all
 ```
 

+ 2 - 2
packages/ckeditor5-select-all/docs/features/select-all.md

@@ -5,7 +5,7 @@ category: features
 
 {@snippet features/build-select-all-source}
 
-The {@link module:select-all/selectall~SelectAll} feature allows selecting the entire content of the editor using the <kbd>Ctrl/⌘</kbd>+<kbd>A</kbd> keystroke or a toolbar button.
+The {@link module:select-all/selectall~SelectAll} feature allows selecting the entire content of the WYSIWYG editor using the <kbd>Ctrl/⌘</kbd>+<kbd>A</kbd> keystroke or the toolbar button.
 
 ## Demo
 
@@ -21,7 +21,7 @@ Press <kbd>Ctrl/⌘</kbd>+<kbd>A</kbd> or use the toolbar button to select the e
 
 To add this feature to your editor, install the [`@ckeditor/ckeditor5-select-all`](https://www.npmjs.com/package/@ckeditor/ckeditor5-select-all) package:
 
-```bash
+```
 npm install --save @ckeditor/ckeditor5-select-all
 ```
 

+ 1 - 1
packages/ckeditor5-select-all/src/selectallui.js

@@ -49,7 +49,7 @@ export default class SelectAllUI extends Plugin {
 
 			view.bind( 'isOn', 'isEnabled' ).to( command, 'value', 'isEnabled' );
 
-			// Execute command.
+			// Execute the command.
 			this.listenTo( view, 'execute', () => {
 				editor.execute( 'selectAll' );
 				editor.editing.view.focus();