Wiki source code of Home

Version 30.1 by Isaac Mejia on 2025/12/10 17:05

Show last authors
1 {{velocity}}
2 ## ---------------------------------------------
3 ## KB Home (Main.WebHome)
4 ## Discover category landing pages dynamically.
5 ## ---------------------------------------------
6
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())##
23
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
107 {{html clean="false"}}
108 <div class="kb-home">
109
110 <!-- HERO -->
111 <div class="kb-hero">
112 <h1 class="kb-hero-title">Member Solutions Knowledge Base</h1>
113 <p class="kb-hero-subtitle">
114 Guides, walkthroughs, and best practices to help you and your team get the most out of the platform.
115 </p>
116
117 <!-- Hero search wired to custom KB search page -->
118 <div class="kb-hero-search">
119 <form action="$xwiki.getURL('Main.KBSearch', 'view')" method="get">
120 <input
121 type="text"
122 name="text"
123 placeholder="Search for an article (e.g. &quot;family membership&quot;)"
124 aria-label="Search the knowledge base"
125 />
126 <!-- optional: add a button if you want -->
127 <!-- <button type="submit" class="kb-search-button">Search</button> -->
128 </form>
129 </div>
130 </div>
131
132 <!-- CATEGORY GRID -->
133 <div class="kb-section">
134 <h2 class="kb-section-title">Browse by category</h2>
135
136 <div class="kb-category-grid">
137 #foreach ($cat in $kbCategories)
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"))
143
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>
164 #end
165 </div>
166 </div>
167
168 </div>
169 {{/html}}
170 {{/velocity}}
171
172 {{include reference="KBSupportCTA.WebHome"/}}