Fetching contributors…
Cannot retrieve contributors at this time
80 lines (61 sloc) 4.31 KB

Show a rsc as a HTML page.

This controller is used to show the HTML page of a :term:`resource`. A “404 Not Found” or “410 Gone” page is shown if the requested page never existed or has been deleted.

The user will be redirected to the logon URL when the current user is not allowed to view the page.

This controller also adds a noindex response header when the page’s “seo_noindex” flag is set.

Example dispatch rule:

{page, ["page", id], controller_page, []}

Dispatch arguments

controller_page recognizes the following arguments inside the dispatch pattern:

Argument Description Example URL
id The id of the page (rsc) to be shown. This can be the numerical id or the unique name of a page. /page/12345

Dispatch options

The following options can be given to the dispatch rule:

Option Description Example
id Id or unique name of the resource to be shown. This overrules any id in the query arguments. {id, page_about}
template Name of the template to be rendered. Defaults to “page.tpl” Can also be a tuple of the following form: {cat, Name}. See also: :ref:`tag-catinclude`.

{template, "about.tpl"}

{template, {cat, "home. tpl"}}

cat The category the resource that is requested has to be. If a page of a different category is requested, a 404 is shown. {cat, text}
acl_action What ACL action will be checked. Defaults to 'view'; but can also be 'edit' if users need edit permission on the rsc to be able to access the resource. {acl_action, edit}
acl Extra authorization checks to be performed. See `ACL options`_.
is_canonical Whether this URL should be considered the caninical URL of the page. If so, the controller will redirect to the sc's page path if set. Defaults to true. {is_canonical, false}