16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
47 lines
870 B
Plaintext
47 lines
870 B
Plaintext
== Why is this an issue?
|
|
|
|
Heading tags are used by search engines and screen reader softwares to construct an outline of the page.
|
|
|
|
Starting at ``++<h1>++`` and not skipping any level eases this automatic construction.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,html]
|
|
----
|
|
<h2>My Title</h2> <!-- Non-Compliant - h1 is not being used -->
|
|
|
|
<h3>My Sub Title</h3> <!-- Compliant -->
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,html]
|
|
----
|
|
<h1>My Title</h1> <!-- Compliant -->
|
|
|
|
<h2>My Sub Title</h2> <!-- Compliant -->
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Do not skip level "Hx".
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== on 8 Jul 2013, 18:24:51 Freddy Mallet wrote:
|
|
Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-2986
|
|
|
|
endif::env-github,rspecator-view[]
|