Browse Source

Docs: Revised the Lists feature guide. [skip ci]

Anna Tomanek 5 years ago
parent
commit
3679012f75

+ 10 - 12
packages/ckeditor5-list/docs/_snippets/features/lists-basic.html

@@ -1,20 +1,18 @@
 <div id="snippet-lists-basic">
-    <h2>Unordered list</h2>
-    <p>Such a list can represent items where the order is not important, e.g. a list of ingredients required for preparing a dish or a drink.</p>
+    <h2>Ingredients</h2>
     <p>Ingredients required for making a coffee:</p>
     <ul>
-        <li>15g coffee ground</li>
-        <li>a cup</li>
+        <li>15g ground coffee</li>
         <li>water</li>
+        <li>milk <i>(optional)</i></li>
     </ul>
-    <h2>Ordered list</h2>
-    <p>The ordered list can be used if the order of the items matters, e.g. when describing an instruction. The order of steps that must be done is important.</p>
-    <p>How to prepare the coffee?</p>
+    <h2>Instructions</h2>
+    <p>How to prepare a cup of coffee:</p>
     <ol>
-        <li>Gather the ingredients</li>
-        <li>Put 15g of the coffee ground into the cup</li>
-        <li>Boil 200ml of water</li>
-        <li>Pour water into a cup</li>
-        <li>Optional: add milk as you wish</li>
+        <li>Gather the ingredients.</li>
+        <li>Put 15g of ground coffee in the cup.</li>
+        <li>Boil 200ml of water.</li>
+        <li>Pour the water into the cup.</li>
+        <li>Optional: Add milk.</li>
     </ol>
 </div>

+ 10 - 9
packages/ckeditor5-list/docs/_snippets/features/lists-style.html

@@ -1,17 +1,18 @@
 <div id="snippet-lists-styles">
-    <p>Let's use the coffee recipe from the demo in section <a href="#demo">Ordered and unordered lists</a> and use the list styles feature.</p>
+    <h2>Ingredients</h2>
     <p>Ingredients required for making a coffee:</p>
     <ul style="list-style-type:circle;">
-        <li>15g coffee ground</li>
-        <li>a cup</li>
+        <li>15g ground coffee</li>
         <li>water</li>
+        <li>milk <i>(optional)</i></li>
     </ul>
-    <p>How to prepare the coffee?</p>
+    <h2>Instructions</h2>
+    <p>How to prepare a cup of coffee:</p>
     <ol style="list-style-type:decimal-leading-zero;">
-        <li>Gather the ingredients</li>
-        <li>Put 15g of the coffee ground into the cup</li>
-        <li>Boil 200ml of water</li>
-        <li>Pour water into a cup</li>
-        <li>Optional: add milk as you wish</li>
+        <li>Gather the ingredients.</li>
+        <li>Put 15g of ground coffee in the cup.</li>
+        <li>Boil 200ml of water.</li>
+        <li>Pour the water into the cup.</li>
+        <li>Optional: Add milk.</li>
     </ol>
 </div>

+ 3 - 3
packages/ckeditor5-list/docs/api/list.md

@@ -6,15 +6,15 @@ category: api-reference
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-list.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-list)
 
-This package implements bulleted, numbered and to-do list feature for CKEditor 5.
+This package implements bulleted, numbered and to-do list features for CKEditor 5.
 
 ## Documentation
 
-See the {@link module:list/list~List} plugin documentation and {@link features/todo-lists to-do list feature} guide.
+See the {@link module:list/list~List} plugin documentation as well as the {@link features/lists lists} and {@link features/todo-lists to-do list} feature guides.
 
 ## Installation
 
-```bash
+```
 npm install --save @ckeditor/ckeditor5-list
 ```
 

+ 17 - 9
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 and unordered lists in the editor.
+The {@link module:list/list~List list} feature allows creating ordered (numbered) and unordered (bulleted) lists in the editor.
 
 <info-box info>
 	The feature is enabled by default in all CKEditor 5 WYSIWYG editor builds.
@@ -14,6 +14,10 @@ The {@link module:list/list~List list} feature allows creating ordered and unord
 
 ## Ordered and unordered lists
 
+An unordered (bulleted) list can represent items where the order is not important, for example, a list of ingredients required for preparing a dish or a drink.
+
+An ordered (numbered) list can be used if the order of the items matters, for example, when creating an instruction. Here, the sequence of steps that must be done is important.
+
 Use the editor below to see the list feature plugin in action.
 
 ### Demo
@@ -22,11 +26,11 @@ Use the editor below to see the list feature plugin in action.
 
 ## List styles
 
-The {@link module:list/liststyle~ListStyle list styles} feature allows customizing the list's marker.
+The {@link module:list/liststyle~ListStyle list style} feature allows customizing the list item markers. When enabled, it adds 3 styles for unordered lists and 6 styles for ordered lists to choose from. The styles can be changed via the dropdown that opens when you click the arrow next to the appropriate list button in the toolbar.
 
 ### Demo
 
-Use the editor below to see the list styles feature plugin in action.
+Use the editor below to see the list style plugin in action.
 
 {@snippet features/lists-style}
 
@@ -34,7 +38,7 @@ Use the editor below to see the list styles feature plugin in action.
 
 To add this feature to your editor, install the [`@ckeditor/ckeditor5-list`](https://www.npmjs.com/package/@ckeditor/ckeditor5-list) package:
 
-```bash
+```
 npm install --save @ckeditor/ckeditor5-list
 ```
 
@@ -60,6 +64,10 @@ ClassicEditor
 	The {@link module:list/liststyle~ListStyle} feature overrides UI button implementations from the {@link module:list/listui~ListUI}.
 </info-box>
 
+## List indentation
+
+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.
@@ -72,12 +80,12 @@ The {@link module:list/list~List} plugin registers:
 * The {@link module:list/listcommand~ListCommand `'bulletedList'`} command.
 * The {@link module:list/indentcommand~IndentCommand `'indentList'`} command.
 * The {@link module:list/indentcommand~IndentCommand `'outdentList'`} command.
-* The `'numberedList'` ui button.
-* The `'bulletedList'` ui button.
+* The `'numberedList'` UI button.
+* The `'bulletedList'` UI button.
 
 The {@link module:list/liststyle~ListStyle} plugin registers:
 
-* The {@link module:list/liststylecommand~ListStyleCommand `'listStyle'`} command that accepts a `type` of a list style to set.
+* The {@link module:list/liststylecommand~ListStyleCommand `'listStyle'`} command that accepts a `type` of the list style to set.
     ```js
     editor.execute( 'listStyle', { type: 'decimal' } );
     ```
@@ -85,8 +93,8 @@ The {@link module:list/liststyle~ListStyle} plugin registers:
 
     * For bulleted lists: `'disc'`, `'circle'`, and `'square'`.
     * For numbered lists: `'decimal'`, `'decimal-leading-zero'`, `'lower-roman'`, `'upper-roman'`, `'lower-latin'`, and `'upper-latin'`.
-* The `'numberedList'` ui split button (it overrides UI button registered by the `List` plguin.
-* The `'bulletedList'` ui split button (it overrides UI button registered by the `List` plguin.
+* The `'numberedList'` UI split button (it overrides the UI button registered by the `List` plguin.
+* The `'bulletedList'` UI split button (it overrides the UI button registered by the `List` plguin.
 
 ## Contribute
 

+ 2 - 2
packages/ckeditor5-list/docs/features/todo-lists.md

@@ -4,7 +4,7 @@ category: features
 
 # To-do lists
 
-The {@link module:list/todolist~TodoList to-do list} feature lets you create a list of interactive checkboxes with labels. It supports all features of regular lists so you can nest a to-do list together with bulleted and numbered lists in any combination.
+The {@link module:list/todolist~TodoList to-do list} feature lets you create a list of interactive checkboxes with labels. It supports all features of regular lists so you can nest a to-do list together with {@link features/lists bulleted and numbered lists} in any combination.
 
 ## Demo
 
@@ -90,7 +90,7 @@ From the technical point of view, to-do lists are built on top of the {@link mod
 
 ## Ordered and unordered lists
 
-You can read more about those features in the {@link features/lists Lists} feature guide.
+You can read more about these features in the {@link features/lists Lists} feature guide.
 
 ## Contribute