Skip to content

Commit 79d5c48

Browse files
author
Farzad Hayatbakhsh
committed
DOC-1928: Update config options part 4 (S-Z)
1 parent b1a330b commit 79d5c48

File tree

76 files changed

+280
-268
lines changed

Some content is hidden

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

76 files changed

+280
-268
lines changed

modules/ROOT/partials/configuration/sandbox_iframes_exclusions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This option allows a list of domains to be specified that should be excluded fro
66
[NOTE]
77
When the `sandbox_iframes` option is set to `+false+`, all domains will be excluded from sandboxing.
88

9-
*Type:* `+Array+`
9+
*Type:* `+Array+` of `+Strings+`
1010

1111
*Default value:*
1212
[source,js]

modules/ROOT/partials/configuration/save_enablewhendirty.adoc

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

4-
This option allows you to disable the save button until modifications have been made to the content of the editor. This option is enabled by default.
4+
This option allows you to disable the `+save+` button until modifications have been made to the content of the editor.
55

66
*Type:* `+Boolean+`
77

modules/ROOT/partials/configuration/save_oncancelcallback.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
[[save_oncancelcallback]]
22
== `+save_oncancelcallback+`
33

4-
This option allows you to specify the function that will be executed when the cancel button/command is invoked.
4+
This option allows you to specify the function that will be executed when the `+cancel+` button is pressed or the `mceCancel` command is invoked.
55

66
*Type:* `+Function+`
77

8+
*Default value:* `+undefined+`
9+
810
=== Example: using `+save_oncancelcallback+`
911

1012
[source,js]

modules/ROOT/partials/configuration/save_onsavecallback.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
[[save_onsavecallback]]
22
== `+save_onsavecallback+`
33

4-
This option allows you to specify the function that will be executed when the save button/command is invoked.
4+
This option allows you to specify the function that will be executed when the `+save+` button is pressed or the `mceSave` command is invoked.
55

66
*Type:* `+Function+`
77

8+
*Default value:* `+undefined+`
9+
810
=== Example: using `+save_onsavecallback+`
911

1012
[source,js]

modules/ROOT/partials/configuration/schema.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
[[schema]]
22
== `+schema+`
33

4-
This option enables you to switch between the HTML4 and HTML5 schema. This controls the valid elements and attributes that can be placed in the HTML. This value can either be the default `+html5+`, `+html4+` or `+html5-strict+`.
4+
This option enables you to switch between the HTML4 and HTML5 schema. This controls the valid elements and attributes that can be placed in the HTML.
55

6-
The html5 schema is the full HTML5 specification including the older HTML4 elements for compatibility. The html5-strict will only allow the elements that are in the current HTML5 specification excluding things that were removed. The html4 schema includes the full html4 transitional specification.
6+
The `+'html5'+` schema is the full HTML5 specification including the older HTML4 elements for compatibility. The `+'html5-strict'+` will only allow the elements that are in the current HTML5 specification excluding things that were removed. The `+'html4'+` schema includes the full HTML4 transitional specification.
77

88
Also note that all event attributes are excluded by default since it's a bad practice to use inline script handles like "onclick". You can manually add extra elements and attributes using the xref:content-filtering.adoc#extended_valid_elements[extended_valid_elements] option.
99

1010
*Type:* `+String+`
1111

12-
*Default value:* `+'html5'+`
13-
1412
*Possible values:* `+'html5'+`, `+'html4'+`, `+'html5-strict'+`
1513

14+
*Default value:* `+'html5'+`
15+
1616
=== Example: using `+schema+`
1717

1818
[source,js]

modules/ROOT/partials/configuration/selection_toolbar.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33

44
The *quickbars_selection_toolbar* option configures the Quick Selection toolbar provided by the xref:quickbars.adoc[quickbars plugin]. To change the buttons on the Quick Selection toolbar, provide a space-separated string of xref:available-toolbar-buttons.adoc[toolbar button names]. The Quick Selection toolbar is intended for buttons related to formatting content, but any xref:available-toolbar-buttons.adoc[{productname} toolbar buttons] or xref:custom-toolbarbuttons.adoc[custom toolbar buttons] are allowed.
55

6-
To disable the Quick Selection toolbar, set `+quickbars_selection_toolbar+` to `+false+`.
7-
86
*Type:* `+String+`
97

108
*Default value:* `+'bold italic | quicklink h2 h3 blockquote'+`

modules/ROOT/partials/configuration/selector.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ For more information on the differences between regular and inline editing modes
99

1010
*Type:* `+String+`
1111

12+
*Default value:* `+undefined+`
13+
1214
=== Example: replace all textarea elements on the page
1315

1416
[source,js]

modules/ROOT/partials/configuration/setup.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ A common use case for this setting is to add editor events to {productname}. For
99

1010
*Type:* `+Function+`
1111

12+
*Default value:* `+undefined+`
13+
1214
=== Example: using `+setup+`
1315

1416
[source,js]

modules/ROOT/partials/configuration/sidebar_show.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ include::partial$misc/admon-iframe-only.adoc[]
99

1010
*Type:* `+String+`
1111

12+
*Default value:* `+undefined+`
13+
1214
=== Example: using `+sidebar_show+`
1315

1416
[source,js]

modules/ROOT/partials/configuration/skin.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ This option allows you to specify the skin that {productname} should use, or `+f
55

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

8-
*Default value:* `+'oxide'+`
9-
108
*Possible values:* the name of a skin or `+false+`
119

10+
*Default value:* `+'oxide'+`
11+
1212
The name of the skin should match the name of the folder within the skins directory of {productname}. If the specified skin is not found, {productname} will not load.
1313

1414
[source,js]

0 commit comments

Comments
 (0)