[BUGFIX] Fix menu directive

TYPO3-Documentation · Oct 22, 2024 · f84a720 · f84a720
1 parent 9f9f466
commit f84a720
Show file tree

Hide file tree

Showing 41 changed files with 81 additions and 96 deletions.
diff --git a/packages/typo3-docs-theme/resources/template/body/menu/menu.html.twig b/packages/typo3-docs-theme/resources/template/body/menu/menu.html.twig
@@ -1,12 +1,16 @@
-
 {% if node.options.menu == 'mainmenu' %}
     {% include "structure/navigation/menu.html.twig" %}
 {% elseif node.options.menu == 'sitemap' %}
     {% include "body/menu/sitemap.html.twig" %}
 {% else %}
     <div class="toctree-wrapper compound">
+        {% if node.caption -%}
+            <p class="topic-title">{{ renderNode(node.caption) }}</p>
+        {% elseif node.options['caption'] -%}
+            <p class="topic-title">{{ node.options['caption'] }}</p>
+        {% endif -%}
         <ul>
-            {% for entry in node.entries -%}
+            {% for entry in node.menuEntries -%}
                 {{ renderNode(entry) }}
             {% endfor %}
         </ul>

diff --git a/tests/Integration/tests-full/breadcrumb/expected/index.html b/tests/Integration/tests-full/breadcrumb/expected/index.html
@@ -80,8 +80,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="page.html">
         Page 

diff --git a/tests/Integration/tests-full/breadcrumb/expected/page.html b/tests/Integration/tests-full/breadcrumb/expected/page.html
@@ -81,8 +81,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class=" current active">
     <a href="#" aria-current="page">
         Page 

diff --git a/tests/Integration/tests-full/breadcrumb/expected/yetAnotherPage.html b/tests/Integration/tests-full/breadcrumb/expected/yetAnotherPage.html
@@ -80,8 +80,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="page.html">
         Page TYPO3 Extension oauth2 (mfc/oauth2)

diff --git a/...ull/changelog/expected/Changelog/12.0/Breaking-87616-RemovedHookForAlteringPageLinks.html b/...ull/changelog/expected/Changelog/12.0/Breaking-87616-RemovedHookForAlteringPageLinks.html
@@ -95,16 +95,14 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class=" active">
     <a href="../../Changelog-12.html">
         ChangeLog v12
     </a>        <ul class="menu-level-1"><li class=" active">
     <a href="Index.html">
         12.0 Changes
-    </a></li></ul></li>    </ul>
-    <ul class="menu-level-1">
+    </a></li></ul></li>    </ul>    <ul class="menu-level-1">
     <li class="">
     <a href="../../Sitemap.html">
         Sitemap

diff --git a/tests/Integration/tests-full/changelog/expected/Changelog/12.0/Index.html b/tests/Integration/tests-full/changelog/expected/Changelog/12.0/Index.html
@@ -96,16 +96,14 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class=" active">
     <a href="../../Changelog-12.html">
         ChangeLog v12
     </a>        <ul class="menu-level-1"><li class=" current active">
     <a href="#" aria-current="page">
         12.0 Changes
-    </a></li></ul></li>    </ul>
-    <ul class="menu-level-1">
+    </a></li></ul></li>    </ul>    <ul class="menu-level-1">
     <li class="">
     <a href="../../Sitemap.html">
         Sitemap

diff --git a/tests/Integration/tests-full/changelog/expected/Index.html b/tests/Integration/tests-full/changelog/expected/Index.html
@@ -94,16 +94,14 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="Changelog-12.html">
         ChangeLog v12
     </a>        <ul class="menu-level-1"><li class="">
     <a href="Changelog/12.0/Index.html">
         12.0 Changes
-    </a></li></ul></li>    </ul>
-    <ul class="menu-level-1">
+    </a></li></ul></li>    </ul>    <ul class="menu-level-1">
     <li class="">
     <a href="Sitemap.html">
         Sitemap

diff --git a/tests/Integration/tests-full/changelog/expected/Sitemap.html b/tests/Integration/tests-full/changelog/expected/Sitemap.html
@@ -95,16 +95,14 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="Changelog-12.html">
         ChangeLog v12
     </a>        <ul class="menu-level-1"><li class="">
     <a href="Changelog/12.0/Index.html">
         12.0 Changes
-    </a></li></ul></li>    </ul>
-    <ul class="menu-level-1">
+    </a></li></ul></li>    </ul>    <ul class="menu-level-1">
     <li class=" current active">
     <a href="#" aria-current="page">
         Sitemap
@@ -162,8 +160,7 @@
             <h1>Sitemap<a class="headerlink" href="#sitemap" data-bs-toggle="modal" data-bs-target="#linkReferenceModal"  title="Reference this headline"><i class="fa-solid fa-paragraph"></i></a></h1>
     </section>
 <div class="section">
-
-    <div class="sitemap">
+        <div class="sitemap">
     <ul>
         <li class="toctree-l0">
     <a href="Changelog-12.html"
@@ -174,8 +171,7 @@ <h1>Sitemap<a class="headerlink" href="#sitemap" data-bs-toggle="modal" data-bs-
        class="reference internal">
         12.0 Changes
     </a></li></ul></li>            </ul>
-</div>
-    <div class="sitemap">
+</div>    <div class="sitemap">
     <ul>
         <li class="toctree-l0">
     <a href="#"

diff --git a/tests/Integration/tests-full/edit-on-github/edit-on-github-per-page/expected/index.html b/tests/Integration/tests-full/edit-on-github/edit-on-github-per-page/expected/index.html
@@ -80,8 +80,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="page1.html">
         Avatar ViewHelper &lt;be:avatar&gt;

diff --git a/tests/Integration/tests-full/edit-on-github/edit-on-github-per-page/expected/page1.html b/tests/Integration/tests-full/edit-on-github/edit-on-github-per-page/expected/page1.html
@@ -80,8 +80,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class=" current active">
     <a href="#" aria-current="page">
         Avatar ViewHelper &lt;be:avatar&gt;

diff --git a/tests/Integration/tests-full/main-menu-json/expected/index.html b/tests/Integration/tests-full/main-menu-json/expected/index.html
@@ -80,8 +80,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="mainMenu.json.html">
         &lt;Unknown&gt;

diff --git a/tests/Integration/tests-full/menu-subpages-max-1/expected/index.html b/tests/Integration/tests-full/menu-subpages-max-1/expected/index.html
@@ -94,8 +94,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="someDirectory/index.html">
         Some Page

diff --git a/tests/Integration/tests-full/menu-subpages-no-titlesonly-maxdepth-1/expected/index.html b/tests/Integration/tests-full/menu-subpages-no-titlesonly-maxdepth-1/expected/index.html
@@ -94,8 +94,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="someDirectory/index.html">
         Some Page

diff --git a/tests/Integration/tests-full/menu-subpages-no-titlesonly-maxdepth-2/expected/index.html b/tests/Integration/tests-full/menu-subpages-no-titlesonly-maxdepth-2/expected/index.html
@@ -94,8 +94,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="someDirectory/index.html">
         Some Page

diff --git a/tests/Integration/tests-full/menu-subpages/expected/index.html b/tests/Integration/tests-full/menu-subpages/expected/index.html
@@ -94,8 +94,8 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <p class="caption"><span class="caption-text">This is the toctree</span></p>
+<ul class="menu-level-1">
     <li class="">
     <a href="someDirectory/index.html">
         Some Page
@@ -151,6 +151,7 @@ <h1>Document Title<a class="headerlink" href="#document-title" data-bs-toggle="m
     <p>Lorem Ipsum Dolor.</p>
 
             <div class="toctree-wrapper compound">
+            <p class="topic-title">This is the toctree</p>
         <ul class="menu-level">
     <li class="toc-item">
     <a href="someDirectory/index.html#some-page">Some Page</a>
@@ -159,6 +160,23 @@ <h1>Document Title<a class="headerlink" href="#document-title" data-bs-toggle="m
 </li>
     </ul>
 </div>
+                <div class="toctree-wrapper compound">
+        <p class="topic-title">This is a menu</p>
+        <ul>
+            <li class="toc-item">
+    <a href="someDirectory/index.html#some-page">Some Page</a>
+        <ul class="menu-level-1">
+            <li class="toc-item">
+    <a href="someDirectory/anotherDirectory/index.html#another-page">Another Page</a>
+
+
+</li>
+                    </ul>
+
+</li>
+                    </ul>
+    </div>
+
     </section>
         <!-- content end -->
     </div>

diff --git a/tests/Integration/tests-full/menu-subpages/input/index.rst b/tests/Integration/tests-full/menu-subpages/input/index.rst
@@ -13,8 +13,17 @@ Document Title
 Lorem Ipsum Dolor.
 
 ..  toctree::
+    :caption: This is the toctree
     :glob:
     :titlesonly:
     :maxdepth: 1
 
     */index
+
+..  menu::
+    :caption: This is a menu
+    :glob:
+    :titlesonly:
+    :maxdepth: 2
+
+    */index
diff --git a/tests/Integration/tests-full/navigation-title/expected/anotherPage.html b/tests/Integration/tests-full/navigation-title/expected/anotherPage.html
@@ -95,8 +95,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class=" current active">
     <a href="#" aria-current="page">
         Another Page

diff --git a/tests/Integration/tests-full/navigation-title/expected/index.html b/tests/Integration/tests-full/navigation-title/expected/index.html
@@ -94,8 +94,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="anotherPage.html">
         Another Page

diff --git a/tests/Integration/tests-full/navigation-title/expected/yetAnotherPage.html b/tests/Integration/tests-full/navigation-title/expected/yetAnotherPage.html
@@ -94,8 +94,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="anotherPage.html">
         Another Page

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/four.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/four.html
@@ -81,8 +81,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="one.html">
         One

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/i.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/i.html
@@ -82,8 +82,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="one.html">
         One

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/index.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/index.html
@@ -80,8 +80,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="one.html">
         One

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/one.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/one.html
@@ -81,8 +81,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class=" current active">
     <a href="#" aria-current="page">
         One

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/three/index.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/three/index.html
@@ -81,8 +81,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="../one.html">
         One

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/three/pi.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/three/pi.html
@@ -81,8 +81,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="../one.html">
         One

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/three/three.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/three/three.html
@@ -81,8 +81,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="../one.html">
         One

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/three/threepointfive.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/three/threepointfive.html
@@ -81,8 +81,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="../one.html">
         One

diff --git a/tests/Integration/tests-full/next-prev-by-toctree/expected/two.html b/tests/Integration/tests-full/next-prev-by-toctree/expected/two.html
@@ -81,8 +81,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="one.html">
         One

diff --git a/tests/Integration/tests-full/next-prev/expected/index.html b/tests/Integration/tests-full/next-prev/expected/index.html
@@ -80,8 +80,7 @@
 </div>                    <div class="toc-collapse">
                                                 <div aria-label="main navigation" class="toc" role="navigation">
                                 <div aria-label="Main navigation" class="main_menu" role="navigation">
-
-    <ul class="menu-level-1">
+            <ul class="menu-level-1">
     <li class="">
     <a href="page.html">
         Page