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 19.1
edited by Isaac Mejia
on 2025/12/05 17:53
on 2025/12/05 17:53
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,174 @@ 1 -== Welcome to your wiki == 1 +{{velocity}} 2 +## --------------------------------------------- 3 +## KB Home (Main.WebHome) 4 +## Discover category landing pages dynamically. 5 +## --------------------------------------------- 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. 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()) 4 4 5 -XWiki can be used as a knowledge base (support, documentation, sales, etc.), for collaborative workspaces or even as a complete intranet. 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 +}) 6 6 7 -== The basics == 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 +}) 8 8 9 -To make the most out of your wiki, log-in and: 46 +## 4) Build a normalized list of category objects 47 +#set ($kbCategories = []) 10 10 11 -Use the {{displayIcon name="pencil"/}} button above to //edit// this page and start customizing your wiki to your needs. 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)) 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. 55 + ## Label shown on the card 56 + #set ($label = $catDoc.displayTitle) 57 + #if ("$!label" == "") 58 + #set ($label = $pageName) 59 + #end 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. 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 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. 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(" ", "_")) 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}} 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 + #set ($resultList = $countQuery.execute()) 83 + #if ($resultList && $resultList.size() > 0) 84 + #set ($articleCount = $resultList.get(0)) 85 + #end 20 20 21 - (%class="row"%)22 -(( (23 - (%class="col-xs-12 col-sm-6"%)24 -( ((25 - ==Extendyour wiki ==87 + ## Icon, with a sensible default 88 + #set ($icon = $kbCategoryIcons.get($label)) 89 + #if ("$!icon" == "") 90 + #set ($icon = "📘") 91 + #end 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. 93 + ## Build clean URL: /bin/view/Main/<PageName> (no trailing slash) 94 + #set ($encoded = $escapetool.url($pageName)) 95 + #set ($cleanUrl = "/bin/view/Main/$encoded") 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 -))) 97 + ## Push into our categories array as a small map 98 + #set ($entry = { 99 + "label": $label, 100 + "pageName": $pageName, 101 + "desc": $desc, 102 + "icon": $icon, 103 + "url": $cleanUrl, 104 + "count": $articleCount 105 + }) 106 + #set ($discard = $kbCategories.add($entry)) 107 +#end 31 31 32 -(% class="col-xs-12 col-sm-6" %) 33 -((( 34 -== Create your application == 109 +{{html clean="false"}} 110 +<div class="kb-home"> 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). 112 + <!-- HERO --> 113 + <div class="kb-hero"> 114 + <h1 class="kb-hero-title">Member Solutions Knowledge Base</h1> 115 + <p class="kb-hero-subtitle"> 116 + Guides, walkthroughs, and best practices to help you and your team get the most out of the platform. 117 + </p> 37 37 38 -AWM will take care of making it easy for you and your users to create and manage the data. 39 -))) 40 -))) 119 + <!-- Enhanced search box (still uses XWiki search under the hood) --> 120 + <div class="kb-hero-search"> 121 + <form action="$xwiki.getURL('Main.WebHome', 'view')" method="get"> 122 + <input 123 + type="text" 124 + name="text" 125 + placeholder="Search for an article (e.g. "family membership")" 126 + aria-label="Search the knowledge base" 127 + /> 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 +{{/html}} 170 + 171 +## Bottom CTA (support panel) 172 +{{include reference="KBSupportCTA.WebHome"/}} 173 + 174 +{{/velocity}}