rspec/rules/S1086/html/rule.adoc

== 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[]
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Why is this an issue?`

Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`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.

Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Noncompliant code example`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00
RULEAPI-661: Add syntax coloring 2022-02-04 17:28:24 +01:00			`[source,html]`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`----`
			`<h2>My Title</h2> <!-- Non-Compliant - h1 is not being used -->`

			`<h3>My Sub Title</h3> <!-- Compliant -->`
			`----`

Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Compliant solution`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00
RULEAPI-661: Add syntax coloring 2022-02-04 17:28:24 +01:00			`[source,html]`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`----`
			`<h1>My Title</h1> <!-- Compliant -->`

			`<h2>My Sub Title</h2> <!-- Compliant -->`
			`----`
Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`ifdef::env-github,rspecator-view[]`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`'''`
			`== Implementation Specification`
			`(visible only on this page)`

Inline adoc when include has no additional value (#1940) 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. 2023-05-25 14:18:12 +02:00			`=== Message`

			`Do not skip level "Hx".`

RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
RULEAPI-576: add a horizontal rule between rule description and comments 2021-06-08 15:52:13 +02:00			`'''`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00			`== Comments And Links`
			`(visible only on this page)`

Inline adoc when include has no additional value (#1940) 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. 2023-05-25 14:18:12 +02:00			`=== on 8 Jul 2013, 18:24:51 Freddy Mallet wrote:`
			`Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-2986`

Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`endif::env-github,rspecator-view[]`