rspec/rules/S1101/html/rule.adoc

== Why is this an issue?

When links with different targets are given identical link text, this can produce confusion for users of assistive technologies, some of which provide users the ability to view a list of all links on the page.

When this list of links is presented to the user they may be left not knowing the links go to different destinations.

Even if they do realize the links go to different destinations, they may be left not knowing which link to follow to go to the destination they desire.


=== Noncompliant code example

[source,html]
----
<a href="a.html">qux</a>
<a href="b.html">qux</a>          <!-- Noncompliant; same text, different targets -->

<a href="c.html">foo</a>
<a href="d.html">foo</a>          <!-- Noncompliant; same text, different targets -->
----


=== Compliant solution

[source,html]
----
<a href="a.html">qux</a>
<a href="b.html">qaz</a>          <!-- Compliant; different text, different targets -->

<a href="c.html">foo</a>
<a href="c.html">foo</a>          <!-- Compliant; same text, same targets -->
----


ifdef::env-github,rspecator-view[]

'''
== Implementation Specification
(visible only on this page)

=== Message

Use distinct texts or point to the same target for this link and the one at line X.


'''
== Comments And Links
(visible only on this page)

=== on 24 Jun 2013, 13:51:59 Dinesh Bolkensteyn wrote:
SQALE to be added

=== on 8 Jul 2013, 18:18:11 Freddy Mallet wrote:
Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-3010

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			`When links with different targets are given identical link text, this can produce confusion for users of assistive technologies, some of which provide users the ability to view a list of all links on the page.`

			`When this list of links is presented to the user they may be left not knowing the links go to different destinations.`

			`Even if they do realize the links go to different destinations, they may be left not knowing which link to follow to go to the destination they desire.`

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			`----`
			`<a href="a.html">qux</a>`
			`<a href="b.html">qux</a> <!-- Noncompliant; same text, different targets -->`

			`<a href="c.html">foo</a>`
			`<a href="d.html">foo</a> <!-- Noncompliant; same text, different targets -->`
			`----`

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			`----`
			`<a href="a.html">qux</a>`
			`<a href="b.html">qaz</a> <!-- Compliant; different text, different targets -->`

			`<a href="c.html">foo</a>`
			`<a href="c.html">foo</a> <!-- Compliant; same text, same targets -->`
			`----`
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`

			`Use distinct texts or point to the same target for this link and the one at line X.`

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 24 Jun 2013, 13:51:59 Dinesh Bolkensteyn wrote:`
			`SQALE to be added`

			`=== on 8 Jul 2013, 18:18:11 Freddy Mallet wrote:`
			`Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-3010`

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