Przeglądaj źródła

Rename indent-block module to indent.

Maciej Gołaszewski 6 lat temu
rodzic
commit
bb59d2f4e9

+ 1 - 1
packages/ckeditor5-indent/docs/_snippets/features/build-indent-block-source.js

@@ -7,7 +7,7 @@
 
 
 import ClassicEditor from '@ckeditor/ckeditor5-build-classic/src/ckeditor';
 import ClassicEditor from '@ckeditor/ckeditor5-build-classic/src/ckeditor';
 
 
-import IndentBlock from '@ckeditor/ckeditor5-indent-block/src/indentblock';
+import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';
 
 
 ClassicEditor.builtinPlugins.push( IndentBlock );
 ClassicEditor.builtinPlugins.push( IndentBlock );
 
 

+ 0 - 34
packages/ckeditor5-indent/docs/api/indent-block.md

@@ -1,34 +0,0 @@
----
-category: api-reference
----
-
-# CKEditor 5 indent block feature
-
-[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-indent-block.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-indent-block)
-
-This package implements the indent block feature for CKEditor 5.
-
-## Demo
-
-Check out the {@link features/indent-block#demo demo in the indent block feature} guide.
-
-## Documentation
-
-See the {@link module:indent-block/indentblock~IndentBlock} plugin documentation.
-
-## Installation
-
-```bash
-npm install --save @ckeditor/ckeditor5-indent-block
-```
-
-## Contribute
-
-The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-indent-block.
-
-## External links
-
-* [`@ckeditor/ckeditor5-indent-block` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-indent-block)
-* [`ckeditor/ckeditor5-indent-block` on GitHub](https://github.com/ckeditor/ckeditor5-indent-block)
-* [Issue tracker](https://github.com/ckeditor/ckeditor5-indent-block/issues)
-* [Changelog](https://github.com/ckeditor/ckeditor5-indent-block/blob/master/CHANGELOG.md)

+ 34 - 0
packages/ckeditor5-indent/docs/api/indent.md

@@ -0,0 +1,34 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 indent feature
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-indent.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-indent)
+
+This package implements the indent feature for CKEditor 5.
+
+## Demo
+
+Check out the {@link features/indent#demo demo in the indent feature} guide.
+
+## Documentation
+
+See the {@link module:indent/indent~Indent} plugin documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-indent
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-indent.
+
+## External links
+
+* [`@ckeditor/ckeditor5-indent` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-indent)
+* [`ckeditor/ckeditor5-indent` on GitHub](https://github.com/ckeditor/ckeditor5-indent)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-indent/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-indent/blob/master/CHANGELOG.md)

+ 4 - 4
packages/ckeditor5-indent/docs/features/indent-block.md → packages/ckeditor5-indent/docs/features/indent.md

@@ -97,7 +97,7 @@ npm install --save @ckeditor/ckeditor5-indent-block
 Then add it to your plugin list and the toolbar configuration:
 Then add it to your plugin list and the toolbar configuration:
 
 
 ```js
 ```js
-import Font from '@ckeditor/ckeditor5-indent-block/src/indentblock';
+import Font from '@ckeditor/ckeditor5-indent/src/indentblock';
 
 
 ClassicEditor
 ClassicEditor
 	.create( document.querySelector( '#editor' ), {
 	.create( document.querySelector( '#editor' ), {
@@ -114,9 +114,9 @@ ClassicEditor
 
 
 ## Common API
 ## Common API
 
 
-The {@link module:indent-block/indentblock~IndentBlock} plugin registers the following components:
+The {@link module:indent/indentblock~IndentBlock} plugin registers the following components:
 
 
-* The {@link module:indent-block/indentblockcommand~IndentBlockCommand `'indentBlock'`} command.
+* The {@link module:indent/indentblockcommand~IndentBlockCommand `'indentBlock'`} command.
 
 
 	You can increase block indentation in which the selection is set by:
 	You can increase block indentation in which the selection is set by:
 
 
@@ -124,7 +124,7 @@ The {@link module:indent-block/indentblock~IndentBlock} plugin registers the fol
 	editor.execute( 'indentBlock' );
 	editor.execute( 'indentBlock' );
 	```
 	```
 
 
-* The {@link module:indent-block/indentblockcommand~IndentBlockCommand `'outdentBlock'`} command.
+* The {@link module:indent/indentblockcommand~IndentBlockCommand `'outdentBlock'`} command.
 
 
 	You can decrease block indentation in which the selection is set by:
 	You can decrease block indentation in which the selection is set by:
 
 

+ 14 - 14
packages/ckeditor5-indent/src/indentblock.js

@@ -4,7 +4,7 @@
  */
  */
 
 
 /**
 /**
- * @module indent-block/indentblock
+ * @module indent/indentblock
  */
  */
 
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
@@ -216,18 +216,18 @@ function normalizeToMarginLeftStyle( marginStyleValue ) {
 }
 }
 
 
 /**
 /**
- * The configuration of the {@link module:indent-block/indentblock~IndentBlock block indentation feature}.
+ * The configuration of the {@link module:indent/indentblock~IndentBlock block indentation feature}.
  *
  *
- * Read more in {@link module:indent-block/indentblock~IndentBlockConfig}.
+ * Read more in {@link module:indent/indentblock~IndentBlockConfig}.
  *
  *
- * @member {module:indent-block/indentblock~IndentBlockConfig} module:core/editor/editorconfig~EditorConfig#indentBlock
+ * @member {module:indent/indentblock~IndentBlockConfig} module:core/editor/editorconfig~EditorConfig#indentBlock
  */
  */
 
 
 /**
 /**
  * The configuration of the block indentation feature.
  * The configuration of the block indentation feature.
  *
  *
- * If no {@link module:indent-block/indentblock~IndentBlockConfig#classes} are set the block indentation feature will use
- * {@link module:indent-block/indentblock~IndentBlockConfig#offset} and {@link module:indent-block/indentblock~IndentBlockConfig#unit} to
+ * If no {@link module:indent/indentblock~IndentBlockConfig#classes} are set the block indentation feature will use
+ * {@link module:indent/indentblock~IndentBlockConfig#offset} and {@link module:indent/indentblock~IndentBlockConfig#unit} to
  * create indentation steps.
  * create indentation steps.
  *
  *
  *		ClassicEditor
  *		ClassicEditor
@@ -240,7 +240,7 @@ function normalizeToMarginLeftStyle( marginStyleValue ) {
  *			.then( ... )
  *			.then( ... )
  *			.catch( ... );
  *			.catch( ... );
  *
  *
- * Alternatively the block indentation feature may set one of defined {@link module:indent-block/indentblock~IndentBlockConfig#classes} as
+ * Alternatively the block indentation feature may set one of defined {@link module:indent/indentblock~IndentBlockConfig#classes} as
  * indentation steps:
  * indentation steps:
  *
  *
  *		ClassicEditor
  *		ClassicEditor
@@ -266,24 +266,24 @@ function normalizeToMarginLeftStyle( marginStyleValue ) {
  */
  */
 
 
 /**
 /**
- * The size in indentation {@link module:indent-block/indentblock~IndentBlockConfig#unit units} of each indentation step.
+ * The size in indentation {@link module:indent/indentblock~IndentBlockConfig#unit units} of each indentation step.
  *
  *
  * @default 1
  * @default 1
- * @member {Number} module:indent-block/indentblock~IndentBlockConfig#offset
+ * @member {Number} module:indent/indentblock~IndentBlockConfig#offset
  */
  */
 
 
 /**
 /**
- * The unit used for indentation {@link module:indent-block/indentblock~IndentBlockConfig#offset}.
+ * The unit used for indentation {@link module:indent/indentblock~IndentBlockConfig#offset}.
  *
  *
  * @default 'em'
  * @default 'em'
- * @member {String} module:indent-block/indentblock~IndentBlockConfig#unit
+ * @member {String} module:indent/indentblock~IndentBlockConfig#unit
  */
  */
 
 
 /**
 /**
  * An optional list of classes to use for indenting the contents. If not set or set to empty array, no classes will be used and instead
  * An optional list of classes to use for indenting the contents. If not set or set to empty array, no classes will be used and instead
- * the {@link module:indent-block/indentblock~IndentBlockConfig#unit `indentBlock.unit`} and
- * {@link module:indent-block/indentblock~IndentBlockConfig#offset `indentBlock.offset`} properties will be used.
+ * the {@link module:indent/indentblock~IndentBlockConfig#unit `indentBlock.unit`} and
+ * {@link module:indent/indentblock~IndentBlockConfig#offset `indentBlock.offset`} properties will be used.
  *
  *
  * @default undefined
  * @default undefined
- * @member {Array.<String>|undefined} module:indent-block/indentblock~IndentBlockConfig#classes
+ * @member {Array.<String>|undefined} module:indent/indentblock~IndentBlockConfig#classes
  */
  */

+ 6 - 6
packages/ckeditor5-indent/src/indentblockcommand.js

@@ -4,7 +4,7 @@
  */
  */
 
 
 /**
 /**
- * @module indent-block/indentblockcommand
+ * @module indent/indentblockcommand
  */
  */
 
 
 import Command from '@ckeditor/ckeditor5-core/src/command';
 import Command from '@ckeditor/ckeditor5-core/src/command';
@@ -13,7 +13,7 @@ import first from '@ckeditor/ckeditor5-utils/src/first';
 /**
 /**
  * The indent block command.
  * The indent block command.
  *
  *
- * The command is registered by the {@link module:indent-block/indentblock~IndentBlock} as `'indentBlock'` - for indenting blocks and
+ * The command is registered by the {@link module:indent/indentblock~IndentBlock} as `'indentBlock'` - for indenting blocks and
  * `'outdentBlock'` - for outdenting blocks.
  * `'outdentBlock'` - for outdenting blocks.
  *
  *
  * To increase block indentation at current selection execute the command:
  * To increase block indentation at current selection execute the command:
@@ -31,7 +31,7 @@ export default class IndentBlockCommand extends Command {
 	 * Creates an instance of the command.
 	 * Creates an instance of the command.
 	 *
 	 *
 	 * @param {module:core/editor/editor~Editor} editor Editor instance.
 	 * @param {module:core/editor/editor~Editor} editor Editor instance.
-	 * @param {module:indent-block/indentblockcommand~IndentBehavior} indentBehavior
+	 * @param {module:indent/indentblockcommand~IndentBehavior} indentBehavior
 	 */
 	 */
 	constructor( editor, indentBehavior ) {
 	constructor( editor, indentBehavior ) {
 		super( editor );
 		super( editor );
@@ -39,7 +39,7 @@ export default class IndentBlockCommand extends Command {
 		/**
 		/**
 		 * Command's indentation behavior.
 		 * Command's indentation behavior.
 		 *
 		 *
-		 * @type {module:indent-block/indentblockcommand~IndentBehavior}
+		 * @type {module:indent/indentblockcommand~IndentBehavior}
 		 * @private
 		 * @private
 		 */
 		 */
 		this._indentBehavior = indentBehavior;
 		this._indentBehavior = indentBehavior;
@@ -91,9 +91,9 @@ export default class IndentBlockCommand extends Command {
 }
 }
 
 
 /**
 /**
- * Provides indentation behavior to {@link module:indent-block/indentblockcommand~IndentBlockCommand}.
+ * Provides indentation behavior to {@link module:indent/indentblockcommand~IndentBlockCommand}.
  *
  *
- * @interface module:indent-block/indentblockcommand~IndentBehavior
+ * @interface module:indent/indentblockcommand~IndentBehavior
  */
  */
 
 
 /**
 /**

+ 2 - 2
packages/ckeditor5-indent/src/indentcommandbehavior/indentusingclasses.js

@@ -4,13 +4,13 @@
  */
  */
 
 
 /**
 /**
- * @module indent-block/indentcommandbehavior/indentusingclasses
+ * @module indent/indentcommandbehavior/indentusingclasses
  */
  */
 
 
 /**
 /**
  * The block indentation behavior that uses classes to set indentation.
  * The block indentation behavior that uses classes to set indentation.
  *
  *
- * @implements module:indent-block/indentblockcommand~IndentBehavior
+ * @implements module:indent/indentblockcommand~IndentBehavior
  */
  */
 export default class IndentUsingClasses {
 export default class IndentUsingClasses {
 	/**
 	/**

+ 2 - 2
packages/ckeditor5-indent/src/indentcommandbehavior/indentusingoffset.js

@@ -4,11 +4,11 @@
  */
  */
 
 
 /**
 /**
- * @module indent-block/indentcommandbehavior/indentusingoffset
+ * @module indent/indentcommandbehavior/indentusingoffset
  */
  */
 
 
 /**
 /**
- * @implements module:indent-block/indentblockcommand~IndentBehavior
+ * @implements module:indent/indentblockcommand~IndentBehavior
  */
  */
 export default class IndentUsingOffset {
 export default class IndentUsingOffset {
 	/**
 	/**