cziegeler 2002/07/05 02:08:27 Modified: src/documentation/xdocs/developing/webapps Tag: cocoon_2_0_3_branch authentication.xml src/documentation/xdocs/installing Tag: cocoon_2_0_3_branch index.xml Log: Synced docs Revision Changes Path No revision No revision 1.1.2.3 +6 -4 xml-cocoon2/src/documentation/xdocs/developing/webapps/authentication.xml Index: authentication.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/developing/webapps/authentication.xml,v retrieving revision 1.1.2.2 retrieving revision 1.1.2.3 diff -u -r1.1.2.2 -r1.1.2.3 --- authentication.xml 2 Jul 2002 09:07:56 -0000 1.1.2.2 +++ authentication.xml 5 Jul 2002 09:08:27 -0000 1.1.2.3 @@ -134,20 +134,22 @@ <p>The <em>auth-login</em> action uses the handler parameter to call the authentication resource of this handler. This authentication resource needs to know the information provided by the user. For each piece of information an own - parameter is created which name starting with "parameter_". So in the example + parameter is created which name starts with "parameter_". So in the example above, the authentication resource gets two parameters: userid and password. As the values for these parameters were send by a form they need to be passed on to the authentication resource. If you use "{request:...}" for the value of a parameter, the <em>auth-login</em> action will pass the actual value of that request parameter to the authentication resource (by using the input modules concept of Cocoon).</p> - <p>If the user is not authenticated with this handler, the framework calls + <p>If the user is not already authenticated with this handler, the framework calls the authentication resource and passes it the parameters. If this - authentication is successful, the action returns an empty map and the sitemap + authentication is successful, the action returns a map and the sitemap commands inside the map:act are executed. If the authentication fails, these are skipped.</p> <p>If the authentication is successful, a session object is created on - the server (if not already done). </p> + the server (if not already done). If the authentication fails, the error + information delivered by the authentication resource is stored into the + <em>temporary</em> context (which is named simply 'temp').</p> </s2> <s2 title="The authentication resource"> <p>The last chapters described the authentication process but left out No revision No revision 1.18.2.8 +39 -5 xml-cocoon2/src/documentation/xdocs/installing/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/installing/index.xml,v retrieving revision 1.18.2.7 retrieving revision 1.18.2.8 diff -u -r1.18.2.7 -r1.18.2.8 --- index.xml 26 Jun 2002 02:14:56 -0000 1.18.2.7 +++ index.xml 5 Jul 2002 09:08:27 -0000 1.18.2.8 @@ -229,7 +229,7 @@ </s1> <s1 title="Building Cocoon"> - <p>If you downloaded binary distriution of the Cocoon, you can + <p>If you downloaded the binary distribution of Cocoon, you can skip this chapter and proceed to the "Installing Cocoon". </p> @@ -274,7 +274,7 @@ </p> <p> A library/package is available to the build process when it is located - in the <code>./lib/optional</code> directory. + in the <code>./lib/optional</code> or the <code>./lib/local</code> directory. </p> <p> The following table contains a list of the optional components, @@ -313,11 +313,22 @@ <td>No</td> </tr> </table> - <p><strong>Note:</strong> If you added a library/package, you + <p>If you want to add additional libraries, put them in the <code>./lib/local</code> + directory as this directory is not touched by CVS. + <strong>Note:</strong> If you added a library/package, you need to rebuild Cocoon as described in 'Create the Cocoon WAR package'. </p> </s2> - + <s2 title="Building a minimal Cocoon"> + <p>If you want to build a minimal Cocoon, simply remove all optional libraries + from the <code>./lib/local</code> and the <code>./lib/optional</code> directory. + Make a <code>build clean</code> and then a build with the target you want. + However, if you want to build a web application make sure you leave the + <code>servlet.jar</code> in the <code>./lib/optional</code> directory. + </p> + <p><strong>Note:</strong>This feature is only available in the latest developer + version of Cocoon which you can find in the CVS. </p> + </s2> <s2 title="Running the build"> <p>Cocoon uses <link href="http://jakarta.apache.org/ant/">Jakarta Ant</link> for the build and installation, and comes with a build script @@ -367,6 +378,8 @@ <p>Cocoon targets place work files and results in a build directory under the cocoon root. The only exception are the distribution targets that build in a directory called dist.</p> + <p>The target you will most use is propably the <strong>webapp</strong> + target which builds a Cocoon web application. For more information see below.</p> <s4 title="build all"> <p>Builds all main Cocoon targets to create the <strong>cocoon.jar</strong> @@ -502,7 +515,9 @@ </s4> <s4 title="build dist"> - <p>Creates source and binary distributions of Cocoon. + <p>Creates source and binary distributions of Cocoon. This target + is not intented for the usual Cocoon user; it's primary used + by the Cocoon developers to create a new distribution. </p> <ul> @@ -534,6 +549,25 @@ <p>this will create the <code>cocoon.war</code> file in the <code>./build/cocoon</code> directory. Follow instructions in the next chapter to deploy this webapp in your container.</p> + <p>If you want a "clean" web application, you can specify these optional + properties:</p> + <ul> + <li>exclude.webapp.samples : to exclude the samples</li> + <li>exclude.webapp.documentation : to exclude the documentation</li> + <li>exclude.webapp.javadocs : to exclude the java docs</li> + </ul> + <p>So, if you first remove all libraries from the <code>./lib/local</code> + and the <code>./lib/optional</code> directory except the <code>servlet.jar</code> + and then type:</p> +<source> +[unix] ./build.sh -Dinclude.webapp.libs=yes -Dexclude.webapp.samples=yes + -Dexclude.webapp.documenation=yes -Dexclude.webapp.javadocs=yes webapp +[win32] .\build.bat -Dinclude.webapp.libs=yes -Dexclude.webapp.samples=yes + -Dexclude.webapp.documenation=yes -Dexclude.webapp.javadocs=yes webapp</source> + <p>you get a minimal Cocoon web application without any samples or documentation. + But remember to make a <code>build clean</code> beforehand.</p> + <p><strong>Note:</strong>This feature is only available in the latest developer + version of Cocoon which you can find in the CVS. </p> </s4> <s4 title="[BETA] build scratchpad">
---------------------------------------------------------------------- In case of troubles, e-mail: [EMAIL PROTECTED] To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]