Skip to content

Commit

Permalink
DocGen 24_2 result (#6955)
Browse files Browse the repository at this point in the history
  • Loading branch information
dxrobot authored Jan 7, 2025
1 parent fcad9f4 commit eb96618
Show file tree
Hide file tree
Showing 21 changed files with 33 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ A zero-based index at which to begin deleting.

##### param(length): Number
The length of the content to be deleted.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.

---
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: dxHtmlEditor.format(formatName, formatValue)
---
---
##### shortDescription
Applies a format to the selected content. Cannot be used with [embedded formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/').
Applies a format to the selected content. Cannot be used with [embedded formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/').

##### param(formatName): Enums.HtmlEditorFormat | String
<!-- %param(formatName)% -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ id: dxHtmlEditor.formatLine(index, length, formatName, formatValue)
---
---
##### shortDescription
Applies a single [block format](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') to all lines in the given range.
Applies a single [block format](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') to all lines in the given range.

##### param(index): Number
A zero-based index at which to begin formatting.

##### param(length): Number
The length of the content to be formatted.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.

##### param(formatName): Enums.HtmlEditorFormat | String
A [format name](/api-reference/_hidden/dxHtmlEditorToolbarItem/name.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/toolbar/items/#name').
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: dxHtmlEditor.formatLine(index, length, formats)
---
---
##### shortDescription
Applies several [block formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') to all lines in the given range.
Applies several [block formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') to all lines in the given range.

##### param(index): Number
<!-- %param(index)% -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: dxHtmlEditor.formatText(index, length, formatName, formatValue)
---
---
##### shortDescription
Applies a single [text format](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') to all characters in the given range.
Applies a single [text format](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') to all characters in the given range.

##### param(index): Number
<!-- %param(index)% -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: dxHtmlEditor.formatText(index, length, formats)
---
---
##### shortDescription
Applies several [text formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') to all characters in the given range.
Applies several [text formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') to all characters in the given range.

##### param(index): Number
<!-- %param(index)% -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can perform the following tasks after getting a format, module, or Parchment
You can change the markup tag associated with the format and allowed format values, as shown in the code example after this list.

- **<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/extends" target="_blank">Extend</a> the format or module**
You can extend HtmlEditor's <a href="https://github.com/DevExpress/DevExtreme/tree/24_2/packages/devextreme/js/__internal/ui/html_editor/formats" target="_blank">formats</a> and <a href="https://github.com/DevExpress/DevExtreme/tree/24_2/packages/devextreme/js/__internal/ui/html_editor/modules" target="_blank">modules</a>, and also the DevExtreme Quill's <a href="https://github.com/DevExpress/devextreme-quill/tree/master/formats" target="_blank">formats</a> and <a href="https://github.com/DevExpress/devextreme-quill/tree/master/modules" target="_blank">modules</a>. See the [Extend Built-In Formats and Modules](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/33%20Customize%20Built-In%20Formats%20and%20Modules/20%20Extend.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/#Customize_Built-In_Formats_and_Modules/Extend') topic for the code example.
You can extend HtmlEditor's <a href="https://github.com/DevExpress/DevExtreme/tree/24_2/packages/devextreme/js/__internal/ui/html_editor/formats" target="_blank">formats</a> and <a href="https://github.com/DevExpress/DevExtreme/tree/24_2/packages/devextreme/js/__internal/ui/html_editor/modules" target="_blank">modules</a>, and also the DevExtreme Quill's <a href="https://github.com/DevExpress/devextreme-quill/tree/master/formats" target="_blank">formats</a> and <a href="https://github.com/DevExpress/devextreme-quill/tree/master/modules" target="_blank">modules</a>. See the [Extend Built-In Formats and Modules](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/60%20Customize%20Built-In%20Formats%20and%20Modules/20%20Extend.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/#Customize_Built-In_Formats_and_Modules/Extend') topic for the code example.

- **Create a custom format based on the Parchment**
Refer to the <a href="https://github.com/quilljs/parchment/blob/master/README.md" target="_blank">Parchment documentation</a> for more information.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ A zero-based index indicating the range's start.

##### param(length): Number
The range's length.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.

---
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Gets the entire content's length.
The content's length.

---
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.

[note] Even if the HtmlEditor is empty, this method returns 1, because the UI component always contains an empty line ("\n").
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The selected content's range. It has the following structure:
A zero-based index at which the selection starts.
- **length**
The selected content's length.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.

##### param(focus): Boolean | undefined
Pass **true** to focus the content field before getting the selected range. Otherwise, the method returns **null** if the content field doesn't have focus.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Inserts an embedded content at the specified position.
A zero-based index at which to insert an embedded content.

##### param(type): String
An embedded format's [name](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/').
An embedded format's [name](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/').

##### param(config): any
An embedded format's [value](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/').
An embedded format's [value](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/').

---
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: dxHtmlEditor.insertText(index, text, formats)
---
---
##### shortDescription
Inserts formatted text at the specified position. Used with all formats except [embedded](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/').
Inserts formatted text at the specified position. Used with all formats except [embedded](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/').

##### param(index): Number
A zero-based index at which to insert text.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ A zero-based index at which to begin removing.

##### param(length): Number
The length of the content to be removed.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.

---
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ A zero-based index at which to begin selecting.

##### param(length): Number
The length of the content to be selected.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.
[Embedded items](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') have a length of 1.

---
2 changes: 1 addition & 1 deletion api-reference/_hidden/dxHtmlEditorToolbarItem/name.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ In the following code, the `header` and `size` formats are configured as describ

---

Refer to the [Formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') article for a full list of available formats.
Refer to the [Formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') article for a full list of available formats.

#####See Also#####
- [widget](/api-reference/_hidden/dxHtmlEditorToolbarItem/widget.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/toolbar/items/#widget')
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
1. [Toolbar](/concepts/05%20UI%20Components/HtmlEditor/20%20Toolbar/00%20Predefined%20Items '/Documentation/Guide/UI_Components/HtmlEditor/Toolbar/Predefined_Items/')
2. [Image upload](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/imageUpload '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/imageUpload/')
3. [Tags and attributes](/concepts/05%20UI%20Components/HtmlEditor/05%20Tags%20and%20Attributes.md '/Documentation/Guide/UI_Components/HtmlEditor/Tags_and_Attributes/')
4. [Table formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/')
4. [Table formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/')
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
- [**Inline Formats**](/Documentation/Guide/UI_Components/HtmlEditor/Formats/#Inline_Or_Text_Formats)
- [**Inline Formats**](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/05%20Inline%20(Or%20Text)%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/#Inline_Or_Text_Formats')
HTML Editor includes various inline formatting options:
- **Bold**, *italic*, <s>strikethrough</s>, and <u>underscore</u>
- Typeface, font size, and text color

- [**Block Formats**](/Documentation/Guide/UI_Components/HtmlEditor/Formats/#Block_Formats)
- [**Block Formats**](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/10%20Block%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/#Block_Formats')
HTML Editor supports block formatting such as:
- Headers
- Lists (ordered and unordered)
Expand All @@ -20,7 +20,7 @@ Images [can be uploaded](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Co
Users can [insert and modify tables](/concepts/05%20UI%20Components/HtmlEditor/00%20Getting%20Started%20with%20HtmlEditor/30%20Work%20with%20Tables.md '/Documentation/Guide/UI_Components/HtmlEditor/Getting_Started_with_HtmlEditor/#Work_with_Tables') with built-in UI elements. You can allow users to [resize tables](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/tableResizing.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/tableResizing/').

- **Built-in Format Customization**
You can [modify the existing formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/33%20Customize%20Built-In%20Formats%20and%20Modules '/Documentation/Guide/UI_Components/HtmlEditor/Formats/#Customize_Built-In_Formats_and_Modules') to fit specific requirements.
You can [modify the existing formats](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/60%20Customize%20Built-In%20Formats%20and%20Modules '/Documentation/Guide/UI_Components/HtmlEditor/Formats/#Customize_Built-In_Formats_and_Modules') to fit specific requirements.

- **Advanced Format Conversion**
The HTML Editor's default value type is HTML. You can [convert](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/converter.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/converter/') the value from HTML to another markup language, for instance, Markdown.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
The extend operation is available for <a href="https://quilljs.com/guides/how-to-customize-quill/#customizing-blots" target="_blank">blots</a> only. For <a href="https://quilljs.com/guides/how-to-customize-quill/#customizing-attributors" target="_blank">attributors</a>, use the modify operation.

The [format](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') tables include customization operations.
The [format](/concepts/05%20UI%20Components/HtmlEditor/10%20Formats/00%20Formats.md '/Documentation/Guide/UI_Components/HtmlEditor/Formats/') tables include customization operations.
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ This tutorial step guides you through the basic Pagination setup.

Specify the following settings:

* [itemCount](/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#itemCount) sets the total number of items. Pagination does not function properly without this setting.
* [pageIndex](/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#pageIndex) sets the initial page to display. This tutorial sets **pageIndex** to 3 (the default value is 1).
* [allowedPageSizes](/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#allowedPageSizes) specifies page sizes available to users. Modify this list as needed. Include `'all'` to allow users to display all items on one page. This tutorial uses the default value: `[5, 10]`.
* [pageSize](/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#pageSize) specifies the initial page size.
* [itemCount](/api-reference/10%20UI%20Components/dxPagination/1%20Configuration/itemCount.md '/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#itemCount') sets the total number of items. Pagination does not function properly without this setting.
* [pageIndex](/api-reference/10%20UI%20Components/dxPagination/1%20Configuration/pageIndex.md '/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#pageIndex') sets the initial page to display. This tutorial sets **pageIndex** to 3 (the default value is 1).
* [allowedPageSizes](/api-reference/10%20UI%20Components/dxPagination/1%20Configuration/allowedPageSizes.md '/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#allowedPageSizes') specifies page sizes available to users. Modify this list as needed. Include `'all'` to allow users to display all items on one page. This tutorial uses the default value: `[5, 10]`.
* [pageSize](/api-reference/10%20UI%20Components/dxPagination/1%20Configuration/pageSize.md '/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#pageSize') specifies the initial page size.

The following code snippet demonstrates how to apply the aforementioned settings:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The render function is called on every page index/size [change](/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#onOptionChanged):
The render function is called on every page index/size [change](/api-reference/10%20UI%20Components/DOMComponent/1%20Configuration/onOptionChanged.md '/Documentation/ApiReference/UI_Components/dxPagination/Configuration/#onOptionChanged'):

---
##### jQuery
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
The following code integrate a [load panel](/Documentation/Guide/UI_Components/LoadPanel/Overview/) into the application. The panel appears when the app requests card data from the remote service. This step is optional.
The following code integrate a [load panel](/concepts/05%20UI%20Components/LoadPanel/00%20Overview.md '/Documentation/Guide/UI_Components/LoadPanel/Overview/') into the application. The panel appears when the app requests card data from the remote service. This step is optional.

---
##### jQuery

To integrate the DevExtreme LoadPanel component:

1. Add a LoadPanel to the code.
2. [Display](/Documentation/ApiReference/UI_Components/dxLoadPanel/Methods/#show) it before calling the render function.
3. [Hide](/Documentation/ApiReference/UI_Components/dxLoadPanel/Methods/#hide) it after render.
2. [Display](/api-reference/10%20UI%20Components/dxLoadPanel/3%20Methods/show().md '/Documentation/ApiReference/UI_Components/dxLoadPanel/Methods/#show') it before calling the render function.
3. [Hide](/api-reference/10%20UI%20Components/dxOverlay/3%20Methods/hide().md '/Documentation/ApiReference/UI_Components/dxLoadPanel/Methods/#hide') it after render.
<!-- ... -->

<!-- tab: index.html -->
Expand Down Expand Up @@ -61,7 +61,7 @@ To integrate the DevExtreme LoadPanel component:
To integrate the DevExtreme LoadPanel component:

1. Add a LoadPanel to the code.
2. [Display](/Documentation/ApiReference/UI_Components/dxLoadPanel/Configuration/#visible) it before calling the render function.
2. [Display](/api-reference/10%20UI%20Components/dxLoadPanel/1%20Configuration/visible.md '/Documentation/ApiReference/UI_Components/dxLoadPanel/Configuration/#visible') it before calling the render function.
3. Hide it after render.
<!-- ... -->

Expand Down Expand Up @@ -109,7 +109,7 @@ To integrate the DevExtreme LoadPanel component:
To integrate the DevExtreme LoadPanel component:

1. Add a LoadPanel to the code.
2. [Display](/Documentation/ApiReference/UI_Components/dxLoadPanel/Configuration/#visible) it before calling the render function.
2. [Display](/api-reference/10%20UI%20Components/dxLoadPanel/1%20Configuration/visible.md '/Documentation/ApiReference/UI_Components/dxLoadPanel/Configuration/#visible') it before calling the render function.
3. Hide it after render.
<!-- ... -->

Expand Down Expand Up @@ -161,7 +161,7 @@ To integrate the DevExtreme LoadPanel component:
To integrate the DevExtreme LoadPanel component:

1. Add a LoadPanel to the code.
2. [Display](/Documentation/ApiReference/UI_Components/dxLoadPanel/Configuration/#visible) it before calling the render function.
2. [Display](/api-reference/10%20UI%20Components/dxLoadPanel/1%20Configuration/visible.md '/Documentation/ApiReference/UI_Components/dxLoadPanel/Configuration/#visible') it before calling the render function.
3. Hide it after render.
<!-- ... -->

Expand Down

0 comments on commit eb96618

Please sign in to comment.