-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FEATURE] Add option to create an automatic menu
For now all Document entries are added to the root document entry. In a follow up I plan to create a nested menu as well References #1108
- Loading branch information
Showing
41 changed files
with
1,190 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
/** | ||
* This file is part of phpDocumentor. | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
* | ||
* @link https://phpdoc.org | ||
*/ | ||
|
||
namespace phpDocumentor\Guides\Compiler\Passes; | ||
|
||
use phpDocumentor\Guides\Compiler\CompilerContextInterface; | ||
use phpDocumentor\Guides\Compiler\CompilerPass; | ||
use phpDocumentor\Guides\Nodes\DocumentNode; | ||
use phpDocumentor\Guides\Settings\SettingsManager; | ||
|
||
final class AutomaticMenuPass implements CompilerPass | ||
{ | ||
public function __construct( | ||
private readonly SettingsManager $settingsManager, | ||
) { | ||
} | ||
|
||
public function getPriority(): int | ||
{ | ||
return 20; // must be run very late | ||
} | ||
|
||
/** | ||
* @param DocumentNode[] $documents | ||
* | ||
* @return DocumentNode[] | ||
*/ | ||
public function run(array $documents, CompilerContextInterface $compilerContext): array | ||
{ | ||
if (!$this->settingsManager->getProjectSettings()->isAutomaticMenu()) { | ||
return $documents; | ||
} | ||
|
||
$projectNode = $compilerContext->getProjectNode(); | ||
$rootDocumentEntry = $projectNode->getRootDocumentEntry(); | ||
foreach ($documents as $documentNode) { | ||
if ($documentNode->isOrphan()) { | ||
// Do not add orphans to the automatic menu | ||
continue; | ||
} | ||
|
||
if ($documentNode->isRoot()) { | ||
continue; | ||
} | ||
|
||
$documentEntry = $projectNode->getDocumentEntry($documentNode->getFilePath()); | ||
$documentEntry->setParent($rootDocumentEntry); | ||
$rootDocumentEntry->addChild($documentEntry); | ||
} | ||
|
||
return $documents; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 106 additions & 0 deletions
106
tests/Integration/tests-full/automatic_menu/automatic-default-menu/expected/anotherPage.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
<!DOCTYPE html> | ||
<html class="no-js" lang="en"> | ||
<head> | ||
<title>Another Page - Bootstrap Theme</title> | ||
<!-- 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"> | ||
<li class="nav-item"> | ||
<a href="/anotherPage.html" class="nav-link current active" aria-current="page"> | ||
Another Page | ||
</a> | ||
</li><li class="nav-item"> | ||
<a href="/somePage.html" class="nav-link"> | ||
Some Page | ||
</a> | ||
</li><li class="nav-item"> | ||
<a href="/yetAnotherPage.html" class="nav-link"> | ||
Yet Another Page | ||
</a> | ||
</li></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"> | ||
<li> | ||
<a href="/anotherPage.html" | ||
class="nav-link current active" aria-current="page">Another Page</a> | ||
</li> | ||
<li> | ||
<a href="/somePage.html" | ||
class="nav-link">Some Page</a> | ||
</li> | ||
<li> | ||
<a href="/yetAnotherPage.html" | ||
class="nav-link">Yet Another Page</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
|
||
</div> | ||
<div class="col-lg-9"> | ||
|
||
<nav aria-label="breadcrumb"> | ||
<ol class="breadcrumb"> | ||
<li class="breadcrumb-item"><a href="/index.html">Document Title</a></li> | ||
<li class="breadcrumb-item"><a href="/anotherPage.html">Another Page</a></li> | ||
</ol> | ||
</nav> | ||
<!-- content start --> | ||
|
||
<div class="section" id="another-page"> | ||
<h1>Another Page</h1> | ||
|
||
<p>Lorem Ipsum Dolor.</p> | ||
|
||
</div> | ||
<!-- content end --> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
</main> | ||
<footer class="bg-primary text-light"> | ||
<div class="container"> | ||
|
||
<p>Generated by <a href="https://www.phpdoc.org/">phpDocumentor</a>.</p> | ||
|
||
</div> | ||
</footer> | ||
|
||
<!-- 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> |
Oops, something went wrong.