Changes for page Home
Last modified by Isaac Mejia on 2025/12/15 18:27
From version 9.1
edited by Isaac Mejia
on 2025/12/05 16:52
on 2025/12/05 16:52
Change comment:
There is no comment for this version
To version 12.1
edited by Isaac Mejia
on 2025/12/05 17:05
on 2025/12/05 17:05
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,44 +1,115 @@ 1 1 {{velocity}} 2 +## --------------------------------------------- 2 2 ## KB Home (Main.WebHome) 4 +## Discover category landing pages dynamically. 5 +## --------------------------------------------- 3 3 4 -## - -----------------------------------------------------------5 -## 1)Discovercategorypagesautomatically6 -## -Categorypageslive at: Main.<CategoryLabel>.WebHome7 -## -Wequeryalldocs inspace=MainexceptWebHome+KB-Categories8 -## - -----------------------------------------------------------7 +## 1) Find all top-level category pages under "Main" 8 +## We exclude: 9 +## - WebHome itself 10 +## - any technical KB* pages (KBStyles, KBArticleHeader, etc.) 11 +## - hidden docs 9 9 #set ($xwql = 10 - "select doc.fullName, doc.title " + 13 + "select doc.fullName, doc.title, doc.name " + 11 11 "from XWikiDocument doc " + 12 - "where doc.space = :space" +15 + "where doc.space = 'Main' " + 13 13 "and doc.name <> 'WebHome' " + 14 - "and doc.name <>'KB-Categories' " +17 + "and doc.name not like 'KB%' " + 15 15 "and doc.hidden <> true " + 16 16 "order by lower(doc.title)" 17 17 ) 18 - 19 -#set ($query = $services.query.xwql($xwql).bindValue("space", "Main")) 21 +#set ($query = $services.query.xwql($xwql)) 20 20 #set ($rows = $query.execute()) 21 21 22 -## Build a list of document objects for convenience 23 -#set ($categories = []) 24 -#foreach ($row in $rows) 25 - #set ($fullName = $row[0]) ## e.g. "Main.Member Management" 26 - #set ($catDoc = $xwiki.getDocument($fullName)) 27 - #set ($discard = $categories.add($catDoc)) 28 -#end 24 +## 2) Icon map (optional overrides) 25 +#set ($kbCategoryIcons = { 26 + "Member Management": "π₯", 27 + "Configuration": "βοΈ", 28 + "Billing & Payments": "π³", 29 + "Payment Management": "π³", 30 + "Reporting & Analytics": "π", 31 + "Notifications": "π", 32 + "Integrations": "π" 33 +}) 29 29 30 -## ------------------------------------------------------------ 31 -## 2) Optional: description overrides by category label 32 -## Keys must match the *display title* (e.g. "Member Management") 33 -## ------------------------------------------------------------ 34 -#set ($categoryDescriptions = { 35 +## 3) Optional hand-authored descriptions for known categories 36 +#set ($kbCategoryDescriptions = { 35 35 "Member Management": "How to manage members, families, and profiles.", 36 36 "Configuration": "Set up locations, billing, and core system settings.", 37 37 "Billing & Payments": "Invoices, collections, and payment processing.", 40 + "Payment Management": "Articles and guides for Payment Management.", 38 38 "Reporting & Analytics": "Understand your numbers and performance.", 39 - "Integrations": "Connect eFit with other tools in your stack." 42 + "Notifications": "Articles and guides for Notifications.", 43 + "Integrations": "Connect Member Solutions with other tools in your stack." 40 40 }) 41 41 46 +## 4) Build a normalized list of category objects 47 +#set ($kbCategories = []) 48 + 49 +#foreach ($row in $rows) 50 + #set ($fullName = $row.get(0)) ## e.g. "Main.Member Management" 51 + #set ($title = $row.get(1)) ## display title 52 + #set ($pageName = $row.get(2)) ## page name, used in URL & article space 53 + #set ($catDoc = $xwiki.getDocument($fullName)) 54 + 55 + ## Label shown on the card 56 + #set ($label = $catDoc.displayTitle) 57 + #if ("$!label" == "") 58 + #set ($label = $pageName) 59 + #end 60 + 61 + ## Default description (auto-generated if we don't have a custom one) 62 + #set ($desc = $kbCategoryDescriptions.get($label)) 63 + #if ("$!desc" == "") 64 + #set ($desc = "Articles and guides for $label.") 65 + #end 66 + 67 + ## Article space follows the convention: 68 + ## Main.<PageName with spaces replaced by underscores> 69 + ## e.g. Member Management -> space "Main.Member_Management" 70 + #set ($articleSpace = "Main." + $pageName.replace(" ", "_")) 71 + 72 + ## Count non-hidden, non-WebHome pages in that article space 73 + #set ($articleCount = 0) 74 + #set ($countXwql = 75 + "select count(doc.fullName) " + 76 + "from XWikiDocument doc " + 77 + "where doc.space = :space " + 78 + "and doc.name <> 'WebHome' " + 79 + "and doc.hidden <> true" 80 + ) 81 + #set ($countQuery = $services.query.xwql($countXwql).bindValue("space", $articleSpace)) 82 + #try 83 + #set ($resultList = $countQuery.execute()) 84 + #if ($resultList && $resultList.size() > 0) 85 + #set ($articleCount = $resultList.get(0)) 86 + #end 87 + #catch 88 + ## Swallow query errors so we don't break the homepage 89 + #end 90 + 91 + ## Icon, with a sensible default 92 + #set ($icon = $kbCategoryIcons.get($label)) 93 + #if ("$!icon" == "") 94 + #set ($icon = "π") 95 + #end 96 + 97 + ## Build clean URL: /bin/view/Main/<PageName> (no trailing slash) 98 + #set ($encoded = $escapetool.url($pageName)) 99 + #set ($cleanUrl = "/bin/view/Main/$encoded") 100 + 101 + ## Push into our categories array as a small map 102 + #set ($entry = { 103 + "label": $label, 104 + "pageName": $pageName, 105 + "desc": $desc, 106 + "icon": $icon, 107 + "url": $cleanUrl, 108 + "count": $articleCount 109 + }) 110 + #set ($discard = $kbCategories.add($entry)) 111 +#end 112 + 42 42 {{html clean="false"}} 43 43 <div class="kb-home"> 44 44 ... ... @@ -49,7 +49,7 @@ 49 49 Guides, walkthroughs, and best practices to help you and your team get the most out of the platform. 50 50 </p> 51 51 52 - <!-- Simple search box thatpoststoXWiki search -->123 + <!-- Enhanced search box (still uses XWiki search under the hood) --> 53 53 <div class="kb-hero-search"> 54 54 <form action="$xwiki.getURL('Main.WebHome', 'view')" method="get"> 55 55 <input ... ... @@ -56,6 +56,7 @@ 56 56 type="text" 57 57 name="text" 58 58 placeholder="Search for an article (e.g. "family membership")" 130 + aria-label="Search the knowledge base" 59 59 /> 60 60 </form> 61 61 </div> ... ... @@ -66,51 +66,40 @@ 66 66 <h2 class="kb-section-title">Browse by category</h2> 67 67 68 68 <div class="kb-category-grid"> 69 - #foreach ($catDoc in $categories) 70 - ## Label shown on the card 71 - #set ($label = $catDoc.displayTitle) ## e.g. "Member Management" 141 + #foreach ($cat in $kbCategories) 142 + #set ($label = $cat.get("label")) 143 + #set ($desc = $cat.get("desc")) 144 + #set ($icon = $cat.get("icon")) 145 + #set ($url = $cat.get("url")) 146 + #set ($count = $cat.get("count")) 72 72 73 - ## Space/page name used in the URL path: 74 - ## uploader created category pages as Main.<Label>.WebHome, 75 - ## so doc.name is the space segment we need (with spaces). 76 - #set ($spaceName = $catDoc.name) ## e.g. "Member Management" 77 - 78 - ## Description: use override map if present, else generic 79 - #set ($desc = $categoryDescriptions.get($label)) 80 - #if (!$desc) 81 - #set ($desc = "Articles and guides for " + $label) 82 - #end 83 - 84 - ## Build clean URL: /bin/view/Main/<SpaceName> (no trailing slash) 85 - #set ($encoded = $escapetool.url($spaceName)) 86 - #set ($cleanUrl = "/bin/view/Main/$encoded") 87 - 88 - <a class="kb-card" href="$cleanUrl"> 148 + <a class="kb-card" href="$url"> 89 89 <div> 90 - <div class="kb-card-title">$escapetool.xml($label)</div> 150 + <div class="kb-card-title"> 151 + <span class="kb-card-icon">$icon</span> 152 + $escapetool.xml($label) 153 + </div> 91 91 <div class="kb-card-body"> 92 92 $escapetool.xml($desc) 93 93 </div> 94 94 </div> 95 - <div class="kb-card-meta">Category</div> 158 + <div class="kb-card-meta"> 159 + #if ($count == 1) 160 + 1 article 161 + #elseif ($count > 1) 162 + $count articles 163 + #else 164 + Category 165 + #end 166 + </div> 96 96 </a> 97 97 #end 98 98 </div> 99 99 </div> 100 100 101 - <!-- BOTTOM CTA --> 102 - <div class="kb-cta"> 103 - <div class="kb-cta-content"> 104 - <h2>Still need help?</h2> 105 - <p> 106 - If you canβt find what youβre looking for, our support team is happy to help. 107 - </p> 108 - </div> 109 - <a href="mailto:support@membersolutions.com" class="kb-cta-button"> 110 - Contact Support 111 - </a> 112 - </div> 113 - 114 114 </div> 115 115 {{/html}} 174 + 175 +## Reusable bottom CTA (support panel) 176 +{{include reference="KBSupportCTA.WebHome"/}} 116 116 {{/velocity}}