haul 2003/03/01 07:56:56
Modified: src/webapp/WEB-INF cocoon.xconf
Log:
add comments
Revision Changes Path
1.67 +39 -23 xml-cocoon2/src/webapp/WEB-INF/cocoon.xconf
Index: cocoon.xconf
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/webapp/WEB-INF/cocoon.xconf,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -r1.66 -r1.67
--- cocoon.xconf 1 Mar 2003 13:35:53 -0000 1.66
+++ cocoon.xconf 1 Mar 2003 15:56:56 -0000 1.67
@@ -108,18 +108,29 @@
<!-- =================== Sitemap Input/Output Modules ====================== -->
<!--+
- |
- |
- |
- |
- |
- | ????
- |
- |
- |
- |
- |
- |
+ | InputModules are a replacement to reading values directly
+ | e.g. from request parameters. By using this abstraction and
+ | indirection, other components can be more generic and changes
+ | to the application logic are easier.
+ |
+ | A number of components already use InputModules: the sitemap processor,
+ | flow, some matchers, the linkrewriting transformer, database actions
+ | and more.
+ |
+ | For example the sitemap processor allows to obtain a value
+ | named "foo" from an the InputModule for request parameters by
+ | writing {request-param:foo} wherever a sitemap variable is
+ | allowed.
+ |
+ | Some InputModules need the help of other InputModules to
+ | obtain values and only apply a function to the obtained value
+ | or change the name of the attribute. These modules usually
+ | carry "Meta" in their name. An example is the ChainMetaModule
+ | which tries several other modules in turn until a non-null
+ | value is obtained or all modules are tied.
+ |
+ | For details and optional configuration parameters refer to the
+ | accompanying javadocs.
+-->
<input-modules>
<component-instance logger="core.modules.input" name="global"
class="org.apache.cocoon.components.modules.input.GlobalInputModule"/>
@@ -154,18 +165,23 @@
</input-modules>
<!--+
+ | OutputModules are companion modules for InputModules.
|
- |
- |
- |
- |
- | ????
- |
- |
- |
- |
- |
- |
+ | The same principles apply here, only that OutputModules allow
+ | writing data to places. Apparently, there are a lot less
+ | places to write to than to read data from, thus there are only
+ | a few OutputModules coming with Apache Cocoon.
+ |
+ | One special feature of OutputModules is, that they expose some
+ | limited transactional behaviour. Hence it does not suffice to
+ | write a value, but it is required to confirm this at the
+ | end. Until then, the value could not be read from the
+ | corresponding InputModule. This behaviour is not enfored but
+ | it should be expected. Omitting a commit or rollback is an
+ | error.
+ |
+ | OutputModules are currently used by flow, a number of actions
+ | and transformers.
+-->
<output-modules>
<component-instance logger="core.modules.output" name="request-attr"
class="org.apache.cocoon.components.modules.output.RequestAttributeOutputModule"/>
