dion 02/01/20 05:36:06 Modified: latka/doc index.xml Log: Added DTD for DocBook XML V4.1.2 and fixed various validation issues Revision Changes Path 1.6 +75 -51 jakarta-commons/latka/doc/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/jakarta-commons/latka/doc/index.xml,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- index.xml 20 Jan 2002 12:30:33 -0000 1.5 +++ index.xml 20 Jan 2002 13:36:06 -0000 1.6 @@ -1,7 +1,11 @@ <?xml version="1.0"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";> + + <!-- Author: Morgan Delagrange - Version: $Id: index.xml,v 1.5 2002/01/20 12:30:33 dion Exp $ + Version: $Id: index.xml,v 1.6 2002/01/20 13:36:06 dion Exp $ --> <chapter id="latka"> <title>Latka (Version 1.0 Alpha 2)</title> @@ -31,14 +35,16 @@ <section> <title>Requirements</title> <itemizedlist> - <listitem>JDK 1.3 or better</listitem> - <listitem> + <listitem><para>JDK 1.3 or better</para></listitem> + <listitem><para> (for optional web application) - Tomcat 4.0 B7 or better - does not work in Tomcat 3.2, untested in other containers + Tomcat 4.0 B7 or better - does not work in Tomcat 3.2, untested in + other containers</para> </listitem> - <listitem> + <listitem><para> (for optional SSL support) <ulink url="http://java.sun.com/security/index.html";>Sun JSSE library</ulink> + </para> </listitem> </itemizedlist> </section> @@ -46,14 +52,16 @@ <section> <title>General installation</title> <orderedlist> - <listitem> + <listitem><para> Download and uncompress the <ulink url="http://jakarta.apache.org/builds/jakarta-commons/release/commons-latka";>Latka distribution</ulink>. + </para> </listitem> - <listitem> + <listitem><para> If you wish to perform Latka test over SSL, you need to configure your JVM with the <ulink url="http://java.sun.com/security/index.html";>Sun JSSE library</ulink>. + </para> </listitem> </orderedlist> </section> @@ -61,14 +69,14 @@ <section> <title>Optional web application installation </title> <orderedlist> - <listitem> + <listitem><para> Copy the "webapp/latka-webapp.war" file from the - distribution to the "webapp" directory of Tomcat. + distribution to the "webapp" directory of Tomcat.</para> </listitem> - <listitem> + <listitem><para> If you have already configured log4j for Tomcat, you should remove log4j.jar from the /WEB-INF/lib - directory of the Latka webapp. + directory of the Latka webapp. </para> </listitem> </orderedlist> </section> @@ -82,23 +90,32 @@ <remark>Command-line interface</remark> <orderedlist> - <listitem>Open a command prompt inside the "bin" directory of the distribution.</listitem> <listitem> + <para>Open a command prompt inside the "bin" directory of the distribution. + </para> + </listitem> + <listitem><para> Run the Latka batch script on one of the sample XML test suites (e.g. "latka file:../tests/samples/TestCommonsWebsite.xml "). + </para> </listitem> </orderedlist> <remark>Web application</remark> <orderedlist> - <listitem>Go to the index page of the Latka web application.</listitem> - <listitem>Select "Run a test from the server" </listitem> - <listitem> + <listitem><para> + Go to the index page of the Latka web application.</para> + </listitem> + <listitem><para>Select "Run a test from the server"</para></listitem> + <listitem><para> In the test directory dialog box, enter the directory: <latka distrubution directory>/tests/samples + </para> + </listitem> + <listitem><para> + Click on one of the tests to execute it.</para> </listitem> - <listitem>Click on one of the tests to execute it. </listitem> </orderedlist> </section> <section> @@ -114,21 +131,29 @@ <remark>Command-line interface</remark> <orderedlist> - <listitem>Open a command prompt inside the "bin" directory of the distribution. </listitem> + <listitem><para> + Open a command prompt inside the "bin" directory of the distribution. + </para> + </listitem> <listitem> + <para> Run the Latka script with no arguments for information on usage. + </para> </listitem> </orderedlist> <remark>Web application</remark> <orderedlist> - <listitem>Go to the index page of the Latka web application. </listitem> - <listitem>Select "Run a test from the server" </listitem> <listitem> + <para>Go to the index page of the Latka web application.</para> + </listitem> + <listitem><para>Select "Run a test from the server"</para></listitem> + <listitem><para> In the test directory dialog box, enter the directory where your tests are located. + </para> </listitem> - <listitem>Click on one of the tests to execute it. </listitem> + <listitem><para>Click on one of the tests to execute it.</para></listitem> </orderedlist> </section> @@ -209,7 +234,7 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.validate"/></sgmltag></member> + <member><xref linkend="latka.ref.validate"/></member> </simplelist> </section> <section> @@ -289,7 +314,7 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.validate"/></sgmltag></member> + <member><xref linkend="latka.ref.validate"/></member> </simplelist> </section> <section> @@ -352,7 +377,7 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.request"/></sgmltag></member> + <member><xref linkend="latka.ref.request"/></member> </simplelist> </section> <section> @@ -419,7 +444,7 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.validate"/></sgmltag></member> + <member><xref linkend="latka.ref.validate"/></member> </simplelist> </section> <section> @@ -449,13 +474,13 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.request"/></sgmltag></member> + <member><xref linkend="latka.ref.request"/></member> </simplelist> </section> <section> <title>Description</title> <para> - A parameter to be submitted as part of a <sgmltag><xref linkend="latka.ref.request"/></sgmltag>. + A parameter to be submitted as part of a <xref linkend="latka.ref.request"/>. </para> </section> </section> @@ -477,14 +502,14 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.param"/></sgmltag></member> + <member><xref linkend="latka.ref.param"/></member> </simplelist> </section> <section> <title>Description</title> <para> - The name part of <sgmltag><xref linkend="latka.ref.param"/></sgmltag> - to be submitted as part of a <sgmltag><xref linkend="latka.ref.request"/></sgmltag>. + The name part of <xref linkend="latka.ref.param"/> + to be submitted as part of a <xref linkend="latka.ref.request"/>. </para> </section> </section> @@ -506,14 +531,14 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.param"/></sgmltag></member> + <member><xref linkend="latka.ref.param"/></member> </simplelist> </section> <section> <title>Description</title> <para> - The value part of <sgmltag><xref linkend="latka.ref.param"/></sgmltag> - to be submitted as part of a <sgmltag><xref linkend="latka.ref.request"/></sgmltag>. + The value part of <xref linkend="latka.ref.param"/> + to be submitted as part of a <xref linkend="latka.ref.request"/>. </para> </section> </section> @@ -609,7 +634,7 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.validate"/></sgmltag></member> + <member><xref linkend="latka.ref.validate"/></member> </simplelist> </section> <section> @@ -681,7 +706,7 @@ <entry> Host to submit request to. Optional. - When absent, uses default from <sgmltag><xref linkend="latka.ref.suite"/></sgmltag>. + When absent, uses default from <xref linkend="latka.ref.suite"/>. </entry> </row> <row> @@ -691,7 +716,7 @@ <entry> Port to submit request to. Optional. - When absent, uses default from <sgmltag><xref linkend="latka.ref.suite"/></sgmltag>. + When absent, uses default from <xref linkend="latka.ref.suite"/>. </entry> </row> <row> @@ -712,8 +737,8 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.suite"/></sgmltag></member> - <member><sgmltag><xref linkend="latka.ref.session"/></sgmltag></member> + <member><xref linkend="latka.ref.suite"/></member> + <member><xref linkend="latka.ref.session"/></member> </simplelist> </section> <section> @@ -729,7 +754,7 @@ <title>session</title> - <para>wrapper for a sequence of <sgmltag><xref linkend="latka.ref.request"/></sgmltag>s associated with the same state (session)</para> + <para>wrapper for a sequence of <xref linkend="latka.ref.request"/>s associated with the same state (session)</para> <section> <title>DTD</title> @@ -781,19 +806,19 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.suite"/></sgmltag></member> + <member><xref linkend="latka.ref.suite"/></member> </simplelist> </section> <section> <title>Description</title> <para> A <sgmltag>session</sgmltag> is a collection of - <sgmltag><xref linkend="latka.ref.request"/></sgmltag>s + <xref linkend="latka.ref.request"/>s that share the same underlying state. For example, a cookie that returned in the response to one - <sgmltag><xref linkend="latka.ref.request"/></sgmltag> + <xref linkend="latka.ref.request"/> will be included in subsequent - <sgmltag><xref linkend="latka.ref.request"/></sgmltag>s. + <xref linkend="latka.ref.request"/>s. </para> </section> </section> @@ -855,7 +880,7 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.validate"/></sgmltag></member> + <member><xref linkend="latka.ref.validate"/></member> </simplelist> </section> <section> @@ -905,7 +930,7 @@ <entry>CDATA</entry> <entry><emphasis>none</emphasis></entry> <entry> - Default hostname for <sgmltag><xref linkend="latka.ref.request"/></sgmltag>s. Optional. + Default hostname for <xref linkend="latka.ref.request"/>s. Optional. </entry> </row> <row> @@ -913,7 +938,7 @@ <entry>NUMBER</entry> <entry><emphasis>none</emphasis></entry> <entry> - Default port for <sgmltag><xref linkend="latka.ref.request"/></sgmltag>s. Optional. + Default port for <xref linkend="latka.ref.request"/>s. Optional. </entry> </row> <row> @@ -940,8 +965,8 @@ <title>Description</title> <para> A <sgmltag>suite</sgmltag> is a collection of - <sgmltag><xref linkend="latka.ref.request"/></sgmltag>s - and <sgmltag><xref linkend="latka.ref.session"/></sgmltag>s + <xref linkend="latka.ref.request"/>s + and <xref linkend="latka.ref.session"/>s to execute. </para> </section> @@ -955,7 +980,7 @@ <para> indicates the suite of validations to apply to the - current <sgmltag><xref linkend="latka.ref.request"/></sgmltag> (and its response) + current <xref linkend="latka.ref.request"/> (and its response) </para> <section> @@ -971,14 +996,14 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.request"/></sgmltag></member> + <member><xref linkend="latka.ref.request"/></member> </simplelist> </section> <section> <title>Description</title> <para> Contains the set of validations to apply to the - current <sgmltag><xref linkend="latka.ref.request"/></sgmltag> + current <xref linkend="latka.ref.request"/> (and its response). </para> </section> @@ -1081,7 +1106,7 @@ <section> <title>Parents</title> <simplelist type="inline"> - <member><sgmltag><xref linkend="latka.ref.validate"/></sgmltag></member> + <member><xref linkend="latka.ref.validate"/></member> </simplelist> </section> <section> @@ -1092,7 +1117,6 @@ </para> </section> </section> - </section> </chapter>
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
