Author: rgardler
Date: Sun Dec 3 19:18:20 2006
New Revision: 482026
URL: http://svn.apache.org/viewvc?view=rev&rev=482026
Log:
Some very basic docs about debugging a content object. Much more flesh needed
here, but it will serve as a reminder.
Added:
forrest/trunk/whiteboard/forrest2/core/src/docs/debugging.html
Added: forrest/trunk/whiteboard/forrest2/core/src/docs/debugging.html
URL:
http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/docs/debugging.html?view=auto&rev=482026
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/docs/debugging.html (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/docs/debugging.html Sun Dec 3
19:18:20 2006
@@ -0,0 +1,36 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Debugging Forrest2 Content Objects</title>
+</head>
+<body>
+ <h1>Debugging Content Objects</h1>
+
+ <p>Forrest2 provides some special url extensions that
+ allow a Content Object developer to debug the processing
+ a request undergoes. This document provides an overview
+ of these extensions.</p>
+
+ <p>In all cases you simply add the extension to the request
+ URL you are working with.</p>
+
+ <h2>.forrestPipeline</h2>
+
+ <p>A request with this extension will return an XML
+ representation of the pipeline executed in order to
+ create the document request.</p>
+
+ <h2>.forrestSource</h2>
+
+ <p>A request with this extension will return the source
+ document read by Forrest2.</p>
+
+ <h2>.forrestInternal</h2>
+
+ <p>A request with this extension will return the
+ document produced when Forrest has finished processing the
+ source with the relevant internal plugins.</p>
+
+</body>
+</html>
\ No newline at end of file
