[BUGFIX] Correct Menu levels in global menu tree

Resolves #803
phpDocumentor · Jan 6, 2024 · 5165cfd · 5165cfd
1 parent d160f4c
commit 5165cfd
Show file tree

Hide file tree

Showing 22 changed files with 48 additions and 44 deletions.
diff --git a/packages/guides-theme-bootstrap/resources/template/body/menu/mainmenu/menu.html.twig b/packages/guides-theme-bootstrap/resources/template/body/menu/mainmenu/menu.html.twig
@@ -2,7 +2,7 @@
         {% if node.caption %}
             <h2>{{ renderNode(node.caption) }}</h2>
         {% endif %}
-        <ul class="level-1">
+        <ul class="menu-level-main">
     {% for entry in node.menuEntries -%}
         <li><a href="{{ renderLink(entry.url) }}"
            class="nav-link {%- if node.currentPath == entry.url %} current {%- endif -%}{% if entry.url in node.rootlinePaths %} active {%- endif -%}"

diff --git a/packages/guides/src/Compiler/Passes/GlobalMenuPass.php b/packages/guides/src/Compiler/Passes/GlobalMenuPass.php
@@ -97,7 +97,7 @@ private function getMenuEntryWithChildren(CompilerContext $compilerContext, Menu
             return $menuEntry;
         }
 
-        $newMenuEntry = new InternalMenuEntryNode($menuEntry->getUrl(), $menuEntry->getValue(), [], false, 2);
+        $newMenuEntry = new InternalMenuEntryNode($menuEntry->getUrl(), $menuEntry->getValue(), [], false, 1);
         $maxdepth = $this->settingsManager->getProjectSettings()->getMaxMenuDepth();
         $maxdepth = $maxdepth < 1 ? PHP_INT_MAX : $maxdepth + 1;
         $documentEntryOfMenuEntry = $compilerContext->getProjectNode()->getDocumentEntry($menuEntry->getUrl());

diff --git a/...Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/anotherPage.html b/...Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/anotherPage.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="#"
            class="nav-link current active" aria-current="page" >
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpages/subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="yetAnotherPage.html"
            class="nav-link">
             Yet Another Page

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/index.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpages/subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="yetAnotherPage.html"
            class="nav-link">
             Yet Another Page

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/somePage.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/somePage.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpages/subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="yetAnotherPage.html"
            class="nav-link">
             Yet Another Page

diff --git a/...egration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/index.html b/...egration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/index.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link current active" aria-current="page" >
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../yetAnotherPage.html"
            class="nav-link">
             Yet Another Page

diff --git a/...ation/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/subpage1.html b/...ation/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/subpage1.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link active">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="#"
                        class="nav-link current active" aria-current="page">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../yetAnotherPage.html"
            class="nav-link">
             Yet Another Page

diff --git a/...ation/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/subpage2.html b/...ation/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/subpage2.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link active">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../yetAnotherPage.html"
            class="nav-link">
             Yet Another Page

diff --git a/...egration/tests-full/bootstrap/bootstrap-default-menu-several/expected/yetAnotherPage.html b/...egration/tests-full/bootstrap/bootstrap-default-menu-several/expected/yetAnotherPage.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpages/subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="#"
            class="nav-link current active" aria-current="page" >
             Yet Another Page

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/anotherPage.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/anotherPage.html
@@ -47,7 +47,7 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link current active" aria-current="page" >
             Another Page
@@ -79,7 +79,7 @@
 
 
 <div class="section" id="another-page">
-    <h1>Another Page</h1>
+            <h1>Another Page</h1>
 
             <p>Lorem Ipsum Dolor.</p>
     </div>

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/index.html
@@ -47,7 +47,7 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
@@ -78,7 +78,7 @@
 
 
 <div class="section" id="document-title">
-    <h1>Document Title</h1>
+            <h1>Document Title</h1>
 
             <p>Lorem Ipsum Dolor.</p>
 

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/somePage.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/somePage.html
@@ -47,7 +47,7 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@
 
 
 <div class="section" id="some-page">
-    <h1>Some Page</h1>
+            <h1>Some Page</h1>
 
             <p>Lorem Ipsum <span class="custom">Dolor</span>.</p>
     </div>

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-1/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-1/expected/index.html
@@ -39,7 +39,7 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="someDirectory/index.html"
            class="nav-link">
             Some Page

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-2/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-2/expected/index.html
@@ -44,12 +44,12 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="someDirectory/index.html"
            class="nav-link">
             Some Page
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="someDirectory/anotherDirectory/index.html"
                        class="nav-link">
                                 Another Page

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-3/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-3/expected/index.html
@@ -44,12 +44,12 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="someDirectory/index.html"
            class="nav-link">
             Some Page
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="someDirectory/anotherDirectory/index.html"
                        class="nav-link">
                                 Another Page

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages/expected/index.html
@@ -44,12 +44,12 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="someDirectory/index.html"
            class="nav-link">
             Some Page
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="someDirectory/anotherDirectory/index.html"
                        class="nav-link">
                                 Another Page

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/anotherPage.html b/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/anotherPage.html
@@ -48,7 +48,7 @@
                             <div class="rubric">Main Menu</div>
 
     <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@
 
 
 <div class="section" id="another-page">
-    <h1>Another Page</h1>
+            <h1>Another Page</h1>
 
             <p>Lorem Ipsum Dolor.</p>
     </div>

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/index.html
@@ -48,7 +48,7 @@
                             <div class="rubric">Main Menu</div>
 
     <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
@@ -78,7 +78,7 @@
 
 
 <div class="section" id="document-title">
-    <h1>Document Title</h1>
+            <h1>Document Title</h1>
 
             <p>Lorem Ipsum Dolor.</p>
 

diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/somePage.html b/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/somePage.html
@@ -48,7 +48,7 @@
                             <div class="rubric">Main Menu</div>
 
     <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@
 
 
 <div class="section" id="some-page">
-    <h1>Some Page</h1>
+            <h1>Some Page</h1>
 
             <p>Lorem Ipsum <span class="custom">Dolor</span>.</p>
     </div>

diff --git a/.../Integration/tests-full/bootstrap/bootstrap-menu-external-linktargets/expected/index.html b/.../Integration/tests-full/bootstrap/bootstrap-menu-external-linktargets/expected/index.html
@@ -48,7 +48,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Some Caption</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="https://example.com/index.html#debug-settings"
            class="nav-link">
             Title

diff --git a/tests/Integration/tests-full/index/expected/index.html b/tests/Integration/tests-full/index/expected/index.html
@@ -7,7 +7,7 @@
 <body>
 <!-- content start -->
     <div class="section" id="document-title">
-    <h1>Document Title</h1>
+            <h1>Document Title</h1>
 
             <p>Lorem Ipsum Dolor.</p>
     </div>

diff --git a/tools/integration-test-copy-baseline.php b/tools/integration-test-copy-baseline.php
@@ -18,6 +18,10 @@ function copyTests(string $directory, bool $shortenHtml=true): void
         if (!is_dir($inputDirectory)) {
             continue;
         }
+        if (file_exists($inputDirectory . '/skip')) {
+            // ignore skipped tests
+            continue;
+        }
         $tempDir = $dir->getPathname() . '/temp';
         $expectedDir = $dir->getPathname() . '/expected';
         if (!file_exists($tempDir)) {