[FEATURE] Introduce twig function to output menu

This way in the bootstrap template we can always output a menu even if no block is defined

Author: linawolf

packages/guides-restructured-text/src/RestructuredText/Directives/AbstractAdmonitionDirective.php

@@ -13,9 +13,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\RestructuredText\Nodes\AdmonitionNode;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 

packages/guides-restructured-text/src/RestructuredText/Directives/AbstractVersionChangeDirective.php

@@ -13,8 +13,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Nodes\VersionChangeNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;

packages/guides-restructured-text/src/RestructuredText/Directives/AdmonitionDirective.php

@@ -13,9 +13,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\RestructuredText\Nodes\AdmonitionNode;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 use function preg_replace;

packages/guides-restructured-text/src/RestructuredText/Directives/ClassDirective.php

@@ -5,9 +5,9 @@
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
 use phpDocumentor\Guides\Nodes\ClassNode;
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\DocumentNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use Symfony\Component\String\Slugger\AsciiSlugger;
 

packages/guides-restructured-text/src/RestructuredText/Directives/ContainerDirective.php

@@ -4,8 +4,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Nodes\ContainerNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 

packages/guides-restructured-text/src/RestructuredText/Directives/DocumentBlockDirective.php

@@ -4,9 +4,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\DocumentBlockNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 class DocumentBlockDirective extends SubDirective

packages/guides-restructured-text/src/RestructuredText/Directives/EpigraphDirective.php

@@ -4,9 +4,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\QuoteNode;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 /**

packages/guides-restructured-text/src/RestructuredText/Directives/FigureDirective.php

@@ -4,10 +4,10 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\FigureNode;
 use phpDocumentor\Guides\Nodes\ImageNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 use phpDocumentor\Guides\UrlGeneratorInterface;

packages/guides-restructured-text/src/RestructuredText/Directives/GeneralDirective.php

@@ -4,9 +4,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\InlineCompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Nodes\GeneralDirectiveNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 

packages/guides-restructured-text/src/RestructuredText/Directives/HighlightsDirective.php

@@ -4,9 +4,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\QuoteNode;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 /**

packages/guides-restructured-text/src/RestructuredText/Directives/IncludeDirective.php

@@ -14,9 +14,9 @@
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
 use phpDocumentor\Guides\Nodes\CodeNode;
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\LiteralBlockNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\DocumentRule;

packages/guides-restructured-text/src/RestructuredText/Directives/PullQuoteDirective.php

@@ -4,9 +4,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\QuoteNode;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 /**

packages/guides-restructured-text/src/RestructuredText/Directives/ReplaceDirective.php

@@ -4,11 +4,11 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\InlineCompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\ParagraphNode;
 use phpDocumentor\Guides\Nodes\ReplacementNode;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 use function count;

packages/guides-restructured-text/src/RestructuredText/Directives/SidebarDirective.php

@@ -13,8 +13,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Nodes\SidebarNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 

packages/guides-restructured-text/src/RestructuredText/Directives/SubDirective.php

@@ -4,8 +4,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;

packages/guides-restructured-text/src/RestructuredText/Directives/TableDirective.php

@@ -4,9 +4,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\TableNode;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 use Psr\Log\LoggerInterface;

packages/guides-restructured-text/src/RestructuredText/Directives/TodoDirective.php

@@ -4,8 +4,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 /**

packages/guides-restructured-text/src/RestructuredText/Directives/TopicDirective.php

@@ -13,8 +13,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Nodes\TopicNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 

packages/guides-restructured-text/src/RestructuredText/Directives/WrapDirective.php

@@ -4,8 +4,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 /**

packages/guides-restructured-text/src/RestructuredText/NodeRenderers/Html/CollectionNodeRenderer.php

@@ -15,9 +15,9 @@
 
 use InvalidArgumentException;
 use phpDocumentor\Guides\NodeRenderers\NodeRenderer;
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\RenderContext;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\TemplateRenderer;
 
 /** @implements NodeRenderer<CollectionNode> */

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/BlockQuoteRule.php

@@ -13,10 +13,10 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Parser\Productions;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\CompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\QuoteNode;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Buffer;
 

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/DirectiveContentRule.php

@@ -4,9 +4,9 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Parser\Productions;
 
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\CompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 
 /** @implements Rule<CollectionNode> */

packages/guides-theme-bootstrap/resources/template/body/menu/mainmenu/menu.html.twig

@@ -1,5 +1,8 @@
 
 <nav class="nav flex-column">
+        {% if node.options.caption %}
+            <h2>{{ node.options.caption }}</h2>
+        {% endif %}
         <ul class="level-1">
     {% for entry in node.menuEntries -%}
         <li><a href="{{ renderLink(entry.url) }}"

packages/guides-theme-bootstrap/resources/template/structure/navigation/menu_doc.html.twig

@@ -2,4 +2,6 @@
     {% for child in parts.mainmenu -%}
         {{ renderNode(child) }}
     {%~ endfor -%}
+{% else %}
+    {{ renderMenu('mainmenu') }}
 {% endif %}

packages/guides-theme-bootstrap/resources/template/structure/navigation/navbar.html.twig

@@ -1,4 +1,4 @@
-{% if parts.navbar %}
+
 <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
     <div class="container">
 
@@ -8,11 +8,13 @@
         </button>
         <div class="collapse navbar-collapse" id="navbarSupportedContent">
 
-
-            {% for child in parts.navbar -%}
-                {{ renderNode(child) }}
-            {%~ endfor -%}
+            {% if parts.navbar %}
+                {% for child in parts.navbar -%}
+                    {{ renderNode(child) }}
+                {%~ endfor -%}
+            {% else %}
+                {{ renderMenu('navbar', 1) }}
+            {% endif %}
         </div>
     </div>
 </nav>
-{% endif %}

packages/guides-theme-bootstrap/src/Bootstrap/Directives/TabDirective.php

@@ -14,10 +14,10 @@
 namespace phpDocumentor\Guides\Bootstrap\Directives;
 
 use phpDocumentor\Guides\Bootstrap\Nodes\TabNode;
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\InlineCompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\RestructuredText\Directives\SubDirective;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 
 use function is_string;

packages/guides-theme-bootstrap/src/Bootstrap/Directives/TabsDirective.php

@@ -15,10 +15,10 @@
 
 use phpDocumentor\Guides\Bootstrap\Nodes\TabNode;
 use phpDocumentor\Guides\Bootstrap\Nodes\TabsNode;
+use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\InlineCompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\RestructuredText\Directives\SubDirective;
-use phpDocumentor\Guides\RestructuredText\Nodes\CollectionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 use Psr\Log\LoggerInterface;

packages/guides/src/Compiler/NodeTransformers/MenuNodeAddEntryTransformer.php

@@ -96,8 +96,12 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node|nu
         }
 
         $menuEntries = array_unique($menuEntries);
+        $node = $node->withMenuEntries($menuEntries);
+        if ($node instanceof TocNode) {
+            $compilerContext->getDocumentNode()->addTocNode($node);
+        }
 
-        return $node->withMenuEntries($menuEntries);
+        return $node;
     }
 
     private function isInRootline(DocumentEntryNode $menuEntry, DocumentEntryNode $currentDoc): bool

packages/guides-restructured-text/src/RestructuredText/Nodes/CollectionNode.php renamed to packages/guides/src/Nodes/CollectionNode.php

@@ -11,10 +11,7 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\RestructuredText\Nodes;
-
-use phpDocumentor\Guides\Nodes\CompoundNode;
-use phpDocumentor\Guides\Nodes\Node;
+namespace phpDocumentor\Guides\Nodes;
 
 /**
  * A collection node is a node that renders all its children without adding

packages/guides/src/Nodes/DocumentNode.php

@@ -17,6 +17,7 @@
 use phpDocumentor\Guides\Meta\FootnoteTarget;
 use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
 use phpDocumentor\Guides\Nodes\DocumentTree\SectionEntryNode;
+use phpDocumentor\Guides\Nodes\Menu\TocNode;
 use phpDocumentor\Guides\Nodes\Metadata\MetadataNode;
 
 use function array_filter;
@@ -45,6 +46,9 @@ final class DocumentNode extends CompoundNode
     /** @var array<int, FootnoteTarget> */
     private array $footnoteTargets = [];
 
+    /** @var TocNode[] */
+    private array $tocNodes = [];
+
     private int $maxFootnoteNumber = 0;
     private int $lastReturnedAnonymousFootnoteNumber = -1;
 
@@ -201,6 +205,17 @@ public function hasDocumentPart(string $identifier): bool
         return isset($this->documentPartNodes[$identifier]);
     }
 
+    public function addTocNode(TocNode $tocNode): void
+    {
+        $this->tocNodes[] = $tocNode;
+    }
+
+    /** @return TocNode[] */
+    public function getTocNodes(): array
+    {
+        return $this->tocNodes;
+    }
+
     public function addFootnoteTarget(FootnoteTarget $target): int
     {
         if ($target->getNumber() > 0) {

packages/guides/src/Nodes/Menu/NavMenuNode.php

@@ -13,6 +13,7 @@
 
 namespace phpDocumentor\Guides\Nodes\Menu;
 
+use function assert;
 use function is_scalar;
 
 class NavMenuNode extends MenuNode
@@ -34,4 +35,22 @@ public function isPageLevelOnly(): bool
     {
         return true;
     }
+
+    public static function fromTocNode(TocNode $tocNode, string|null $menuType = null): NavMenuNode
+    {
+        $node = new NavMenuNode($tocNode->getFiles());
+        $node = $node->withMenuEntries($tocNode->getMenuEntries());
+        $options = $tocNode->getOptions();
+        unset($options['hidden']);
+        unset($options['titlesonly']);
+        unset($options['maxdepth']);
+        if ($menuType !== null) {
+            $options['menu'] = $menuType;
+        }
+
+        $node = $node->withOptions($options);
+        assert($node instanceof NavMenuNode);
+
+        return $node;
+    }
 }