fix: In page Namespaces keyword disappear (#8739)

* fix: In page Namespaces keyword disappear * test(snapshot): update snapshots for 75c9e05 --------- Co-authored-by: yufeih <[email protected]>
dotnet · May 6, 2023 · 7841bfb · 7841bfb
1 parent c86f85e
commit 7841bfb
Show file tree

Hide file tree

Showing 25 changed files with 18 additions and 35 deletions.
diff --git a/templates/common/ManagedReference.common.js b/templates/common/ManagedReference.common.js
@@ -20,7 +20,6 @@ exports.transform = function (model) {
       case 'namespace':
         model.isNamespace = true;
         if (model.children) groupChildren(model, namespaceCategory);
-        model[getTypePropertyName(model.type)] = true;
         break;
       case 'class':
       case 'interface':

diff --git a/templates/common/partials/namespaceSubtitle.tmpl.partial b/templates/common/partials/namespaceSubtitle.tmpl.partial
@@ -1,9 +1,8 @@
 {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
-{{^isNamespace}}
+
 {{#inNamespace}}
 {{__global.namespacesInSubtitle}}
 {{/inNamespace}}
-{{/isNamespace}}
 {{#inClass}}
 {{__global.classesInSubtitle}}
 {{/inClass}}

diff --git a/templates/default/partials/title.tmpl.partial b/templates/default/partials/title.tmpl.partial
@@ -2,9 +2,9 @@
 {{#inPackage}}
 Package {{name.0.value}}
 {{/inPackage}}
-{{#inNamespace}}
+{{#isNamespace}}
 Namespace {{name.0.value}}
-{{/inNamespace}}
+{{/isNamespace}}
 {{#inClass}}
 Class {{name.0.value}}
 {{/inClass}}

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp10.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp10.html.view.verified.json
@@ -543,7 +543,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp11.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp11.html.view.verified.json
@@ -490,7 +490,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.html.view.verified.json
@@ -673,7 +673,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp9.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp9.html.view.verified.json
@@ -537,7 +537,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/MyExample.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/MyExample.html.view.verified.json
@@ -231,7 +231,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.html.view.verified.json
@@ -138,7 +138,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/...cfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromCSharpSourceCode.html.view.verified.json b/...cfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromCSharpSourceCode.html.view.verified.json
@@ -134,7 +134,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/....Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Issue8540.A.html.view.verified.json b/....Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Issue8540.A.html.view.verified.json
@@ -152,7 +152,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/....Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Issue8540.B.html.view.verified.json b/....Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Issue8540.B.html.view.verified.json
@@ -152,7 +152,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/...fx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Issue8540.html.view.verified.json b/...fx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Issue8540.html.view.verified.json
@@ -190,7 +190,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json
@@ -923,7 +923,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.html.view.verified.json
@@ -197,7 +197,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.html.view.verified.json
@@ -486,7 +486,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json
@@ -834,7 +834,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.html.view.verified.json
@@ -138,7 +138,6 @@
   "hideTitleType": false,
   "hideSubtitle": false,
   "isNamespace": true,
-  "inNamespace": true,
   "_disableToc": false,
   "_disableNextArticle": true
 }
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json
@@ -42,7 +42,7 @@
   "api/BuildFromProject.html": {
     "href": "api/BuildFromProject.html",
     "title": "Namespace BuildFromProject | docfx seed website",
-    "keywords": "Namespace BuildFromProject BuildFromProject.Issue8540 Classes Class1 Class1.Issue8665 Class1.Issue8696Attribute Class1.Test<T> Inheritdoc Inheritdoc.Issue6366 Inheritdoc.Issue6366.Class1<T> Inheritdoc.Issue6366.Class2 Inheritdoc.Issue7035 Inheritdoc.Issue7484 This is a test class to have something for DocFX to document. Inheritdoc.Issue8101 Structs Inheritdoc.Issue8129 Interfaces IInheritdoc"
+    "keywords": "Namespace BuildFromProject Namespaces BuildFromProject.Issue8540 Classes Class1 Class1.Issue8665 Class1.Issue8696Attribute Class1.Test<T> Inheritdoc Inheritdoc.Issue6366 Inheritdoc.Issue6366.Class1<T> Inheritdoc.Issue6366.Class2 Inheritdoc.Issue7035 Inheritdoc.Issue7484 This is a test class to have something for DocFX to document. Inheritdoc.Issue8101 Structs Inheritdoc.Issue8129 Interfaces IInheritdoc"
   },
   "api/BuildFromProject.IInheritdoc.html": {
     "href": "api/BuildFromProject.IInheritdoc.html",
@@ -112,7 +112,7 @@
   "api/BuildFromProject.Issue8540.html": {
     "href": "api/BuildFromProject.Issue8540.html",
     "title": "Namespace BuildFromProject.Issue8540 | docfx seed website",
-    "keywords": "Namespace BuildFromProject.Issue8540 BuildFromProject.Issue8540.A BuildFromProject.Issue8540.B"
+    "keywords": "Namespace BuildFromProject.Issue8540 Namespaces BuildFromProject.Issue8540.A BuildFromProject.Issue8540.B"
   },
   "api/BuildFromVBSourceCode.BaseClass1.html": {
     "href": "api/BuildFromVBSourceCode.BaseClass1.html",
@@ -187,7 +187,7 @@
   "api/CatLibrary.html": {
     "href": "api/CatLibrary.html",
     "title": "Namespace CatLibrary | docfx seed website",
-    "keywords": "Namespace CatLibrary CatLibrary.Core Classes CatException<T> Cat<T, K> Here's main class of this Demo. You can see mostly type of article within this class and you for more detail, please see the remarks. this class is a template class. It has two Generic parameter. they are: T and K. The extension method of this class can refer to ICatExtension class Complex<T, J> ICatExtension It's the class that contains ICat interface's extension method. This class must be public and static. Also it shouldn't be a geneic class Tom Tom class is only inherit from Object. Not any member inside itself. TomFromBaseClass TomFromBaseClass inherits from @ Interfaces IAnimal This is basic interface of all animal. ICat Cat's interface Delegates FakeDelegate<T> Fake delegate MRefDelegate<K, T, L> Generic delegate with many constrains. MRefNormalDelegate Delegate in the namespace"
+    "keywords": "Namespace CatLibrary Namespaces CatLibrary.Core Classes CatException<T> Cat<T, K> Here's main class of this Demo. You can see mostly type of article within this class and you for more detail, please see the remarks. this class is a template class. It has two Generic parameter. they are: T and K. The extension method of this class can refer to ICatExtension class Complex<T, J> ICatExtension It's the class that contains ICat interface's extension method. This class must be public and static. Also it shouldn't be a geneic class Tom Tom class is only inherit from Object. Not any member inside itself. TomFromBaseClass TomFromBaseClass inherits from @ Interfaces IAnimal This is basic interface of all animal. ICat Cat's interface Delegates FakeDelegate<T> Fake delegate MRefDelegate<K, T, L> Generic delegate with many constrains. MRefNormalDelegate Delegate in the namespace"
   },
   "api/CatLibrary.IAnimal.html": {
     "href": "api/CatLibrary.IAnimal.html",

diff --git a/...x.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.html.verified.png b/...x.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.html.verified.png
diff --git a/....Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.html.verified.png b/....Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.html.verified.png
diff --git a/...fx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.html.verified.png b/...fx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.html.verified.png
diff --git a/...fx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.html.verified.png b/...fx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.html.verified.png
diff --git a/...docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html b/...docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html
@@ -521,7 +521,7 @@ <h1 id="CatLibrary" data-uid="CatLibrary" class="text-break">Namespace Cat<wbr>L
   <div class="markdown level0 conceptual"></div>
   <div class="markdown level0 remarks"></div>
 
-    <h3 id="namespaces"><a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#namespaces" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h3>
+    <h3 id="namespaces">Namespaces<a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#namespaces" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h3>
     <dl class="jumplist">
       <dt><a class="xref" href="CatLibrary.Core.html">Cat<wbr>Library.<wbr>Core</a></dt>
       <dd></dd>
@@ -601,7 +601,7 @@ <h3 id="delegates">Delegates<a class="anchorjs-link " aria-label="Anchor" data-a
       <div class="affix">
         <nav id="affix">
       <h5 class="border-bottom">In this article</h5>
-      <ul><li><a class="link-secondary" href="#namespaces"></a></li><li><a class="link-secondary" href="#classes">Classes</a></li><li><a class="link-secondary" href="#interfaces">Interfaces</a></li><li><a class="link-secondary" href="#delegates">Delegates</a></li></ul></nav>
+      <ul><li><a class="link-secondary" href="#namespaces">Namespaces</a></li><li><a class="link-secondary" href="#classes">Classes</a></li><li><a class="link-secondary" href="#interfaces">Interfaces</a></li><li><a class="link-secondary" href="#delegates">Delegates</a></li></ul></nav>
       </div>
     </main>
 

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html
@@ -521,7 +521,7 @@ <h1 id="CatLibrary" data-uid="CatLibrary" class="text-break">Namespace Cat<wbr>L
   <div class="markdown level0 conceptual"></div>
   <div class="markdown level0 remarks"></div>
 
-    <h3 id="namespaces"><a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#namespaces" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h3>
+    <h3 id="namespaces">Namespaces<a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#namespaces" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h3>
     <dl class="jumplist">
       <dt><a class="xref" href="CatLibrary.Core.html">Cat<wbr>Library.<wbr>Core</a></dt>
       <dd></dd>
@@ -601,7 +601,7 @@ <h3 id="delegates">Delegates<a class="anchorjs-link " aria-label="Anchor" data-a
       <div class="affix">
         <nav id="affix">
       <h5 class="border-bottom">In this article</h5>
-      <ul><li><a class="link-secondary" href="#namespaces"></a></li><li><a class="link-secondary" href="#classes">Classes</a></li><li><a class="link-secondary" href="#interfaces">Interfaces</a></li><li><a class="link-secondary" href="#delegates">Delegates</a></li></ul></nav>
+      <ul><li><a class="link-secondary" href="#namespaces">Namespaces</a></li><li><a class="link-secondary" href="#classes">Classes</a></li><li><a class="link-secondary" href="#interfaces">Interfaces</a></li><li><a class="link-secondary" href="#delegates">Delegates</a></li></ul></nav>
       </div>
     </main>