Brent Royal-Gordon > WWW-Kontent > WWW::Kontent::Class::Setting

Download:
WWW-Kontent-0.02.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

WWW::Kontent::Class::Setting - Page class for a setting in Kontent

SYNOPSIS ^

        # Attributes
        kontent:class=setting
        kontent:version=1
        setting:value=the setting's value
        setting:desc=documentation about the setting
        setting:desctype=text/x-kolophon

DESCRIPTION ^

Setting is a page class representing a Kontent setting.

Note: Settings are fairly magical pages, and Kontent's core is sensitive to their internal structure. Settings should only be placed under the /kontent/settings page in your Kontent store, and should never have child pages. However, it is safe to create settings with names Kontent doesn't use.

Each setting has a value and a description; the description serves as documentation of the setting's meaning. Both values and descriptions can be edited through the page's 'edit' mode, although the description is usually left alone.

Internally, settings are retrieved through the WWW::Kontent::setting function. Settings are usually interpreted as simple text strings, but are sometimes treated as YAML documents or interpolated like Perl 6 string literals; this should be noted in the description.

Attributes

setting:value

The value of the setting.

setting:desc

The setting's description.

setting:desctype

The MIME type of the description. Defaults to text/x-kolophon.

Modes

view, history, edit

SEE ALSO ^

WWW::Kontent, WWW::Kontent::Foundation

syntax highlighting: