Skip to Content

Changes for page Home

Last modified by Isaac Mejia on 2025/12/15 18:27
From version 33.2
edited by Isaac Mejia
on 2025/12/15 17:54
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,225 +1,40 @@
1 -{{velocity}}
2 -## ---------------------------------------------
3 -## KB Home (Main.WebHome)
4 -## Discover category landing pages dynamically.
5 -## ---------------------------------------------
1 +== Welcome to your wiki ==
6 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())##
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.
23 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 -})##
5 +XWiki can be used as a knowledge base (support, documentation, sales, etc.), for collaborative workspaces or even as a complete intranet.
34 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 -})##
7 +== The basics ==
45 45  
46 -## 4) Build a normalized list of category objects
47 -#set ($kbCategories = [])##
9 +To make the most out of your wiki, log-in and:
48 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))##
11 +Use the {{displayIcon name="pencil"/}} button above to //edit// this page and start customizing your wiki to your needs.
54 54  
55 - ## Label shown on the card
56 - #set ($label = $catDoc.displayTitle)##
57 - #if ("$!label" == "")##
58 - #set ($label = $pageName)##
59 - #end##
13 +Use the {{displayIcon name="add"/}} button above to //add// more pages to your wiki and create the //hierarchy// that best organizes your content.
60 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##
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.
66 66  
67 - ## Article space: Main.<PageName with spaces replaced by underscores>
68 - #set ($articleSpace = "Main." + $pageName.replace(" ", "_"))##
17 +You can also use the [[Sandbox>>Sandbox.WebHome]] for more demo content and generally a place to experiment with your wiki's features.
69 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##
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 - ## Icon, with a sensible default
86 - #set ($icon = $kbCategoryIcons.get($label))##
87 - #if ("$!icon" == "")##
88 - #set ($icon = "📘")##
89 - #end##
21 +(% class="row" %)
22 +(((
23 +(% class="col-xs-12 col-sm-6" %)
24 +(((
25 +== Extend your wiki ==
90 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")##
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.
94 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##
29 +To browse through the 900+ community contributed extensions available for XWiki, head over to the [[Extensions Repository>>https://extensions.xwiki.org]].
30 +)))
106 106  
107 -{{html clean="false"}}
108 -<div class="kb-home">
32 +(% class="col-xs-12 col-sm-6" %)
33 +(((
34 +== Create your application ==
109 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>
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).
116 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 -
170 -<style>
171 -/* HOMEPAGE HERO OVERRIDE – BIGGER + MORE BREATHING ROOM */
172 -
173 -/* Scope tightly so we only touch KB home hero */
174 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero {
175 - padding: 4.2rem 1rem 3.3rem !important; /* more air above + below */
176 - max-width: 1100px;
177 - margin: 0 auto;
178 -}
179 -
180 -/* Title */
181 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-title {
182 - font-size: 3.5rem !important;
183 - font-weight: 800 !important;
184 - line-height: 1.15;
185 - margin-bottom: 1rem !important;
186 - color: #0f172a;
187 -}
188 -
189 -/* Subtitle */
190 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-subtitle {
191 - font-size: 1.35rem !important;
192 - line-height: 1.7;
193 - color: #4b5563 !important;
194 - max-width: 720px;
195 - margin: 0 auto 2.3rem !important; /* more space before search bar */
196 -}
197 -
198 -/* Search bar – taller + larger text */
199 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-search input[type="text"] {
200 - max-width: 650px !important;
201 - padding: 1.25rem 1.6rem !important;
202 - font-size: 1.2rem !important;
203 - border-radius: 999px;
204 - border: 1px solid #d1d5db;
205 - box-shadow:
206 - 0 26px 60px rgba(15, 23, 42, 0.14),
207 - 0 2px 4px rgba(15, 23, 42, 0.06) !important;
208 -}
209 -
210 -/* Placeholder text tone/size */
211 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-hero-search input[type="text"]::placeholder {
212 - font-size: 1.15rem;
213 - color: #9ca3af;
214 -}
215 -
216 -/* Extra space between hero and "Browse by category" */
217 -body.viewbody.page-WebHome[class*="space-Main"] #xwikicontent .kb-section {
218 - margin-top: 4.6rem !important;
219 -}
220 -</style>
221 -
222 -{{/html}}
223 -{{/velocity}}
224 -
225 -{{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 +)))