Skip to content

Commit 462ff5f

Browse files
jrfnljrfnl
committed
Generators/HTML: slugify anchor links
... to prevent issues with URL encoding. Note: as this _may_ result in duplicate anchor links, this commit includes a protection against this by adding a numeric suffix to the anchor if a duplicate is detected. Includes a test with a variety of non-ascii chars and duplicate titles. Includes updated test expectations for various other tests.
1 parent d6c20b7 commit 462ff5f

File tree

37 files changed

+268
-42
lines changed

37 files changed

+268
-42
lines changed

‎src/Generators/HTML.php

+25-1
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,13 @@ class HTML extends Generator
113113
}
114114
</style>';
115115

116+
/**
117+
* List of seen slugified anchors to ensure uniqueness.
118+
*
119+
* @var array<string, true>
120+
*/
121+
private $seenAnchors = [];
122+
116123

117124
/**
118125
* Generates the documentation for a standard.
@@ -132,6 +139,10 @@ public function generate()
132139
$content = ob_get_contents();
133140
ob_end_clean();
134141

142+
// Clear anchor cache after Documentation generation.
143+
// The anchor generation for the TOC anchor links will use the same logic, so should end up with the same unique slugs.
144+
$this->seenAnchors = [];
145+
135146
if (trim($content) !== '') {
136147
echo $this->getFormattedHeader();
137148
echo $this->getFormattedToc();
@@ -325,7 +336,20 @@ public function processSniff(DOMNode $doc)
325336
*/
326337
private function titleToAnchor($title)
327338
{
328-
return str_replace(' ', '-', $title);
339+
// Slugify the text.
340+
$title = strtolower($title);
341+
$title = preg_replace('`[^a-z0-9\._-]`', '-', $title);
342+
343+
if (isset($this->seenAnchors[$title]) === true) {
344+
// Try to find a unique anchor for this title.
345+
for ($i = 2; (isset($this->seenAnchors[$title.'-'.$i]) === true); $i++);
346+
$title .= '-'.$i;
347+
}
348+
349+
// Add to "seen" list.
350+
$this->seenAnchors[$title] = true;
351+
352+
return $title;
329353

330354
}//end titleToAnchor()
331355

‎tests/Core/Generators/AnchorLinksTest.xml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0"?>
2+
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="GeneratorTest" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/PHPCSStandards/PHP_CodeSniffer/master/phpcs.xsd">
3+
4+
<config name="installed_paths" value="./tests/Core/Generators/Fixtures/"/>
5+
6+
<rule ref="StandardWithDocs.Content.DocumentationTitleToAnchorSlug1"/>
7+
<rule ref="StandardWithDocs.Content.DocumentationTitleToAnchorSlug2"/>
8+
<rule ref="StandardWithDocs.Content.DocumentationTitleToAnchorSlug3"/>
9+
10+
</ruleset>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeComparisonBlankLines.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-blank-lines">Code Comparison, blank lines<a class="sniffanchor" href="#Code-Comparison,-blank-lines"> &sect; </a></h2>
91+
<h2 id="code-comparison--blank-lines">Code Comparison, blank lines<a class="sniffanchor" href="#code-comparison--blank-lines"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeComparisonBlockLength.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-block-length">Code Comparison, block length<a class="sniffanchor" href="#Code-Comparison,-block-length"> &sect; </a></h2>
91+
<h2 id="code-comparison--block-length">Code Comparison, block length<a class="sniffanchor" href="#code-comparison--block-length"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeComparisonEncoding.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-char-encoding">Code Comparison, char encoding<a class="sniffanchor" href="#Code-Comparison,-char-encoding"> &sect; </a></h2>
91+
<h2 id="code-comparison--char-encoding">Code Comparison, char encoding<a class="sniffanchor" href="#code-comparison--char-encoding"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeComparisonLineLength.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-line-length">Code Comparison, line length<a class="sniffanchor" href="#Code-Comparison,-line-length"> &sect; </a></h2>
91+
<h2 id="code-comparison--line-length">Code Comparison, line length<a class="sniffanchor" href="#code-comparison--line-length"> &sect; </a></h2>
9292
<p class="text">Ensure there is no PHP &quot;Warning: str_repeat(): Second argument has to be greater than or equal to 0&quot;.<br/>
9393
Ref: squizlabs/PHP_CodeSniffer#2522</p>
9494
<table class="code-comparison">

‎tests/Core/Generators/Expectations/ExpectedOutputCodeTitleLineWrapping.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Title,-line-wrapping">Code Title, line wrapping<a class="sniffanchor" href="#Code-Title,-line-wrapping"> &sect; </a></h2>
91+
<h2 id="code-title--line-wrapping">Code Title, line wrapping<a class="sniffanchor" href="#code-title--line-wrapping"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeTitleWhitespace.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Title,-whitespace-handling">Code Title, whitespace handling<a class="sniffanchor" href="#Code-Title,-whitespace-handling"> &sect; </a></h2>
91+
<h2 id="code-title--whitespace-handling">Code Title, whitespace handling<a class="sniffanchor" href="#code-title--whitespace-handling"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputDocumentationTitleLength.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="This-is-a-very-very-very-very-very-very-very-very-very-very-very-long-title">This is a very very very very very very very very very very very long title<a class="sniffanchor" href="#This-is-a-very-very-very-very-very-very-very-very-very-very-very-long-title"> &sect; </a></h2>
91+
<h2 id="this-is-a-very-very-very-very-very-very-very-very-very-very-very-long-title">This is a very very very very very very very very very very very long title<a class="sniffanchor" href="#this-is-a-very-very-very-very-very-very-very-very-very-very-very-long-title"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>
9494
</body>

‎tests/Core/Generators/Expectations/ExpectedOutputDocumentationTitlePCREFallback.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Documentation-Title-PCRE-Fallback">Documentation Title PCRE Fallback<a class="sniffanchor" href="#Documentation-Title-PCRE-Fallback"> &sect; </a></h2>
91+
<h2 id="documentation-title-pcre-fallback">Documentation Title PCRE Fallback<a class="sniffanchor" href="#documentation-title-pcre-fallback"> &sect; </a></h2>
9292
<p class="text">Testing the document title can get determined from the sniff name if missing.</p>
9393
<p class="text">This file name contains an acronym on purpose to test the word splitting.</p>
9494
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>

‎tests/Core/Generators/Expectations/ExpectedOutputDocumentationTitleToAnchorSlug.html

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<html>
2+
<head>
3+
<title>GeneratorTest Coding Standards</title>
4+
<style>
5+
body {
6+
background-color: #FFFFFF;
7+
font-size: 14px;
8+
font-family: Arial, Helvetica, sans-serif;
9+
color: #000000;
10+
}
11+
12+
h1 {
13+
color: #666666;
14+
font-size: 20px;
15+
font-weight: bold;
16+
margin-top: 0px;
17+
background-color: #E6E7E8;
18+
padding: 20px;
19+
border: 1px solid #BBBBBB;
20+
}
21+
22+
h2 {
23+
color: #00A5E3;
24+
font-size: 16px;
25+
font-weight: normal;
26+
margin-top: 50px;
27+
}
28+
29+
h2 a.sniffanchor,
30+
h2 a.sniffanchor {
31+
color: #006C95;
32+
opacity: 0;
33+
padding: 0 3px;
34+
text-decoration: none;
35+
font-weight: bold;
36+
}
37+
h2:hover a.sniffanchor,
38+
h2:focus a.sniffanchor {
39+
opacity: 1;
40+
}
41+
42+
.code-comparison {
43+
width: 100%;
44+
}
45+
46+
.code-comparison td {
47+
border: 1px solid #CCCCCC;
48+
}
49+
50+
.code-comparison-title, .code-comparison-code {
51+
font-family: Arial, Helvetica, sans-serif;
52+
font-size: 12px;
53+
color: #000000;
54+
vertical-align: top;
55+
padding: 4px;
56+
width: 50%;
57+
background-color: #F1F1F1;
58+
line-height: 15px;
59+
}
60+
61+
.code-comparison-title {
62+
text-align: left;
63+
font-weight: 600;
64+
}
65+
66+
.code-comparison-code {
67+
font-family: Courier;
68+
background-color: #F9F9F9;
69+
}
70+
71+
.code-comparison-highlight {
72+
background-color: #DDF1F7;
73+
border: 1px solid #00A5E3;
74+
line-height: 15px;
75+
}
76+
77+
.tag-line {
78+
text-align: center;
79+
width: 100%;
80+
margin-top: 30px;
81+
font-size: 12px;
82+
}
83+
84+
.tag-line a {
85+
color: #000000;
86+
}
87+
</style>
88+
</head>
89+
<body>
90+
<h1>GeneratorTest Coding Standards</h1>
91+
<h2>Table of Contents</h2>
92+
<ul class="toc">
93+
<li><a href="#url-enc-de-non---sc-----chars">URL enc@de non-àscíï chars</a></li>
94+
<li><a href="#url-enc-de-non---sc-----chars-2">URL enc@de non-àscíï chars</a></li>
95+
<li><a href="#url-enc-de-non---sc-----chars-3">URL enc@de non-àscíï chars</a></li>
96+
</ul>
97+
<h2 id="url-enc-de-non---sc-----chars">URL enc@de non-àscíï chars<a class="sniffanchor" href="#url-enc-de-non---sc-----chars"> &sect; </a></h2>
98+
<p class="text">The documentation title has non-ascii characters, which will be slugified for use in an HTML anchor link.</p>
99+
<h2 id="url-enc-de-non---sc-----chars-2">URL enc@de non-àscíï chars<a class="sniffanchor" href="#url-enc-de-non---sc-----chars-2"> &sect; </a></h2>
100+
<p class="text">The documentation title has non-ascii characters, which will be slugified for use in an HTML anchor link.<br/>
101+
A duplicate anchor link will get a numeric suffix.</p>
102+
<h2 id="url-enc-de-non---sc-----chars-3">URL enc@de non-àscíï chars<a class="sniffanchor" href="#url-enc-de-non---sc-----chars-3"> &sect; </a></h2>
103+
<p class="text">The documentation title has non-ascii characters, which will be slugified for use in an HTML anchor link.<br/>
104+
A duplicate anchor link will get a numeric suffix.</p>
105+
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>
106+
</body>
107+
</html>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMismatchedCodeElms.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-mismatched-code-blocks">Code Comparison, mismatched code blocks<a class="sniffanchor" href="#Code-Comparison,-mismatched-code-blocks"> &sect; </a></h2>
91+
<h2 id="code-comparison--mismatched-code-blocks">Code Comparison, mismatched code blocks<a class="sniffanchor" href="#code-comparison--mismatched-code-blocks"> &sect; </a></h2>
9292
<p class="text">This doc has two code elements, one only has a title, one has actual code. Unbalanced</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMissingCodeElm.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-missing-code-element">Code Comparison, missing code element<a class="sniffanchor" href="#Code-Comparison,-missing-code-element"> &sect; </a></h2>
91+
<h2 id="code-comparison--missing-code-element">Code Comparison, missing code element<a class="sniffanchor" href="#code-comparison--missing-code-element"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>
9494
</body>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonNoCode.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-no-code">Code Comparison, no code<a class="sniffanchor" href="#Code-Comparison,-no-code"> &sect; </a></h2>
91+
<h2 id="code-comparison--no-code">Code Comparison, no code<a class="sniffanchor" href="#code-comparison--no-code"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonNoContent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-no-content">Code Comparison, no content<a class="sniffanchor" href="#Code-Comparison,-no-content"> &sect; </a></h2>
91+
<h2 id="code-comparison--no-content">Code Comparison, no content<a class="sniffanchor" href="#code-comparison--no-content"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>
9494
</body>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonOneEmptyCodeElm.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-one-empty-code-element">Code Comparison, one empty code element<a class="sniffanchor" href="#Code-Comparison,-one-empty-code-element"> &sect; </a></h2>
91+
<h2 id="code-comparison--one-empty-code-element">Code Comparison, one empty code element<a class="sniffanchor" href="#code-comparison--one-empty-code-element"> &sect; </a></h2>
9292
<p class="text">This doc has two code elements, but only one of them has a title and actual code.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonTwoEmptyCodeElms.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Comparison,-two-empty-code-elements">Code Comparison, two empty code elements<a class="sniffanchor" href="#Code-Comparison,-two-empty-code-elements"> &sect; </a></h2>
91+
<h2 id="code-comparison--two-empty-code-elements">Code Comparison, two empty code elements<a class="sniffanchor" href="#code-comparison--two-empty-code-elements"> &sect; </a></h2>
9292
<p class="text">This doc has two code elements, but neither of them contain any information.</p>
9393
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>
9494
</body>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeTitleEmpty.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Title,-empty">Code Title, empty<a class="sniffanchor" href="#Code-Title,-empty"> &sect; </a></h2>
91+
<h2 id="code-title--empty">Code Title, empty<a class="sniffanchor" href="#code-title--empty"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeTitleMissing.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Code-Title,-missing">Code Title, missing<a class="sniffanchor" href="#Code-Title,-missing"> &sect; </a></h2>
91+
<h2 id="code-title--missing">Code Title, missing<a class="sniffanchor" href="#code-title--missing"> &sect; </a></h2>
9292
<p class="text">This is a standard block.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidDocumentationTitleEmpty.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Documentation-Title-Empty">Documentation Title Empty<a class="sniffanchor" href="#Documentation-Title-Empty"> &sect; </a></h2>
91+
<h2 id="documentation-title-empty">Documentation Title Empty<a class="sniffanchor" href="#documentation-title-empty"> &sect; </a></h2>
9292
<p class="text">The above &quot;documentation&quot; element has an empty title attribute.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidDocumentationTitleMissing.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Documentation-Title-Missing">Documentation Title Missing<a class="sniffanchor" href="#Documentation-Title-Missing"> &sect; </a></h2>
91+
<h2 id="documentation-title-missing">Documentation Title Missing<a class="sniffanchor" href="#documentation-title-missing"> &sect; </a></h2>
9292
<p class="text">The above &quot;documentation&quot; element is missing the title attribute.</p>
9393
<table class="code-comparison">
9494
<tr>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidStandardNoContent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Standard-Element,-no-content">Standard Element, no content<a class="sniffanchor" href="#Standard-Element,-no-content"> &sect; </a></h2>
91+
<h2 id="standard-element--no-content">Standard Element, no content<a class="sniffanchor" href="#standard-element--no-content"> &sect; </a></h2>
9292
<table class="code-comparison">
9393
<tr>
9494
<th class="code-comparison-title">Valid: Lorem ipsum dolor sit amet.</th>

‎tests/Core/Generators/Expectations/ExpectedOutputOneDoc.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="One-Standard-Block,-No-Code">One Standard Block, No Code<a class="sniffanchor" href="#One-Standard-Block,-No-Code"> &sect; </a></h2>
91+
<h2 id="one-standard-block--no-code">One Standard Block, No Code<a class="sniffanchor" href="#one-standard-block--no-code"> &sect; </a></h2>
9292
<p class="text">Documentation contains one standard block and no code comparison.</p>
9393
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>
9494
</body>

‎tests/Core/Generators/Expectations/ExpectedOutputStandardBlankLines.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Standard-Element,-blank-line-handling">Standard Element, blank line handling<a class="sniffanchor" href="#Standard-Element,-blank-line-handling"> &sect; </a></h2>
91+
<h2 id="standard-element--blank-line-handling">Standard Element, blank line handling<a class="sniffanchor" href="#standard-element--blank-line-handling"> &sect; </a></h2>
9292
<p class="text">There is a blank line at the start of this standard.</p>
9393
<p class="text">And the above blank line is also deliberate to test part of the logic.</p>
9494
<p class="text">Let&#039;s also end on a blank line to test that too.</p>

‎tests/Core/Generators/Expectations/ExpectedOutputStandardEncoding.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Standard-Element,-handling-of-HTML-tags">Standard Element, handling of HTML tags<a class="sniffanchor" href="#Standard-Element,-handling-of-HTML-tags"> &sect; </a></h2>
91+
<h2 id="standard-element--handling-of-html-tags">Standard Element, handling of HTML tags<a class="sniffanchor" href="#standard-element--handling-of-html-tags"> &sect; </a></h2>
9292
<p class="text">The use of <em>tags</em> in standard descriptions is allowed and their handling should be <em>safeguarded</em>.<br/>
9393
Other tags, like &lt;a href=&quot;example.com&quot;&gt;link&lt;/a&gt;, &lt;b&gt;bold&lt;/bold&gt;, &lt;script&gt;&lt;/script&gt; are not allowed and will be encoded for display when the HTML or Markdown report is used.</p>
9494
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>

‎tests/Core/Generators/Expectations/ExpectedOutputStandardIndent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Standard-Element,-indentation-should-be-ignored">Standard Element, indentation should be ignored<a class="sniffanchor" href="#Standard-Element,-indentation-should-be-ignored"> &sect; </a></h2>
91+
<h2 id="standard-element--indentation-should-be-ignored">Standard Element, indentation should be ignored<a class="sniffanchor" href="#standard-element--indentation-should-be-ignored"> &sect; </a></h2>
9292
<p class="text">This line has no indentation.<br/>
9393
This line has 4 spaces indentation.<br/>
9494
This line has 8 spaces indentation.<br/>

‎tests/Core/Generators/Expectations/ExpectedOutputStandardLineWrapping.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
</head>
8989
<body>
9090
<h1>GeneratorTest Coding Standards</h1>
91-
<h2 id="Standard-Element,-line-wrapping-handling">Standard Element, line wrapping handling<a class="sniffanchor" href="#Standard-Element,-line-wrapping-handling"> &sect; </a></h2>
91+
<h2 id="standard-element--line-wrapping-handling">Standard Element, line wrapping handling<a class="sniffanchor" href="#standard-element--line-wrapping-handling"> &sect; </a></h2>
9292
<p class="text">This line has to be exactly 99 chars to test part of the logic.------------------------------------<br/>
9393
And this line has to be exactly 100 chars.----------------------------------------------------------<br/>
9494
And here we have a line which should start wrapping as it is longer than 100 chars. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean pellentesque iaculis enim quis hendrerit. Morbi ultrices in odio pharetra commodo.</p>

0 commit comments

Comments
 (0)