Skip to Content

Changes for page Home

Last modified by Isaac Mejia on 2025/12/15 18:27
From version 5.1
edited by Isaac Mejia
on 2025/11/21 16:35
Change comment: There is no comment for this version
To version 15.1
edited by Isaac Mejia
on 2025/12/05 17:08
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,74 +1,177 @@
1 -{{html clean="false"}}
1 +{{velocity}}
2 +## ---------------------------------------------
3 +## KB Home (Main.WebHome)
4 +## Discover category landing pages dynamically.
5 +## ---------------------------------------------
2 2  
3 -<div class="kb-hero">
4 - <h1 class="kb-hero-title">Welcome to the Member Solutions Knowledge Base</h1>
5 - <p class="kb-hero-subtitle">
6 - Guides, troubleshooting, and best practices to help you run a better business.
7 - </p>
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())
8 8  
9 - <!-- Simple search form that goes to the WebSearch page -->
10 - <form class="kb-hero-search" method="get" action="/bin/view/Main/WebSearch">
11 - <input type="text" name="text" placeholder="Search for articles..." />
12 - </form>
13 -</div>
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 +})
14 14  
15 -<div class="kb-section">
16 - <h2 class="kb-section-title">Browse by category</h2>
17 - <div class="kb-category-grid">
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 +})
18 18  
19 - <a class="kb-card" href="/bin/view/Main/GettingStarted">
20 - <h3 class="kb-card-title">Getting Started</h3>
21 - <p class="kb-card-body">
22 - Start here to set up your account and learn the basics.
23 - </p>
24 - <span class="kb-card-meta">Setup • Onboarding</span>
25 - </a>
46 +## 4) Build a normalized list of category objects
47 +#set ($kbCategories = [])
26 26  
27 - <a class="kb-card" href="/bin/view/Main/BillingPayments">
28 - <h3 class="kb-card-title">Billing &amp; Payments</h3>
29 - <p class="kb-card-body">
30 - Invoices, payments, autopay, collections, and more.
31 - </p>
32 - <span class="kb-card-meta">Finance</span>
33 - </a>
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))
34 34  
35 - <a class="kb-card" href="/bin/view/Main/MemberManagement">
36 - <h3 class="kb-card-title">Member Management</h3>
37 - <p class="kb-card-body">
38 - Day-to-day operations for memberships and classes.
39 - </p>
40 - <span class="kb-card-meta">Members • Attendance</span>
41 - </a>
55 + ## Label shown on the card
56 + #set ($label = $catDoc.displayTitle)
57 + #if ("$!label" == "")
58 + #set ($label = $pageName)
59 + #end
42 42  
43 - <a class="kb-card" href="/bin/view/Main/Integrations">
44 - <h3 class="kb-card-title">Integrations</h3>
45 - <p class="kb-card-body">
46 - Automations, data sync, APIs, and external tools.
47 - </p>
48 - <span class="kb-card-meta">Automations</span>
49 - </a>
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
50 50  
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 +
113 +{{html clean="false"}}
114 +<div class="kb-home">
115 +
116 + <!-- HERO -->
117 + <div class="kb-hero">
118 + <h1 class="kb-hero-title">Member Solutions Knowledge Base</h1>
119 + <p class="kb-hero-subtitle">
120 + Guides, walkthroughs, and best practices to help you and your team get the most out of the platform.
121 + </p>
122 +
123 + <!-- Enhanced search box (still uses XWiki search under the hood) -->
124 + <div class="kb-hero-search">
125 + <form action="$xwiki.getURL('Main.WebHome', 'view')" method="get">
126 + <input
127 + type="text"
128 + name="text"
129 + placeholder="Search for an article (e.g. &quot;family membership&quot;)"
130 + aria-label="Search the knowledge base"
131 + />
132 + </form>
133 + </div>
51 51   </div>
52 -</div>
53 53  
54 -<div class="kb-section">
55 - <h2 class="kb-section-title">Popular articles</h2>
56 - <ul class="kb-popular-list">
57 - <li><a href="/bin/view/Main/ImportingData">How to import member data</a></li>
58 - <li><a href="/bin/view/Main/BillingBasics">Billing basics: everything you need to know</a></li>
59 - <li><a href="/bin/view/Main/DigitalCheckin">Using digital check-in</a></li>
60 - <li><a href="/bin/view/Main/EventSetup">Creating your first event</a></li>
61 - </ul>
62 -</div>
136 + <!-- CATEGORY GRID -->
137 + <div class="kb-section">
138 + <h2 class="kb-section-title">Browse by category</h2>
63 63  
64 -<div class="kb-cta">
65 - <div class="kb-cta-content">
66 - <h2>Need more help?</h2>
67 - <p>Our support team is here for you.</p>
68 - <a class="kb-cta-button" href="/bin/view/Main/ContactSupport">
69 - Contact Support
70 - </a>
140 + <div class="kb-category-grid">
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"))
147 +
148 + <a class="kb-card" href="$url">
149 + <div>
150 + <div class="kb-card-title">
151 + <span class="kb-card-icon">$icon</span>
152 + $escapetool.xml($label)
153 + </div>
154 + <div class="kb-card-body">
155 + $escapetool.xml($desc)
156 + </div>
157 + </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>
167 + </a>
168 + #end
169 + </div>
71 71   </div>
72 -</div>
73 73  
172 +</div>
74 74  {{/html}}
174 +
175 +## Reusable bottom CTA (support panel)
176 +{{include reference="KBSupportCTA.WebHome"/}}
177 +{{/velocity}}