Skip to content

Commit b0db3a3

Browse files
DOC-3266: Standardised section order for options. (#3826)
* Standardised section order for options. * Update modules/ROOT/partials/configuration/advanced-typography.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/partials/configuration/details_initial_state.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/partials/configuration/dialog_align.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/partials/configuration/details_serialized_state.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/partials/configuration/details_serialized_state.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Fixed indent spacing in dialog_align.adoc. --------- Co-authored-by: Karl Kemister-Sheppard <[email protected]>
1 parent 9ecf0a1 commit b0db3a3

File tree

9 files changed

+34
-37
lines changed

9 files changed

+34
-37
lines changed

modules/ROOT/partials/configuration/advanced-typography.adoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ If an HTML tag or an HTML tag with a specified attribute is added to the `typogr
2727

2828
*Type:* `+Array+`
2929

30-
*Possible values:* `[ '<html-selector>', 'span["<html-selector>"]' ]`
31-
3230
*Default value:* none
3331

32+
*Possible values:* `+[ '<html-selector>', 'span["<html-selector>"]' ]+`
33+
3434
=== Example: Using `typography_ignore`
3535

3636
[source,js,subs="attributes+"]
@@ -39,7 +39,7 @@ tinymce.init({
3939
selector: 'textarea', // change this value according to your html
4040
plugins: '{plugincode}',
4141
toolbar: 'typography',
42-
typography_default_lang: 'en-US',
42+
typography_default_lang: 'en-US',
4343
typography_ignore: [ 'code', 'span["lang"]' ]
4444
});
4545
----
@@ -96,7 +96,7 @@ tinymce.init({
9696

9797
[cols="1,1"]
9898
|===
99-
|Supported language |Language code
99+
|Supported language |Language code
100100

101101
|Belarusian
102102
|be
@@ -212,5 +212,3 @@ tinymce.init({
212212
]
213213
});
214214
----
215-
216-

modules/ROOT/partials/configuration/details_initial_state.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ The default value for this option is `+inherited+`.
1616

1717
*Type:* `+String+`
1818

19-
*Possible values:* `+inherited+`, `+collapsed+`, `+expanded+`
19+
*Default value:* `'+inherited+'`
2020

21-
*Default value:* `+inherited+`
21+
*Possible values:* `'+inherited+'`, `'+collapsed+'`, `'+expanded+'`
2222

2323
=== Example: using `details_initial_state` to set all created Accordion sections to present as closed by default
2424

modules/ROOT/partials/configuration/details_serialized_state.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ The default value for this option is `+inherited+`.
1313

1414
*Type:* `+String+`
1515

16-
*Possible values:* `+inherited+`, `+collapsed+`, `+expanded+`
16+
*Default value:* `'+inherited+'`
1717

18-
*Default value:* `+inherited+`
18+
*Possible values:* `'+inherited+'`, `'+collapsed+'`, `'+expanded+'`
1919

2020
=== Example: using `details_serialized_state` to close all Accordions on content save
2121

modules/ROOT/partials/configuration/dialog_align.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ This is also the value applied if the property is not explicitly set.
99

1010
*Type:* `+String+`
1111

12-
*Possible values:* `'+start+'`, `'+center+'`, `+end+`
13-
1412
*Default value:* `+start+`
1513

14+
*Possible values:* `'+start+'`, `'+center+'`, `'+end+'`
15+
1616
The values, `+start+` and `+end+`, refer to the beginning or end of a text line and are relative to the display language.
1717

1818
For left-to-right written languages (eg English or Vietnamese), `+start+` sets the dialog label as left-aligned and `+end+` sets the dialog label as right-aligned.
@@ -28,18 +28,18 @@ tinymce.activeEditor.windowManager.open({
2828
title: 'Dialog Title', // The dialog's title - displayed in the dialog header
2929
body: {
3030
type: 'panel', // The root body type - a Panel or TabPanel
31-
items: [
32-
{
33-
type: 'label', // component type
34-
label: 'Caption', // text for the group label
35-
align: 'end',
36-
items: [
37-
{
38-
type: 'htmlpanel', // an HTML panel component
39-
html: 'Panel content goes here.'
40-
}
41-
]
42-
}
31+
items: [
32+
{
33+
type: 'label', // component type
34+
label: 'Caption', // text for the group label
35+
align: 'end',
36+
items: [
37+
{
38+
type: 'htmlpanel', // an HTML panel component
39+
html: 'Panel content goes here.'
40+
}
41+
]
42+
}
4343
]
4444
},
4545
buttons: [ // A list of footer buttons

modules/ROOT/partials/configuration/dialog_border.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ The border is also highlighted when the `iframe` component takes focus (by, for
1111

1212
*Type:* `+Boolean+`
1313

14-
*Possible values:* `+true+`, `+false+`
15-
1614
*Default value:* `+false+`
1715

16+
*Possible values:* `+true+`, `+false+`
17+
1818
=== Example: using `border` to display a border around an `iframe` component
1919

2020
[source,js]

modules/ROOT/partials/configuration/dialog_persistent.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ NOTE: If an inline dialog is open and focus is switched away from the {productna
1313

1414
*Type:* `+Boolean+`
1515

16-
*Possible values:* `+true+`, `+false+`
16+
*Default value:* `+false+`
1717

18-
*Default value:* `false`
18+
*Possible values:* `+true+`, `+false+`
1919

2020
=== Example: using `persistent`
2121

modules/ROOT/partials/configuration/dialog_streamContent.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ A user can, however, scroll through the `+iframe+` component as updates are bein
1919

2020
*Type:* `+Boolean+`
2121

22-
*Possible values:* `+true+` `+false+`
22+
*Default value:* `+false+`
2323

24-
*Default value:* `false`
24+
*Possible values:* `+true+` `+false+`
2525

2626
=== Example: setting an `iframe` component to display updating content using the `streamContent` property
2727

@@ -72,4 +72,3 @@ The recommended method for updating content in an `+iframe+` component is:
7272
. `onAction` is a callback defined in the dialog spec. It is called when a button within the dialog `body` is triggered.
7373

7474
. `myiframe` is the name of the `+iframe+` component in this spec.
75-

modules/ROOT/partials/configuration/editimage_toolbar.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
The exact selection of buttons that will appear on the contextual toolbar can be controlled via `+editimage_toolbar+` option.
55

6+
*Type:* `+String+`
7+
8+
*Default value:* `+'rotateleft rotateright | flipv fliph | editimage imageoptions'+`
9+
610
*Possible values:*
711

812
* `+rotateleft+`
@@ -12,10 +16,6 @@ The exact selection of buttons that will appear on the contextual toolbar can be
1216
* `+editimage+`
1317
* `+imageoptions+`
1418

15-
*Type:* `+String+`
16-
17-
*Default value:* `+'rotateleft rotateright | flipv fliph | editimage imageoptions'+`
18-
1919
=== Example: using `+editimage_toolbar+`
2020

2121
[source,js]

modules/ROOT/partials/configuration/tableofcontents_orderedlist_type.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ And setting the `+tableofcontents_orderedlist_type+` to one of its available val
1111

1212
*Type:* `+String+`
1313

14-
*Possible values:* `+'1'+`, `+'A'+`, `+'a'+`, `+'I'+`, `+'i'+`
15-
1614
*Default value:* `+'1'+`
1715

16+
*Possible values:* `+'1'+`, `+'A'+`, `+'a'+`, `+'I'+`, `+'i'+`
17+
1818
The possible values set the type attribute of the ordered list, `<ol>` as follows:
1919

2020
[cols="10%,90%"]

0 commit comments

Comments
 (0)