PageLayoutApplication

PageLayout Application

Specifies page-level display of right and left sidebars, inline comment/attachment blocks, and allows one type of editor to be forced.

Usage

When most pages in an XWiki are used for status, documentation, project information, etc., it can be nice to have a primary (narrow) sidebar always visible for navigation while having the other sidebar only available on some pages, e.g. Space.WebHome.

When PageLayout is present, you can enable display of the primary/navigation sidebar and disable display of the ancillary sidebar in the global/space preferences so that it applies to all pages. Then add a PageLayout object to Space.WebHome, and enable the display of the ancillary sidebar on only that page.

The converse could be true as well: if you want both sidebars displayed on all pages except a few, enable display of both in the global/space preferences, and use a PageLayout object to suppress rendering of one or the other or both sidebars on certain pages.

How to use

First download the XAR and import it on your XWiki.

The templates/skin must be updated to use these settings when rendering the page.

Information about the template modifications required to support the PageLayout class are described in the document itself, which can be found in the XWiki space after import: http://<server>/xwiki/bin/view/XWiki/PageLayout.

The class definition is fairly straight-forward, and does not provide "application-level" function in the true sense, so there are no sheets or templates defined.