Skip to content

Commit e2265b3

Browse files
author
Farzad Hayatbakhsh
committed
DOC-1928: Update configuration option templates
1 parent 6619b69 commit e2265b3

File tree

2 files changed

+13
-23
lines changed

2 files changed

+13
-23
lines changed
Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
[[<configuration_option>]]
22
== `<configuration_option>`
33

4-
// Replace all instances of <configuration_option> with the
5-
// configuration option name then remove this comment.
6-
7-
// Add explanatory material as per the comment block below then remove
8-
// the block and this comment.
9-
104
////
115
What does the option do?
126
Why use it?
@@ -19,7 +13,7 @@ Are there risks?
1913
- For longer or more complicated scenarios, use the limitations section below.
2014
////
2115

22-
*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, or `+Regexp+`
16+
*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, `+RegExp+`, `+null+`, `+undefined+`
2317

2418
// Remove the *Possible values* line if there is no discrete set of possible values.
2519
*Possible values:* `'string1'`, `'string2'`, `false`
@@ -32,14 +26,14 @@ Are there risks?
3226
[source,js]
3327
----
3428
tinymce.init({
35-
selector: 'textarea', // change this value according to your html
29+
selector: 'textarea', // change this value according to your HTML
3630
<configuration_option>: '<value>'
3731
});
3832
----
3933

4034
// Add a working and tested configuration (edit as required)
4135
// or remove if not applicable.
42-
=== Example: disabling the <feature>
36+
=== Example: disabling the `<configuration_option>` option
4337

4438
To disable <feature>, set `<configuration_option>` to `false`.
4539

@@ -53,17 +47,12 @@ tinymce.init({
5347

5448
// Remove if not applicable.
5549
// Edit the sub-head to singular or plural as required.
56-
=== Limitation(s) of the `<configuration_option>` option
50+
=== Limitation<s> of the `<configuration_option>` option
5751

58-
The `<configuration_option>` option has the following limitations.
59-
60-
// Add explanatory material as per the comment block below then remove
61-
// the block and this comment.
52+
The `<configuration_option>` option has the following limitation<s>:
6253

6354
////
6455
Known limitations.
6556
Complicated scenarios.
6657
Anything that warrants a CAUTION or WARNING admonition.
67-
///
68-
69-
// Remove all comment lines and comment blocks before publishing.
58+
////

-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{configuration_option}.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Are there risks?
1313
- For longer or more complicated scenarios, use the limitations section below.
1414
////
1515

16-
*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, or `+Regexp+`
16+
*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, `+RegExp+`, `+null+`, `+undefined+`
1717

1818
// Remove the *Possible values* line if there is no discrete set of possible values.
1919
*Possible values:* `'string1'`, `'string2'`, `false`
@@ -26,32 +26,33 @@ Are there risks?
2626
[source,js]
2727
----
2828
tinymce.init({
29-
selector: 'textarea', // Change this value according to your HTML
29+
selector: 'textarea', // change this value according to your HTML
3030
<configuration_option>: '<value>'
3131
});
3232
----
3333

3434
// Add a working and tested configuration (edit as required)
3535
// or remove if not applicable.
36-
=== Example: disabling the <feature>
36+
=== Example: disabling the `<configuration_option>` option
3737

3838
To disable <feature>, set `<configuration_option>` to `false`.
3939

4040
[source,js]
4141
----
4242
tinymce.init({
43-
selector: 'textarea', // Change this value according to your HTML
43+
selector: 'textarea', // change this value according to your HTML
4444
<configuration_option>: 'false'
4545
});
4646
----
4747

4848
// Remove if not applicable.
49+
// Edit the sub-head to singular or plural as required.
4950
=== Limitation<s> of the `<configuration_option>` option
5051

51-
The `<configuration_option>` option has the following limitations.
52+
The `<configuration_option>` option has the following limitation<s>:
5253

5354
////
5455
Known limitations.
5556
Complicated scenarios.
5657
Anything that warrants a CAUTION or WARNING admonition.
57-
////
58+
////

0 commit comments

Comments
 (0)