Changes for page Home

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,177 +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		- ## 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
	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 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(" ", "_"))
	17	+You can also use the [[Sandbox>>Sandbox.WebHome]] for more demo content and generally a place to experiment with your wiki's features.
71	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
	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}}
90	90
91		- ## Icon, with a sensible default
92		- #set ($icon = $kbCategoryIcons.get($label))
93		- #if ("$!icon" == "")
94		- #set ($icon = "📘")
95		- #end
	21	+(% class="row" %)
	22	+(((
	23	+(% class="col-xs-12 col-sm-6" %)
	24	+(((
	25	+== Extend your wiki ==
96	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")
	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.
100	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
	29	+To browse through the 900+ community contributed extensions available for XWiki, head over to the [[Extensions Repository>>https://extensions.xwiki.org]].
	30	+)))
112	112
113		-{{html clean="false"}}
114		-<div class="kb-home">
	32	+(% class="col-xs-12 col-sm-6" %)
	33	+(((
	34	+== Create your application ==
115	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>
	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).
122	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>
134		- </div>
135		-
136		- <!-- CATEGORY GRID -->
137		- <div class="kb-section">
138		- <h2 class="kb-section-title">Browse by category</h2>
139		-
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>
170		- </div>
171		-
172		-</div>
173		-{{/html}}
174		-
175		-## Reusable bottom CTA (support panel)
176		-{{include reference="KBSupportCTA.WebHome"/}}
177		-{{/velocity}}
	38	+AWM will take care of making it easy for you and your users to create and manage the data.
	39	+)))
	40	+)))