shannon 2002/06/08 05:09:29
Modified: src/documentation/xdocs/userdocs/generators
error-generator.xml
Log:
Clarified some language. Added
consistent style treatment of
elements.
Revision Changes Path
1.2 +19 -23
xml-cocoon2/src/documentation/xdocs/userdocs/generators/error-generator.xml
Index: error-generator.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/error-generator.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- error-generator.xml 3 Jan 2002 12:31:04 -0000 1.1
+++ error-generator.xml 8 Jun 2002 12:09:29 -0000 1.2
@@ -15,13 +15,9 @@
<s1 title="Error Generator">
<p>
The error generator creates xml content describing an error condition.
- This generator is activated by the sitemap manager in case of an
- error condition.
- </p>
- <p>
- If a pipeline has defined an error handler, and an error occurs the
- sitemap manager activates an error generator, feeding the cause of
- the error into the error generator.
+ When an error occurs in a pipeline with a defined an error handler, the
+ sitemap manager activates the error generator, feeding it the cause of
+ the error.
</p>
<ul>
<li>Name : !error-notifier!</li>
@@ -32,43 +28,43 @@
</s1>
<s1 title="DTD">
<p>
- The error generator generates xml content, having
- namespace <code>http://apache.org/cocoon/error/2.0</code>, and
- prefix <code>error</code>.
+ XML generated by error generator uses the
+ namespace <code>http://apache.org/cocoon/error/2.0</code> and
+ the <code>error</code> prefix.
</p>
<p>
- Usually the error condition is described by an throwable object.
+ Usually the error condition is described by a throwable object.
The information of this throwable object is used by the
- error generator producing the xml content.
- The various elements of the xml content:
+ error generator to produce the xml content.
+ The various elements of the xml content include the following.
</p>
<ul>
<li>
- The element <code>notify</code> is the root element, having.
- attribute <code>type</code>, and <code>sender</code>.
+ The element <code>notify</code> is the root element, having
+ attributes <code>type</code> and <code>sender</code>.
The attribute <code>type</code> has fixed value <code>error</code>.
The attribute <code>sender</code> describes the sender of the
- error notification object, in the current implementation it has
+ error notification object. In the current implementation, it has
fixed value <code>org.apache.cocoon.sitemap.ErrorNotifier</code>.
</li>
<li>
- The element <code>title</code> stores some title of this eror notification.
- In the current implementation it has fixed value <code>Cocoon error</code>.
+ The element <code>title</code> stores the title of the eror notification.
+ In the current implementation, it has fixed value <code>Cocoon error</code>.
</li>
<li>
- The source element stores the class name of the throwable object
+ The <code>source</code> element stores the class name of the throwable object
of the error notification.
</li>
<li>
- The message element stores the <code>getMessage()</code> result
- of the throwable object of the error notification, and maybe empty.
+ The <code>message</code> element stores the <code>getMessage()</code> result
+ of the throwable object of the error notification, and may be empty.
</li>
<li>
- The description element stores the <code>toString()</code> result
+ The <code>description</code> element stores the <code>toString()</code> result
of the throwable object of the error notification.
</li>
<li>
- The optional extra elements stores optional nested exceptions
+ Optional <code>extra</code> elements stores nested exceptions
of the throwable object of the error notification.
</li>
</ul>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
