Skip to content

Do not add anchor to URL for document (root) titles #780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Do not add anchor to URL for document (root) titles #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/guides/src/Compiler/NodeTransformers/MenuNodeAddEntryTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node|nu
$documentEntry->getFile(),
$documentEntry->getTitle(),
[],
false,
true,
1,
'',
$this->isInRootline($documentEntry, $compilerContext->getDocumentNode()->getDocumentEntry()),
Expand Down
2 changes: 1 addition & 1 deletion packages/guides/src/Compiler/NodeTransformers/MenuNodeAddSubDocumentsTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ private function addSubEntries(
$subDocumentEntryNode->getFile(),
$subDocumentEntryNode->getTitle(),
[],
false,
true,
$currentLevel,
'',
self::isInRootline($subDocumentEntryNode, $compilerContext->getDocumentNode()->getDocumentEntry()),
Expand Down
2 changes: 1 addition & 1 deletion packages/guides/src/NodeRenderers/Html/BreadCrumbNodeRenderer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ private function buildBreadcrumb(
$documentEntry->getFile(),
$documentEntry->getTitle(),
[],
false,
true,
$level,
'',
true,
Expand Down
6 changes: 5 additions & 1 deletion packages/guides/src/NodeRenderers/Html/MenuEntryRenderer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
use phpDocumentor\Guides\Renderer\UrlGenerator\UrlGeneratorInterface;
use phpDocumentor\Guides\TemplateRenderer;

use function assert;

/** @implements NodeRenderer<MenuEntryNode> */
final class MenuEntryRenderer implements NodeRenderer
{
Expand All @@ -27,11 +29,13 @@ public function supports(Node $node): bool

public function render(Node $node, RenderContext $renderContext): string
{
assert($node instanceof MenuEntryNode);

return $this->renderer->renderTemplate(
$renderContext,
'body/menu/menu-item.html.twig',
[
'url' => $this->urlGenerator->generateCanonicalOutputUrl($renderContext, $node->getUrl(), $node->getValue()->getId()),
'url' => $this->urlGenerator->generateCanonicalOutputUrl($renderContext, $node->getUrl(), !$node->isDocumentRoot() ? $node->getValue()->getId() : null),
'node' => $node,
],
);
Expand Down
12 changes: 6 additions & 6 deletions tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,14 @@ <h1>Document Title</h1>
<div class="toc">
<p class="caption">Main Menu</p>
<ul class="menu-level">
<li class="toc-item"><a href="anotherPage.html#another-page">Another Page</a></li>
<li class="toc-item"><a href="anotherPage.html">Another Page</a></li>

<li class="toc-item"><a href="somePage.html#some-page">Some Page</a></li>
<li class="toc-item"><a href="somePage.html">Some Page</a></li>

<li class="toc-item"><a href="subpages/index.html#subpages">Subpages</a> <ul class="menu-level-1">
<li class="toc-item"><a href="subpages/subpage1.html#subpages-1">Subpages 1</a></li>
<li class="toc-item"><a href="subpages/index.html">Subpages</a> <ul class="menu-level-1">
<li class="toc-item"><a href="subpages/subpage1.html">Subpages 1</a></li>

<li class="toc-item"><a href="subpages/subpage2.html#subpages-2">Subpages 2</a></li>
<li class="toc-item"><a href="subpages/subpage2.html">Subpages 2</a></li>

</ul></li>

Expand All @@ -141,7 +141,7 @@ <h1>Document Title</h1>
<div class="toc">
<p class="caption">Additional Menu</p>
<ul class="menu-level">
<li class="toc-item"><a href="yetAnotherPage.html#yet-another-page">Yet Another Page</a></li>
<li class="toc-item"><a href="yetAnotherPage.html">Yet Another Page</a></li>

</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions ...egration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,9 @@ <h1>Subpages</h1>

<div class="toc">
<ul class="menu-level">
<li class="toc-item"><a href="subpage1.html#subpages-1">Subpages 1</a></li>
<li class="toc-item"><a href="subpage1.html">Subpages 1</a></li>

<li class="toc-item"><a href="subpage2.html#subpages-2">Subpages 2</a></li>
<li class="toc-item"><a href="subpage2.html">Subpages 2</a></li>

</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion tests/Integration/tests/graphs/plantuml-external/expected/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ <h1>Uml Directive</h1>
<figcaption>Figure 1-1: Application flow</figcaption></figure>
<div class="toc">
<ul class="menu-level">
<li class="toc-item"><a href="/Plantuml/index.html#uml-directive">Uml Directive</a></li>
<li class="toc-item"><a href="/Plantuml/index.html">Uml Directive</a></li>

</ul>
</div>
Expand Down
28 changes: 14 additions & 14 deletions tests/Integration/tests/navigation/breadcrumb/expected/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,35 @@ <h1>Document Title</h1>
<p>Lorem Ipsum Dolor.</p>
<div class="toc">
<ul class="menu-level">
<li class="toc-item"><a href="/page1.html#page-1">Page 1</a></li>
<li class="toc-item"><a href="/page1.html">Page 1</a></li>

<li class="toc-item"><a href="/page2.html#page-2">Page 2</a></li>
<li class="toc-item"><a href="/page2.html">Page 2</a></li>

<li class="toc-item"><a href="/level-1-1/index.html#level-1-1">Level 1-1</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-1/subpage1.html#subpage-1-level-1-1">Subpage 1, Level 1-1</a></li>
<li class="toc-item"><a href="/level-1-1/index.html">Level 1-1</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-1/subpage1.html">Subpage 1, Level 1-1</a></li>

<li class="toc-item"><a href="/level-1-1/subpage2.html#subpage-2-level-1-1">Subpage 2, Level 1-1</a></li>
<li class="toc-item"><a href="/level-1-1/subpage2.html">Subpage 2, Level 1-1</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-1/index.html#level-2-1">Level 2-1</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage1.html#subpage-1-level-2-1">Subpage 1, Level 2-1</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-1/index.html">Level 2-1</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage1.html">Subpage 1, Level 2-1</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-1/subpage2.html#subpage-2-level-2-1">Subpage 2, Level 2-1</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage2.html">Subpage 2, Level 2-1</a></li>

</ul></li>

<li class="toc-item"><a href="/level-1-1/level-2-2/index.html#level-2-2">Level 2-2</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage1.html#subpage-1-level-2-2">Subpage 1, Level 2-2</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-2/index.html">Level 2-2</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage1.html">Subpage 1, Level 2-2</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-2/subpage2.html#subpage-2-level-2-2">Subpage 2, Level 2-2</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage2.html">Subpage 2, Level 2-2</a></li>

</ul></li>

</ul></li>

<li class="toc-item"><a href="/level-1-2/index.html#level-1-2">Level 1-2</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-2/subpage1.html#subpage-1-level-1-2">Subpage 1, Level 1-2</a></li>
<li class="toc-item"><a href="/level-1-2/index.html">Level 1-2</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-2/subpage1.html">Subpage 1, Level 1-2</a></li>

<li class="toc-item"><a href="/level-1-2/subpage2.html#subpage-2-level-1-2">Subpage 2, Level 1-2</a></li>
<li class="toc-item"><a href="/level-1-2/subpage2.html">Subpage 2, Level 1-2</a></li>

</ul></li>

Expand Down
28 changes: 14 additions & 14 deletions tests/Integration/tests/navigation/breadcrumb/expected/page1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,35 +11,35 @@ <h1>Page 1</h1>
<p>Lorem Ipsum Dolor.</p>
<div class="menu">
<ul class="menu-level">
<li class="toc-item current active"><a href="/page1.html#page-1">Page 1</a></li>
<li class="toc-item current active"><a href="/page1.html">Page 1</a></li>

<li class="toc-item"><a href="/page2.html#page-2">Page 2</a></li>
<li class="toc-item"><a href="/page2.html">Page 2</a></li>

<li class="toc-item"><a href="/level-1-1/index.html#level-1-1">Level 1-1</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-1/subpage1.html#subpage-1-level-1-1">Subpage 1, Level 1-1</a></li>
<li class="toc-item"><a href="/level-1-1/index.html">Level 1-1</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-1/subpage1.html">Subpage 1, Level 1-1</a></li>

<li class="toc-item"><a href="/level-1-1/subpage2.html#subpage-2-level-1-1">Subpage 2, Level 1-1</a></li>
<li class="toc-item"><a href="/level-1-1/subpage2.html">Subpage 2, Level 1-1</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-1/index.html#level-2-1">Level 2-1</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage1.html#subpage-1-level-2-1">Subpage 1, Level 2-1</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-1/index.html">Level 2-1</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage1.html">Subpage 1, Level 2-1</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-1/subpage2.html#subpage-2-level-2-1">Subpage 2, Level 2-1</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage2.html">Subpage 2, Level 2-1</a></li>

</ul></li>

<li class="toc-item"><a href="/level-1-1/level-2-2/index.html#level-2-2">Level 2-2</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage1.html#subpage-1-level-2-2">Subpage 1, Level 2-2</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-2/index.html">Level 2-2</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage1.html">Subpage 1, Level 2-2</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-2/subpage2.html#subpage-2-level-2-2">Subpage 2, Level 2-2</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage2.html">Subpage 2, Level 2-2</a></li>

</ul></li>

</ul></li>

<li class="toc-item"><a href="/level-1-2/index.html#level-1-2">Level 1-2</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-2/subpage1.html#subpage-1-level-1-2">Subpage 1, Level 1-2</a></li>
<li class="toc-item"><a href="/level-1-2/index.html">Level 1-2</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-2/subpage1.html">Subpage 1, Level 1-2</a></li>

<li class="toc-item"><a href="/level-1-2/subpage2.html#subpage-2-level-1-2">Subpage 2, Level 1-2</a></li>
<li class="toc-item"><a href="/level-1-2/subpage2.html">Subpage 2, Level 1-2</a></li>

</ul></li>

Expand Down
28 changes: 14 additions & 14 deletions tests/Integration/tests/navigation/menu-level-3/expected/level-1-1/level-2-2/subpage1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,35 @@ <h1>Subpage 1, Level 2-2</h1>
<p>Lorem Ipsum Dolor.</p>
<div class="menu">
<ul class="menu-level">
<li class="toc-item"><a href="/page1.html#page-1">Page 1</a></li>
<li class="toc-item"><a href="/page1.html">Page 1</a></li>

<li class="toc-item"><a href="/page2.html#page-2">Page 2</a></li>
<li class="toc-item"><a href="/page2.html">Page 2</a></li>

<li class="toc-item active"><a href="/level-1-1/index.html#level-1-1">Level 1-1</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-1/subpage1.html#subpage-1-level-1-1">Subpage 1, Level 1-1</a></li>
<li class="toc-item active"><a href="/level-1-1/index.html">Level 1-1</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-1/subpage1.html">Subpage 1, Level 1-1</a></li>

<li class="toc-item"><a href="/level-1-1/subpage2.html#subpage-2-level-1-1">Subpage 2, Level 1-1</a></li>
<li class="toc-item"><a href="/level-1-1/subpage2.html">Subpage 2, Level 1-1</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-1/index.html#level-2-1">Level 2-1</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage1.html#subpage-1-level-2-1">Subpage 1, Level 2-1</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-1/index.html">Level 2-1</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage1.html">Subpage 1, Level 2-1</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-1/subpage2.html#subpage-2-level-2-1">Subpage 2, Level 2-1</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage2.html">Subpage 2, Level 2-1</a></li>

</ul></li>

<li class="toc-item active"><a href="/level-1-1/level-2-2/index.html#level-2-2">Level 2-2</a> <ul class="menu-level-2">
<li class="toc-item current active"><a href="/level-1-1/level-2-2/subpage1.html#subpage-1-level-2-2">Subpage 1, Level 2-2</a></li>
<li class="toc-item active"><a href="/level-1-1/level-2-2/index.html">Level 2-2</a> <ul class="menu-level-2">
<li class="toc-item current active"><a href="/level-1-1/level-2-2/subpage1.html">Subpage 1, Level 2-2</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-2/subpage2.html#subpage-2-level-2-2">Subpage 2, Level 2-2</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage2.html">Subpage 2, Level 2-2</a></li>

</ul></li>

</ul></li>

<li class="toc-item"><a href="/level-1-2/index.html#level-1-2">Level 1-2</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-2/subpage1.html#subpage-1-level-1-2">Subpage 1, Level 1-2</a></li>
<li class="toc-item"><a href="/level-1-2/index.html">Level 1-2</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-2/subpage1.html">Subpage 1, Level 1-2</a></li>

<li class="toc-item"><a href="/level-1-2/subpage2.html#subpage-2-level-1-2">Subpage 2, Level 1-2</a></li>
<li class="toc-item"><a href="/level-1-2/subpage2.html">Subpage 2, Level 1-2</a></li>

</ul></li>

Expand Down
28 changes: 14 additions & 14 deletions tests/Integration/tests/navigation/menu-level-3/expected/level-1-2/subpage1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,35 @@ <h1>Subpage 1, Level 1-2</h1>
<p>Lorem Ipsum Dolor.</p>
<div class="menu">
<ul class="menu-level">
<li class="toc-item"><a href="/page1.html#page-1">Page 1</a></li>
<li class="toc-item"><a href="/page1.html">Page 1</a></li>

<li class="toc-item"><a href="/page2.html#page-2">Page 2</a></li>
<li class="toc-item"><a href="/page2.html">Page 2</a></li>

<li class="toc-item"><a href="/level-1-1/index.html#level-1-1">Level 1-1</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-1/subpage1.html#subpage-1-level-1-1">Subpage 1, Level 1-1</a></li>
<li class="toc-item"><a href="/level-1-1/index.html">Level 1-1</a> <ul class="menu-level-1">
<li class="toc-item"><a href="/level-1-1/subpage1.html">Subpage 1, Level 1-1</a></li>

<li class="toc-item"><a href="/level-1-1/subpage2.html#subpage-2-level-1-1">Subpage 2, Level 1-1</a></li>
<li class="toc-item"><a href="/level-1-1/subpage2.html">Subpage 2, Level 1-1</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-1/index.html#level-2-1">Level 2-1</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage1.html#subpage-1-level-2-1">Subpage 1, Level 2-1</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-1/index.html">Level 2-1</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage1.html">Subpage 1, Level 2-1</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-1/subpage2.html#subpage-2-level-2-1">Subpage 2, Level 2-1</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-1/subpage2.html">Subpage 2, Level 2-1</a></li>

</ul></li>

<li class="toc-item"><a href="/level-1-1/level-2-2/index.html#level-2-2">Level 2-2</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage1.html#subpage-1-level-2-2">Subpage 1, Level 2-2</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-2/index.html">Level 2-2</a> <ul class="menu-level-2">
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage1.html">Subpage 1, Level 2-2</a></li>

<li class="toc-item"><a href="/level-1-1/level-2-2/subpage2.html#subpage-2-level-2-2">Subpage 2, Level 2-2</a></li>
<li class="toc-item"><a href="/level-1-1/level-2-2/subpage2.html">Subpage 2, Level 2-2</a></li>

</ul></li>

</ul></li>

<li class="toc-item active"><a href="/level-1-2/index.html#level-1-2">Level 1-2</a> <ul class="menu-level-1">
<li class="toc-item current active"><a href="/level-1-2/subpage1.html#subpage-1-level-1-2">Subpage 1, Level 1-2</a></li>
<li class="toc-item active"><a href="/level-1-2/index.html">Level 1-2</a> <ul class="menu-level-1">
<li class="toc-item current active"><a href="/level-1-2/subpage1.html">Subpage 1, Level 1-2</a></li>

<li class="toc-item"><a href="/level-1-2/subpage2.html#subpage-2-level-1-2">Subpage 2, Level 1-2</a></li>
<li class="toc-item"><a href="/level-1-2/subpage2.html">Subpage 2, Level 1-2</a></li>

</ul></li>

Expand Down
Loading