lenya/src/webapp/lenya/pubs/docs-new/content/xdocs/docs/components pageenvelopemodule.xml,NONE,1.1

Andreas Hartmann <[email protected]> Fri, 16 May 2003 17:29:33 +0200
Newsgroups	gmane.comp.cms.wyona.cvs
Message-ID	<[email protected]>
Update of /repository/lenya/src/webapp/lenya/pubs/docs-new/content/xdocs/docs/components
In directory erbium:/tmp/cvs-serv29927/src/webapp/lenya/pubs/docs-new/content/xdocs/docs/components

Added Files:
	pageenvelopemodule.xml 
Log Message:
- added PageEnvelopeModule docs
- added PEM to cocoon.xconf
- moved workflow.xmap to usecase.xmap
- added common publishing pipeline + xsp + xslt
- added shared scheduling XSP

--- NEW FILE: pageenvelopemodule.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">

<document>
  <header>
    <title>The PageEnvelopeModule</title>
    <version/>
    <type/>
    <authors>
      <person name="Andreas Hartmann" email="[email protected]"/>
    </authors>
  </header>
  <body>

<section><title>Overview</title>
<p>
The <code>PageEnvelopeModule</code> is an <code>InputModule</code> that provides
access to the <code>PageEnvelope</code> parameters. For documentation on
input modules see section
<link href="http://cocoon.apache.org/2.1/userdocs/concepts/modules.html">Modules</link>
of the Cocoon documentation.
</p>
</section>
  
<section><title>Module Parameters</title>
<dl>
  <dt>publication-id</dt>
  <dd>The current publication ID.</dd>
  <dt>context-prefix</dt>
  <dd>The context prefix of the web application, e.g. <code>/lenya</code>.</dd>
  <dt>area</dt>
  <dd>The CMS area, <code>authoring</code> or <code>live</code>.</dd>
  <dt>document-id</dt>
  <dd>The document ID, i.e. the path of the document in the sitetree.</dd>
  <dt>document-url</dt>
  <dd>The URL of the document within the area, e.g., <code>/news/index.html</code></dd>
</dl>
</section>

<section><title>Sitemap usage</title>
<source>
<![CDATA[<map:parameter name="document-id" value="{page-envelope:document-id}"/>]]>
</source>
</section>

<section><title>XSP usage</title>
<source>
<![CDATA[<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>       
]]>
</source>
</section>


  </body>
</document>