[Checkins] SVN: zope.testrecorder/trunk/INSTALL.txt attempt at improving installation docs

Philipp von Weitershausen philikon at philikon.de
Thu Jun 22 17:44:13 EDT 2006


Log message for revision 68796:
  attempt at improving installation docs
  

Changed:
  U   zope.testrecorder/trunk/INSTALL.txt

-=-
Modified: zope.testrecorder/trunk/INSTALL.txt
===================================================================
--- zope.testrecorder/trunk/INSTALL.txt	2006-06-22 21:38:28 UTC (rev 68795)
+++ zope.testrecorder/trunk/INSTALL.txt	2006-06-22 21:44:13 UTC (rev 68796)
@@ -4,23 +4,32 @@
 This package is designed to be deployable in Zope 2 or Zope 3
 applications.
 
-For a Zope 2 system, drop this package into the products directory of
-the Zope instance and restart the instance.  After restart, it will be
-possible to add a ``Test Recorder`` object in the ZMI.  The Test
-Recorder Zope object mainly provides the ability to traverse to the
-html and .js files that make up the recorder.
 
-In a Zope 3 or Five system, you only need to register the ``html``
-directory of this package as a ``resourceDirectory`` using ZCML.  The
-following example ZCML directive will register the test recorder
-resources and make them available through a resource URL such as
-'/@@/recorder/index.html'.
+Zope 2
+------
 
-    <browser:resourceDirectory
-      name="recorder"
-      directory="html"
-      layer="default"
-      />
+For a Zope 2 system, drop the ``zope/testrecorder`` directory into the
+``Products`` directory of the Zope instance and restart the instance.
+After restart, it will be possible to add a ``Test Recorder`` object
+in the ZMI.  The Test Recorder Zope object mainly provides the ability
+to traverse to the ``.html`` and ``.js`` files that make up the
+recorder.
 
 
-Needs more docs.
+Zope 3
+------
+
+In a Zope 3 or Five environment, you can install the
+``zope.testrecorder`` as an additional package into your instance's
+``lib/python`` directory.  Then you only need to load the
+testrecorder's ZCML, by adding the following line to your
+``site.zcml``:
+
+  <include package="zope.testrecorder" />
+
+Alternatively, you can put this line into a separate
+``zope.testrecorder-configure.zcml`` file within your instance's
+``package-includes`` directory.  After restarting your instance, the
+testrecorder will be available through a resource URL,
+e.g. http://localhost:8080/@@/recorder/index.html (Zope 3) or
+http://localhost:8080/++resource++recorder/index.html (Five).



More information about the Checkins mailing list