Skip to content

Commit 86a19e1

Browse files
linawolflinawolf
committed
[FEATURE] Introduce NavigationTitle
1 parent 3ef4ee0 commit 86a19e1

File tree

18 files changed

+485
-4
lines changed

18 files changed

+485
-4
lines changed

‎packages/guides-restructured-text/resources/config/guides-restructured-text.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@
8181
use phpDocumentor\Guides\RestructuredText\Parser\Productions\FieldList\DateFieldListItemRule;
8282
use phpDocumentor\Guides\RestructuredText\Parser\Productions\FieldList\DedicationFieldListItemRule;
8383
use phpDocumentor\Guides\RestructuredText\Parser\Productions\FieldList\FieldListItemRule;
84+
use phpDocumentor\Guides\RestructuredText\Parser\Productions\FieldList\NavigationTitleFieldListItemRule;
8485
use phpDocumentor\Guides\RestructuredText\Parser\Productions\FieldList\NocommentsFieldListItemRule;
8586
use phpDocumentor\Guides\RestructuredText\Parser\Productions\FieldList\NosearchFieldListItemRule;
8687
use phpDocumentor\Guides\RestructuredText\Parser\Productions\FieldList\OrganizationFieldListItemRule;
@@ -320,6 +321,9 @@
320321
->set(DedicationFieldListItemRule::class)
321322
->tag('phpdoc.guides.parser.rst.fieldlist')
322323

324+
->set(NavigationTitleFieldListItemRule::class)
325+
->tag('phpdoc.guides.parser.rst.fieldlist')
326+
323327
->set(NocommentsFieldListItemRule::class)
324328
->tag('phpdoc.guides.parser.rst.fieldlist')
325329

‎packages/guides-restructured-text/src/RestructuredText/Parser/Productions/FieldList/NavigationTitleFieldListItemRule.php

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* This file is part of phpDocumentor.
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*
11+
* @link https://phpdoc.org
12+
*/
13+
14+
namespace phpDocumentor\Guides\RestructuredText\Parser\Productions\FieldList;
15+
16+
use phpDocumentor\Guides\Nodes\FieldLists\FieldListItemNode;
17+
use phpDocumentor\Guides\Nodes\Metadata\MetadataNode;
18+
use phpDocumentor\Guides\Nodes\Metadata\NavigationTitleNode;
19+
use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
20+
21+
use function strtolower;
22+
23+
final class NavigationTitleFieldListItemRule implements FieldListItemRule
24+
{
25+
public function applies(FieldListItemNode $fieldListItemNode): bool
26+
{
27+
return strtolower($fieldListItemNode->getTerm()) === 'navigation-title';
28+
}
29+
30+
public function apply(FieldListItemNode $fieldListItemNode, BlockContext $blockContext): MetadataNode
31+
{
32+
return new NavigationTitleNode($fieldListItemNode->getPlaintextContent());
33+
}
34+
}

‎packages/guides/src/Compiler/NodeTransformers/DocumentEntryRegistrationTransformer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node|nu
4444
$this->logger->warning('Document has no title', $compilerContext->getLoggerInformation());
4545
}
4646

47-
$entry = new DocumentEntryNode($node->getFilePath(), $node->getTitle() ?? TitleNode::emptyNode(), $node->isRoot());
47+
$entry = new DocumentEntryNode($node->getFilePath(), $node->getTitle() ?? TitleNode::emptyNode(), $node->isRoot(), $node->getNavigationTitle());
4848
$compilerContext->getProjectNode()->addDocumentEntry($entry);
4949

5050
return $node->setDocumentEntry($entry);

‎packages/guides/src/Compiler/NodeTransformers/MenuNodeTransformers/GlobMenuEntryNodeTransformer.php

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@
2020
use phpDocumentor\Guides\Nodes\Menu\MenuNode;
2121
use phpDocumentor\Guides\Nodes\Menu\TocNode;
2222
use phpDocumentor\Guides\Nodes\Node;
23+
use phpDocumentor\Guides\Nodes\TitleNode;
2324

2425
use function array_pop;
2526
use function assert;
2627
use function explode;
2728
use function implode;
2829
use function in_array;
30+
use function is_string;
2931
use function preg_match;
3032
use function str_replace;
3133

@@ -65,10 +67,15 @@ protected function handleMenuEntry(MenuNode $currentMenu, MenuEntryNode $entryNo
6567
}
6668
}
6769

70+
$titleNode = $documentEntry->getTitle();
71+
if (is_string($documentEntry->getNavigationTitle())) {
72+
$titleNode = TitleNode::fromString($documentEntry->getNavigationTitle());
73+
}
74+
6875
$documentEntriesInTree[] = $documentEntry;
6976
$newEntryNode = new InternalMenuEntryNode(
7077
$documentEntry->getFile(),
71-
$documentEntry->getTitle(),
78+
$titleNode,
7279
[],
7380
false,
7481
1,

‎packages/guides/src/Compiler/NodeTransformers/MenuNodeTransformers/InternalMenuEntryNodeTransformer.php

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,15 @@
1919
use phpDocumentor\Guides\Nodes\Menu\MenuNode;
2020
use phpDocumentor\Guides\Nodes\Menu\TocNode;
2121
use phpDocumentor\Guides\Nodes\Node;
22+
use phpDocumentor\Guides\Nodes\TitleNode;
2223
use phpDocumentor\Guides\ReferenceResolvers\DocumentNameResolverInterface;
2324
use Psr\Log\LoggerInterface;
2425

2526
use function array_pop;
2627
use function assert;
2728
use function explode;
2829
use function implode;
30+
use function is_string;
2931
use function sprintf;
3032

3133
final class InternalMenuEntryNodeTransformer extends AbstractMenuEntryNodeTransformer
@@ -63,10 +65,19 @@ protected function handleMenuEntry(MenuNode $currentMenu, MenuEntryNode $entryNo
6365
continue;
6466
}
6567

68+
$titleNode = $documentEntry->getTitle();
69+
if (is_string($documentEntry->getNavigationTitle())) {
70+
$titleNode = TitleNode::fromString($documentEntry->getNavigationTitle());
71+
}
72+
73+
if ($entryNode->getValue() instanceof TitleNode) {
74+
$titleNode = $entryNode->getValue();
75+
}
76+
6677
$documentEntriesInTree[] = $documentEntry;
6778
$newEntryNode = new InternalMenuEntryNode(
6879
$documentEntry->getFile(),
69-
$entryNode->getValue() ?? $documentEntry->getTitle(),
80+
$titleNode,
7081
[],
7182
false,
7283
1,

‎packages/guides/src/NodeRenderers/Html/BreadCrumbNodeRenderer.php

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,14 @@
1919
use phpDocumentor\Guides\Nodes\Menu\InternalMenuEntryNode;
2020
use phpDocumentor\Guides\Nodes\Menu\MenuEntryNode;
2121
use phpDocumentor\Guides\Nodes\Node;
22+
use phpDocumentor\Guides\Nodes\TitleNode;
2223
use phpDocumentor\Guides\RenderContext;
2324
use phpDocumentor\Guides\TemplateRenderer;
2425

2526
use function array_reverse;
2627
use function assert;
2728
use function is_a;
29+
use function is_string;
2830

2931
/**
3032
* @template T as Node
@@ -107,9 +109,14 @@ private function buildBreadcrumb(
107109
int $level,
108110
bool $isCurrent,
109111
): array {
112+
$title = $documentEntry->getTitle();
113+
if (is_string($documentEntry->getNavigationTitle())) {
114+
$title = TitleNode::fromString($documentEntry->getNavigationTitle());
115+
}
116+
110117
$entry = new InternalMenuEntryNode(
111118
$documentEntry->getFile(),
112-
$documentEntry->getTitle(),
119+
$title,
113120
[],
114121
false,
115122
$level,

‎packages/guides/src/Nodes/DocumentNode.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
use phpDocumentor\Guides\Nodes\DocumentTree\SectionEntryNode;
2020
use phpDocumentor\Guides\Nodes\Menu\TocNode;
2121
use phpDocumentor\Guides\Nodes\Metadata\MetadataNode;
22+
use phpDocumentor\Guides\Nodes\Metadata\NavigationTitleNode;
2223

2324
use function array_filter;
2425
use function max;
@@ -52,6 +53,8 @@ final class DocumentNode extends CompoundNode
5253
private int $maxFootnoteNumber = 0;
5354
private int $lastReturnedAnonymousFootnoteNumber = -1;
5455

56+
private string|null $navigationTitle = null;
57+
5558
/**
5659
* Variables are replacements in a document or project.
5760
*
@@ -97,6 +100,11 @@ public function getNodes(string $nodeType = Node::class): array
97100
return array_filter($this->value, static fn ($node): bool => $node instanceof $nodeType);
98101
}
99102

103+
public function getNavigationTitle(): string|null
104+
{
105+
return $this->navigationTitle;
106+
}
107+
100108
public function getPageTitle(): string|null
101109
{
102110
if ($this->metaTitle !== null) {
@@ -132,6 +140,10 @@ public function setMetaTitle(string $metaTitle): void
132140

133141
public function addHeaderNode(MetadataNode $node): void
134142
{
143+
if ($node instanceof NavigationTitleNode) {
144+
$this->navigationTitle = $node->getValue();
145+
}
146+
135147
$this->headerNodes[] = $node;
136148
}
137149

‎packages/guides/src/Nodes/DocumentTree/DocumentEntryNode.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ public function __construct(
3030
private readonly string $file,
3131
private readonly TitleNode $titleNode,
3232
private readonly bool $isRoot = false,
33+
private string|null $navigationTitle = null,
3334
) {
3435
}
3536

@@ -81,4 +82,9 @@ public function isRoot(): bool
8182
{
8283
return $this->isRoot;
8384
}
85+
86+
public function getNavigationTitle(): string|null
87+
{
88+
return $this->navigationTitle;
89+
}
8490
}

‎packages/guides/src/Nodes/Metadata/NavigationTitleNode.php

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* This file is part of phpDocumentor.
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*
11+
* @link https://phpdoc.org
12+
*/
13+
14+
namespace phpDocumentor\Guides\Nodes\Metadata;
15+
16+
/**
17+
* The organization element contains the name of document author's organization,
18+
* or the organization responsible for the document.
19+
*/
20+
final class NavigationTitleNode extends MetadataNode
21+
{
22+
public function __construct(string $plaintext)
23+
{
24+
parent::__construct($plaintext);
25+
}
26+
}

‎tests/Integration/tests-full/bootstrap/bootstrap-navigation-title/expected/anotherPage.html

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
<!DOCTYPE html>
2+
<html class="no-js" lang="en">
3+
<head>
4+
<title>Another Page - Bootstrap Theme</title>
5+
<!-- Required meta tags -->
6+
<meta charset="utf-8">
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
9+
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
10+
</head>
11+
<body>
12+
<header class="">
13+
14+
<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
15+
<div class="container">
16+
17+
<a class="navbar-brand" href="#">Navbar</a>
18+
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
19+
<span class="navbar-toggler-icon"></span>
20+
</button>
21+
<div class="collapse navbar-collapse" id="navbarSupportedContent">
22+
23+
<ul class="navbar-nav me-auto mb-2 mb-lg-0">
24+
<li class="nav-item">
25+
<a href="/anotherPage.html" class="nav-link current active" aria-current="page">
26+
Another Page
27+
</a>
28+
</li><li class="nav-item">
29+
<a href="/somePage.html" class="nav-link">
30+
Some Page
31+
</a>
32+
</li><li class="nav-item">
33+
<a href="/yetAnotherPage.html" class="nav-link">
34+
Title in Menu
35+
</a>
36+
</li></ul>
37+
38+
</div>
39+
</div>
40+
</nav>
41+
</header>
42+
<main id="main-content">
43+
<div class="container">
44+
<div class="container">
45+
<div class="row">
46+
<div class="col-lg-3">
47+
<nav class="nav flex-column">
48+
<ul class="menu-level-main">
49+
<li>
50+
<a href="/anotherPage.html"
51+
class="nav-link current active" aria-current="page">Another Page</a>
52+
</li>
53+
<li>
54+
<a href="/somePage.html"
55+
class="nav-link">Some Page</a>
56+
</li>
57+
<li>
58+
<a href="/yetAnotherPage.html"
59+
class="nav-link">Title in Menu</a>
60+
</li>
61+
</ul>
62+
</nav>
63+
64+
</div>
65+
<div class="col-lg-9">
66+
67+
<nav aria-label="breadcrumb">
68+
<ol class="breadcrumb">
69+
<li class="breadcrumb-item"><a href="/index.html">Document Title</a></li>
70+
<li class="breadcrumb-item"><a href="/anotherPage.html">Another Page</a></li>
71+
</ol>
72+
</nav>
73+
<!-- content start -->
74+
75+
<div class="section" id="another-page">
76+
<h1>Another Page</h1>
77+
78+
<p>Lorem Ipsum Dolor.</p>
79+
80+
</div>
81+
<!-- content end -->
82+
</div>
83+
</div>
84+
</div>
85+
</div>
86+
</main>
87+
<footer class="bg-primary text-light">
88+
<div class="container">
89+
90+
<p>Generated by <a href="https://www.phpdoc.org/">phpDocumentor</a>.</p>
91+
92+
</div>
93+
</footer>
94+
95+
<!-- Optional JavaScript; choose one of the two! -->
96+
97+
<!-- Option 1: Bootstrap Bundle with Popper -->
98+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
99+
100+
<!-- Option 2: Separate Popper and Bootstrap JS -->
101+
<!--
102+
<script src="https://cdn.jsdelivr.net/npm/@popperjs/[email protected]/dist/umd/popper.min.js" integrity="sha384-IQsoLXl5PILFhosVNubq5LC7Qb9DXgDA9i+tQ8Zj3iwWAwPtgFTxbJ8NT4GN1R8p" crossorigin="anonymous"></script>
103+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js" integrity="sha384-cVKIPhGWiC2Al4u+LWgxfKTRIcfu0JTxR+EQDz/bgldoEyl4H0zUF0QKbrJ0EcQF" crossorigin="anonymous"></script>
104+
-->
105+
</body>
106+
</html>

0 commit comments

Comments
 (0)