Merge branch 'feature/8.0.0/DOC-3147' into feature/8.0.0/DOC-3147_TINY-12090

Author: kemister85

modules/ROOT/examples/live-demos/a11ychecker/index.js

@@ -2,8 +2,11 @@ tinymce.init({
   selector: 'textarea#a11ychecker',
   plugins: 'a11ychecker advcode table advlist lists image media anchor link autoresize',
   toolbar: 'a11ycheck | blocks bold forecolor backcolor | bullist numlist | link image media anchor | table | code',
+  max_height: 500,
   a11y_advanced_options: true,
   a11ychecker_html_version: 'html5',
   a11ychecker_level: 'aaa',
+  a11ychecker_allow_decorative_images: true,
+  a11ychecker_alt_text_max_length: 150,
   content_style: 'body { font-family:Helvetica,Arial,sans-serif; font-size:16px }'
 });

modules/ROOT/nav.adoc

@@ -140,8 +140,6 @@
 **** xref:configure-imageproxy-service.adoc[Image Proxy service settings]
 **** xref:configure-spelling-service.adoc[Spelling service settings]
 **** xref:self-hosting-hunspell.adoc[Spelling service - Using Hunspell dictionaries]
-**** xref:configure-logging-services.adoc[Activity logging]
-*** xref:introduction-to-premium-selfhosted-services.adoc[Server-side component installation without Docker]
 *** xref:troubleshoot-server.adoc[Troubleshoot server-side components]
 ** Customizing the editor appearance
 *** xref:customize-ui.adoc[Customizing the UI]

modules/ROOT/pages/8.0-release-notes.adoc

@@ -46,307 +46,68 @@ Each rule has a severity level, which will be one of the following, listed in or
 * Warning
 * Error
 
-[[D1]]
-=== D1 - Usage of paragraphs as headings
+[[document-structure-rules]]
+=== Document structure rules
 
-*Rule description:* this rule checks that `+h1+`-`+h6+` tags are used for heading content, not `+p+` tags. Not using correct heading markup will make it difficult for assistive technologies to represent and navigate through your content.
+include::partial$a11y-rules/d1.adoc[]
 
-==== {pluginname} rule details - D1
+include::partial$a11y-rules/d2.adoc[]
 
-Notification level (severity):: Warning
+include::partial$a11y-rules/d3.adoc[]
 
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
+include::partial$a11y-rules/d4o.adoc[]
 
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
+include::partial$a11y-rules/d4u.adoc[]
 
-WCAG 2.1 specifications::
+include::partial$a11y-rules/d5.adoc[]
 
-* https://www.w3.org/WAI/WCAG21/Techniques/html/H42.html[H42 - Using h1-h6 to identify headings].
-* https://www.w3.org/WAI/WCAG21/Techniques/html/H69.html[H69 - Providing heading elements at the beginning of each section of content].
+'''
 
-[[D2]]
-=== D2 - Sequential headings
+[[html-rules]]
+=== HTML rules
 
-*Rule description:* this rule checks that headings tags are used sequentially.
+include::partial$a11y-rules/h93.adoc[]
 
-For example: A `+h1+` heading should be followed by a `+h2+` heading, not a `+h3+` heading. Using sequential headings will make it easier for assistive technology to parse your content.
+'''
 
-==== {pluginname} rule details - D2
+[[image-rules]]
+=== Image rules
 
-Notification level (severity):: Error
+include::partial$a11y-rules/i1.adoc[]
 
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
+include::partial$a11y-rules/i2.adoc[]
 
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
+include::partial$a11y-rules/i3.adoc[]
 
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/general/G141.html[G141 - Organizing a page using headings].
+include::partial$a11y-rules/i4.adoc[]
 
-[[D3]]
-=== D3 - Adjacent links
+'''
 
-*Rule description:* this rule checks that links next to other links do not have the same `+href+` attribute.
+[[table-rules]]
+=== Table rules
 
-For example: If an image link and a text link have the same `+href+` attribute, both elements should be in the same `+a+` element. If an image link and a text link point to the same URL but are two separate elements, it can be confusing for users of screen readers and other assistive technologies.
+include::partial$a11y-rules/t1.adoc[]
 
-==== {pluginname} rule details - D3
+include::partial$a11y-rules/t2.adoc[]
 
-Notification level (severity):: Error
+include::partial$a11y-rules/t3.adoc[]
 
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
+include::partial$a11y-rules/t4a.adoc[]
 
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
+include::partial$a11y-rules/t4b.adoc[]
 
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H2.html[H2 - Combining adjacent image and text links for the same resource].
+include::partial$a11y-rules/t4c.adoc[]
 
-[[D4O]]
-=== D4O - Ordered list structure
-
-*Rule description:* this rule checks that an `+ol+` element is used for ordered lists. Do not use paragraphs beginning with numbers or roman numerals instead of an `+ol+` element containing `+li+` items. This is to simplify navigation and parsing of the content for users of assistive technologies.
-
-==== {pluginname} rule details - D4O
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H48.html[H48 - Using ol, ul and dl for lists or groups of links].
-
-[[D4U]]
-=== D4U - Unordered list structure
-
-*Rule description:* this rule checks that a `+ul+` element is used for unordered lists. Do not use paragraphs beginning with `+*+` or `+-+` or some similar character instead of an `+ol+` element containing `+li+` items. This is to simplify navigation and parsing of the content for users of assistive technologies.
-
-==== {pluginname} rule details - D4U
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H48.html[H48 - Using ol, ul and dl for lists or groups of links].
-
-[[D5]]
-=== D5 - Contrast ratio of the text (D5A, D5B, and D5C)
-
-*Rule description:* this rule checks that the contrast ratio of the text is above the following values:
-
-* When the compliance level is set to AA,
-** 4.5:1 for normal text
-** 3:1 for large text
-* When the compliance level is set to AAA,
-** 7:1 for any text
-
-Text with a low contrast ratio is hard to read for users with impaired vision.
-
-[[D5A]]
-==== {pluginname} rule details - D5A
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level AA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/general/G145.html[G145 - Ensuring that a contrast ratio of at least 3:1 exists between text (and images of text) and background behind the text].
-
-[[D5B]]
-==== {pluginname} rule details - D5B
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level AA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/general/G18.html[G18 - Ensuring that a contrast ratio of at least 4.5:1 exists between text (and images of text) and background behind the text].
-
-[[D5C]]
-==== {pluginname} rule details - D5C
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/general/G17.html[G17 - Ensuring that a contrast ratio of at least 7:1 exists between text (and images of text) and background behind the text].
-
-[[H93]]
-=== H93 - IDs must be unique
-
-*Rule description:* this rule checks that all `+id+` attributes are unique in the editor. Duplicate `+id+` attributes are known to cause problems for assistive technologies when parsing the content.
-
-==== {pluginname} rule details - H93
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H93.html[H93 - Ensuring that id attributes are unique on a Web page].
-
-[[I1]]
-=== I1 - Image `+alt+` text
-
-*Rule description:* this rule checks that all images have alternative (`+alt+`) text for screen readers and other assistive technologies.
-
-==== {pluginname} rule details - I1
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/general/G95.html[G95 - Providing short text alternatives that provide a brief description of the non-text content].
-
-include::partial$misc/admon-accessibility-rule-i3-can-also-be-applied.adoc[]
-
-[[I2]]
-=== I2 - Image `+alt+` text is not the image filename
-
-*Rule description:* this rule checks that the `+alt+` attribute text of the image is not the same as the filename of the image.
-
-==== {pluginname} rule details - I2
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/general/G95.html[G95 - Providing short text alternatives that provide a brief description of the non-text content].
-
-include::partial$misc/admon-accessibility-rule-i3-can-also-be-applied.adoc[]
-
-[[I3]]
-=== I3 - Image `+alt+` text is not greater than 100 characters
-
-*Rule description:* this rule checks that the `+alt+` attribute text of the image is not more than 100 characters.
-
-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.
-
-==== {pluginname} rule details - I3
-
-Notification level (severity):: Warning
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: n/a.
-
-
-[[T1]]
-=== T1 - Table caption
-
-*Rule description:* this rule checks that all `+table+` elements have a `+caption+` element describing the data inside the table to simplify parsing and navigation of the content for users of assistive technologies.
-
-==== {pluginname} rule details - T1
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H39.html[H39 - Using caption elements to associate data table captions with data tables].
-
-[[T2]]
-=== T2 - Complex table summary
-
-*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.
-
-[NOTE]
-====
-This rule only applies to HTML 4 content and is not checked when `+a11ychecker_html_version+` is set to `+html5+`.
-====
-
-==== {pluginname} rule details - T2
-
-Notification level (severity):: Warning
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H73.html[H73 - Using the summary attribute of the table element to give an overview of data tables].
-
-[[T3]]
-=== T3 - Table caption and summary
-
-*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.
-
-[NOTE]
-====
-The table `+summary+` attribute was deprecated in HTML 5, both the *what* and *how* information should be moved to the table caption.
-====
-
-==== {pluginname} rule details - T3
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H73.html[H73 - Using the summary attribute of the table element to give an overview of data tables].
-
-[[T4A]]
-=== T4A - Table markup
-
-*Rule description:* this rule checks that all `+tables+` contain both `+tr+` and `+td+` elements.
-
-==== {pluginname} rule details - T4A
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H51.html[H51 - Using table markup to present tabular information].
-
-[[T4B]]
-=== T4B - Table headers
-
-*Rule description:* this rule checks that all `+table+` elements contain at least one table header (`+th+`) element.
-
-==== {pluginname} rule details - T4B
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H51.html[H51 - Using table markup to present tabular information].
-
-[[T4C]]
-=== T4C - Table heading scope
-
-*Rule description:* this rule checks that all table header (`+th+`) elements have a `+scope+` attribute clarifying what scope the heading has inside of the `+table+`. The allowed values are `+row+`, `+col+`, `+rowgroup+`, and `+colgroup+`. This is important for users of assistive technologies to be able to parse table data.
-
-==== {pluginname} rule details - T4C
-
-Notification level (severity):: Error
-
-https://www.w3.org/TR/WCAG21/#conformance[WCAG level]:: Level A ; Level AA ; Level AAA
-
-xref:a11ychecker_html_version[HTML version]:: HTML4 and HTML5
-
-WCAG 2.1 specification:: https://www.w3.org/WAI/WCAG21/Techniques/html/H63.html[H63 - Using the scope attribute to associate header cells and data cells in data tables].
+'''
 
 == Options
 
 The following configuration options affect the behavior of the {pluginname} plugin.
 
 include::partial$configuration/a11y_advanced_options.adoc[leveloffset=+1]
 
+include::partial$configuration/a11ychecker_alt_text_max_length.adoc[leveloffset=+1]
+
 include::partial$configuration/a11ychecker_allow_decorative_images.adoc[leveloffset=+1]
 
 include::partial$configuration/a11ychecker_filter_issue.adoc[leveloffset=+1]