Skip to content

Commit e295593

Browse files
author
Farzad Hayatbakhsh
committed
DOC-2592: Fix inline code inside admonitions
1 parent 277332b commit e295593

File tree

5 files changed

+23
-8
lines changed

5 files changed

+23
-8
lines changed

modules/ROOT/pages/a11ychecker.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,10 @@ WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H39.html[
264264

265265
*Rule description:* this rule checks that all complex tables must have a `+summary+` attribute explaining to users of assistive technologies how to navigate through the data inside of the table.
266266

267-
NOTE: This rule only applies to HTML 4 content and is not checked when `+a11ychecker_html_version+` is set to `+html5+`.
267+
[NOTE]
268+
====
269+
This rule only applies to HTML 4 content and is not checked when `+a11ychecker_html_version+` is set to `+html5+`.
270+
====
268271

269272
==== {pluginname} rule details - T2
270273

@@ -281,7 +284,10 @@ WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H73.html[
281284

282285
*Rule description:* this rule checks that the table caption and summary does not have the same text content. The caption should explain *what* the table is about while the summary should explain *how* to navigate the data inside of the table.
283286

284-
NOTE: The table `+summary+` attribute was deprecated in HTML 5, both the *what* and *how* information should be moved to the table caption.
287+
[NOTE]
288+
====
289+
The table `+summary+` attribute was deprecated in HTML 5, both the *what* and *how* information should be moved to the table caption.
290+
====
285291

286292
==== {pluginname} rule details - T3
287293

@@ -380,7 +386,7 @@ Opens and closes the accessibility checker dialog with the results of the audit
380386

381387
[source,js]
382388
----
383-
editor.plugins.a11ychecker.toggleaudit();
389+
tinymce.activeEditor.plugins.a11ychecker.toggleaudit();
384390
----
385391

386392
[[getreport]]
@@ -420,7 +426,7 @@ console.log(issues);
420426
[[issue]]
421427
=== The `+issue+` object
422428

423-
In a11ychecker, when the content within the editor is `audited`, each element is checked to ensure that no xref:a11ychecker.adoc#accessibility-rules[Accessibility rules] are violated. Any element which doesnt adhere to a rule will generate an `issue` within the audit; the details of which are to be displayed in the a11ychecker dialog.
429+
In a11ychecker, when the content within the editor is `audited`, each element is checked to ensure that no xref:a11ychecker.adoc#accessibility-rules[Accessibility rules] are violated. Any element which doesn't adhere to a rule will generate an `issue` within the audit; the details of which are to be displayed in the a11ychecker dialog.
424430

425431
The `+'issue'+` object provides relevant data pertaining to any issue generated by an element which violates an xref:a11ychecker.adoc#accessibility-rules[Accessibility rule]:
426432

modules/ROOT/partials/configuration/a11y_advanced_options.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ Setting `+a11y_advanced_options+` to `+true+`:
1111
* Adds the *Image is decorative* option to the _Insert/Edit Image_ dialog, allowing users to specify that an image is decorative and does not require alternative text for accessibility purposes.
1212
* Adds the *Image is decorative* option to the _Accessibility Checker error_ dialog for images without alternative text or the `+role="presentation"+` attribute.
1313

14-
IMPORTANT: When `+a11y_advanced_options+` is set to `+true+`, xref:a11ychecker.adoc#a11ychecker_allow_decorative_images[`+a11ychecker_allow_decorative_images+`] will default to `+true+`.
14+
[IMPORTANT]
15+
====
16+
When `+a11y_advanced_options+` is set to `+true+`, xref:a11ychecker.adoc#a11ychecker_allow_decorative_images[`+a11ychecker_allow_decorative_images+`] will default to `+true+`.
17+
====
1518

1619
*Type:* `+Boolean+`
1720

modules/ROOT/partials/configuration/a11ychecker_allow_decorative_images.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ If `+a11ychecker_allow_decorative_images+` is set to `+false+`, the Accessibilit
2525
* An image has an empty alternative text attribute.
2626
* An image has the `+role="presentation"+` attribute.
2727

28-
NOTE: If xref:a11ychecker.adoc#a11y_advanced_options[`+a11y_advanced_options+`] is set to `+true+`, `+a11ychecker_allow_decorative_images+` will default to `+true+`.
28+
[NOTE]
29+
====
30+
If xref:a11ychecker.adoc#a11y_advanced_options[`+a11y_advanced_options+`] is set to `+true+`, `+a11ychecker_allow_decorative_images+` will default to `+true+`.
31+
====
2932

3033
*Type:* `+Boolean+`
3134

modules/ROOT/partials/configuration/a11ychecker_issue_url_callback.adoc

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

4-
The `+a11ychecker_issue_url_callback+` option is used to change the target URL for the "Click for more info" button (image:icons/help.svg[help icon - a question mark inside a circle]) in the Accessibility Checker dialog. By default, the "more info" links will point to `+https://www.tiny.cloud/docs/tinymce/6/a11ychecker/#<ruleId>+`, such as `+https://www.tiny.cloud/docs/tinymce/6/a11ychecker/#D1+`. This option can be used to set the target URL to a page or pages outside {site-url}/.
4+
The `+a11ychecker_issue_url_callback+` option is used to change the target URL for the "Click for more info" button (image:icons/help.svg[help icon - a question mark inside a circle]) in the Accessibility Checker dialog. By default, the "more info" links will point to `+https://www.tiny.cloud/docs/tinymce/7/a11ychecker/#<ruleId>+`, such as `+https://www.tiny.cloud/docs/tinymce/7/a11ychecker/#D1+`. This option can be used to set the target URL to a page or pages outside {site-url}/.
55

66
*Type:* `+Function+`
77

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
NOTE: In {productname} 6.3 and later, rule xref:I3[I3] can also be applied. If applied, an _Image alternative text should be less than 100 characters_ warning dialog presents if the alternative (`+alt+`) text is longer than 100 characters. This dialog also presents the alternative text in an editable field, for immediate repair.
1+
[NOTE]
2+
====
3+
In {productname} 6.3 and later, rule xref:I3[I3] can also be applied. If applied, an _Image alternative text should be less than 100 characters_ warning dialog presents if the alternative (`+alt+`) text is longer than 100 characters. This dialog also presents the alternative text in an editable field, for immediate repair.
4+
====

0 commit comments

Comments
 (0)