The PageEnvelopeModule
Table of Contents
Overview
The PageEnvelopeModule is an InputModule
that provides access to the PageEnvelope parameters. For
documentation on input modules see section Modules
of the Cocoon documentation.
Module Parameters
- publication-id
- The current publication ID.
- context-prefix
- The context prefix of the web application, e.g.
/lenya. - area
- The CMS area,
authoringorlive. - publication
- The current publication
- document-id
- The document ID, i.e. the path of the document in the sitetree.
- document-name
- The document name, i.e. the very last part of the document ID.
- document-url
- The URL of the document within the area, e.g.,
/news/index.html - document-path
- The file path where this document is physically located in the file system.
- document-language
- The language of this document.
- document-type
- The document type.
Sitemap usage
<map:parameter name="document-id" value="{page-envelope:document-id}"/>
XSP usage
<xsp:page
language="java"
xmlns:xsp="http://apache.org/xsp"
xmlns:input="http://apache.org/cocoon/xsp/input/1.0">
<usecase:url>
<input:get-attribute
module="page-envelope" as="string" name="document-url"/>
</usecase:url>
</xsp:page>