Web Oriented Object Framework

User Guide (Version 0.5b4)

Woof!
User Guide (Version 0.5b4)

The pagevar object

For each request, Woof! automatically creates an object called pagevar of class Map and intializes it to default values. By convention, this object contains settings related to page layout options and other page meta information such as title or stylesheets.

These pagevar values may be set in either the controller constructor and/or action method depending on how widely they are to be applied.

Applications may define their own keys and store them and associated data in the pagevar object but to avoid conflicts with Woof! usage, it is advisable to have the keys start with an upper case character.

The keys currently defined by Woof! are described below.

layout

Allows overriding of the constructed name of the layout file for the current request. See Page layout for details.

title

The default layout uses this as the title for the page. See Setting the page title.

scripts

The list of URL's to Javascript resources to include in the page, if any. Each URL in this list is linked into the page.

stylesheets

The list of URL's to stylesheets to include in the page, if any. Each URL in this list is linked into the page.

header, footer, main, sidebar, supplement

Each of these keys contains a dictionary that specifies settings for the corresponding page section in the default layout. The content of this dictionary are detailed in Tailoring the default layout.

widths

Specifies the relative widths of page sections. See Tailoring the default layout for details.

responsive_settings

The presence of this key results in the default layout generating a responsive web page. A description of the contents of this key are provided in the Responsive web design chapter.