Skip to Content

Changes for page Home

Last modified by Isaac Mejia on 2025/12/15 18:27
From version 6.1
edited by Isaac Mejia
on 2025/12/05 16:22
Change comment: There is no comment for this version
To version 29.1
edited by Isaac Mejia
on 2025/12/09 16:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,16 +1,109 @@
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 + ## Description (custom if defined, otherwise auto)
62 + #set ($desc = $kbCategoryDescriptions.get($label))##
63 + #if ("$!desc" == "")##
64 + #set ($desc = "Articles and guides for $label.")##
65 + #end##
66 +
67 + ## Article space: Main.<PageName with spaces replaced by underscores>
68 + #set ($articleSpace = "Main." + $pageName.replace(" ", "_"))##
69 +
70 + ## Count non-hidden, non-WebHome pages in that article space
71 + #set ($articleCount = 0)##
72 + #set ($countXwql =
73 + "select count(doc.fullName) " +
74 + "from XWikiDocument doc " +
75 + "where doc.space = :space " +
76 + "and doc.name <> 'WebHome' " +
77 + "and doc.hidden <> true"
78 + )##
79 + #set ($countQuery = $services.query.xwql($countXwql).bindValue("space", $articleSpace))##
80 + #set ($resultList = $countQuery.execute())##
81 + #if ($resultList && $resultList.size() > 0)##
82 + #set ($articleCount = $resultList.get(0))##
83 + #end##
84 +
85 + ## Icon, with a sensible default
86 + #set ($icon = $kbCategoryIcons.get($label))##
87 + #if ("$!icon" == "")##
88 + #set ($icon = "📘")##
89 + #end##
90 +
91 + ## Build clean URL: /bin/view/Main/<PageName> (no trailing slash)
92 + #set ($encoded = $escapetool.url($pageName))##
93 + #set ($cleanUrl = "/bin/view/Main/$encoded")##
94 +
95 + ## Push into our categories array as a small map
96 + #set ($entry = {
97 + "label": $label,
98 + "pageName": $pageName,
99 + "desc": $desc,
100 + "icon": $icon,
101 + "url": $cleanUrl,
102 + "count": $articleCount
103 + })##
104 + #set ($discard = $kbCategories.add($entry))##
105 +#end##
106 +
14 14  {{html clean="false"}}
15 15  <div class="kb-home">
16 16  
... ... @@ -21,16 +21,18 @@
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 -->
25 - <div class="kb-hero-search">
26 - <form action="$xwiki.getURL('Main.WebHome', 'view')" method="get">
27 - <input
28 - type="text"
29 - name="text"
30 - placeholder="Search for an article (e.g. &quot;family membership&quot;)"
31 - />
32 - </form>
33 - </div>
117 + <!-- Enhanced search box (still uses XWiki search under the hood) -->
118 +<div class="kb-hero-search">
119 + <form action="$xwiki.getURL('Main.WebSearch', 'view')" method="get">
120 + ## XWiki will use ?text=... as the search query
121 + <input
122 + type="text"
123 + name="text"
124 + placeholder="Search for an article (e.g. &quot;family membership&quot;)"
125 + aria-label="Search the knowledge base"
126 + />
127 + </form>
128 +</div>
34 34   </div>
35 35  
36 36   <!-- CATEGORY GRID -->
... ... @@ -39,24 +39,30 @@
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))
137 + #set ($label = $cat.get("label"))
138 + #set ($desc = $cat.get("desc"))
139 + #set ($icon = $cat.get("icon"))
140 + #set ($url = $cat.get("url"))
141 + #set ($count = $cat.get("count"))
45 45  
46 - ## Category page lives at Main.<Label>.WebHome (same pattern as our uploader)
47 - #set ($docRef = "Main.${spaceName}.WebHome")
48 - #set ($docObj = $xwiki.getDocument($docRef))
49 - #set ($url = $docObj.getURL('view'))
50 -
51 51   <a class="kb-card" href="$url">
52 52   <div>
53 - <div class="kb-card-title">$escapetool.xml($label)</div>
145 + <div class="kb-card-title">
146 + <span class="kb-card-icon">$icon</span>
147 + $escapetool.xml($label)
148 + </div>
54 54   <div class="kb-card-body">
55 55   $escapetool.xml($desc)
56 56   </div>
57 57   </div>
58 58   <div class="kb-card-meta">
59 - Category
154 + #if ($count == 1)
155 + 1 article
156 + #elseif ($count > 1)
157 + $count articles
158 + #else
159 + Category
160 + #end
60 60   </div>
61 61   </a>
62 62   #end
... ... @@ -63,19 +63,8 @@
63 63   </div>
64 64   </div>
65 65  
66 - <!-- BOTTOM CTA -->
67 - <div class="kb-cta">
68 - <div class="kb-cta-content">
69 - <h2>Still need help?</h2>
70 - <p>
71 - If you can’t find what you’re looking for, our support team is happy to help.
72 - </p>
73 - </div>
74 - <a href="mailto:support@membersolutions.com" class="kb-cta-button">
75 - Contact Support
76 - </a>
77 - </div>
78 -
79 79  </div>
80 80  {{/html}}
81 81  {{/velocity}}
170 +
171 +{{include reference="KBSupportCTA.WebHome"/}}