[BUGFIX] Fix interlink target URLs for links with anchor prefix

phpDocumentor · Nov 22, 2024 · a821ca9 · a821ca9
1 parent 3ceb2cf
commit a821ca9
Show file tree

Hide file tree

Showing 40 changed files with 128 additions and 69 deletions.
diff --git a/packages/guides/src/Renderer/InterlinkObjectsRenderer.php b/packages/guides/src/Renderer/InterlinkObjectsRenderer.php
@@ -14,6 +14,7 @@
 namespace phpDocumentor\Guides\Renderer;
 
 use phpDocumentor\Guides\Handlers\RenderCommand;
+use phpDocumentor\Guides\Meta\InternalTarget;
 use phpDocumentor\Guides\ReferenceResolvers\DocumentNameResolverInterface;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\Renderer\UrlGenerator\UrlGeneratorInterface;
@@ -73,6 +74,13 @@ public function render(RenderCommand $renderCommand): void
                     '',
                     $this->urlGenerator->createFileUrl($context, $internalTarget->getDocumentPath(), $internalTarget->getAnchor()),
                 );
+                if ($internalTarget instanceof InternalTarget) {
+                    $url = $this->documentNameResolver->canonicalUrl(
+                        '',
+                        $this->urlGenerator->createFileUrl($context, $internalTarget->getDocumentPath(), $internalTarget->getPrefix() . $internalTarget->getAnchor()),
+                    );
+                }
+
                 $inventory[$linkType][$key] = [
                     $projectNode->getTitle() ?? '-',
                     $projectNode->getVersion() ?? '-',

diff --git a/tests/Integration/tests-full/markdown-full/default-menu-md/expected/anotherPage.html b/tests/Integration/tests-full/markdown-full/default-menu-md/expected/anotherPage.html
@@ -71,7 +71,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="another-page">
+
+<div class="section" id="another-page">
             <h1>Another Page</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests-full/markdown-full/default-menu-md/expected/index.html b/tests/Integration/tests-full/markdown-full/default-menu-md/expected/index.html
@@ -70,7 +70,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="document-title">
+
+<div class="section" id="document-title">
             <h1>Document Title</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests-full/markdown-full/default-menu-md/expected/somePage.html b/tests/Integration/tests-full/markdown-full/default-menu-md/expected/somePage.html
@@ -71,7 +71,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="some-page">
+
+<div class="section" id="some-page">
             <h1>Some Page</h1>
 
     <p>Lorem Ipsum <code>Dolor</code>.</p>

diff --git a/tests/Integration/tests-full/markdown-full/front-matter-md/expected/index.html b/tests/Integration/tests-full/markdown-full/front-matter-md/expected/index.html
@@ -5,57 +5,70 @@
     <!-- Required meta tags -->
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
+
     <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
 </head>
 <body>
 <header class="">
-    <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
-        <div class="container">
-            <a class="navbar-brand" href="#">Navbar</a>
-            <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
-                <span class="navbar-toggler-icon"></span>
-            </button>
-            <div class="collapse navbar-collapse" id="navbarSupportedContent">
-                <ul class="navbar-nav me-auto mb-2 mb-lg-0">
-                </ul>
-            </div>
-        </div>
-    </nav>
+
+<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
+    <div class="container">
+
+        <a class="navbar-brand" href="#">Navbar</a>
+        <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+            <span class="navbar-toggler-icon"></span>
+        </button>
+        <div class="collapse navbar-collapse" id="navbarSupportedContent">
+
+<ul class="navbar-nav me-auto mb-2 mb-lg-0">
+    </ul>
+
+                    </div>
+    </div>
+</nav>
 </header>
 <main id="main-content">
     <div class="container">
         <div class="container">
             <div class="row">
                 <div class="col-lg-3">
-                    <nav class="nav flex-column">
-                        <ul class="menu-level-main">
-                        </ul>
-                    </nav>
+                                <nav class="nav flex-column">
+        <ul class="menu-level-main">
+            </ul>
+</nav>
+
                 </div>
                 <div class="col-lg-9">
-                    <nav aria-label="breadcrumb">
-                        <ol class="breadcrumb">
-                            <li class="breadcrumb-item"><a href="#">Document Title</a></li>
-                        </ol>
-                    </nav>
+
+<nav aria-label="breadcrumb">
+    <ol class="breadcrumb">
+        <li class="breadcrumb-item"><a href="#">Document Title</a></li>
+            </ol>
+</nav>
                     <!-- content start -->
-                    <div class="section" id="document-title">
-                        <h1>Document Title</h1>
-                        <p>Lorem Ipsum Dolor.</p>
-                    </div>
+
+<div class="section" id="document-title">
+            <h1>Document Title</h1>
+
+    <p>Lorem Ipsum Dolor.</p>
+
+    </div>
                     <!-- content end -->
                 </div>
             </div>
         </div>
     </div>
 </main>
+
 <!-- Optional JavaScript; choose one of the two! -->
+
 <!-- Option 1: Bootstrap Bundle with Popper -->
 <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
+
 <!-- Option 2: Separate Popper and Bootstrap JS -->
 <!--
 <script src="https://cdn.jsdelivr.net/npm/@popperjs/[email protected]/dist/umd/popper.min.js" integrity="sha384-IQsoLXl5PILFhosVNubq5LC7Qb9DXgDA9i+tQ8Zj3iwWAwPtgFTxbJ8NT4GN1R8p" crossorigin="anonymous"></script>
 <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js" integrity="sha384-cVKIPhGWiC2Al4u+LWgxfKTRIcfu0JTxR+EQDz/bgldoEyl4H0zUF0QKbrJ0EcQF" crossorigin="anonymous"></script>
 -->
 </body>
-</html>
+</html>
diff --git a/tests/Integration/tests-full/markdown-full/multi-nested-menu-md/expected/dir2/index.html b/tests/Integration/tests-full/markdown-full/multi-nested-menu-md/expected/dir2/index.html
@@ -140,7 +140,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="dir-2-title">
+
+<div class="section" id="dir-2-title">
             <h1>Dir 2 Title</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests-full/markdown-full/multi-nested-menu-md/expected/dir2/somePage.html b/tests/Integration/tests-full/markdown-full/multi-nested-menu-md/expected/dir2/somePage.html
@@ -141,7 +141,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="some-page-in-dir-2">
+
+<div class="section" id="some-page-in-dir-2">
             <h1>Some Page in dir 2</h1>
 
     <p>Lorem Ipsum <code>Dolor</code>.</p>

diff --git a/tests/Integration/tests-full/markdown-full/multi-nested-menu-md/expected/index.html b/tests/Integration/tests-full/markdown-full/multi-nested-menu-md/expected/index.html
@@ -139,7 +139,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="document-title">
+
+<div class="section" id="document-title">
             <h1>Document Title</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests-full/markdown-full/nested-menu-md/expected/dir2/index.html b/tests/Integration/tests-full/markdown-full/nested-menu-md/expected/dir2/index.html
@@ -117,7 +117,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="dir-2-title">
+
+<div class="section" id="dir-2-title">
             <h1>Dir 2 Title</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests-full/markdown-full/nested-menu-md/expected/dir2/somePage.html b/tests/Integration/tests-full/markdown-full/nested-menu-md/expected/dir2/somePage.html
@@ -118,7 +118,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="some-page-in-dir-2">
+
+<div class="section" id="some-page-in-dir-2">
             <h1>Some Page in dir 2</h1>
 
     <p>Lorem Ipsum <code>Dolor</code>.</p>

diff --git a/tests/Integration/tests-full/markdown-full/nested-menu-md/expected/index.html b/tests/Integration/tests-full/markdown-full/nested-menu-md/expected/index.html
@@ -116,7 +116,8 @@
             </ol>
 </nav>
                     <!-- content start -->
-                        <div class="section" id="document-title">
+
+<div class="section" id="document-title">
             <h1>Document Title</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests/confval/confval-name/expected/objects.inv.json b/tests/Integration/tests/confval/confval-name/expected/objects.inv.json
@@ -26,37 +26,37 @@
         "another-demo": [
             "-",
             "-",
-            "another.html#another-demo",
+            "another.html#confval-another-demo",
             "demo"
         ],
         "demo": [
             "-",
             "-",
-            "index.html#demo",
+            "index.html#confval-demo",
             "demo"
         ],
         "demo2": [
             "-",
             "-",
-            "index.html#demo2",
+            "index.html#confval-demo2",
             "demo2"
         ],
         "demo3": [
             "-",
             "-",
-            "index.html#demo3",
+            "index.html#confval-demo3",
             "demo3"
         ],
         "demo4": [
             "-",
             "-",
-            "index.html#demo4",
+            "index.html#confval-demo4",
             "demo4"
         ],
         "demo5": [
             "-",
             "-",
-            "index.html#demo5",
+            "index.html#confval-demo5",
             "demo5"
         ]
     }

diff --git a/tests/Integration/tests/confval/confval-noindex/expected/objects.inv.json b/tests/Integration/tests/confval/confval-noindex/expected/objects.inv.json
@@ -26,7 +26,7 @@
         "demo": [
             "-",
             "-",
-            "index.html#demo",
+            "index.html#confval-demo",
             "demo"
         ]
     }

diff --git a/tests/Integration/tests/confval/confval-warning/expected/objects.inv.json b/tests/Integration/tests/confval/confval-warning/expected/objects.inv.json
@@ -33,7 +33,7 @@
         "demo": [
             "-",
             "-",
-            "another.html#demo",
+            "another.html#confval-demo",
             "demo"
         ]
     }

diff --git a/tests/Integration/tests/markdown/admonitions-md/expected/index.html b/tests/Integration/tests/markdown/admonitions-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-                        <div class="section" id="markdown-admonitions">
+
+<div class="section" id="markdown-admonitions">
             <h1>Markdown Admonitions</h1>
                 <div class="alert alert-secondary " role="alert">
     <h4 class="alert-heading">Note</h4>

diff --git a/tests/Integration/tests/markdown/blockquote-md/expected/index.html b/tests/Integration/tests/markdown/blockquote-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="markdown-blockquotes">
+
+<div class="section" id="markdown-blockquotes">
             <h1>Markdown Blockquotes</h1>
             <blockquote>
     <p>This is a blockquote. It can span multiple lines.</p>

diff --git a/tests/Integration/tests/markdown/code-md/expected/index.html b/tests/Integration/tests/markdown/code-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="markdown-with-code-blocks">
+
+<div class="section" id="markdown-with-code-blocks">
             <h1>Markdown with Code Blocks</h1>
             <pre><code class="language-">&lt;html&gt;
   &lt;head&gt;

diff --git a/tests/Integration/tests/markdown/emphasis-md/expected/index.html b/tests/Integration/tests/markdown/emphasis-md/expected/index.html
@@ -1,8 +1,12 @@
 <!-- content start -->
-    <div class="section" id="markdown-with-emphasis">
+
+<div class="section" id="markdown-with-emphasis">
             <h1>Markdown with emphasis</h1>
 
     <p><em>Italic</em> or <em>Italic</em>, <strong>Bold</strong> or <strong>Bold</strong>, <strong>Bold and <em>Italic</em></strong>, <em>Italic and <strong>Bold</strong></em></p>
+
+
     <p><a href="https://phpdoc.org"><em>test</em></a></p>
+
     </div>
 <!-- content end -->
diff --git a/tests/Integration/tests/markdown/html-inline-md/expected/index.html b/tests/Integration/tests/markdown/html-inline-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="markdown-with-html">
+
+<div class="section" id="markdown-with-html">
             <h1>Markdown with html</h1>
 
     <p>In files of text, where words take flight, Markdown weaves its magic, bold and bright. Hashes and stars, a simple code, A poet&#039;s playground, where stories unfold. &lt;BR&gt;</p>

diff --git a/tests/Integration/tests/markdown/html-md/expected/index.html b/tests/Integration/tests/markdown/html-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="markdown-with-html">
+
+<div class="section" id="markdown-with-html">
             <h1>Markdown with html</h1>
 
     <p>&lt;div align=&quot;center&quot;&gt;

diff --git a/tests/Integration/tests/markdown/image-empty-alt-md/expected/index.html b/tests/Integration/tests/markdown/image-empty-alt-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="images-with-and-without-alt-text">
+
+<div class="section" id="images-with-and-without-alt-text">
             <h1>Images with and without alt text</h1>
 
     <p><img src="https://example.org/example.png" alt="with alt Text"/></p>

diff --git a/tests/Integration/tests/markdown/image-md/expected/index.html b/tests/Integration/tests/markdown/image-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="markdown-image">
+
+<div class="section" id="markdown-image">
             <h1>Markdown Image</h1>
 
     <p><img src="/hero-illustration.svg" alt="Hero Illustrations"/></p>

diff --git a/tests/Integration/tests/markdown/image-path-relative-md/expected/dir1/dir2/index.html b/tests/Integration/tests/markdown/image-path-relative-md/expected/dir1/dir2/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-                        <div class="section" id="dir-2-title">
+
+<div class="section" id="dir-2-title">
             <h1>Dir 2 Title</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests/markdown/image-path-relative-md/expected/dir1/dir2/somePage.html b/tests/Integration/tests/markdown/image-path-relative-md/expected/dir1/dir2/somePage.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-                        <div class="section" id="some-page-in-dir-2">
+
+<div class="section" id="some-page-in-dir-2">
             <h1>Some Page in dir 2</h1>
 
     <p>Lorem Ipsum <code>Dolor</code>.</p>

diff --git a/tests/Integration/tests/markdown/image-path-relative-md/expected/dir1/index.html b/tests/Integration/tests/markdown/image-path-relative-md/expected/dir1/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-                        <div class="section" id="dir-1-title">
+
+<div class="section" id="dir-1-title">
             <h1>Dir 1 Title</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests/markdown/image-path-relative-md/expected/index.html b/tests/Integration/tests/markdown/image-path-relative-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-                        <div class="section" id="document-title">
+
+<div class="section" id="document-title">
             <h1>Document Title</h1>
 
     <p>Lorem Ipsum Dolor.</p>

diff --git a/tests/Integration/tests/markdown/image-title-md/expected/index.html b/tests/Integration/tests/markdown/image-title-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="markdown-image">
+
+<div class="section" id="markdown-image">
             <h1>Markdown Image</h1>
 
     <p><img src="/hero-illustration.svg" alt="Hero Illustrations" title="Some title"/></p>

diff --git a/tests/Integration/tests/markdown/index-md/expected/index.html b/tests/Integration/tests/markdown/index-md/expected/index.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="markdown-example">
+
+<div class="section" id="markdown-example">
             <h1>Markdown Example</h1>
 
     <p>This is a Markdown document with some basic formatting.</p>

diff --git a/tests/Integration/tests/markdown/index-name-md/expected/anotherPage.html b/tests/Integration/tests/markdown/index-name-md/expected/anotherPage.html
@@ -1,5 +1,6 @@
 <!-- content start -->
-    <div class="section" id="another-page">
+
+<div class="section" id="another-page">
             <h1>Another Page</h1>
 
     <p>Lorem Ipsum Dolor.</p>
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,7 +26,7 @@ @@
             "demo": [
                 "-",
                 "-",
-                "index.html#demo",
+                "index.html#confval-demo",
                 "demo"
             ]
         }
@@ Expand Down @@