Specifications
Understanding the Types of Sidebars
There are several types of sidebars, each with a specic purpose and set of keys:
Sidebar Type Description Related Section
static A list of URLs. “Static Unique Keys” on page 41
search A list of search results using tag-
based or text-based searching.
“Search Unique Keys” on
page 42
calendar A list of upcoming events. “Calendar Unique Keys” on
page 44
tag A list of search results using tag-
based searching.
“Tag Unique Keys” on page 44
recentActivity A list of pages sorted by recent
viewing frequency.
Based on the last 100 page
views in a wiki, this list displays
the most-viewed page rst,
followed by the next most-
viewed, and so on.
“Recent Activity Unique Keys” on
page 44
admin A sidebar that appears if
someone logs in as an admin.
This sidebar isn’t customizable.
Not applicable
Shared Keys
All sidebars require the following keys:
Key Example Values Possible Values Optional or Required Description
displayName What’s Hot, What’s New,
Useful Links, Upcoming
Events
Any string Required Name of the sidebar.
type search, static, calendar static, search, calendar,
tag, recentActivity,
admin
Required Type of sidebar used.
uid HotList, RecentAddsList,
UsefulLinks
Any string Required Identier for the
sidebar. This value must
be unique.
40 Chapter 3 Customizing How the Wiki Looks