Attachment 59493 Details for Bug 171664 – org.eclipse.tptp.test.doc.isv patch

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

[patch] org.eclipse.tptp.test.doc.isv patch

org.eclipse.tptp.test.doc.isv_patch.txt (text/plain), 25.39 KB, created by Paul Slauenwhite

on 2007-02-21 11:55:48 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Paul Slauenwhite

Created: 2007-02-21 11:55:48 EST

Size: 25.39 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.tptp.test.doc.isv
>Index: tasks/t_portrecorder.html
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/tasks/t_portrecorder.html,v
>retrieving revision 1.2
>diff -u -r1.2 t_portrecorder.html
>--- tasks/t_portrecorder.html	2 Oct 2006 21:34:46 -0000	1.2
>+++ tasks/t_portrecorder.html	21 Feb 2007 16:52:49 -0000
>@@ -25,7 +25,7 @@
> <meta name="DC.Language" content="en-us" />
> </a>
>+<body><a name="t_portrecorder"></a>
> <h1 class="topictitle1">Porting a recorder into version 4.2 from an earlier version</h1>
> <div><p>Recorders that were created in earlier versions of the Test and
> Performance Tools Platform (TPTP) will still work in version 4.2. However,
>@@ -49,33 +49,33 @@
> Controller and cannot use the recorder UI wizard entry point.</p>
> <div class="p">The following list of tasks describes the steps required to port earlier
> versions of recorders to the new Generic Recorder Framework of TPTP 4.2.</div>
>-<ol><li class="stepexpand"><span>You can change your old IRecorderDataProcessor class from an earlier
>-version into a MessageHandler class. For an example of this, see HttpRecorderDataProcessor
>-in the org.eclipse.hyades.test.ui project.</span> The recorderMessageHandlers
>-enables the data being received from the agent to persist in the recording
>-file. In version 4.2, the processing is now done from the method processDataFromDataProcessor().</li>
>-<li class="stepexpand"><span>The executable adapters ExecutableObjectAdapter and EnvironmentAdapter
>-in earlier versions have been combined into the execOptionsProvider in version
>-4.2. You can now extend the AbstractRecorderExecOptionsProvider class without
>-having to override the following methods:</span><ol type="a"><li><span>getAgentClassPath: The fully qualified path of the recorder
>-class (the class that extends RecorderAgent)	</span></li>
>-<li><span>getVMArgString: The location where you createJVM arguments,
>+<ol><li class="stepexpand"><span>You can change your old <code>org.eclipse.hyades.execution.recorder.IRecorderDataProcessor</code> class from an earlier
>+version into an implementation of the <code>org.eclipse.tptp.test.provisional.recorder.framework.IRecorderMessageProvider</code> interface. 
>+For an example, see <code>org.eclipse.hyades.execution.recorder.http.local.HttpRecorderDataProcessor</code>.</span> The implementation of the 
>+<code>org.eclipse.tptp.test.provisional.recorder.framework.IRecorderMessageProvider</code> interface enables the data being received from the agent to 
>+persist in the recording file. In version 4.2, the processing is now done from the <code>processDataFromDataProcessor()</code>.</li>
>+<li class="stepexpand"><span>The executable adapters (<code>org.eclipse.hyades.execution.recorder.remote.RecorderExecutableObjectAdapter</code> and <code>org.eclipse.hyades.execution.recorder.remote.RecorderEnvironmentAdapter</code>)
>+in earlier versions have been combined into the <code>org.eclipse.tptp.test.provisional.recorder.framework.AbstractRecorderExecOptions</code> class in version
>+4.2. You can now extend the <code>org.eclipse.tptp.test.provisional.recorder.framework.AbstractRecorderExecOptionsProvider</code> class without
>+having to override the following methods:</span><ol type="a"><li><span><code>getAgentClassPath()</code>: The fully qualified path of the recorder
>+class (extension of the <code>org.eclipse.hyades.execution.recorder.remote.RecorderAgent</code> class)</span></li>
>+<li><span><code>getVMArgString()</code>: The location where you create JVM arguments,
> such as debug.</span></li>
>-<li><span>getRecorderJars: The location where you return a list of JAR
>+<li><span><code>getRecorderJars()</code>: The location where you return a list of JAR
> files that should be in the class path when the recorder is running on the
> agent.</span></li>
> </ol>
>  For more information, see the <a href="../../org.eclipse.tptp.platform.doc.isv/ref/rextpoint.xhtml#org.eclipse.hyades.test.core.Recorder">generic recorder extension point documentation</a>.</li>
>-<li class="stepexpand"><span>The recorderAgent is the class that runs on the agent that starts
>-the recorder (proxy in the case of socket). This extends the class RecorderAgent
>+<li class="stepexpand"><span>The Recorder Agent runs on the agent that starts
>+the recorder (proxy in the case of socket). This class extends the <code>org.eclipse.hyades.execution.recorder.remote.RecorderAgent</code> class
> and must have a main and a run method. <strong>This class has not changed from
> earlier versions.</strong> </span></li>
>-<li class="stepexpand"><span>The recorderClientHelper class enables any kind of settings to
>+<li class="stepexpand"><span>The implementation of the <code>org.eclipse.tptp.test.provisional.recorder.framework.IRecorderClientHelper</code> interface enables any kind of settings to
> be set for the recorder. Typically, settings can be retrieved from preferences
>-and stored in the recorder. Settings can also be stored is in the wizardPageProvider,
>-which provides the settings to be used by the recorder. Override the preSetup()
>+and stored in the recorder. Settings can also be stored is in the implementation of the <code>org.eclipse.tptp.test.provisional.recorder.ui.wizards.IRecorderPageProvider</code> interface,
>+which provides the settings to be used by the recorder. Override the <code>preSetup()</code>
> method to provide these settings.</span></li>
>-<li class="stepexpand"><span>The wizardPageProvider class can provide default settings to the
>+<li class="stepexpand"><span>The implementation of the <code>org.eclipse.tptp.test.provisional.recorder.ui.wizards.IRecorderPageProvider</code> interface can provide default settings to the
> recorder. For more information, see <a href="t_cretestrec.html#t_cretestrec" title="To create a test recorder, you extend the recorder user interface wizard and the four main Generic Recorder Framework (GRF) helper classes in the extension point org.eclipse.hyades.test.core.Recorder.">Creating a new test recorder</a>.</span></li>
> </ol>
> </div>
>Index: tasks/t_extgenrec.html
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/tasks/t_extgenrec.html,v
>retrieving revision 1.1
>diff -u -r1.1 t_extgenrec.html
>--- tasks/t_extgenrec.html	5 Jun 2006 21:05:57 -0000	1.1
>+++ tasks/t_extgenrec.html	21 Feb 2007 16:52:49 -0000
>@@ -24,7 +24,7 @@
> <meta name="DC.Language" content="en-us" />
> </a>
>+<body><a name="t_extgenrec.dita"></a>
> <h1 class="topictitle1">Extending the generic test recorder</h1>
> <div><p>A test recorder captures user interactions with an application.
> These interactions are saved, and a test is generated from these recorded
>Index: tasks/t_cretestrec.html
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/tasks/t_cretestrec.html,v
>retrieving revision 1.1
>diff -u -r1.1 t_cretestrec.html
>--- tasks/t_cretestrec.html	5 Jun 2006 21:05:57 -0000	1.1
>+++ tasks/t_cretestrec.html	21 Feb 2007 16:52:49 -0000
>@@ -24,7 +24,7 @@
> <meta name="DC.Language" content="en-us" />
> </a>
>+<body><a name="t_cretestrec"></a>
> <h1 class="topictitle1">Creating a new test recorder</h1>
> <div><p>To create a test recorder, you extend the recorder user interface
> wizard and the four main Generic Recorder Framework (GRF) helper classes in
>-the extension point org.eclipse.hyades.test.core.Recorder.</p>
>+the <code>org.eclipse.hyades.test.core.Recorder</code> extension point.</p>
> <div class="section">To create a new test recorder, use the Generic Recorder extension
> point to perform the following steps:</div>
> <ol><li><span>Define the Recorder Message Provider.</span></li>
> <li><span>Define the Recorder Client Helper.</span></li>
> <li><span>Define the Wizard Page Provider.</span></li>
>-<li><span>Define the Exec Options Provider.</span></li>
>+<li><span>Define the Execution Options Provider.</span></li>
> </ol>
> <div class="section"><p>Defaults exist for each of these providers. To review the defaults
> and to see more details about these providers, refer to the <a href="../../org.eclipse.tptp.platform.doc.isv/ref/rextpoint.xhtml#org.eclipse.hyades.test.core.Recorder">generic
>@@ -57,9 +57,9 @@
> <p><strong>Defining the Recorder
> Message Handler</strong></p>
> <p>The Recorder Message Provider handles incoming messages
>-from the RecorderAgent. The RecorderAgent controls how the recorder interprets
>+from the Recorder Agent. The Recorder Agent controls how the recorder interprets
> the application that is being recorded. It is responsible for sending messages
>-back to the Workbench that are intercepted by the IRecorderDataProcessor interface
>+back to the workbench that are intercepted by the <code>IRecorderDataProcessor</code> interface
> where the recording file is actually written. </p>
> <p>Some default messages
> are handled in the Abstract class.</p>
>@@ -69,7 +69,7 @@
> </div>
> <p><strong>Defining the Recorder Client Helper</strong></p>
> <p>The Generic Recorder
>-Framework (GRF) calls ClientHelper methods during initialization and shutdown.
>+Framework (GRF) calls client helper methods during initialization and shutdown.
> You can add custom initialization code for the extending recorder here. </p>
> <div class="p"><ul><li>Interface: IRecorderClientHelper </li>
> <li>Adapter: RecorderClientHelperAdapter </li>
>@@ -78,29 +78,29 @@
> <p><strong>Defining the Wizard Page Provider</strong></p>
> <p>Use the wizard
> page provider to develop additional pages for the recorder wizard. This is
>-the only provider that exists in the org.eclipse.hyades.test.ui project. All
>-the other providers are in the org.eclipse.hyades.test.core project.</p>
>+the only provider that exists in the <code>org.eclipse.hyades.test.ui</code> project. All
>+the other providers are in the <code>org.eclipse.hyades.test.core</code> project.</p>
> <div class="p"><ul><li>Interface: IRecorderWizardPageProvider</li>
> <li>Default: DefaultRecWizardProvider</li>
> </ul>
> </div>
> <p>The default produces only one page: the Select Location for Test
> Suite page.</p>
>-<p>All pages served must be of type IGenericRecorderPage.</p>
>+<p>All pages served must be of type <code>IGenericRecorderPage</code>.</p>
> <p>For
> each page, you can optionally define the following methods as well:</p>
> <div class="p"><ul><li>public String getRecorderData(String key)</li>
> <li>public Object getRecorderObjectData(String key)</li>
>-<li>public void saveSettings();RecorderAgent</li>
>+<li>public void saveSettings()</li>
> </ul>
> </div>
>-<p>The default process for retrieving data from WizardPageProvider
>-is to call the getRecorderData() methods of all pages until the key is found.
>-Thus, only the getRecorderData() of the pages must be implemented.</p>
>+<p>The default process for retrieving data from wizard page provider
>+is to call the <code>getRecorderData()</code> methods of all pages until the key is found.
>+Thus, only the <code>getRecorderData()</code> of the pages must be implemented.</p>
> <p><strong>Defining
> the Exec Options Provider</strong></p>
> <p>Extend the Exec Options Provider to enable
>-agent parameters to be set before the RecorderAgent is launched. For example,
>+agent parameters to be set before the Recorder Agent is launched. For example,
> you can define JVM arguments or enable additional files to be deployed.</p>
> <div class="p"><ul><li>Interface: IRecorderExecOptionsProvider</li>
> <li>Abstract class: AbstractRecorderExecOptionsProvider</li>
>@@ -108,7 +108,7 @@
> </div>
> <p>After you have extended the recorder user interface wizard and
> the four main GRF helper classes, your new recorder will be set to display
>-in the Select a recorder type window.</p>
>+in the <i>Select a Recorder Type</i> window.</p>
> </div>
> </div>
> <div>
>Index: ref/rtestextpoint.xhtml
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/ref/rtestextpoint.xhtml,v
>retrieving revision 1.3
>diff -u -r1.3 rtestextpoint.xhtml
>--- ref/rtestextpoint.xhtml	9 Aug 2006 21:30:53 -0000	1.3
>+++ ref/rtestextpoint.xhtml	21 Feb 2007 16:52:49 -0000
>@@ -3,7 +3,7 @@
> <html xmlns="http://www.w3.org/1999/xhtml">
> </a>
>+<body><a name="c_testrecorders"></a>
> <h1 class="topictitle1">Test recorders</h1>
> <div><p>A test recorder captures user interactions with an application.
> These interactions are saved, and a test is generated from these recorded
>Index: concepts/c_recuiwizard.html
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/concepts/c_recuiwizard.html,v
>retrieving revision 1.1
>diff -u -r1.1 c_recuiwizard.html
>--- concepts/c_recuiwizard.html	5 Jun 2006 21:05:57 -0000	1.1
>+++ concepts/c_recuiwizard.html	21 Feb 2007 16:52:49 -0000
>@@ -25,7 +25,7 @@
> <meta name="DC.Language" content="en-us" />
> </a>
>+<body><a name="c_recuiwizard"></a>
> <h1 class="topictitle1">Recorder user interface wizard</h1>
> <div><p>The recorder user interface wizard records a session with a Web
> application, generates a test from the recording, and then opens the test
>Index: concepts/c_exnewtestrec.html
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/concepts/c_exnewtestrec.html,v
>retrieving revision 1.1
>diff -u -r1.1 c_exnewtestrec.html
>--- concepts/c_exnewtestrec.html	5 Jun 2006 21:05:57 -0000	1.1
>+++ concepts/c_exnewtestrec.html	21 Feb 2007 16:52:49 -0000
>@@ -20,7 +20,7 @@
> <meta name="DC.Language" content="en-us" />
> </a>
>+<body><a name="c_exnewtestrec"></a>
> <h1 class="topictitle1">Example of a new test recorder</h1>
> <div><p>The following example shows how the Generic Recorder extension
> point might be defined for the HTTP recorder in the plugin.xml file of the
>@@ -53,9 +53,9 @@
> 		fileExtension="rec"
> 		icon="icons/full/obj16/http.gif"
> 	&lt;/extension&gt;</pre>
>-<p>In this example, recorderAgent is the class that runs on the agent that
>-starts the recorder. This extends the class RecorderAgent and must include
>-a main and a run method. For more information about this extension point,
>+<p>In this example, the <code>recorderAgent</code> attribute contains the name of the class that runs on the agent that
>+starts the recorder. This class extends the <code>org.eclipse.hyades.execution.recorder.remote.RecorderAgent</code> class and must include
>+<code>main()</code> and <code>run()</code> methods. For more information about this extension point,
> see the <a href="../../org.eclipse.tptp.platform.doc.isv/ref/rextpoint.xhtml#org.eclipse.hyades.test.core.Recorder">generic
> recorder extension point documentation</a></p>
> </div>
>Index: concepts/c_genrecframework.html
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/concepts/c_genrecframework.html,v
>retrieving revision 1.1
>diff -u -r1.1 c_genrecframework.html
>--- concepts/c_genrecframework.html	5 Jun 2006 21:05:56 -0000	1.1
>+++ concepts/c_genrecframework.html	21 Feb 2007 16:52:49 -0000
>@@ -25,7 +25,7 @@
> <meta name="DC.Language" content="en-us" />
> </a>
>+<body><a name="c_genrecframework"></a>
> <h1 class="topictitle1">Generic Recorder Framework</h1>
> <div><p>The Generic Recorder Framework (GRF) provides a common user interface
> experience for all users that record tests. The GRF simplifies the process
>@@ -48,17 +48,16 @@
> you could define one custom set of wizard pages to reuse for multiple recorders.</p>
> <p>The GRF is backwards-compatible with previous versions of the Test and
> Performance Tools Platform (TPTP).</p>
>-<p>The GRF includes the extension point org.eclipse.hyades.test.core.Recorder,
>-which contains four main helper classes and a recorder user interface wizard.
>-The following is a list of the four helper classes:</p>
>-<ul><li>recorderClientHelper</li>
>-<li>WizardPageProvider</li>
>-<li>execOptionsProvider</li>
>-<li>recorderMessageHandler</li>
>-</ul>
>+<p>The GRF includes the <code>org.eclipse.hyades.test.core.Recorder</code> extension point,
>+for creating a new recorder.  The extension point can be used to perform the following steps:</p>
>+<ol><li><span>Define the Recorder Message Provider.</span></li>
>+<li><span>Define the Recorder Client Helper.</span></li>
>+<li><span>Define the Wizard Page Provider.</span></li>
>+<li><span>Define the Execution Options Provider.</span></li>
>+</ol>
>+<p>The recorder user interface wizard records a 
>+session, generates a test from the recording, and then opens the test in the test editor.</p>
> <p>For more information about these classes, see the <a href="../../org.eclipse.tptp.platform.doc.isv/ref/rextpoint.xhtml#org.eclipse.hyades.test.core.Recorder">generic recorder extension point documentation</a>.</p>
>-<p>The recorder user interface wizard records a session with a Web application,
>-generates a test from the recording, and then opens the test in the test editor.</p>
> </div>
> <div>
> <div class="familylinks">
>Index: notices.html
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/notices.html,v
>retrieving revision 1.1
>diff -u -r1.1 notices.html
>--- notices.html	1 Jun 2006 15:43:55 -0000	1.1
>+++ notices.html	21 Feb 2007 16:52:49 -0000
>@@ -1,5 +1,5 @@
> <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
>-<html>
>+<html lang="en-us" xml:lang="en-us">
> <head>
> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
> <link rel="STYLESHEET" HREF="css/book.css" charset="ISO-8859-1" type="text/css">
>@@ -8,7 +8,7 @@
> <body>
> 
> <h3><a name="Notices"></a>Notices</h3>
>-<p>The material in this guide is Copyright (c) IBM Corporation 2006.</p>
>+<p>The material in this guide is Copyright (c) IBM Corporation 2006, 2007.</p>
> <p><a href="about.html">Terms and conditions regarding the use of this
> guide.</a></p>
> </body>
>Index: about.html
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.doc.isv/about.html,v
>retrieving revision 1.2
>diff -u -r1.2 about.html
>--- about.html	13 Jun 2006 16:33:38 -0000	1.2
>+++ about.html	21 Feb 2007 16:52:49 -0000
>@@ -1,6 +1,6 @@
> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
>     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
>-<html xmlns="http://www.w3.org/1999/xhtml">
>+<html lang="en-us" xml:lang="en-us" xmlns="http://www.w3.org/1999/xhtml">
> <head>
> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
> <title>About</title>

Actions: View | Diff

Attachments on bug 171664: 59492 | 59493 | 59494