rspec/rules/S5254/html/rule.adoc
2024-06-04 12:18:07 +02:00

93 lines
2.1 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== Why is this an issue?
The ``++<html>++`` element should provide the ``++lang++`` and/or ``++xml:lang++`` attribute in order to identify the default language of a document.
It enables assistive technologies, such as screen readers, to provide a comfortable reading experience by adapting the pronunciation and accent to the language. It also helps braille translation software, telling it to switch the control codes for accented characters for instance.
Other benefits of marking the language include assisting user agents in providing dictionary definitions or helping users benefit from translation tools.
Both the ``++lang++`` and the ``++xml:lang++`` attributes can take only one value.
 
=== Noncompliant code example
[source,html]
----
<!DOCTYPE html>
<html> <!-- Noncompliant -->
    <head>
         <title>A page written in english</title>
         <meta content="text/html; charset=utf-8" />
    </head>  
    <body>     
    ...   
    </body>
</html>
----
=== Compliant solution
[source,html]
----
<!DOCTYPE html>
<html lang="en">
    <head>
         <title>A page written in english</title>
         <meta content="text/html; charset=utf-8" />
    </head>  
    <body>     
    ...   
    </body>
</html>
----
[source,html]
----
<!DOCTYPE html>
<html lang="en" xml:lang="en">
    <head>
         <title>A page written in english</title>
         <meta content="text/html; charset=utf-8" />
    </head>  
    <body>     
    ...   
    </body>
</html>
----
== Resources
* https://www.w3.org/TR/WCAG20-TECHS/html.html#H57[WCAG2, H57] - Using language attributes on the html element
* https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0#qr-meaning-doc-lang-id[WCAG2, 3.1.1] - Language of Page
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Add "lang" and/or "xml:lang" attributes to this "<html>" element
=== Highlighting
Highlight the <html> element
endif::env-github,rspecator-view[]