cziegeler 2002/07/02 02:07:56
Modified: src/documentation/xdocs Tag: cocoon_2_0_3_branch who.xml
src/documentation/xdocs/developing Tag: cocoon_2_0_3_branch
book.xml
src/documentation/xdocs/developing/webapps Tag:
cocoon_2_0_3_branch authentication.xml sunrise.xml
src/documentation/xdocs/plan Tag: cocoon_2_0_3_branch
release.xml
Log:
Syncing docs
Revision Changes Path
No revision
No revision
1.2.2.9 +1 -1 xml-cocoon2/src/documentation/xdocs/who.xml
Index: who.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/who.xml,v
retrieving revision 1.2.2.8
retrieving revision 1.2.2.9
diff -u -r1.2.2.8 -r1.2.2.9
--- who.xml 24 Jun 2002 06:44:52 -0000 1.2.2.8
+++ who.xml 2 Jul 2002 09:07:56 -0000 1.2.2.9
@@ -42,6 +42,7 @@
<li>Vadim Gritsenko ([EMAIL PROTECTED])</li>
<li>Christian Haul ([EMAIL PROTECTED])</li>
<li>Ivelin Ivanov ([EMAIL PROTECTED])</li>
+ <li>Stefano Mazzocchi ([EMAIL PROTECTED])</li>
<li>Stephan Michels ([EMAIL PROTECTED])</li>
<li>John Morrison ([EMAIL PROTECTED])</li>
<li>Konstantin Piroumian ([EMAIL PROTECTED])</li>
@@ -65,7 +66,6 @@
<li>Bernhard Huber ([EMAIL PROTECTED])</li>
<li>Berin Loritsch ([EMAIL PROTECTED])</li>
<li>Martin Man ([EMAIL PROTECTED])</li>
- <li>Stefano Mazzocchi ([EMAIL PROTECTED])</li>
<li>Giacomo Pati ([EMAIL PROTECTED])</li>
<li>Peter Royal ([EMAIL PROTECTED])</li>
</ul>
No revision
No revision
1.5.2.5 +2 -2 xml-cocoon2/src/documentation/xdocs/developing/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/developing/book.xml,v
retrieving revision 1.5.2.4
retrieving revision 1.5.2.5
diff -u -r1.5.2.4 -r1.5.2.5
--- book.xml 14 Jun 2002 07:12:53 -0000 1.5.2.4
+++ book.xml 2 Jul 2002 09:07:56 -0000 1.5.2.5
@@ -10,8 +10,8 @@
</menu>
<menu label="Concepts">
- <menu-item label="Flow" href="httprequest.html"/>
- <menu-item label="Extending C2" href="extending.html"/>
+ <menu-item label="Internals" href="httprequest.html"/>
+ <menu-item label="Extending" href="extending.html"/>
<menu-item label="Avalon" href="avalon.html"/>
<menu-item label="Using Databases" href="datasources.html"/>
<menu-item label="Parent CM" href="parent-component-manager.html"/>
No revision
No revision
1.1.2.2 +19 -18
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.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- authentication.xml 14 Jun 2002 07:12:54 -0000 1.1.2.1
+++ authentication.xml 2 Jul 2002 09:07:56 -0000 1.1.2.2
@@ -9,7 +9,7 @@
</header>
<body>
<s1 title="Introduction">
- <note><strong>IMPORTANT:</strong> This document conforms to the development
version of Cocoon. So
+ <note>IMPORTANT: This document conforms to the development version of Cocoon. So
you will only find these components in the current CVS. An early alpha
version is already
available in the latest release of Cocoon, you will find an introduction
<link href="sunrise.html">here</link>.
</note>
@@ -122,8 +122,8 @@
<source><map:match pattern="login">
<map:act type="auth-login">
<map:parameter name="handler" value="unique"/>
- <map:parameter name="parameter_userid" value="request:name"/>
- <map:parameter name="parameter_password" value="request:password"/>
+ <map:parameter name="parameter_userid" value="{request:name}"/>
+ <map:parameter name="parameter_password" value="{request:password}"/>
<map:redirect-to uri="authentication-successful"/>
</map:act>
<!-- authentication failed: -->
@@ -131,15 +131,16 @@
<map:transform src="tohtml.xsl"/>
<map:serialize/>
</map:match></source>
- <p>The "auth-protect" action uses the handler parameter to call the
+ <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 starts with "parameter_". So in the
example
+ parameter is created which name starting 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 auth-login action will pass the actual value of that
request
- parameter to the authentication resource.</p>
+ 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
the authentication resource and passes it the parameters. If this
authentication is successful, the action returns an empty map and the
sitemap
@@ -217,11 +218,11 @@
in the subsitemap are then simply protected in the same way as if the
action
were declared in the main sitemap. This makes moving resources from one
sitemap
to the other very simple.</p>
- <p><Strong>However, there is one drawback with this solution. After
+ <p><strong>However, there is one drawback with this solution. After
you have started your server, make sure that first a resource using the
framework
- from the main sitemap is invoked, before any of the
subsitemap!</Strong></p>
- <p><Strong>The definition of handlers in a sub-sitemap is a TODO and will be
- available in the next release.</Strong></p>
+ from the main sitemap is invoked, before any of the
subsitemap!</strong></p>
+ <p><strong>The definition of handlers in a sub-sitemap is a TODO and will be
+ available in the next release.</strong></p>
</s2>
</s1>
<s1 title="User Management">
@@ -413,16 +414,16 @@
about the available users is needed. There are three different uses of
this
resource:</p>
<ul>
- <il>Loading all users: The resource gets the parameter "type"
+ <li>Loading all users: The resource gets the parameter "type"
with the value "users". It should then deliver all users in the system.
- </il>
- <il>Loading all users of one role. The resource gets the
+ </li>
+ <li>Loading all users of one role. The resource gets the
parameters "type" with the value "users" and "role" with the rolename.
- </il>
- <il>Load information of one user. The resource gets the
+ </li>
+ <li>Load information of one user. The resource gets the
parameters "type" with the value "user", "role" with the rolename and
"ID" with
the authentication ID of the user.
- </il>
+ </li>
</ul>
<p>The XML format of the resource should look like the
following:</p>
1.1.2.2 +35 -35
xml-cocoon2/src/documentation/xdocs/developing/webapps/sunrise.xml
Index: sunrise.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/developing/webapps/sunrise.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- sunrise.xml 14 Jun 2002 07:12:54 -0000 1.1.2.1
+++ sunrise.xml 2 Jul 2002 09:07:56 -0000 1.1.2.2
@@ -23,12 +23,12 @@
management/authentication system.</p>
</s1>
<s1 title="Sitemap-Components">
- <p>sunRise adds some actions to the sitemap: the <en>sunRise-auth</en>
- action, the <en>sunRise-login</en> action, the <en>sunRise-logout</en>
action
- and the <en>sunRise-loggedIn</en> action. The <en>sunRise-auth</en> action
gets
+ <p>sunRise adds some actions to the sitemap: the <em>sunRise-auth</em>
+ action, the <em>sunRise-login</em> action, the <em>sunRise-logout</em>
action
+ and the <em>sunRise-loggedIn</em> action. The <em>sunRise-auth</em> action
gets
the configuration for sunRise and controlles the pipelines. The
- <en>sunRise-login</en> and the <en>sunRise-logout</en> action control the
- authentication the <en>sunRiseLoggedIn</en> action controlles the
application
+ <em>sunRise-login</em> and the <em>sunRise-logout</em> action control the
+ authentication the <em>sunRiseLoggedIn</em> action controlles the
application
flow.</p>
<p>The use of sunRise and its components is described in the following
chapters.</p>
@@ -117,7 +117,7 @@
<p>This redirect-to resource is an unprotected resource in the
sitemap. For tracking which resource was requested, the redirect-to
resource
gets the request parameter "resource" with the value. In addition all
- parameters specified inside the <en>redirect-to</en> tag of the handler
+ parameters specified inside the <em>redirect-to</em> tag of the handler
configuration are passed to the resource.</p>
<p>This redirect-to resource can contain a form for the user
authentication. This form should invoke the real login resource which is
@@ -179,8 +179,8 @@
</action></source>
<p>If the authentication resource is a sitemap resource or a remote
resource, this resource is requested by sunRise with the given parameters
from
- the <en>sunRise-login</en> action (see previous chapter: parameters:
userid and
- password). In addition all parameters inside the <en>authentication</en>
tag of
+ the <em>sunRise-login</em> action (see previous chapter: parameters:
userid and
+ password). In addition all parameters inside the <em>authentication</em>
tag of
the handler configuration are passed to the resource. The response for
this
resource must contain valid XML conforming to the following scheme:</p>
<source><authentication>
@@ -222,9 +222,9 @@
in the subsitemap are then simply protected in the same way as if the
action
were declared in the main sitemap. This makes moving resources from one
sitemap
to the other very simple.</p>
- <p><Strong>However, there is one drawback with this solution. After
+ <p><strong>However, there is one drawback with this solution. After
you have started your server, make sure that first a resource using
sunRise
- from the main sitemap is invoked, before any of the
subsitemap!</Strong></p>
+ from the main sitemap is invoked, before any of the
subsitemap!</strong></p>
</s2>
</s1>
@@ -400,7 +400,7 @@
<url>db:usertable</url>
</delete-user></source>
<s2 title="Getting Roles">
- <p>The <en>load-roles</en> resource is invoked from sunRise whenever
+ <p>The <em>load-roles</em> resource is invoked from sunRise whenever
it needs information about the available roles. This resource gets the
parameter "type" with the value "roles" and should deliver an XML schema
with
the root node "roles" and for each role a subelement "role" with a text
child
@@ -412,20 +412,20 @@
</roles></source>
</s2>
<s2 title="Getting Users">
- <p>The <en>load-users</en> resource is called whenever information
+ <p>The <em>load-users</em> resource is called whenever information
about the available users is needed. There are three different uses of
this
resource:</p>
<ul>
- <il>Loading all users: The resource gets the parameter "type"
+ <li>Loading all users: The resource gets the parameter "type"
with the value "users". It should then deliver all users in the system.
- </il>
- <il>Loading all users of one role. The resource gets the
+ </li>
+ <li>Loading all users of one role. The resource gets the
parameters "type" with the value "users" and "role" with the rolename.
- </il>
- <il>Load information of one user. The resource gets the
+ </li>
+ <li>Load information of one user. The resource gets the
parameters "type" with the value "user", "role" with the rolename and
"ID" with
the sunRise ID of the user.
- </il>
+ </li>
</ul>
<p>The XML format of the resource should look like the
following:</p>
@@ -442,19 +442,19 @@
</users></source>
</s2>
<s2 title="Creating a new role">
- <p>The <en>new-role</en> resource creates a new role in the system. It
+ <p>The <em>new-role</em> resource creates a new role in the system. It
gets the parameters "type" with the value "role" and "role" with the new
rolename.</p>
</s2>
<s2 title="Creating a new user">
- <p>The <en>new-user</en> resource creates a new user with a role. It
- gets the parameters <en>"type"</en> with the value <en>"user"</en>,
- <en>"role"</en> with the rolename and <en>"ID"</en> with the new ID for
this
+ <p>The <em>new-user</em> resource creates a new user with a role. It
+ gets the parameters <em>"type"</em> with the value <em>"user"</em>,
+ <em>"role"</em> with the rolename and <em>"ID"</em> with the new ID for
this
user.</p>
<p>The sunrise transformer offers a tag to create a newuser:
- <en>"adduser"</en>. The input for this element is all information needed
to add
+ <em>"adduser"</em>. The input for this element is all information needed
to add
a user including the ID and the role. All these values are then passed on
to
- the <en>"new-user"</en> resource:</p>
+ the <em>"new-user"</em> resource:</p>
<source><adduser>
<ID>New ID for this user</ID>
<role>The role</role>
@@ -466,9 +466,9 @@
...
</adduser></source>
<p>In the example above a sunRise tries to create a new user with the
- given <en>"ID"</en> and <en>"role"</en>. The <en>"new-user"</en> resource
gets
- also the parameters <en>"firstname"</en> and <en>"lastname"</en> with the
- values <en>"X"</en> and <en>"Y"</en>.</p>
+ given <em>"ID"</em> and <em>"role"</em>. The <em>"new-user"</em> resource
gets
+ also the parameters <em>"firstname"</em> and <em>"lastname"</em> with the
+ values <em>"X"</em> and <em>"Y"</em>.</p>
<p>If no user with this ID exists the "sunrise:adduser" element is
replaced with the element "success". Inside this element all the values
are
repeated inside the "values" element:</p>
@@ -503,18 +503,18 @@
</error></source>
</s2>
<s2 title="Changing information of a user">
- <p>The <en>change-user</en> resources changes information of a user.
+ <p>The <em>change-user</em> resources changes information of a user.
It gets the parameters "type" with the value "user", "role" with the
rolename
and "ID" with the ID of the user. In addition all - application specific -
information of this user is send as parameters.</p>
</s2>
<s2 title="Delete a user">
- <p>The <en>delete-user</en> resource should delete a user. It gets the
+ <p>The <em>delete-user</em> resource should delete a user. It gets the
parameters "type" with the value "user", "role" with the rolename and
"ID" with
the ID of the user.</p>
</s2>
<s2 title="Delete a role">
- <p>The <en>delete-role</en> resources deletes a role. It gets the
+ <p>The <em>delete-role</em> resources deletes a role. It gets the
parameters "type" with the value "role" and "role" with the rolename .</p>
</s2>
</s1>
@@ -627,9 +627,9 @@
</s2>
<s2 title="Controlling the Application Flow">
<p>If you want to create resources which behave different wheather you
- are logged in or not, the <en>sunRiseLoggedIn</en> action is the
component to
+ are logged in or not, the <em>sunRiseLoggedIn</em> action is the
component to
controll your application flow. This action checks if the user is
authenticated
- for a given handler and calls all sitemap components inside the
<en>act</en>
+ for a given handler and calls all sitemap components inside the
<em>act</em>
tag.</p>
<source><map:match pattern="startpage">
@@ -644,10 +644,10 @@
<map:serialize/>
</map:match></source>
<p>In the example above, if the user is already logged he is
- redirected to the <en>loggedInStartPage</en> resource. If he is not
logged in
+ redirected to the <em>loggedInStartPage</em> resource. If he is not
logged in
for the given handler, the usual start page is generated.</p>
- <p>Both actions, the <en>sunRise-auth</en> and the
- <en>sunRise-loggedIn</en> action return - if the user is logged in for the
+ <p>Both actions, the <em>sunRise-auth</em> and the
+ <em>sunRise-loggedIn</em> action return - if the user is logged in for the
given handler - all values from the context to the sitemap, e.g. ID, role
etc.
These values can be used within the other components:</p>
<source><map:match pattern"protected">
No revision
No revision
1.1.2.5 +2 -2 xml-cocoon2/src/documentation/xdocs/plan/release.xml
Index: release.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/release.xml,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -u -r1.1.2.4 -r1.1.2.5
--- release.xml 1 Jul 2002 10:07:24 -0000 1.1.2.4
+++ release.xml 2 Jul 2002 09:07:56 -0000 1.1.2.5
@@ -15,8 +15,8 @@
<s1 title="Timeframe">
<p>This is the current time frame for the next releases:</p>
<ul>
- <li> 1st of July : Release date for 2.0.3 (bug fix release)</li>
- <li>15th of July : Release date for 2.1 Beta 1</li>
+ <li>July/August 2002 : Release date for 2.0.3 (bug fix release)</li>
+ <li>Summer 2002 : Release date for 2.1 Alpha 1</li>
</ul>
</s1>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
