Skip to Content

Changes for page Home

Last modified by Isaac Mejia on 2025/12/22 19:31
From version 36.1
edited by Isaac Mejia
on 2025/12/22 19:30
Change comment: There is no comment for this version
To version 1.1
edited by Isaac Mejia
on 2025/11/14 19:59
Change comment: Install extension [org.xwiki.platform:xwiki-platform-distribution-flavor-common/16.10.14]

Summary

Details

Page properties
Content
... ... @@ -1,246 +1,40 @@
1 -{{velocity}}
2 -## ---------------------------------------------
3 -## KB Home (Main.WebHome)
4 -## Discover category landing pages dynamically.
5 -## (WITH HARD ALLOWLIST)
6 -## ---------------------------------------------
1 +== Welcome to your wiki ==
7 7  
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())##
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.
24 24  
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 -})##
5 +XWiki can be used as a knowledge base (support, documentation, sales, etc.), for collaborative workspaces or even as a complete intranet.
35 35  
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 -})##
7 +== The basics ==
46 46  
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 -])##
9 +To make the most out of your wiki, log-in and:
60 60  
61 -## 4) Build a normalized list of category objects
62 -#set ($kbCategories = [])##
11 +Use the {{displayIcon name="pencil"/}} button above to //edit// this page and start customizing your wiki to your needs.
63 63  
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))##
13 +Use the {{displayIcon name="add"/}} button above to //add// more pages to your wiki and create the //hierarchy// that best organizes your content.
69 69  
70 - ## Label shown on the card
71 - #set ($label = $catDoc.displayTitle)##
72 - #if ("$!label" == "")##
73 - #set ($label = $pageName)##
74 - #end##
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.
75 75  
76 - ## Only include categories we actually want
77 - #if ($allowedCategories.contains($label))##
17 +You can also use the [[Sandbox>>Sandbox.WebHome]] for more demo content and generally a place to experiment with your wiki's features.
78 78  
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##
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}}
84 84  
85 - ## Article spaces (support both naming conventions)
86 - #set ($spaceA = "Main." + $pageName)##
87 - #set ($spaceB = "Main." + $pageName.replace(" ", "_"))##
21 +(% class="row" %)
22 +(((
23 +(% class="col-xs-12 col-sm-6" %)
24 +(((
25 +== Extend your wiki ==
88 88  
89 - ## Count non-hidden, non-WebHome pages in either article space
90 - #set ($articleCount = 0)##
91 - #set ($countXwql =
92 - "select count(doc.fullName) " +
93 - "from XWikiDocument doc " +
94 - "where doc.space in (:spaceA, :spaceB) " +
95 - "and doc.name <> 'WebHome' " +
96 - "and doc.hidden <> true"
97 - )##
98 - #set ($countQuery = $services.query.xwql($countXwql))##
99 - #set ($discard = $countQuery.bindValue("spaceA", $spaceA))##
100 - #set ($discard = $countQuery.bindValue("spaceB", $spaceB))##
101 - #set ($resultList = $countQuery.execute())##
102 - #if ($resultList && $resultList.size() > 0)##
103 - #set ($articleCount = $resultList.get(0))##
104 - #end##
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&section=XWiki.Extensions"]] where you can search for and install extensions.
105 105  
106 - ## Icon, with a sensible default
107 - #set ($icon = $kbCategoryIcons.get($label))##
108 - #if ("$!icon" == "")##
109 - #set ($icon = "📘")##
110 - #end##
29 +To browse through the 900+ community contributed extensions available for XWiki, head over to the [[Extensions Repository>>https://extensions.xwiki.org]].
30 +)))
111 111  
112 - ## Build clean URL: /bin/view/Main/<PageName> (no trailing slash)
113 - #set ($encoded = $escapetool.url($pageName))##
114 - #set ($cleanUrl = "/bin/view/Main/$encoded")##
32 +(% class="col-xs-12 col-sm-6" %)
33 +(((
34 +== Create your application ==
115 115  
116 - ## Push into our categories array as a small map
117 - #set ($entry = {
118 - "label": $label,
119 - "pageName": $pageName,
120 - "desc": $desc,
121 - "icon": $icon,
122 - "url": $cleanUrl,
123 - "count": $articleCount
124 - })##
125 - #set ($discard = $kbCategories.add($entry))##
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).
126 126  
127 - #end##
128 -#end##
129 -
130 -{{html clean="false"}}
131 -<div class="kb-home">
132 -
133 - <!-- HERO -->
134 - <div class="kb-hero">
135 - <h1 class="kb-hero-title">Member Solutions Knowledge Base</h1>
136 - <p class="kb-hero-subtitle">
137 - Guides, walkthroughs, and best practices to help you and your team get the most out of the platform.
138 - </p>
139 -
140 - <!-- Hero search wired to custom KB search page -->
141 - <div class="kb-hero-search">
142 - <form action="$xwiki.getURL('Main.KBSearch', 'view')" method="get">
143 - <input
144 - type="text"
145 - name="text"
146 - placeholder="Search for an article (e.g. &quot;family membership&quot;)"
147 - aria-label="Search the knowledge base"
148 - />
149 - </form>
150 - </div>
151 - </div>
152 -
153 - <!-- CATEGORY GRID -->
154 - <div class="kb-section">
155 - <h2 class="kb-section-title">Browse by category</h2>
156 -
157 - <div class="kb-category-grid">
158 - #foreach ($cat in $kbCategories)
159 - #set ($label = $cat.get("label"))
160 - #set ($desc = $cat.get("desc"))
161 - #set ($icon = $cat.get("icon"))
162 - #set ($url = $cat.get("url"))
163 - #set ($count = $cat.get("count"))
164 -
165 - <a class="kb-card" href="$url">
166 - <div>
167 - <div class="kb-card-title">
168 - <span class="kb-card-icon">$icon</span>
169 - $escapetool.xml($label)
170 - </div>
171 - <div class="kb-card-body">
172 - $escapetool.xml($desc)
173 - </div>
174 - </div>
175 - <div class="kb-card-meta">
176 - #if ($count == 1)
177 - 1 article
178 - #elseif ($count > 1)
179 - $count articles
180 - #else
181 - Category
182 - #end
183 - </div>
184 - </a>
185 - #end
186 - </div>
187 - </div>
188 -
189 -</div>
190 -
191 -<style>
192 -/* HOMEPAGE HERO OVERRIDE – BIGGER + MORE BREATHING ROOM */
193 -
194 -/* Scope tightly so we only touch KB home hero */
195 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero {
196 - padding: 4.2rem 1rem 3.3rem !important;
197 - max-width: 1100px;
198 - margin: 0 auto;
199 -}
200 -
201 -/* Title */
202 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-title {
203 - font-size: 3.5rem !important;
204 - font-weight: 800 !important;
205 - line-height: 1.15;
206 - margin-bottom: 1rem !important;
207 - color: #0f172a;
208 -}
209 -
210 -/* Subtitle */
211 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-subtitle {
212 - font-size: 1.35rem !important;
213 - line-height: 1.7;
214 - color: #4b5563 !important;
215 - max-width: 720px;
216 - margin: 0 auto 2.3rem !important;
217 -}
218 -
219 -/* Search bar – taller + larger text */
220 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-search input[type="text"] {
221 - max-width: 650px !important;
222 - padding: 1.25rem 1.6rem !important;
223 - font-size: 1.2rem !important;
224 - border-radius: 999px;
225 - border: 1px solid #d1d5db;
226 - box-shadow:
227 - 0 26px 60px rgba(15, 23, 42, 0.14),
228 - 0 2px 4px rgba(15, 23, 42, 0.06) !important;
229 -}
230 -
231 -/* Placeholder text tone/size */
232 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-search input[type="text"]::placeholder {
233 - font-size: 1.15rem;
234 - color: #9ca3af;
235 -}
236 -
237 -/* Extra space between hero and "Browse by category" */
238 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-section {
239 - margin-top: 4.6rem !important;
240 -}
241 -</style>
242 -
243 -{{/html}}
244 -{{/velocity}}
245 -
246 -{{include reference="KBSupportCTA.WebHome"/}}
38 +AWM will take care of making it easy for you and your users to create and manage the data.
39 +)))
40 +)))