Skip to content

Commit 226d97e

Browse files
author
Farzad Hayatbakhsh
committed
DOC-1928: Clean up partials/configuration directory
1 parent de0dd33 commit 226d97e

Some content is hidden

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

48 files changed

+150
-115
lines changed

modules/ROOT/pages/advanced-typography.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ tinymce.init({
7777
selector: 'textarea', // change this value according to your HTML
7878
plugins: '{plugincode}',
7979
toolbar: '{plugincode}',
80-
typography_default_lang: [ "en-US" ], // Required to set specific typography language rules.
80+
typography_default_lang: 'en-US', // Required to set specific typography language rules.
8181
});
8282
----
8383

modules/ROOT/pages/customsidebar.adoc

Lines changed: 21 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -18,42 +18,30 @@ When a new sidebar is registered, a corresponding toolbar button for toggling th
1818

1919
=== Specification object
2020

21-
[[tooltip]]
22-
==== `+tooltip+`
21+
[cols="1,1,4", options="header"]
22+
|===
23+
| Property | Type | Description
2324

24-
The `+tooltip+` specifies a tooltip to be displayed when hovering over the sidebar toggle button.
25+
| `+tooltip+`
26+
| `+String+`
27+
| Specifies a tooltip to be displayed when hovering over the sidebar toggle button.
2528

26-
*Type:* `+String+`
29+
| `+icon+`
30+
| `+String+`
31+
| Specifies an icon for the sidebar toggle button. The icon should be the name of an icon provided by the {productname} skin or a xref:apis/tinymce.editor.ui.registry.adoc#addIcon[custom icon].
2732

28-
[[icon]]
29-
==== `+icon+`
33+
| `+onSetup+`
34+
| `+Function+`
35+
| Specifies a function to be called when the panel is first created. It passes in an API object and should return a callback that takes an API. The default is `+(api) => (api) => {}+`. This function runs whenever the sidebar is rendered, and the returned callback is executed when the sidebar is destroyed. Therefore, the returned function is essentially an `+onTeardown+` handler, and can be used to unbind events and callbacks.
3036

31-
The `+icon+` specifies an icon for the sidebar toggle button. The icon should be the name of an icon provided by the {productname} skin or a xref:apis/tinymce.editor.ui.registry.adoc#addIcon[custom icon].
37+
| `+onShow+`
38+
| `+Function+`
39+
| Specifies a function to be called when the panel is displayed. It passes in an API object.
3240

33-
*Type:* `+String+`
34-
35-
[[onSetup]]
36-
==== `+onSetup+`
37-
38-
The `+onSetup+` specifies a function to be called when the panel is first created. It passes in an API object and should return a callback that takes an API. The default is `+(api) => (api) => {}+`.
39-
40-
`+onSetup+` is a complex property. It requires a function that takes the sidebar’s API and should return a callback that takes the sidebar's API and returns nothing. This occurs because `+onSetup+` runs whenever the sidebar is rendered, and the returned callback is executed when the sidebar is destroyed. Therefore the returned function is essentially an `+onTeardown+` handler, and can be used to unbind events and callbacks.
41-
42-
*Type:* `+Function+`
43-
44-
[[onShow]]
45-
==== `+onShow+`
46-
47-
The `+onShow+` specifies a function to be called when the panel displayed. It passes in an API object.
48-
49-
*Type:* `+Function+`
50-
51-
[[onHide]]
52-
==== `+onHide+`
53-
54-
The `+onHide+` specifies a function to be called when the panel is hidden. It passes in an API object.
55-
56-
*Type:* `+Function+`
41+
| `+onHide+`
42+
| `+Function+`
43+
| Specifies a function to be called when the panel is hidden. It passes in an API object.
44+
|===
5745

5846
=== API Object
5947

@@ -72,7 +60,8 @@ include::partial$configuration/sidebar_show.adoc[leveloffset=+1]
7260
[source,js]
7361
----
7462
tinymce.init({
75-
...
63+
selector: 'textarea', // change this value according to your HTML
64+
sidebar_show: 'mysidebar',
7665
toolbar: 'mysidebar',
7766
setup: (editor) => {
7867
editor.ui.registry.addSidebar('mysidebar', {

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ This option sets which languages are available for applying language-specific ty
7373

7474
A user can then select text and select from the available languages. That language’s language-specific typography rules are then applied to the selected text.
7575

76-
*Type:* `+Object+`
76+
*Type:* `+Array+`
7777

7878
=== Example: Using `typography_langs`
7979

@@ -161,7 +161,7 @@ tinymce.init({
161161
|Russian
162162
|ru
163163

164-
|Servian
164+
|Serbian
165165
|sr
166166

167167
|Slovak
@@ -203,7 +203,7 @@ tinymce.init({
203203
selector: 'textarea', // change this value according to your html
204204
plugins: '{plugincode}',
205205
toolbar: '{plugincode}',
206-
typography_default_lang: 'en_US', // This is required to configure the default language used by typography.
206+
typography_default_lang: 'en-US', // This is required to configure the default language used by typography.
207207
typography_rules: [
208208
'common/punctuation/quote',
209209
'en-US/dash/main',

modules/ROOT/partials/configuration/advcode.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ include::partial$misc/admon-requires-6.3v.adoc[]
55

66
As part of the {productname} 6.3 release, the {pluginname} plugin includes a new option, `advcode_inline`, that allows users to open the Enhanced Code Editor within {productname}’s existing editor space instead of being displayed in a separate dialog box.
77

8-
Type : `boolean`,
8+
*Type:* `+Boolean+`
99

10-
Default: false
10+
*Possible values:* `+true+`, `+false+`
11+
12+
*Default value:* `+false+`
1113

1214
== Example: basic setup
1315

@@ -62,9 +64,9 @@ As part of the {productname} 7.3 release, the {pluginname} plugin includes a new
6264

6365
By default, any code rendered inside **Enhanced Coded Editor** will be formatted with correct indentation.
6466

65-
Type : `boolean`,
67+
*Type:* `+Boolean+`
6668

67-
Default: `+true+`
69+
*Default value:* `+true+`
6870

6971
*Possible values:* `+true+`, `+false+`
7072

modules/ROOT/partials/configuration/anchor_bottom.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
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

6-
*Type:* `+String+`
6+
*Type:* `+String+` or `+false+`
77

88
*Default value:* `+'#bottom'+`
99

modules/ROOT/partials/configuration/anchor_top.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
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

6-
*Type:* `+String+`
6+
*Type:* `+String+` or `+false+`
77

88
*Default value:* `+'#top'+`
99

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[[auto_focus]]
22
== `+auto_focus+`
33

4-
Automatically set the focus to an editor instance. The value of this option should be an editor instance `+id+`. The editor instance id is the id for the original `+textarea+` or `+div+` element that got replaced.
4+
Automatically set the focus to an editor instance. The value of this option should be an editor instance `+id+`. The editor instance id is the id for the original `+textarea+` or `+div+` element that got replaced. If you set this option to `+true+`, the focus will be set to the last initialized editor instance.
55

6-
*Type:* `+String+`
6+
*Type:* `+String+` or `+true+`
77

8-
=== Example: using `+auto_focus+`
8+
=== Example: using `+auto_focus+` with custom `+id+`
99

1010
[source,js]
1111
----
@@ -14,3 +14,13 @@ tinymce.init({
1414
auto_focus: 'element1'
1515
});
1616
----
17+
18+
=== Example: using `+auto_focus+` with `+true+`
19+
20+
[source,js]
21+
----
22+
tinymce.init({
23+
selector: 'textarea', // change this value according to your HTML
24+
auto_focus: true
25+
});
26+
----

modules/ROOT/partials/configuration/autoresize_bottom_margin.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ This option allows you to specify the size of the `+padding+` at the bottom of t
55

66
*Type:* `+Number+`
77

8+
*Default value:* `+50+`
9+
810
=== Example: using `+autoresize_bottom_margin+`
911

1012
[source,js]

modules/ROOT/partials/configuration/autoresize_overflow_padding.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ This option allows you to specify the size of the `+padding+` at the sides of th
55

66
*Type:* `+Number+`
77

8+
*Default value:* `+1+`
9+
810
=== Example: `+autoresize_overflow_padding+`
911

1012
[source,js]

modules/ROOT/partials/configuration/autosave_prefix.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This option allows you to set the prefix that is used for local storage keys.
55

66
*Type:* `+String+`
77

8-
*Default value:* `+'tinymce-autosave-{path}{query}-{id}-'+`
8+
*Default value:* `+'tinymce-autosave-{path}{query}{hash}-{id}-'+`
99

1010
=== Example: using `+autosave_prefix+`
1111

@@ -14,6 +14,6 @@ This option allows you to set the prefix that is used for local storage keys.
1414
tinymce.init({
1515
selector: 'textarea', // change this value according to your HTML
1616
plugins: 'autosave',
17-
autosave_prefix: 'tinymce-autosave-{path}{query}-{id}-'
17+
autosave_prefix: 'tinymce-autosave-{path}{query}{hash}-{id}-'
1818
});
1919
----

0 commit comments

Comments
 (0)