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 27.1
edited by Isaac Mejia
on 2025/12/09 15:57
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,74 +1,170 @@
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 + ## 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##
50 50  
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 + <!-- Enhanced search box (still uses XWiki search under the hood) -->
118 + <div class="kb-hero-search">
119 + <form action="$xwiki.getURL('Main.WebHome', 'view', 'xpage=search')" 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 +</form>
127 + </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>
130 + <!-- CATEGORY GRID -->
131 + <div class="kb-section">
132 + <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>
134 + <div class="kb-category-grid">
135 + #foreach ($cat in $kbCategories)
136 + #set ($label = $cat.get("label"))
137 + #set ($desc = $cat.get("desc"))
138 + #set ($icon = $cat.get("icon"))
139 + #set ($url = $cat.get("url"))
140 + #set ($count = $cat.get("count"))
141 +
142 + <a class="kb-card" href="$url">
143 + <div>
144 + <div class="kb-card-title">
145 + <span class="kb-card-icon">$icon</span>
146 + $escapetool.xml($label)
147 + </div>
148 + <div class="kb-card-body">
149 + $escapetool.xml($desc)
150 + </div>
151 + </div>
152 + <div class="kb-card-meta">
153 + #if ($count == 1)
154 + 1 article
155 + #elseif ($count > 1)
156 + $count articles
157 + #else
158 + Category
159 + #end
160 + </div>
161 + </a>
162 + #end
163 + </div>
71 71   </div>
72 -</div>
73 73  
166 +</div>
74 74  {{/html}}
168 +{{/velocity}}
169 +
170 +{{include reference="KBSupportCTA.WebHome"/}}