You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by co...@apache.org on 2003/05/30 17:48:09 UTC
cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/flow api.xml sitemap.xml velocity.xml
coliver 2003/05/30 08:48:09
Modified: src/documentation/xdocs/userdocs/flow api.xml sitemap.xml
velocity.xml
Log:
added links to javadocs and a few corrections
Revision Changes Path
1.9 +7 -7 cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml
Index: api.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- api.xml 25 May 2003 19:25:06 -0000 1.8
+++ api.xml 30 May 2003 15:48:08 -0000 1.9
@@ -38,7 +38,7 @@
</p>
<p>The flow script is suspended after the page is generated and the whole execution stack saved in the WebContinuation object returned from this function. </p>
<p> <code>uri</code> is the relative URL of the page to be sent back to the client. <code>bean</code> is a context object which can be accessed inside this page to extract various values and place them in the generated page.</p>
- <p><code>timeToLive</code> is the time to live for the continuation created.</p>
+ <p><code>timeToLive</code> is the time to live in milliseconds for the continuation created.</p>
<p>The return value is the <link href="#WebContinuation">continuation</link> object.</p>
</s2>
</s1>
@@ -48,31 +48,31 @@
<s3 title="request">
<p>The current Cocoon request:</p>
<p>
- <em>Property</em> <code>[org.apache.cocoon.environment.Request] request</code>
+ <em>Property</em> <code>[<link href="../../../api/java/org/apache/cocoon/environment/Request.html">org.apache.cocoon.environment.Request</link>] request</code>
</p>
</s3>
<s3 title="response">
<p>The current Cocoon response:</p>
<p>
- <em>Property</em> <code>[org.apache.cocoon.environment.Response] response</code>
+ <em>Property</em> <code>[<link href="../../../api/java/org/apache/cocoon/environment/Response.html">org.apache.cocoon.environment.Response</link>] response</code>
</p>
</s3>
<s3 title="session">
<p>The current Cocoon session:</p>
<p>
- <em>Property</em> <code>[org.apache.cocoon.environment.Session] session</code>
+ <em>Property</em> <code>[<link href="../../../api/java/org/apache/cocoon/environment/Session.html">org.apache.cocoon.environment.Session</link>] session</code>
</p>
</s3>
<s3 title="context">
<p>The current Cocoon application context:</p>
<p>
- <em>Property</em> <code>[org.apache.cocoon.environment.Context] context</code>
+ <em>Property</em> <code>[<link href="../../../api/java/org/apache/cocoon/environment/Context.html">org.apache.cocoon.environment.Context</link>] context</code>
</p>
</s3>
<s3 title="environment">
<p>The current Cocoon environment:</p>
<p>
- <em>Property</em> <code>[org.apache.cocoon.environment.Environment] environment</code>
+ <em>Property</em> <code>[<link href="../../../api/java/org/apache/cocoon/environment/Environment.html">org.apache.cocoon.environment.Environment</link>] environment</code>
</p>
</s3>
<s3 title="componentManager">
@@ -84,7 +84,7 @@
<s3 title="parameters">
<p>Any parameters passed to the script by the Sitemap:</p>
<p>
- <em>Property</em> <code>[Array] parameters</code>
+ <em>Property</em> <code>[Array [org.apache.avalon.framework.parameters.Parameters]] parameters</code>
</p>
<p>The <code>cocoon</code> object also provides the following functions:</p>
</s3>
1.6 +1 -1 cocoon-2.1/src/documentation/xdocs/userdocs/flow/sitemap.xml
Index: sitemap.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/sitemap.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- sitemap.xml 25 May 2003 19:25:07 -0000 1.5
+++ sitemap.xml 30 May 2003 15:48:08 -0000 1.6
@@ -12,7 +12,7 @@
<body>
<s1 title="Sitemap">
- <p>The Cocoon sitemap includes several elements to specify interactions with your Flowscripts.</p>
+ <p>The Cocoon sitemap includes two elements to specify interactions with your Flowscripts.</p>
<s2 title="flow">
<p>The <code>flow</code> element defines a Flowscript interpreter for a sitemap. The <code>language</code> attribute specifies the target programming language. Currently the only supported language is <code>"JavaScript"</code>. Its embedded <code>script</code> elements allow you to specify the files that make up the flow for this sitemap. Each <code>script</code> element specifies the URI of a script that will be compiled and executed when this Sitemap is created. The <code>src</code> attribute specifies the URI of the script.</p>
<source><![CDATA[
1.5 +1 -1 cocoon-2.1/src/documentation/xdocs/userdocs/flow/velocity.xml
Index: velocity.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/velocity.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- velocity.xml 25 May 2003 19:25:07 -0000 1.4
+++ velocity.xml 30 May 2003 15:48:08 -0000 1.5
@@ -12,7 +12,7 @@
<body>
<s1 title="Velocity Generator">
<p>
-If called from a Flowscript, the Cocoon <link href="http://jakarta.apache.org/velocity">Velocity</link> Generator provides access to the immediate properties of the context object passed to <code>sendPage</code> and <code>sendPageAndWait</code>. In that case, the current <code>WebContinuation</code> is also available as a variable named <code>$continuation</code>
+If called from a Flowscript, the Cocoon <link href="http://jakarta.apache.org/velocity">Velocity</link> <link href="../generators/velocity-generator.html">Generator</link> provides access to the immediate properties of the context object passed to <code>sendPage</code> and <code>sendPageAndWait</code>. In that case, the current <code>WebContinuation</code> is also available as a variable named <code>$continuation</code>
You would
typically access its <code>id</code>:</p>
<source>