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
Change comment: Install extension [org.xwiki.platform:xwiki-platform-distribution-flavor-common/16.10.14]
To version 9.1
edited by Isaac Mejia
on 2025/12/05 16:52
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,40 +1,116 @@
1 -== Welcome to your wiki ==
1 +{{velocity}}
2 +## KB Home (Main.WebHome)
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.
4 +## ------------------------------------------------------------
5 +## 1) Discover category pages automatically
6 +## - Category pages live at: Main.<CategoryLabel>.WebHome
7 +## - We query all docs in space=Main except WebHome + KB-Categories
8 +## ------------------------------------------------------------
9 +#set ($xwql =
10 + "select doc.fullName, doc.title " +
11 + "from XWikiDocument doc " +
12 + "where doc.space = :space " +
13 + "and doc.name <> 'WebHome' " +
14 + "and doc.name <> 'KB-Categories' " +
15 + "and doc.hidden <> true " +
16 + "order by lower(doc.title)"
17 +)
4 4  
5 -XWiki can be used as a knowledge base (support, documentation, sales, etc.), for collaborative workspaces or even as a complete intranet.
19 +#set ($query = $services.query.xwql($xwql).bindValue("space", "Main"))
20 +#set ($rows = $query.execute())
6 6  
7 -== The basics ==
22 +## Build a list of document objects for convenience
23 +#set ($categories = [])
24 +#foreach ($row in $rows)
25 + #set ($fullName = $row[0]) ## e.g. "Main.Member Management"
26 + #set ($catDoc = $xwiki.getDocument($fullName))
27 + #set ($discard = $categories.add($catDoc))
28 +#end
8 8  
9 -To make the most out of your wiki, log-in and:
30 +## ------------------------------------------------------------
31 +## 2) Optional: description overrides by category label
32 +## Keys must match the *display title* (e.g. "Member Management")
33 +## ------------------------------------------------------------
34 +#set ($categoryDescriptions = {
35 + "Member Management": "How to manage members, families, and profiles.",
36 + "Configuration": "Set up locations, billing, and core system settings.",
37 + "Billing & Payments": "Invoices, collections, and payment processing.",
38 + "Reporting & Analytics": "Understand your numbers and performance.",
39 + "Integrations": "Connect eFit with other tools in your stack."
40 +})
10 10  
11 -Use the {{displayIcon name="pencil"/}} button above to //edit// this page and start customizing your wiki to your needs.
42 +{{html clean="false"}}
43 +<div class="kb-home">
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.
45 + <!-- HERO -->
46 + <div class="kb-hero">
47 + <h1 class="kb-hero-title">Member Solutions Knowledge Base</h1>
48 + <p class="kb-hero-subtitle">
49 + Guides, walkthroughs, and best practices to help you and your team get the most out of the platform.
50 + </p>
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.
52 + <!-- Simple search box that posts to XWiki search -->
53 + <div class="kb-hero-search">
54 + <form action="$xwiki.getURL('Main.WebHome', 'view')" method="get">
55 + <input
56 + type="text"
57 + name="text"
58 + placeholder="Search for an article (e.g. &quot;family membership&quot;)"
59 + />
60 + </form>
61 + </div>
62 + </div>
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.
64 + <!-- CATEGORY GRID -->
65 + <div class="kb-section">
66 + <h2 class="kb-section-title">Browse by category</h2>
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}}
68 + <div class="kb-category-grid">
69 + #foreach ($catDoc in $categories)
70 + ## Label shown on the card
71 + #set ($label = $catDoc.displayTitle) ## e.g. "Member Management"
20 20  
21 -(% class="row" %)
22 -(((
23 -(% class="col-xs-12 col-sm-6" %)
24 -(((
25 -== Extend your wiki ==
73 + ## Space/page name used in the URL path:
74 + ## uploader created category pages as Main.<Label>.WebHome,
75 + ## so doc.name is the space segment we need (with spaces).
76 + #set ($spaceName = $catDoc.name) ## e.g. "Member Management"
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&section=XWiki.Extensions"]] where you can search for and install extensions.
78 + ## Description: use override map if present, else generic
79 + #set ($desc = $categoryDescriptions.get($label))
80 + #if (!$desc)
81 + #set ($desc = "Articles and guides for " + $label)
82 + #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 -)))
84 + ## Build clean URL: /bin/view/Main/<SpaceName> (no trailing slash)
85 + #set ($encoded = $escapetool.url($spaceName))
86 + #set ($cleanUrl = "/bin/view/Main/$encoded")
31 31  
32 -(% class="col-xs-12 col-sm-6" %)
33 -(((
34 -== Create your application ==
88 + <a class="kb-card" href="$cleanUrl">
89 + <div>
90 + <div class="kb-card-title">$escapetool.xml($label)</div>
91 + <div class="kb-card-body">
92 + $escapetool.xml($desc)
93 + </div>
94 + </div>
95 + <div class="kb-card-meta">Category</div>
96 + </a>
97 + #end
98 + </div>
99 + </div>
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).
101 + <!-- BOTTOM CTA -->
102 + <div class="kb-cta">
103 + <div class="kb-cta-content">
104 + <h2>Still need help?</h2>
105 + <p>
106 + If you can’t find what you’re looking for, our support team is happy to help.
107 + </p>
108 + </div>
109 + <a href="mailto:support@membersolutions.com" class="kb-cta-button">
110 + Contact Support
111 + </a>
112 + </div>
37 37  
38 -AWM will take care of making it easy for you and your users to create and manage the data.
39 -)))
40 -)))
114 +</div>
115 +{{/html}}
116 +{{/velocity}}