Wiki source code of Home
Version 28.1 by Isaac Mejia on 2025/12/09 16:01
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
6.1 | 1 | {{velocity}} |
| |
11.1 | 2 | ## --------------------------------------------- |
| |
6.1 | 3 | ## KB Home (Main.WebHome) |
| |
11.1 | 4 | ## Discover category landing pages dynamically. |
| 5 | ## --------------------------------------------- | ||
| |
4.1 | 6 | |
| |
11.1 | 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 | ||
| |
9.1 | 12 | #set ($xwql = |
| |
11.1 | 13 | "select doc.fullName, doc.title, doc.name " + |
| |
9.1 | 14 | "from XWikiDocument doc " + |
| |
11.1 | 15 | "where doc.space = 'Main' " + |
| 16 | "and doc.name <> 'WebHome' " + | ||
| 17 | "and doc.name not like 'KB%' " + | ||
| |
9.1 | 18 | "and doc.hidden <> true " + |
| 19 | "order by lower(doc.title)" | ||
| |
25.1 | 20 | )## |
| 21 | #set ($query = $services.query.xwql($xwql))## | ||
| 22 | #set ($rows = $query.execute())## | ||
| |
9.1 | 23 | |
| |
11.1 | 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": "🔗" | ||
| |
25.1 | 33 | })## |
| |
9.1 | 34 | |
| |
11.1 | 35 | ## 3) Optional hand-authored descriptions for known categories |
| 36 | #set ($kbCategoryDescriptions = { | ||
| |
9.1 | 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.", | ||
| |
11.1 | 40 | "Payment Management": "Articles and guides for Payment Management.", |
| |
9.1 | 41 | "Reporting & Analytics": "Understand your numbers and performance.", |
| |
11.1 | 42 | "Notifications": "Articles and guides for Notifications.", |
| 43 | "Integrations": "Connect Member Solutions with other tools in your stack." | ||
| |
25.1 | 44 | })## |
| |
9.1 | 45 | |
| |
11.1 | 46 | ## 4) Build a normalized list of category objects |
| |
25.1 | 47 | #set ($kbCategories = [])## |
| |
11.1 | 48 | |
| |
25.1 | 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.1 | 54 | |
| 55 | ## Label shown on the card | ||
| |
25.1 | 56 | #set ($label = $catDoc.displayTitle)## |
| 57 | #if ("$!label" == "")## | ||
| 58 | #set ($label = $pageName)## | ||
| 59 | #end## | ||
| |
11.1 | 60 | |
| |
24.1 | 61 | ## Description (custom if defined, otherwise auto) |
| |
25.1 | 62 | #set ($desc = $kbCategoryDescriptions.get($label))## |
| 63 | #if ("$!desc" == "")## | ||
| 64 | #set ($desc = "Articles and guides for $label.")## | ||
| 65 | #end## | ||
| |
11.1 | 66 | |
| |
24.1 | 67 | ## Article space: Main.<PageName with spaces replaced by underscores> |
| |
25.1 | 68 | #set ($articleSpace = "Main." + $pageName.replace(" ", "_"))## |
| |
11.1 | 69 | |
| 70 | ## Count non-hidden, non-WebHome pages in that article space | ||
| |
25.1 | 71 | #set ($articleCount = 0)## |
| |
11.1 | 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" | ||
| |
25.1 | 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## | ||
| |
11.1 | 84 | |
| 85 | ## Icon, with a sensible default | ||
| |
25.1 | 86 | #set ($icon = $kbCategoryIcons.get($label))## |
| 87 | #if ("$!icon" == "")## | ||
| 88 | #set ($icon = "📘")## | ||
| 89 | #end## | ||
| |
11.1 | 90 | |
| 91 | ## Build clean URL: /bin/view/Main/<PageName> (no trailing slash) | ||
| |
25.1 | 92 | #set ($encoded = $escapetool.url($pageName))## |
| 93 | #set ($cleanUrl = "/bin/view/Main/$encoded")## | ||
| |
11.1 | 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 | ||
| |
25.1 | 103 | })## |
| 104 | #set ($discard = $kbCategories.add($entry))## | ||
| 105 | #end## | ||
| |
11.1 | 106 | |
| |
6.1 | 107 | {{html clean="false"}} |
| 108 | <div class="kb-home"> | ||
| |
1.1 | 109 | |
| |
6.1 | 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> | ||
| |
1.1 | 116 | |
| |
11.1 | 117 | <!-- Enhanced search box (still uses XWiki search under the hood) --> |
| |
6.1 | 118 | <div class="kb-hero-search"> |
| |
28.1 | 119 | <form action="$xwiki.getURL('', 'view', 'xpage=search')" method="get"> |
| 120 | ## XWiki Solr search expects the "text" parameter | ||
| 121 | <input | ||
| 122 | type="text" | ||
| 123 | name="text" | ||
| 124 | placeholder="Search for an article (e.g. "family membership")" | ||
| 125 | aria-label="Search the knowledge base" | ||
| 126 | /> | ||
| 127 | </form> | ||
| 128 | </div> | ||
| |
6.1 | 129 | </div> |
| |
4.1 | 130 | |
| |
6.1 | 131 | <!-- CATEGORY GRID --> |
| 132 | <div class="kb-section"> | ||
| 133 | <h2 class="kb-section-title">Browse by category</h2> | ||
| |
4.1 | 134 | |
| |
6.1 | 135 | <div class="kb-category-grid"> |
| |
11.1 | 136 | #foreach ($cat in $kbCategories) |
| 137 | #set ($label = $cat.get("label")) | ||
| 138 | #set ($desc = $cat.get("desc")) | ||
| 139 | #set ($icon = $cat.get("icon")) | ||
| 140 | #set ($url = $cat.get("url")) | ||
| 141 | #set ($count = $cat.get("count")) | ||
| |
4.1 | 142 | |
| |
11.1 | 143 | <a class="kb-card" href="$url"> |
| |
7.2 | 144 | <div> |
| |
11.1 | 145 | <div class="kb-card-title"> |
| 146 | <span class="kb-card-icon">$icon</span> | ||
| 147 | $escapetool.xml($label) | ||
| 148 | </div> | ||
| |
7.2 | 149 | <div class="kb-card-body"> |
| 150 | $escapetool.xml($desc) | ||
| 151 | </div> | ||
| 152 | </div> | ||
| |
11.1 | 153 | <div class="kb-card-meta"> |
| 154 | #if ($count == 1) | ||
| 155 | 1 article | ||
| 156 | #elseif ($count > 1) | ||
| 157 | $count articles | ||
| 158 | #else | ||
| 159 | Category | ||
| 160 | #end | ||
| 161 | </div> | ||
| |
7.2 | 162 | </a> |
| |
6.1 | 163 | #end |
| 164 | </div> | ||
| |
4.1 | 165 | </div> |
| |
17.1 | 166 | |
| |
4.1 | 167 | </div> |
| |
2.1 | 168 | {{/html}} |
| |
20.1 | 169 | {{/velocity}} |
| 170 | |||
| |
19.1 | 171 | {{include reference="KBSupportCTA.WebHome"/}} |