RoxenCMS 5.4Web Developer ManualRXML Scopes & Entities

   

AC Scope
Client Scope
Cookie Scope
Form Scope
Header Scope
Page Scope
Request-Header Scope
Roxen Scope
User Scope
Var Scope

Page

This scope contains information specific to this page.


&page.accessed; (provided by Tags: Accessed counter)

Generates an access counter that shows how many times the page has been accessed. Needs the accessed module.


&page.author; (provided by CMS: Tags)

Returns the author's name.


&page.author-id; (provided by CMS: Tags)

Returns the author's identification number.


&page.author-name; (provided by CMS: Tags)

Returns the author's handle, i.e. login name.


&page.content-editor; (provided by CMS: Tags)

Returns the full internal SiteBuilder URL to the page in the Content Editor, focusing on the file.


&page.default-charset; (provided by CMS: Tags)

Returns the default output charset for this page.


&page.description; (provided by CMS: Tags)

Returns the description of the file, set in the metadata.


&page.dir; (provided by Tags: RXML tags)

The name of the directory in the virtual filesystem where the file resides, as derived from the URL. If the URL is "http://community.roxen.com/articles/index.html", then the value of this entity is "/articles/".


&page.filename; (provided by CMS: Tags)

Returns the filename.


&page.filesize; (provided by Tags: RXML tags)

This file's size, in bytes.


&page.filesize; (provided by CMS: Tags)

Returns the filesize.


&page.is-explicit-ppoint; (provided by CMS: Tags)

Is "yes" if the page has an explicit protection point set and "no" if the permissions are controlled by a directory protection point.


&page.keywords; (provided by CMS: Tags)

Returns the keywords of the file, set in the metadata.


&page.language; (provided by Tags: RXML tags)

What language the contents of this file is written in. The language must be given as metadata to be found.


&page.languages; (provided by CMS: Tags)

All languages present in the file returned as a comma-separated string.


&page.last-true; (provided by Tags: RXML tags)

Is "1" if the last <if>-statement succeeded, otherwise 0. (<true> and <false> is considered as <if>-statements here) See also: If Tags.


&page.modification-date; (provided by CMS: Tags)

Returns the date when the file was last modified.


&page.modification-time; (provided by CMS: Tags)

Returns the time when the file was last modified.


&page.mountpoint; (provided by Tags: RXML tags)

The root of the present virtual filesystem without the ending slash, usually "".


&page.nicefilesize; (provided by CMS: Tags)

Returns the size of the file formatted for easier reading.


&page.path; (provided by Tags: RXML tags)

Absolute path to this file in the virtual filesystem. E.g. with the URL "http://www.roxen.com/partners/../products/index.xml.html", as well as "http://www.roxen.com/products/index.xml.html", the value will be "/products/index.xml.html", given that the virtual filsystem was mounted on "/".


&page.pathinfo; (provided by Tags: RXML tags)

The "path info" part of the URL, if any. Can only get set if the "Path info support" module is installed. For details see the documentation for that module.


&page.permission; (provided by CMS: Tags)

Returns the string "read" or "write" depending on whether the viewer has permission to write in the file or not.


&page.ppoint-handle; (provided by CMS: Tags)

The handle of the protection point controlling the permissions of the page.


&page.ppoint-id; (provided by CMS: Tags)

The id of the protection point controlling the permissions of the page.


&page.query; (provided by Tags: RXML tags)

The query part of the page URL. If the page URL is "http://www.server.com/index.html?a=1&b=2" the value of this entity is "a=1&b=2".


&page.realfile; (provided by Tags: RXML tags)

Path to this file in the file system. An example output: "/home/joe/html/index.html".


&page.revision; (provided by CMS: Tags)

Returns the file's current revision number.


&page.scope; (provided by Tags: RXML tags)

The name of the current scope, i.e. the scope accessible through the name "_".


&page.selectable; (provided by CMS: Tags)

For showing whether an XSL template file is selectable within the "Edit metadata" wizard. Returns either "n/a" if the file is of an other content-type than "sitebuilder/xsl-template", "yes" if the file is selectable or "no" if the file isn't selectable.


&page.selected; (provided by CMS: Tags)

Whether this file is the current file or if this directory is a directory within the path to the current file. Only one entry will be selected.


&page.self; (provided by Tags: RXML tags)

The name of this file, derived from the URL. If the URL is "http://community.roxen.com/articles/index.html", then the value of this entity is "index.html".


&page.site-status; (provided by CMS: Tags)

Returns the file's status in the site's workarea. The possible values for this and &page.user-status; are one of "none", "added" (only applicable to user status), "exists", "modified", "removed" and "unpublished-removed" (only applicable to site status in combination with workflow).


&page.ssl-strength; (provided by Tags: RXML tags)

The number of bits used in the key of the current SSL connection.


&page.stationery; (provided by CMS: Tags)

Returns "yes" if the page is marked as a stationery, "no" otherwise.


&page.status-img; (provided by CMS: Tags)

Returns the full internal SiteBuilder URL to the page's current status image. The status image tells if the page has been modified etc. from the viewer's point of view. This is the same status icon as used by the Content Editor.


&page.template; (provided by CMS: Tags)

Returns the current page's selected template.


&page.title; (provided by CMS: Tags)

Returns the title of the file, set in the metadata.


&page.type; (provided by CMS: Tags)

Returns the file's content-type.


&page.type-img; (provided by CMS: Tags)

Returns the internal SiteBuilder URI to where the file's content-type image is stored.


&page.url; (provided by Tags: RXML tags)

The absolute path for this file from the web server's root view including query variables.


&page.user-status; (provided by CMS: Tags)

Returns the file's status in the user's workarea. Please see &page.site-status; for more information on possible values.


&page.uuid; (provided by CMS: Tags)

Returns the page's unique identifier (UUID) if one exists.


&page.virtfile; (provided by Tags: RXML tags)

This tag is deprecated. Use &page.path; instead.


&page.virtroot; (provided by Tags: RXML tags)

The root of the present virtual filesystem, usually "/".


&page.visible; (provided by CMS: Tags)

Returns "yes" if the page is currently externally visible, "no" otherwise.


&page.visible-from; (provided by CMS: Tags)

Returns the date and time, in iso format, when the page starts to be visible. If external visibility is set to Never, "never" will be returned. If external visibility is set to Always or Visible until a specified time, "now" will be returned.


&page.visible-to; (provided by CMS: Tags)

Returns the date and time, in iso format, when the page ends to be visible. If external visibility is set to Never, "never" will be returned. If external visibility is set to Always or Visible after a specified time, "infinity" will be returned.


&page.workarea; (provided by CMS: Tags)

Returns the name of the workarea where the viewed page is stored.


&page.workarea-id; (provided by CMS: Tags)

Returns the unique id of the workarea. Useful when doing web applications.


&page.workarea-ppoint-id; (provided by CMS: Tags)

Returns the id of the protection point for the workarea.


&page.workflow-hidden; (provided by CMS: Tags)

Returns "yes" if the repository version is newer than the view area version of this file, "no" otherwise. This happens when the file is controlled by workflow and internal commits have taken place since the last publish action.