Merge pull request #81 from feelpp/79-allow-arbitrary-nesting-of-modules

filter based on catalog parent-id and tags #79
feelpp · Sep 23, 2024 · d86119c · d86119c
2 parents 5dbdaea + 05d5f65
commit d86119c
Show file tree

Hide file tree

Showing 17 changed files with 131 additions and 5 deletions.
diff --git a/docs/modules/ROOT/images/A-1.png b/docs/modules/ROOT/images/A-1.png
diff --git a/docs/modules/ROOT/images/A-2.png b/docs/modules/ROOT/images/A-2.png
diff --git a/docs/modules/ROOT/images/A.png b/docs/modules/ROOT/images/A.png
diff --git a/docs/modules/ROOT/images/B.png b/docs/modules/ROOT/images/B.png
diff --git a/docs/modules/ROOT/images/C.png b/docs/modules/ROOT/images/C.png
diff --git a/docs/modules/ROOT/images/grid.png b/docs/modules/ROOT/images/grid.png
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -5,4 +5,4 @@
 ** xref:copy-to-clipboard.adoc[]
 //** xref:plotly.adoc[]
 ** xref:pseudocode.adoc[]
-
+* xref:page-layouts.adoc[]
diff --git a/docs/modules/ROOT/pages/catalogExample/catalog.adoc b/docs/modules/ROOT/pages/catalogExample/catalog.adoc
@@ -0,0 +1,7 @@
+:page-layout: toolboxes
+:page-tags: toolbox, catalog, catalog-base
+:parent-catalogs: page-layouts
+:description: Example of the catalog page layout.
+:page-illustration: ROOT:grid.png
+
+= Catalog
diff --git a/docs/modules/ROOT/pages/catalogExample/itemA.adoc b/docs/modules/ROOT/pages/catalogExample/itemA.adoc
@@ -0,0 +1,6 @@
+= Item A
+:page-layout: toolboxes
+:page-tags: toolbox, catalog, itemA
+:parent-catalogs: catalog-base
+:description: Item containing 2 subitems.
+:page-illustration: ROOT:A.png
diff --git a/docs/modules/ROOT/pages/catalogExample/itemB.adoc b/docs/modules/ROOT/pages/catalogExample/itemB.adoc
@@ -0,0 +1,6 @@
+= Item B
+:page-layout: toolboxes
+:page-tags: toolbox, catalog, itemB
+:parent-catalogs: catalog-base
+:description: Item containing 1 shared subitem.
+:page-illustration: ROOT:B.png
diff --git a/docs/modules/ROOT/pages/catalogExample/itemC.adoc b/docs/modules/ROOT/pages/catalogExample/itemC.adoc
@@ -0,0 +1,33 @@
+= Item C
+:page-tags: toolbox, catalog, itemC
+:parent-catalogs: catalog-base, itemB
+:description: Leaf item.
+:page-illustration: ROOT:C.png
+
+This is a leaf item, shared between the Item B and the catalog base.
+
+Note that this page appears twice, without duplicating the content.
+
+To replicate this page structure:
+
+- Base page
+[asciidoc]
+----
+:page-layout: toolboxes
+:page-tags: catalog, catalog-base
+----
+
+- Item B
+[asciidoc]
+----
+:page-layout: toolboxes
+:page-tags: catalog, itemB
+:parent-catalogs: catalog-base
+----
+
+- Item C
+[asciidoc]
+----
+:page-tags: catalog, itemC
+:parent-catalogs: catalog-base, itemB
+----
diff --git a/docs/modules/ROOT/pages/catalogExample/subitemA1.adoc b/docs/modules/ROOT/pages/catalogExample/subitemA1.adoc
@@ -0,0 +1,32 @@
+= Subitem A-1
+:page-tags: toolbox, catalog, subitemA-1
+:parent-catalogs: itemA
+:page-illustration: ROOT:A-1.png
+
+== Leaf Item
+This is a leaf item of the catalog.
+It is a children from Item A, which is a children from the catalog base.
+
+To replicate this page structure:
+
+- Base page
+[asciidoc]
+----
+:page-layout: toolboxes
+:page-tags: catalog, catalog-base
+----
+
+- Item A
+[asciidoc]
+----
+:page-layout: toolboxes
+:page-tags: catalog, itemA
+:parent-catalogs: catalog-base
+----
+
+- Subitem A-1
+[asciidoc]
+----
+:page-tags: catalog, subitemA-1
+:parent-catalogs: itemA
+----
diff --git a/docs/modules/ROOT/pages/catalogExample/subitemA2.adoc b/docs/modules/ROOT/pages/catalogExample/subitemA2.adoc
@@ -0,0 +1,32 @@
+= Subitem A-2
+:page-tags: toolbox, catalog, subitemA-2
+:parent-catalogs: itemA
+:page-illustration: ROOT:A-2.png
+
+== Leaf Item
+This is a leaf item of the catalog.
+It is a children from Item A, which is a children from the catalog base.
+
+To replicate this page structure:
+
+- Base page
+[asciidoc]
+----
+:page-layout: toolboxes
+:page-tags: catalog, catalog-base
+----
+
+- Item A
+[asciidoc]
+----
+:page-layout: toolboxes
+:page-tags: catalog, itemA
+:parent-catalogs: catalog-base
+----
+
+- Subitem A-2
+[asciidoc]
+----
+:page-tags: catalog, subitemA-2
+:parent-catalogs: itemA
+----
diff --git a/docs/modules/ROOT/pages/page-layouts.adoc b/docs/modules/ROOT/pages/page-layouts.adoc
@@ -0,0 +1,4 @@
+= Page Layouts
+:navtitle: Page Layouts
+:page-layout: toolboxes
+:page-tags: catalog, page-layouts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -82,9 +82,9 @@
     "generate-fontawesome-icon-defs": "node tasks/generate-fontawesome-icon-defs.js"
   },
   "dependencies": {
-    "@antora/cli": "^3.1.9",
+    "@antora/cli": "^3.1",
     "@antora/collector-extension": "^1.0.0-beta.2",
-    "@antora/site-generator": "^3.1.9",
+    "@antora/site-generator": "^3.1",
     "@asciidoctor/core": "~2.2.8",
     "asciidoctor": "~2.2.8",
     "asciidoctor-jupyter": "^0.7.0",

diff --git a/src/helpers/get-page-cards.js b/src/helpers/get-page-cards.js
@@ -8,6 +8,12 @@ module.exports = (parentPage, tag, withinParentModule = true, { data: { root } }
       (withinParentModule && src.module !== parentPage.module) ||
       src.version !== parentPage.componentVersion.version) return
     const pageTags = asciidoc.attributes['page-tags']
+    if (pageTags && pageTags.split(',').map((tag) => tag.trim()).includes('catalog') &&
+      parentPage.attributes.tags && asciidoc.attributes['parent-catalogs'] &&
+      asciidoc.attributes['parent-catalogs'].split(',').map((parentCat) => parentCat.trim()).every((parentCat) =>
+        !parentPage.attributes.tags.split(',').map((parentTag) => parentTag.trim()).includes(parentCat)
+      )
+    ) return
     return pageTags && pageTags.split(',').map((v) => v.trim()).includes(tag)
   }).sort((a, b) => (a.title || '').localeCompare((b.title || '')))
   if (pages && pages.length > 0) {