dion 02/01/20 04:30:33
Modified: latka/doc index.xml
Log:
Changed sect1..sect5 tags to section tags. Section tags
are arbitrarily nestable, and supported since DocBook 3.1
Revision Changes Path
1.5 +162 -162 jakarta-commons/latka/doc/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/latka/doc/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 20 Jan 2002 07:33:39 -0000 1.4
+++ index.xml 20 Jan 2002 12:30:33 -0000 1.5
@@ -1,11 +1,11 @@
<?xml version="1.0"?>
<!--
Author: Morgan Delagrange
- Version: $Id: index.xml,v 1.4 2002/01/20 07:33:39 dion Exp $
+ Version: $Id: index.xml,v 1.5 2002/01/20 12:30:33 dion Exp $
-->
<chapter id="latka">
<title>Latka (Version 1.0 Alpha 2)</title>
- <sect1>
+ <section>
<title>What is Latka?</title>
<para>
<firstterm>Latka</firstterm> is a functional (end-to-end) testing
@@ -25,10 +25,10 @@
When processed, this example would verify that the Jakarta Commons
homepage is present and that all the Commons Components have online
documenation.
</para>
- </sect1>
- <sect1>
+ </section>
+ <section>
<title>Installing Latka</title>
- <sect2>
+ <section>
<title>Requirements</title>
<itemizedlist>
<listitem>JDK 1.3 or better</listitem>
@@ -41,9 +41,9 @@
<ulink url="http://java.sun.com/security/index.html";>Sun JSSE
library</ulink>
</listitem>
</itemizedlist>
- </sect2>
+ </section>
- <sect2>
+ <section>
<title>General installation</title>
<orderedlist>
<listitem>
@@ -56,9 +56,9 @@
<ulink url="http://java.sun.com/security/index.html";>Sun JSSE
library</ulink>.
</listitem>
</orderedlist>
- </sect2>
+ </section>
- <sect2>
+ <section>
<title>Optional web application installation </title>
<orderedlist>
<listitem>
@@ -71,12 +71,12 @@
directory of the Latka webapp.
</listitem>
</orderedlist>
- </sect2>
- </sect1>
+ </section>
+ </section>
- <sect1>
+ <section>
<title>Using Latka</title>
- <sect2>
+ <section>
<title>Running the sample tests</title>
<remark>Command-line interface</remark>
@@ -100,15 +100,15 @@
</listitem>
<listitem>Click on one of the tests to execute it. </listitem>
</orderedlist>
- </sect2>
- <sect2>
+ </section>
+ <section>
<title>Creating your own tests</title>
<para>
(More to come...) Examine the Latka DTD in the conf directory
for a list of all available elements. See the samples for typical syntax.
</para>
- </sect2>
- <sect2>
+ </section>
+ <section>
<title>Running tests</title>
<remark>Command-line interface</remark>
@@ -130,31 +130,31 @@
</listitem>
<listitem>Click on one of the tests to execute it. </listitem>
</orderedlist>
- </sect2>
+ </section>
- <sect2>
+ <section>
<title>Creating your custom validations</title>
<remark>(More to come...)</remark>
- </sect2>
- </sect1>
+ </section>
+ </section>
- <sect1>
+ <section>
<title>Latka XML Reference</title>
<!-- REFENTRY: byteLength -->
- <sect2 id="latka.ref.byteLength" xreflabel="byteLength">
+ <section id="latka.ref.byteLength" xreflabel="byteLength">
<title>byteLength</title>
<para>
validates the length of an HTTP(S) response
</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting> <!ELEMENT byteLength EMPTY>
<!ATTLIST byteLength min CDATA "0"
max CDATA #IMPLIED
label CDATA #IMPLIED></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -205,14 +205,14 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.validate"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A <sgmltag>byteLength</sgmltag> validation
@@ -221,23 +221,23 @@
bytes long, and (when specified) at most
<sgmltag class="attribute">max</sgmltag> bytes long.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: COOKIE -->
- <sect2 id="latka.ref.cookie" xreflabel="cookie">
+ <section id="latka.ref.cookie" xreflabel="cookie">
<title>cookie</title>
<para>
validates the presence of an HTTP(S) cookie in a response
</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><![CDATA[<!ELEMENT cookie EMPTY>
<!ATTLIST cookie name CDATA #REQUIRED
value CDATA #IMPLIED
label CDATA #IMPLIED>]]></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -285,14 +285,14 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.validate"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A <sgmltag>cookie</sgmltag> validation
@@ -301,22 +301,22 @@
If a <sgmltag class="attribute">value</sgmltag> is provided,
the cookie must also have the specified value.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: CREDENTIALS -->
- <sect2 id="latka.ref.credentials" xreflabel="credentials">
+ <section id="latka.ref.credentials" xreflabel="credentials">
<title>credentials</title>
<para>
username/password credentials for Basic HTTP authentication.
</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><![CDATA[<!ELEMENT credentials EMPTY>
<!ATTLIST credentials userName CDATA #REQUIRED
password CDATA #REQUIRED>]]></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -348,32 +348,32 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.request"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
Contains credentials for HTTP Basic Authentication.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: maxRequestTime -->
- <sect2 id="latka.ref.maxRequestTime" xreflabel="maxRequestTime">
+ <section id="latka.ref.maxRequestTime" xreflabel="maxRequestTime">
<title>maxRequestTime</title>
<para>validates the response time for an HTTP(S) request</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><![CDATA[<!ELEMENT maxRequestTime EMPTY>
<!ATTLIST maxRequestTime millis CDATA "30000"
message CDATA #IMPLIED>]]></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -415,124 +415,124 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.validate"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A <sgmltag>maxRequestTime</sgmltag> validation
passes if the HTTP(S) response is obtained in no more than
<sgmltag class="attribute">millis</sgmltag> milliseconds.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: PARAM -->
- <sect2 id="latka.ref.param" xreflabel="param">
+ <section id="latka.ref.param" xreflabel="param">
<title>param</title>
<para>indicates a request parameter as part of an HTTP(S) request to be
executed</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><!ELEMENT request (<xref
linkend="latka.ref.paramName"/>, <xref
linkend="latka.ref.paramValue"/>)></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<para>
<emphasis>None.</emphasis>
</para>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.request"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A parameter to be submitted as part of a <sgmltag><xref
linkend="latka.ref.request"/></sgmltag>.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: paramName -->
- <sect2 id="latka.ref.paramName" xreflabel="paramName">
+ <section id="latka.ref.paramName" xreflabel="paramName">
<title>paramName</title>
<para>the name part of a name/value pair parameter</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><!ELEMENT paramName (#PCDATA)></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<para>
<emphasis>None.</emphasis>
</para>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref linkend="latka.ref.param"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </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>.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: paramValue -->
- <sect2 id="latka.ref.paramValue" xreflabel="paramValue">
+ <section id="latka.ref.paramValue" xreflabel="paramValue">
<title>paramValue</title>
<para>the value part of a name/value pair parameter</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><!ELEMENT paramValue (#PCDATA)></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<para>
<emphasis>None.</emphasis>
</para>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref linkend="latka.ref.param"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </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>.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: REGEXP -->
- <sect2 id="latka.ref.regexp" xreflabel="regexp">
+ <section id="latka.ref.regexp" xreflabel="regexp">
<title>regexp</title>
<para>
validates the presence or absence of a regular expression within an
HTTP(S) response
</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><![CDATA[<!ELEMENT regexp EMPTY>
<!ATTLIST regexp pattern CDATA #REQUIRED
cond (true | false) "true"
ignoreCase (true | false) "false"
label CDATA #IMPLIED>]]></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -605,31 +605,31 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.validate"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A <sgmltag>maxRequestTime</sgmltag> validation
passes if the HTTP(S) response is obtained in no more than
<sgmltag class="attribute">millis</sgmltag> milliseconds.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: REQUEST -->
- <sect2 id="latka.ref.request" xreflabel="request">
+ <section id="latka.ref.request" xreflabel="request">
<title>request</title>
<para>indicates an HTTP(S) request to be executed</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><!ELEMENT request (<xref
linkend="latka.ref.credentials"/>?, <xref linkend="latka.ref.param"/>*, <xref
linkend="latka.ref.validate"/>?)>
<!ATTLIST request path CDATA #REQUIRED
@@ -637,8 +637,8 @@
host CDATA #IMPLIED
port CDATA #IMPLIED
label CDATA #IMPLIED></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<para>
<informaltable colsep="1" rowsep="1">
@@ -708,36 +708,36 @@
</tgroup>
</informaltable>
</para>
- </sect3>
- <sect3>
+ </section>
+ <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>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
An HTTP(S) request to be executed.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: SESSION -->
- <sect2 id="latka.ref.session" xreflabel="session">
+ <section id="latka.ref.session" xreflabel="session">
<title>session</title>
<para>wrapper for a sequence of <sgmltag><xref
linkend="latka.ref.request"/></sgmltag>s associated with the same state
(session)</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><!ELEMENT session (<xref
linkend="latka.ref.request"/>+)>
<!ATTLIST session sessionId CDATA #IMPLIED
label CDATA #IMPLIED></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -777,14 +777,14 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref linkend="latka.ref.suite"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A <sgmltag>session</sgmltag> is a collection of
@@ -795,23 +795,23 @@
will be included in subsequent
<sgmltag><xref linkend="latka.ref.request"/></sgmltag>s.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: statusCode -->
- <sect2 id="latka.ref.statusCode" xreflabel="statusCode">
+ <section id="latka.ref.statusCode" xreflabel="statusCode">
<title>statusCode</title>
<para>validates an HTTP response code</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><![CDATA[<!ELEMENT statusCode EMPTY>
<!ATTLIST statusCode code CDATA "200"
label CDATA #IMPLIED>]]></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -851,14 +851,14 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.validate"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A <sgmltag>statusCode</sgmltag> validation
@@ -866,24 +866,24 @@
matches the value specified by
<sgmltag class="attribute">code</sgmltag>.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: SUITE -->
- <sect2 id="latka.ref.suite" xreflabel="suite">
+ <section id="latka.ref.suite" xreflabel="suite">
<title>suite</title>
<para>root element for a suite of tests</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><!ELEMENT suite ( (<xref
linkend="latka.ref.session"/> | <xref linkend="latka.ref.request"/>)+ )>
<!ATTLIST suite defaultHost CDATA #IMPLIED
defaultPort CDATA #IMPLIED
label CDATA #IMPLIED></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -929,14 +929,14 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<para>
<emphasis>None.</emphasis>
</para>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A <sgmltag>suite</sgmltag> is a collection of
@@ -944,12 +944,12 @@
and <sgmltag><xref linkend="latka.ref.session"/></sgmltag>s
to execute.
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: VALIDATE -->
- <sect2 id="latka.ref.validate" xreflabel="validate">
+ <section id="latka.ref.validate" xreflabel="validate">
<title>validate</title>
@@ -958,34 +958,34 @@
current <sgmltag><xref linkend="latka.ref.request"/></sgmltag> (and
its response)
</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><!ELEMENT validate (<xref
linkend="latka.ref.byteLength"/> | <xref linkend="latka.ref.cookie"/> | <xref
linkend="latka.ref.maxRequestTime"/> | <xref linkend="latka.ref.regexp"/> | <xref
linkend="latka.ref.statusCode"/> | <xref linkend="latka.ref.xpath"/>
)+></programlisting>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Attributes</title>
<para>
<emphasis>None.</emphasis>
</para>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.request"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
Contains the set of validations to apply to the
current <sgmltag><xref linkend="latka.ref.request"/></sgmltag>
(and its response).
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
<!-- REFENTRY: xpath -->
- <sect2 id="latka.ref.xpath" xreflabel="xpath">
+ <section id="latka.ref.xpath" xreflabel="xpath">
<title>xpath</title>
<para>
@@ -994,16 +994,16 @@
</para>
- <sect3>
+ <section>
<title>DTD</title>
<programlisting><!ELEMENT xpath EMPTY>
<!ATTLIST xpath select CDATA #REQUIRED
cond (true | false) "true"
value CDATA #IMPLIED
label CDATA #IMPLIED></programlisting>
- </sect3>
+ </section>
- <sect3>
+ <section>
<title>Attributes</title>
<informaltable colsep="1" rowsep="1">
<tgroup cols="4">
@@ -1077,22 +1077,22 @@
</tbody>
</tgroup>
</informaltable>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Parents</title>
<simplelist type="inline">
<member><sgmltag><xref
linkend="latka.ref.validate"/></sgmltag></member>
</simplelist>
- </sect3>
- <sect3>
+ </section>
+ <section>
<title>Description</title>
<para>
A xpath validation passes if the HTTP(S) response body contains XML,
and the specified XPath expression matches (or not, depending on
cond)
</para>
- </sect3>
- </sect2>
+ </section>
+ </section>
- </sect1>
+ </section>
</chapter>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
