Skip to content

Commit 4fb435c

Browse files
author
Farzad Hayatbakhsh
committed
DOC-1928: Update config options part 2 (F-M)
1 parent 7dd3581 commit 4fb435c

File tree

94 files changed

+224
-122
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+224
-122
lines changed

modules/ROOT/partials/configuration/a11ychecker_filter_issue.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ tinymce.init({
4747

4848
=== Example: using `+a11ychecker_filter_issue+` to filter images with empty alternative text from the Accessibility Checker I1 rule
4949

50-
The callback function in the following example will only return `+false+` for any issues with `'I1'` as the `+'id'+` image elements with an empty `+'alt+'` attribute, otherwise the issue wont be filtered out. This implementation can be useful as allowing images to have empty alternative text can be another method of applying the `+role="presentation"+` attribute to mark an image as `+decorative+`.
50+
The callback function in the following example will only return `+false+` for any issues with `'I1'` as the `+'id'+` image elements with an empty `+'alt+'` attribute, otherwise the issue won't be filtered out. This implementation can be useful as allowing images to have empty alternative text can be another method of applying the `+role="presentation"+` attribute to mark an image as `+decorative+`.
5151

5252
[source,js]
5353
----

modules/ROOT/partials/configuration/advtable_value_series.adoc

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,14 @@ Each top-level properties of the `advtable_value_series` object are used as the
4848

4949
[cols="1,2,1,4",options="header"]
5050
|===
51-
|Name |Value |Requirement |Description
52-
|title |`+String+` |Required |The text shown in the UI for the series.
53-
|update |`+boolean+` |Optional |default: `+false+` - When `+true+`, the series values will be updated when changes are made to the table.
54-
|resizable |`+boolean+` |Optional |default: `+true+` - When `+true+`, table cells containing the series values can be resized using a mouse or touch device.
55-
|generator |`+(info: GeneratorInfo, rowIndex: number, columnIndex: number) => GeneratorResult+` |Required |For details on creating a value series generator, see: xref:advtable.adoc#creating-a-value-series-generator[Creating a value series generator].
51+
| Name | Value | Requirement | Description
52+
| title | `+String+` | Required | The text shown in the UI for the series.
53+
| update | `+Boolean+` | Optional | default: `+false+` - When `+true+`, the series values will be updated when changes are made to the table.
54+
| resizable | `+Boolean+` | Optional | default: `+true+` - When `+true+`, table cells containing the series values can be resized using a mouse or touch device.
55+
| generator | `+(info: GeneratorInfo, rowIndex: number, columnIndex: number) => GeneratorResult+` | Required | For details on creating a value series generator, see: xref:advtable.adoc#creating-a-value-series-generator[Creating a value series generator].
5656
|===
5757

58+
5859
[[creating-a-value-series-generator]]
5960
==== Creating a value series generator
6061

@@ -69,13 +70,13 @@ An object with the following properties is passed to the generator callback func
6970

7071
[cols="1,2,4",options="header"]
7172
|===
72-
|Name |Value |Description
73-
|sectionType |`+'thead'+`, `+'tbody'+` or `+'tfoot'+` |The section of the table cell.
74-
|cellType |`+'td'+` or `+'th'+` |The type of the table cell.
75-
|getRowType |`+() => 'header' \| 'body' \| 'footer'+` | A function that returns the type of row the table cell is part of. A 'header' row is either a row that is part of a `thead` section or contains all `th` cells.
76-
|classes |`+string[]+` |The classes present on the table cell.
77-
|direction |`+'row'+` or `+'column'+` |The direction of the generator.
78-
|prev |`+GeneratorResult+` |The generator result from the previous iteration.
73+
| Name | Value | Description
74+
| sectionType | `+'thead'+`, `+'tbody'+` or `+'tfoot'+` | The section of the table cell.
75+
| cellType | `+'td'+` or `+'th'+` | The type of the table cell.
76+
| getRowType | `+() => 'header' \| 'body' \| 'footer'+` | A function that returns the type of row the table cell is part of. A 'header' row is either a row that is part of a `thead` section or contains all `th` cells.
77+
| classes | `+Array+` of `+Strings+` | The classes present on the table cell.
78+
| direction | `+'row'+` or `+'column'+` | The direction of the generator.
79+
| prev | `+GeneratorResult+` | The generator result from the previous iteration.
7980
|===
8081

8182
[[generatorresult]]
@@ -85,12 +86,13 @@ The generator callback function should return an object with the following prope
8586

8687
[cols="1,1,1,4",options="header"]
8788
|===
88-
|Name |Value |Requirement |Description
89-
|classes |`+string[]+` |Optional |The classes to be applied to the table cell.
90-
|attributes |`+Object+` |Optional |The attributes to be applied to the table cell. The `+attributes+` should be provided as an object where each key is an attribute and each value is of type `+String+`, `+boolean+`, `+number+`, or `+null+`. A value of `+null+` for an attribute will remove the attribute from the table cell.
91-
|value |`+String+`, `+number+` or `+undefined+` |Optional |The value of the table cell. If the value is `+undefined+`, the editor will use the previous value of the table cell.
89+
| Name | Value | Requirement | Description
90+
| classes | `+Array+` of `+Strings+` | Optional | The classes to be applied to the table cell.
91+
| attributes | `+Object+` | Optional | The attributes to be applied to the table cell. The `+attributes+` should be provided as an object where each key is an attribute and each value is of type `+String+`, `+Boolean+`, `+Number+`, or `+null+`. A value of `+null+` for an attribute will remove the attribute from the table cell.
92+
| value | `+String+`, `+Number+` or `+undefined+` | Optional | The value of the table cell. If the value is `+undefined+`, the editor will use the previous value of the table cell.
9293
|===
9394

95+
9496
=== Example: using `+advtable_value_series+`
9597

9698
[source,js]

modules/ROOT/partials/configuration/anchor_bottom.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[anchor_bottom]]
22
== `anchor_bottom`
33

4-
Lets you specify a custom name for the bottom anchor in the url type ahead drop down. To disable the bottom anchor from the drop down set it `+false+`.
4+
Lets you specify a custom name for the bottom anchor in the URL type ahead drop down. To disable the bottom anchor from the drop down set it `+false+`.
55

66
*Type:* `+String+` or `+false+`
77

modules/ROOT/partials/configuration/anchor_top.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[anchor_top]]
22
== `anchor_top`
33

4-
Lets you specify a custom name for the top anchor in the url type ahead drop down. To disable the to anchor from the drop down set it `+false+`.
4+
Lets you specify a custom name for the top anchor in the URL type ahead drop down. To disable the to anchor from the drop down set it `+false+`.
55

66
*Type:* `+String+` or `+false+`
77

modules/ROOT/partials/configuration/br_in_pre.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[br_in_pre]]
22
== `+br_in_pre+`
33

4-
This option allows you to disable {productname}'s default behavior when pressing the enter key within a `+pre+` tag. By default, pressing enter within a `+pre+` tag produces a `+br+` tag at the insertion point. For example:
4+
This option allows you to disable {productname}'s default behavior when pressing the kbd:[Enter] key within a `+pre+` tag. By default, pressing kbd:[Enter] within a `+pre+` tag produces a `+br+` tag at the insertion point. For example:
55

66
`+<pre>This is inside<br>a pre tag.</pre>+`
77

modules/ROOT/partials/configuration/dialog_streamContent.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The recommended method for updating content in an `+iframe+` component is:
6767
onAction: (api) => api.setData({ myiframe: 'new content' })
6868
----
6969

70-
. This updates the iframe to contain the string `'new content'`. This text can be any valid html.
70+
. This updates the iframe to contain the string `'new content'`. This text can be any valid HTML.
7171

7272
. `onAction` is a callback defined in the dialog spec. It is called when a button within the dialog `body` is triggered.
7373

modules/ROOT/partials/configuration/exportword_converter_options.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ As of {productname} 7.5.0, the default value of the `exportword_converter_option
1111
.**Default value:**
1212
[source,js]
1313
----
14-
exportword_converter_options: {
14+
{
1515
document: {
1616
size: 'letter'
1717
}

modules/ROOT/partials/configuration/file_picker_callback.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ It should be noted, that we only provide a hook. It is up to you to implement sp
1111

1212
*Type:* `+Function+`
1313

14+
*Default value:* `+undefined+`
15+
1416
NOTE: The following example demonstrates how you can use `+file_picker_callback+` API, but doesn't pick any real files. Check the xref:interactive-example[Interactive example] for a more functional example.
1517

1618
=== Example: using `+file_picker_callback+`

modules/ROOT/partials/configuration/filetypes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::partial$plugins/tinydrive-filetypeslist.adoc[]
77

88
For example: If the application is using {cloudfilemanager} to insert images, then set `+['image']+` in the file types array.
99

10-
*Type:* `+Array+`
10+
*Type:* `+Array+` of `+Strings+`
1111

1212
=== Interactive example: Using `+filetypes+` to restrict {cloudfilemanager} to image formats
1313

modules/ROOT/partials/configuration/fix_list_elements.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ This invalid list:
1212
<ol>
1313
<li>b</li>
1414
<li>c</li>
15-
</ol>
16-
<li>e</li>
15+
</ol>
16+
<li>e</li>
1717
</ol>
1818
----
1919

0 commit comments

Comments
 (0)