Skip to Content

Changes for page Home

Last modified by Isaac Mejia on 2025/12/15 18:27
From version 7.1
edited by Isaac Mejia
on 2025/12/05 16:27
Change comment: There is no comment for this version
To version 20.1
edited by Isaac Mejia
on 2025/12/05 17:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,16 +1,111 @@
1 1  {{velocity}}
2 +## ---------------------------------------------
2 2  ## KB Home (Main.WebHome)
4 +## Discover category landing pages dynamically.
5 +## ---------------------------------------------
3 3  
4 -## Optionally, you can centralize your category list here.
5 -## Each entry: [ "Label", "SpaceName", "Short description" ]
6 -#set ($kbCategories = [
7 - ["Member Management", "Member Management", "How to manage members, families, and profiles."],
8 - ["Configuration", "Configuration", "Set up locations, billing, and core system settings."],
9 - ["Billing & Payments", "Billing", "Invoices, collections, and payment processing."],
10 - ["Reporting & Analytics", "Reporting", "Understand your numbers and performance."],
11 - ["Integrations", "Integrations", "Connect eFit with other tools in your stack."]
12 -])
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
12 +#set ($xwql =
13 + "select doc.fullName, doc.title, doc.name " +
14 + "from XWikiDocument doc " +
15 + "where doc.space = 'Main' " +
16 + "and doc.name <> 'WebHome' " +
17 + "and doc.name not like 'KB%' " +
18 + "and doc.hidden <> true " +
19 + "order by lower(doc.title)"
20 +)
21 +#set ($query = $services.query.xwql($xwql))
22 +#set ($rows = $query.execute())
13 13  
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 +})
34 +
35 +## 3) Optional hand-authored descriptions for known categories
36 +#set ($kbCategoryDescriptions = {
37 + "Member Management": "How to manage members, families, and profiles.",
38 + "Configuration": "Set up locations, billing, and core system settings.",
39 + "Billing & Payments": "Invoices, collections, and payment processing.",
40 + "Payment Management": "Articles and guides for Payment Management.",
41 + "Reporting & Analytics": "Understand your numbers and performance.",
42 + "Notifications": "Articles and guides for Notifications.",
43 + "Integrations": "Connect Member Solutions with other tools in your stack."
44 +})
45 +
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 + #set ($resultList = $countQuery.execute())
83 + #if ($resultList && $resultList.size() > 0)
84 + #set ($articleCount = $resultList.get(0))
85 + #end
86 +
87 + ## Icon, with a sensible default
88 + #set ($icon = $kbCategoryIcons.get($label))
89 + #if ("$!icon" == "")
90 + #set ($icon = "📘")
91 + #end
92 +
93 + ## Build clean URL: /bin/view/Main/<PageName> (no trailing slash)
94 + #set ($encoded = $escapetool.url($pageName))
95 + #set ($cleanUrl = "/bin/view/Main/$encoded")
96 +
97 + ## Push into our categories array as a small map
98 + #set ($entry = {
99 + "label": $label,
100 + "pageName": $pageName,
101 + "desc": $desc,
102 + "icon": $icon,
103 + "url": $cleanUrl,
104 + "count": $articleCount
105 + })
106 + #set ($discard = $kbCategories.add($entry))
107 +#end
108 +
14 14  {{html clean="false"}}
15 15  <div class="kb-home">
16 16  
... ... @@ -21,7 +21,7 @@
21 21   Guides, walkthroughs, and best practices to help you and your team get the most out of the platform.
22 22   </p>
23 23  
24 - <!-- Simple search box that posts to XWiki search -->
119 + <!-- Enhanced search box (still uses XWiki search under the hood) -->
25 25   <div class="kb-hero-search">
26 26   <form action="$xwiki.getURL('Main.WebHome', 'view')" method="get">
27 27   <input
... ... @@ -28,6 +28,7 @@
28 28   type="text"
29 29   name="text"
30 30   placeholder="Search for an article (e.g. &quot;family membership&quot;)"
126 + aria-label="Search the knowledge base"
31 31   />
32 32   </form>
33 33   </div>
... ... @@ -39,44 +39,41 @@
39 39  
40 40   <div class="kb-category-grid">
41 41   #foreach ($cat in $kbCategories)
42 - #set ($label = $cat.get(0))
43 - #set ($spaceName = $cat.get(1))
44 - #set ($desc = $cat.get(2))
138 + #set ($label = $cat.get("label"))
139 + #set ($desc = $cat.get("desc"))
140 + #set ($icon = $cat.get("icon"))
141 + #set ($url = $cat.get("url"))
142 + #set ($count = $cat.get("count"))
45 45  
46 - ## Category page lives at Main.<Label>.WebHome (same pattern as our uploader)
47 - #set ($label = $cat.get(0))
48 -#set ($spaceName = $cat.get(1))
49 -#set ($desc = $cat.get(2))
50 -
51 -#set ($encoded = $escapetool.url($spaceName))
52 -#set ($cleanUrl = "/bin/view/Main/$encoded")
53 -
54 -<a class="kb-card" href="$cleanUrl">
55 - <div>
56 - <div class="kb-card-title">$escapetool.xml($label)</div>
57 - <div class="kb-card-body">
58 - $escapetool.xml($desc)
59 - </div>
60 - </div>
61 - <div class="kb-card-meta">Category</div>
62 -</a>
144 + <a class="kb-card" href="$url">
145 + <div>
146 + <div class="kb-card-title">
147 + <span class="kb-card-icon">$icon</span>
148 + $escapetool.xml($label)
149 + </div>
150 + <div class="kb-card-body">
151 + $escapetool.xml($desc)
152 + </div>
153 + </div>
154 + <div class="kb-card-meta">
155 + #if ($count == 1)
156 + 1 article
157 + #elseif ($count > 1)
158 + $count articles
159 + #else
160 + Category
161 + #end
162 + </div>
163 + </a>
63 63   #end
64 64   </div>
65 65   </div>
66 66  
67 - <!-- BOTTOM CTA -->
68 - <div class="kb-cta">
69 - <div class="kb-cta-content">
70 - <h2>Still need help?</h2>
71 - <p>
72 - If you can’t find what you’re looking for, our support team is happy to help.
73 - </p>
74 - </div>
75 - <a href="mailto:support@membersolutions.com" class="kb-cta-button">
76 - Contact Support
77 - </a>
78 - </div>
79 -
80 80  </div>
81 81  {{/html}}
170 +
82 82  {{/velocity}}
172 +
173 +
174 +## Bottom CTA (support panel)
175 +{{include reference="KBSupportCTA.WebHome"/}}