Skip to content

Commit d320905

Browse files
author
Farzad Hayatbakhsh
committed
DOC-1928: Fix code sample headings to use ".Example" AsciiDoc syntax
1 parent 3ab64be commit d320905

File tree

376 files changed

+511
-535
lines changed

Some content is hidden

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

376 files changed

+511
-535
lines changed

modules/ROOT/partials/configuration/a11y_advanced_options.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If `xref:a11ychecker.adoc#a11ychecker_allow_decorative_images[a11ychecker_allow_
2424

2525
*Default value:* `+false+`
2626

27-
=== Example: using `+a11y_advanced_options+`
27+
.Example: using `+a11y_advanced_options+`
2828

2929
ifeval::["{includedSection}" == "uploadcarePlugin"]
3030

modules/ROOT/partials/configuration/a11ychecker_allow_decorative_images.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ If `+a11ychecker_allow_decorative_images+` is not explicitly set, the value defi
3636

3737
*Default value:* `+false+`
3838

39-
=== Example: using `+a11ychecker_allow_decorative_images+`
39+
.Example: using `+a11ychecker_allow_decorative_images+`
4040

4141
[source,js]
4242
----

modules/ROOT/partials/configuration/a11ychecker_filter_issue.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ The callback function will be passed xref:a11ychecker.adoc#issue[`issue` objects
1313
(issue) => true;
1414
----
1515

16-
=== Example: using `+a11ychecker_filter_issue+` to filter out the Accessibility Checker T1 rule
17-
1816
The callback function in the following example will return `+false+` if the issue `id` value is `'T1'`, filtering `'T1'` issues from the Accessibility Checker report.
1917

18+
.Example: using `+a11ychecker_filter_issue+` to filter out the Accessibility Checker T1 rule
19+
2020
[source,js]
2121
----
2222
tinymce.init({
@@ -29,10 +29,10 @@ tinymce.init({
2929
});
3030
----
3131

32-
=== Example: using `+a11ychecker_filter_issue+` to filter out all Accessibility Checker table rules and rules less than `+'error'+` level
33-
3432
The callback function in the following example will only return `+false+` if the issue `+element+` is a `+'table'+` and the `+'severity'+` level is not `+'error'+`, filtering all low-severity and `+table+` element-related issues from the Accessibility Checker report.
3533

34+
.Example: using `+a11ychecker_filter_issue+` to filter out all Accessibility Checker table rules and rules less than `+'error'+` level
35+
3636
[source,js]
3737
----
3838
tinymce.init({
@@ -45,10 +45,10 @@ tinymce.init({
4545
});
4646
----
4747

48-
=== Example: using `+a11ychecker_filter_issue+` to filter images with empty alternative text from the Accessibility Checker I1 rule
49-
5048
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+`.
5149

50+
.Example: using `+a11ychecker_filter_issue+` to filter images with empty alternative text from the Accessibility Checker I1 rule
51+
5252
[source,js]
5353
----
5454
tinymce.init({

modules/ROOT/partials/configuration/a11ychecker_html_version.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ For example: Setting the version to HTML 4 will enable the rule "Complex tables
1111

1212
*Default value:* `+html5+`
1313

14-
=== Example: using `+a11ychecker_html_version+`
14+
.Example: using `+a11ychecker_html_version+`
1515

1616
[source,js]
1717
----

modules/ROOT/partials/configuration/a11ychecker_ignored_rules.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ The `+a11ychecker_ignored_rules+` option prevents specific Accessibility Checker
99

1010
*Default value:* `+''+`
1111

12-
=== Example: using `+a11ychecker_ignored_rules+`
13-
14-
This examples shows how to ignore the following checks (rules):
12+
This examples shows how to ignore the following rules:
1513

1614
* D2 - Sequential headings
1715
* I2 - Image `+alt+` text is not the image filename
1816
* T4B - Table headers
1917

18+
.Example: using `+a11ychecker_ignored_rules+`
19+
2020
[source,js]
2121
----
2222
tinymce.init({

modules/ROOT/partials/configuration/a11ychecker_issue_url_callback.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ The `+a11ychecker_issue_url_callback+` option is used to change the target URL f
1111
(ruleId) => `https://www.tiny.cloud/docs/tinymce/6/a11ychecker/#${ruleId}`
1212
----
1313

14-
=== Example: using `+a11ychecker_issue_url_callback+`
15-
1614
This example shows how to change the link for the "Click for more info" button (image:icons/help.svg[help icon - a question mark inside a circle]) on the Accessibility Checker dialog to point to anchors at `+www.example.com/tinymce/a11ychecker/more_info+`.
1715

16+
.Example: using `+a11ychecker_issue_url_callback+`
17+
1818
[source,js]
1919
----
2020
tinymce.init({

modules/ROOT/partials/configuration/a11ychecker_level.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For example, the "Text must have a contrast ratio of at least ..." rule:
1414

1515
*Default value:* `+aa+`
1616

17-
=== Example: using `+a11ychecker_level+`
17+
.Example: using `+a11ychecker_level+`
1818

1919
[source,js]
2020
----

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ By setting up the `typography_default_lang`, each time the user opens the {produ
1111

1212
*Default value:* `+en-US+`
1313

14-
=== Example: Using `typography_default_langs`
14+
.Example: Using `typography_default_langs`
1515

1616
[source,js,subs="attributes+"]
1717
----
@@ -36,7 +36,7 @@ If an HTML tag or an HTML tag with a specified attribute is added to the `typogr
3636

3737
*Default value:* `+[]+`
3838

39-
=== Example: Using `typography_ignore`
39+
.Example: Using `typography_ignore`
4040

4141
[source,js,subs="attributes+"]
4242
----
@@ -58,7 +58,7 @@ This option allows the user to apply language-specific typography rules to parti
5858
5959
When setting up `typography_langs` in {productname}, `lang` values — such as `+"en-US"+`, `+"de"+`, and `+"es"+` — populate the Advanced Typography language dropdown list for the user to select from when applying language-specific typography rules to the selected text.
6060
61-
=== Example: Using `typography_default_lang`
61+
.Example: Using `typography_default_lang`
6262
6363
[source,js,subs="attributes+"]
6464
----
@@ -84,7 +84,7 @@ A user can then select text and select from the available languages. That langua
8484

8585
*Default value:* `+[ 'be', 'bg', 'ca', 'cs', 'da', 'nl', 'en-GB', 'en-US', 'eo', 'et', 'fi', 'de', 'el', 'hu', 'ga', 'it', 'lv', 'no', 'pl', 'ro', 'ru', 'sr', 'sk', 'sl', 'es', 'sv', 'tr', 'uk' ]+`
8686

87-
=== Example: Using `typography_langs`
87+
.Example: Using `typography_langs`
8888

8989
[source,js,subs="attributes+"]
9090
----
@@ -151,7 +151,7 @@ All rules supported by the {pluginname} plugin are documented in the https://git
151151

152152
*Default value:* `+undefined+` (all rules are applied)
153153

154-
=== Example: Using `typography_rules`
154+
.Example: Using `typography_rules`
155155

156156
[source,js,subs="attributes+"]
157157
----

modules/ROOT/partials/configuration/advcode.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ As part of the {productname} 6.3 release, the {pluginname} plugin includes a new
1111

1212
*Default value:* `+false+`
1313

14-
== Example: basic setup
14+
.Example: basic setup
1515

1616
[source,js]
1717
----
@@ -40,7 +40,7 @@ This is equivalent to retrieving formatted content by calling `+tinymce.activeEd
4040

4141
*Default value:* `+false+`
4242

43-
== Example: basic setup
43+
.Example: basic setup
4444

4545
[source,js]
4646
----
@@ -70,7 +70,7 @@ By default, any code rendered inside **Enhanced Coded Editor** will be formatted
7070

7171
*Default value:* `+true+`
7272

73-
== Example: basic setup
73+
.Example: basic setup
7474

7575
[source,js]
7676
----

modules/ROOT/partials/configuration/advlist_bullet_styles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This option allows you to include specific unordered list item markers in the de
1414

1515
*Default value:* `+'default,circle,square'+`
1616

17-
=== Example: using `+advlist_bullet_styles+`
17+
.Example: using `+advlist_bullet_styles+`
1818

1919
[source,js]
2020
----

0 commit comments

Comments
 (0)