Static Unique Keys
Static sidebars list predefined URLs. “Useful Links” is an example static sidebar.
Static sidebars have the following keys:
Key | Example Value | Possible Values | Optional or Required | Description |
urls | Not applicable | An array of dictionary | Required |
|
| entries, each representing |
|
|
| a single link |
|
Because links include several values, such as the name of the link and the URL itself, every link is represented by a dictionary entry.
headerURL | http://example.com/ | Fully qualified URL | Optional | A URL that is linked to |
| groups/groupname/search |
|
| from the sidebar’s header. |
| /?sort=modifiedDate&kind |
|
|
|
| =wiki&kind=weblog&kind |
|
|
|
| =mailinglist&sortDirection |
|
|
|
| =reverse&excludePages= |
|
|
|
| wiki/welcome |
|
|
|
|
|
|
|
|
feedURL | feed://example.com/ | Fully qualified URL | Optional | An RSS or Atom feed that |
| groups/groupname/ |
|
| is associated with the |
| search/index.rss?sort=mod |
|
| sidebar. |
| ifiedDate&kind=wiki&kind |
|
|
|
| =weblog&kind=mailinglist |
|
|
|
| &sortDirection=reverse& |
|
|
|
| excludePages=wiki/ |
|
|
|
| welcome |
|
|
|
|
|
| ||
| Each dictionary entry has the following keys: |
| ||
Key | Example Value | Possible Values | Optional or Required | Description |
|
|
|
|
|
kind | url | url, wiki, weblog, | Required | Not used in any themes. |
|
| mailinglist, calendar |
| Use this to assign a class to |
|
|
|
| a sidebar. |
|
|
|
| You can then use the |
|
|
|
| class selector in CSS |
|
|
|
| to customize sidebars, |
|
|
|
| such as by adding small |
|
|
|
| calendar icons next to |
|
|
|
| calendar sidebar links or |
|
|
|
| small Safari icons next to |
|
|
|
| URL links. |
|
|
|
|
|
subtitle | Your server’s homepage, | Any string | Required | Appears under the name |
| List of groups with wikis |
|
| of the link. |
| on this server |
|
|
|
|
|
|
|
|
title | Server Home, Groups | Any string | Required | Name of the link. |
|
|
|
|
|
uid | serverhome, groups | Any string | Required | Identifier for the URL. This |
|
|
|
| value must be unique. |
|
|
|
|
|
url | /, /groups/ | A relative or absolute path | Required | Contents of the link. |
|
| to a web page |
|
|
|
|
|
|
|
Chapter 1 Customizing How the Wiki Looks
19