Author: pete.muir(a)jboss.org Date: 2009-07-23 18:56:26 -0400 (Thu, 23 Jul 2009) New Revision: 3176 Modified: tck/trunk/doc/reference/en-US/Book_Preface.xml Log: ws Modified: tck/trunk/doc/reference/en-US/Book_Preface.xml =================================================================== --- tck/trunk/doc/reference/en-US/Book_Preface.xml 2009-07-23 22:48:26 UTC (rev 3175) +++ tck/trunk/doc/reference/en-US/Book_Preface.xml 2009-07-23 22:56:26 UTC (rev 3176) @@ -1,44 +1,119 @@ <?xml version='1.0' encoding='UTF-8'?> -<!-- This document was created with Syntext Serna Free. --><!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> +<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> <preface id="book-preface"> - <title>Preface</title> - <para>This guide describes how to download, install, configure, and run the Technology Compatibility Kit (TCK) used to verify the compatibility of a licensee&apos;s implementation of the JSR-299: Context and Dependency Injection for Java EE specification.</para> - <para>The JSR-299 TCK is built atop the JBoss Test Harness, a portable and configurable automated test suite for authoring unit and integration tests in a Java EE environment. The JSR-299 TCK 1.0.0 uses the JBoss Test Harness version 1.0.0.BETA3 to execute the test suite.</para> - <section id="target-audience"> - <title>Who Should Use This Book</title> - <para>This guide is for licensees of the Context and Dependency Injection for Java EE 1.0 (JSR-299) technology to assist in running the test suite that verifies the compatibility of their implementation.</para> - </section> - <section id="before-reading"> - <title>Before You Read This Book</title> - <para>Before reading this guide, you should familiarize yourself with the Java EE programming model, specifically the Enterprise JavaBeans (EJB) 3.0 and the Contexts and Dependency Injection for Java EE 1.0 specifications. A good resource for the Java EE programming model is the <ulink url="http://jcp.org">JCP</ulink> web site.</para> - <para>The JSR-299 TCK is based on the Context and Dependency Injection for Java EE technology specification 1.0 (JSR-299). Information about the specification, including links to the specification documents, can be found on the <ulink url="http://jcp.org/en/jsr/detail?id=299">JSR-299 JCP page</ulink>.</para> - <para>Before running the tests in the JSR-299 TCK, read and become familiar with the JBoss Test Harness Reference Guide (pending), which describes how the test harness functions.</para> - </section> - <section id="book-organization"> - <title>How This Book Is Organized</title> - <para>If you are running the JSR-299 TCK for the first time, read Chapter 1 and Chapter 2 completely for the necessary background information about the TCK and its purpose. Once you have reviewed that material, perform the steps outlined in the remaining chapters.</para> - <itemizedlist> - <listitem> - <para>Chapter 1 gives an overview of the principles that apply generally to all Technology Compatibility Kits (TCKs) and describes the JSR-299 TCK architecture and components. It also includes a broad overview of how the TCK is executed and lists the platforms on which the TCK has been tested and verified.</para> - </listitem> - <listitem> - <para>Chapter 2 explains where to obtain the required software and how to install it. It covers both the primary TCK components as well as tools useful for troubleshooting tests.</para> - </listitem> - <listitem> - <para>Chapter 3 details the configuration of the JBoss Test Harness, how to create a TCK runner for the TCK test suite and the mechanics of how an in-container test is conducted.</para> - </listitem> - <listitem> - <para>Chapter 4 documents how the TCK test suite is executed. It covers both modes supported by the TCK, standalone and in-container, and shows how to dump the generated test artifacts to disk.</para> - </listitem> - <listitem> - <para>Chapter 5 shows how to run individual tests in Eclipse and advices the best way to setup your Eclipse workspace for running the tests.</para> - </listitem> - <listitem> - <para>Chapter 6 builds on chapter 5 by detailing how to debug individual tests in Eclipse.</para> - </listitem> - <listitem> - <para>Chapter 7 (pending) explains the test reports that are generated by the TCK test suite and introduces the TCK audit report as a tool for measure a licensee&apos;s progress in passing the TCK.</para> - </listitem> - </itemizedlist> - </section> + <title>Preface</title> + + <para> + This guide describes how to download, install, configure, and run the + Technology Compatibility Kit (TCK) used to verify the compatibility of a + licensee&apos;s implementation of the JSR-299: Context and Dependency + Injection for Java EE specification. + </para> + <para> + The JSR-299 TCK is built atop the JBoss Test Harness, a portable and + configurable automated test suite for authoring unit and integration tests + in a Java EE environment. The JSR-299 TCK 1.0.0 uses the JBoss Test + Harness version 1.0.0.BETA3 to execute the test suite. + </para> + + <section id="target-audience"> + <title>Who Should Use This Book</title> + <para> + This guide is for licensees of the Context and Dependency Injection + for Java EE 1.0 (JSR-299) technology to assist in running the test + suite that verifies the compatibility of their implementation. + </para> + </section> + + <section id="before-reading"> + <title>Before You Read This Book</title> + + <para> + Before reading this guide, you should familiarize yourself with the + Java EE programming model, specifically the Enterprise JavaBeans (EJB) + 3.0 and the Contexts and Dependency Injection for Java EE 1.0 + specifications. A good resource for the Java EE programming model is + the + <ulink url="http://jcp.org">JCP</ulink> + web site. + </para> + <para> + The JSR-299 TCK is based on the Context and Dependency Injection for + Java EE technology specification 1.0 (JSR-299). Information about the + specification, including links to the specification documents, can be + found on the + <ulink url="http://jcp.org/en/jsr/detail?id=299">JSR-299 JCP page</ulink> + . + </para> + <para> + Before running the tests in the JSR-299 TCK, read and become + familiar with the JBoss Test Harness Reference Guide (pending), which + describes how the test harness functions. + </para> + + </section> + <section id="book-organization"> + + <title>How This Book Is Organized</title> + <para> + If you are running the JSR-299 TCK for the first time, read Chapter + 1 and Chapter 2 completely for the necessary background information + about the TCK and its purpose. Once you have reviewed that material, + perform the steps outlined in the remaining chapters. + </para> + <itemizedlist> + <listitem> + <para> + Chapter 1 gives an overview of the principles that apply + generally to all Technology Compatibility Kits (TCKs) and + describes the JSR-299 TCK architecture and components. It also + includes a broad overview of how the TCK is executed and lists + the platforms on which the TCK has been tested and verified. + </para> + </listitem> + <listitem> + <para> + Chapter 2 explains where to obtain the required software and + how to install it. It covers both the primary TCK components as + well as tools useful for troubleshooting tests. + </para> + </listitem> + <listitem> + <para> + Chapter 3 details the configuration of the JBoss Test Harness, + how to create a TCK runner for the TCK test suite and the + mechanics of how an in-container test is conducted. + </para> + </listitem> + <listitem> + <para> + Chapter 4 documents how the TCK test suite is executed. It + covers both modes supported by the TCK, standalone and + in-container, and shows how to dump the generated test artifacts + to disk. + </para> + </listitem> + <listitem> + <para> + Chapter 5 shows how to run individual tests in Eclipse and + advices the best way to setup your Eclipse workspace for running + the tests. + </para> + </listitem> + <listitem> + <para> + Chapter 6 builds on chapter 5 by detailing how to debug + individual tests in Eclipse. + </para> + </listitem> + <listitem> + <para> + Chapter 7 (pending) explains the test reports that are + generated by the TCK test suite and introduces the TCK audit + report as a tool for measure a licensee&apos;s progress in + passing the TCK. + </para> + </listitem> + </itemizedlist> + </section> </preface>