Changes for page Home
Last modified by Isaac Mejia on 2025/12/15 18:27
From version 1.1
edited by Isaac Mejia
on 2025/11/14 19:59
on 2025/11/14 19:59
Change comment:
Install extension [org.xwiki.platform:xwiki-platform-distribution-flavor-common/16.10.14]
To version 35.1
edited by Isaac Mejia
on 2025/12/15 18:27
on 2025/12/15 18:27
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,40 +1,243 @@ 1 -== Welcome to your wiki == 1 +{{velocity}} 2 +## --------------------------------------------- 3 +## KB Home (Main.WebHome) 4 +## Discover category landing pages dynamically. 5 +## (WITH HARD ALLOWLIST) 6 +## --------------------------------------------- 2 2 3 -XWiki is the best tool to organize your knowledge. A //wiki// is organized in a hierarchy of //pages//. You can create multiple wikis, each with its own set of pages. 8 +## 1) Find all top-level category pages under "Main" 9 +## We exclude: 10 +## - WebHome itself 11 +## - any technical KB* pages (KBStyles, KBArticleHeader, etc.) 12 +## - hidden docs 13 +#set ($xwql = 14 + "select doc.fullName, doc.title, doc.name " + 15 + "from XWikiDocument doc " + 16 + "where doc.space = 'Main' " + 17 + "and doc.name <> 'WebHome' " + 18 + "and doc.name not like 'KB%' " + 19 + "and doc.hidden <> true " + 20 + "order by lower(doc.title)" 21 +)## 22 +#set ($query = $services.query.xwql($xwql))## 23 +#set ($rows = $query.execute())## 4 4 5 -XWiki can be used as a knowledge base (support, documentation, sales, etc.), for collaborative workspaces or even as a complete intranet. 25 +## 2) Icon map (optional overrides) 26 +#set ($kbCategoryIcons = { 27 + "Member Management": "👥", 28 + "Configuration": "⚙️", 29 + "Billing & Payments": "💳", 30 + "Payment Management": "💳", 31 + "Reporting & Analytics": "📊", 32 + "Notifications": "🔔", 33 + "Integrations": "🔗" 34 +})## 6 6 7 -== The basics == 36 +## 3) Optional hand-authored descriptions for known categories 37 +#set ($kbCategoryDescriptions = { 38 + "Member Management": "How to manage members, families, and profiles.", 39 + "Configuration": "Set up locations, billing, and core system settings.", 40 + "Billing & Payments": "Invoices, collections, and payment processing.", 41 + "Payment Management": "Articles and guides for Payment Management.", 42 + "Reporting & Analytics": "Understand your numbers and performance.", 43 + "Notifications": "Articles and guides for Notifications.", 44 + "Integrations": "Connect Member Solutions with other tools in your stack." 45 +})## 8 8 9 -To make the most out of your wiki, log-in and: 47 +## --- HARD ALLOWLIST: only show these categories on the homepage --- 48 +## IMPORTANT: These must match the CATEGORY PAGE DISPLAY TITLE / NAME shown on cards. 49 +#set ($allowedCategories = [ 50 + "Check-In", 51 + "Configuration", 52 + "Lead Management", 53 + "Member Management", 54 + "Member Portal", 55 + "Notifications", 56 + "Payment Management", 57 + "Reporting", 58 + "Feature Release Notes" 59 +])## 10 10 11 -Use the {{displayIcon name="pencil"/}} button above to //edit// this page and start customizing your wiki to your needs. 61 +## 4) Build a normalized list of category objects 62 +#set ($kbCategories = [])## 12 12 13 -Use the {{displayIcon name="add"/}} button above to //add// more pages to your wiki and create the //hierarchy// that best organizes your content. 64 +#foreach ($row in $rows)## 65 + #set ($fullName = $row.get(0))## ## e.g. "Main.Member Management" 66 + #set ($title = $row.get(1))## ## display title 67 + #set ($pageName = $row.get(2))## ## page name, used in URL & article space 68 + #set ($catDoc = $xwiki.getDocument($fullName))## 14 14 15 -Use the {{displayIcon name="home"/}} breadcrumbs located above the title to //navigate// inside your pages. It's easy to get lost in a big wiki without them. 70 + ## Label shown on the card 71 + #set ($label = $catDoc.displayTitle)## 72 + #if ("$!label" == "")## 73 + #set ($label = $pageName)## 74 + #end## 16 16 17 -You can also use the [[Sandbox>>Sandbox.WebHome]] for more demo content and generally a place to experiment with your wiki's features. 76 + ## Only include categories we actually want 77 + #if ($allowedCategories.contains($label))## 18 18 19 - {{box}}Learn more on how to use XWiki with the [[Getting Started Guide>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/GettingStarted/WebHome]].{{/box}} 79 + ## Description (custom if defined, otherwise auto) 80 + #set ($desc = $kbCategoryDescriptions.get($label))## 81 + #if ("$!desc" == "")## 82 + #set ($desc = "Articles and guides for $label.")## 83 + #end## 20 20 21 -(% class="row" %) 22 -((( 23 -(% class="col-xs-12 col-sm-6" %) 24 -((( 25 -== Extend your wiki == 85 + ## Article space: Main.<PageName with spaces replaced by underscores> 86 + #set ($articleSpace = "Main." + $pageName.replace(" ", "_"))## 26 26 27 -To extend the power and functionalities of your wiki with the features that //you// need, head over to the [[Extension Manager>>XWiki.XWikiPreferences||queryString="editor=globaladmin§ion=XWiki.Extensions"]] where you can search for and install extensions. 88 + ## Count non-hidden, non-WebHome pages in that article space 89 + #set ($articleCount = 0)## 90 + #set ($countXwql = 91 + "select count(doc.fullName) " + 92 + "from XWikiDocument doc " + 93 + "where doc.space = :space " + 94 + "and doc.name <> 'WebHome' " + 95 + "and doc.hidden <> true" 96 + )## 97 + #set ($countQuery = $services.query.xwql($countXwql).bindValue("space", $articleSpace))## 98 + #set ($resultList = $countQuery.execute())## 99 + #if ($resultList && $resultList.size() > 0)## 100 + #set ($articleCount = $resultList.get(0))## 101 + #end## 28 28 29 -To browse through the 900+ community contributed extensions available for XWiki, head over to the [[Extensions Repository>>https://extensions.xwiki.org]]. 30 -))) 103 + ## Icon, with a sensible default 104 + #set ($icon = $kbCategoryIcons.get($label))## 105 + #if ("$!icon" == "")## 106 + #set ($icon = "📘")## 107 + #end## 31 31 32 - (%class="col-xs-12col-sm-6" %)33 -(( (34 - ==Createyourapplication==109 + ## Build clean URL: /bin/view/Main/<PageName> (no trailing slash) 110 + #set ($encoded = $escapetool.url($pageName))## 111 + #set ($cleanUrl = "/bin/view/Main/$encoded")## 35 35 36 -Go beyond the available extensions and define the //structure// of your data based on //your// needs, creating //your// own applications with [[App Within Minutes>>AppWithinMinutes]] (AWM). 113 + ## Push into our categories array as a small map 114 + #set ($entry = { 115 + "label": $label, 116 + "pageName": $pageName, 117 + "desc": $desc, 118 + "icon": $icon, 119 + "url": $cleanUrl, 120 + "count": $articleCount 121 + })## 122 + #set ($discard = $kbCategories.add($entry))## 37 37 38 -AWM will take care of making it easy for you and your users to create and manage the data. 39 -))) 40 -))) 124 + #end## 125 +#end## 126 + 127 +{{html clean="false"}} 128 +<div class="kb-home"> 129 + 130 + <!-- HERO --> 131 + <div class="kb-hero"> 132 + <h1 class="kb-hero-title">Member Solutions Knowledge Base</h1> 133 + <p class="kb-hero-subtitle"> 134 + Guides, walkthroughs, and best practices to help you and your team get the most out of the platform. 135 + </p> 136 + 137 + <!-- Hero search wired to custom KB search page --> 138 + <div class="kb-hero-search"> 139 + <form action="$xwiki.getURL('Main.KBSearch', 'view')" method="get"> 140 + <input 141 + type="text" 142 + name="text" 143 + placeholder="Search for an article (e.g. "family membership")" 144 + aria-label="Search the knowledge base" 145 + /> 146 + </form> 147 + </div> 148 + </div> 149 + 150 + <!-- CATEGORY GRID --> 151 + <div class="kb-section"> 152 + <h2 class="kb-section-title">Browse by category</h2> 153 + 154 + <div class="kb-category-grid"> 155 + #foreach ($cat in $kbCategories) 156 + #set ($label = $cat.get("label")) 157 + #set ($desc = $cat.get("desc")) 158 + #set ($icon = $cat.get("icon")) 159 + #set ($url = $cat.get("url")) 160 + #set ($count = $cat.get("count")) 161 + 162 + <a class="kb-card" href="$url"> 163 + <div> 164 + <div class="kb-card-title"> 165 + <span class="kb-card-icon">$icon</span> 166 + $escapetool.xml($label) 167 + </div> 168 + <div class="kb-card-body"> 169 + $escapetool.xml($desc) 170 + </div> 171 + </div> 172 + <div class="kb-card-meta"> 173 + #if ($count == 1) 174 + 1 article 175 + #elseif ($count > 1) 176 + $count articles 177 + #else 178 + Category 179 + #end 180 + </div> 181 + </a> 182 + #end 183 + </div> 184 + </div> 185 + 186 +</div> 187 + 188 +<style> 189 +/* HOMEPAGE HERO OVERRIDE – BIGGER + MORE BREATHING ROOM */ 190 + 191 +/* Scope tightly so we only touch KB home hero */ 192 +body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero { 193 + padding: 4.2rem 1rem 3.3rem !important; 194 + max-width: 1100px; 195 + margin: 0 auto; 196 +} 197 + 198 +/* Title */ 199 +body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-title { 200 + font-size: 3.5rem !important; 201 + font-weight: 800 !important; 202 + line-height: 1.15; 203 + margin-bottom: 1rem !important; 204 + color: #0f172a; 205 +} 206 + 207 +/* Subtitle */ 208 +body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-subtitle { 209 + font-size: 1.35rem !important; 210 + line-height: 1.7; 211 + color: #4b5563 !important; 212 + max-width: 720px; 213 + margin: 0 auto 2.3rem !important; 214 +} 215 + 216 +/* Search bar – taller + larger text */ 217 +body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-search input[type="text"] { 218 + max-width: 650px !important; 219 + padding: 1.25rem 1.6rem !important; 220 + font-size: 1.2rem !important; 221 + border-radius: 999px; 222 + border: 1px solid #d1d5db; 223 + box-shadow: 224 + 0 26px 60px rgba(15, 23, 42, 0.14), 225 + 0 2px 4px rgba(15, 23, 42, 0.06) !important; 226 +} 227 + 228 +/* Placeholder text tone/size */ 229 +body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-search input[type="text"]::placeholder { 230 + font-size: 1.15rem; 231 + color: #9ca3af; 232 +} 233 + 234 +/* Extra space between hero and "Browse by category" */ 235 +body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-section { 236 + margin-top: 4.6rem !important; 237 +} 238 +</style> 239 + 240 +{{/html}} 241 +{{/velocity}} 242 + 243 +{{include reference="KBSupportCTA.WebHome"/}}