Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarkus Tiede2015-01-06 15:51:11 +0000
committerMarkus Tiede2015-01-06 15:51:11 +0000
commit86bd6a5dc51616c4682978b66ae618d9ce289009 (patch)
treea6308720aadad497f389870101e66937618f1610 /org.eclipse.jubula.documentation/developerManual
parent9f06ba9c2c46bc90211007889461ec0becff2abd (diff)
downloadorg.eclipse.jubula.core-86bd6a5dc51616c4682978b66ae618d9ce289009.tar.gz
org.eclipse.jubula.core-86bd6a5dc51616c4682978b66ae618d9ce289009.tar.xz
org.eclipse.jubula.core-86bd6a5dc51616c4682978b66ae618d9ce289009.zip
Sprint task - add general infrastructure for newly created client API descpription.
Diffstat (limited to 'org.eclipse.jubula.documentation/developerManual')
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml1
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml5
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/introduction/introduction.xml58
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/toolkitExtension.xml22
4 files changed, 42 insertions, 44 deletions
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
index 8be6f4ac8..e185f410e 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
@@ -5,6 +5,7 @@
<title>Jubula Developer Manual</title>
<xi:include href="introduction/introduction.xml"/>
+ <xi:include href="clientAPI/chapter.xml"/>
<xi:include href="toolkitExtension/toolkitExtension.xml"/>
<xi:include href="gefToolkitExtension/gefToolkitExtension.xml"/>
<xi:include href="functions/functions.xml"/>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml
new file mode 100644
index 000000000..01b7d1bbd
--- /dev/null
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml
@@ -0,0 +1,5 @@
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink" id="clientAPI" version="5.0">
+ <?dbhtml dir="clientAPI"?>
+ <title>Writing UI tests via API</title>
+ <para>...</para>
+</chapter>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/introduction/introduction.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/introduction/introduction.xml
index 29dea50d7..ff07a4f37 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/introduction/introduction.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/introduction/introduction.xml
@@ -1,43 +1,15 @@
-<chapter id="introduction" version="5.0" xmlns="http://docbook.org/ns/docbook"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:xl="http://www.w3.org/1999/xlink" >
- <?dbhtml dir="introduction"?>
- <title>Introduction</title>
- <para>
- When developing graphical applications, it is often necessary or
- convenient to alter or combine the functionality of existing toolkit
- components, or even to write entirely new ones, as the requirements or
- concept of the software may dictate. These new components generally
- cannot be tested ”out of the box”, as the behavior of custom
- components cannot be predicted, or they may deviate from established
- standards of ”look and feel”. In order to overcome this limitation,
- there is an extension API, which you can use to be able to test your
- custom components.
- </para>
- <para>
- The following sections describe the steps involved in writing
- extensions.
- </para>
- <para>
- AUTs are started, controlled and observed using its remote control
- component. In order for the AUT Agent to know how to control each
- element of a GUI, we have outfitted the AUT Agent with a pluggable
- interface for graphic components. An adapter factory containing one
- or more components must be implemented for and deployed with the
- AUT. On the client side, each GUI toolkit that the ITE supports is
- described in a toolkit plug-in.
- </para>
- <para>
- We have opened up an interface to our users to allow flexible
- customizations. You can extend existing functionality, or provide
- support for in-house graphic components by implementing your own
- <emphasis role="strong">Tester Classes.</emphasis>
- </para>
- <para>
- This handbook shows general steps for creating ITE toolkit
- extensions, which is described in <xref linkend="toolkitExtension"/>. In
- this chapter you will find also a short description of the extension
- examples. Last but not least <xref linkend="functions"/> describes how
- to create a custom ITE function, which can be used in tests.
- </para>
-</chapter> \ No newline at end of file
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink" id="introduction" version="5.0">
+ <?dbhtml dir="introduction"?>
+ <title>Introduction</title>
+ <para>This manual aims for Java and OSGi bundle developers. It describes how
+ to use and extend the ITE on a programmatic level.</para>
+ <para><xref linkend="clientAPI"/> is a general starting point for information
+ on writing UI tests via the ITEs API.</para>
+ <para>This handbook also shows general steps for creating ITE toolkit
+ extensions, which is described in <xref linkend="toolkitExtension"/>. In this
+ chapter you will find also a short description of the extension examples.
+ </para>
+ <para>Information how to write an extension for GEF can be found in <xref linkend="creating-gef-toolkit-extensions"/>.</para>
+ <para>Last but not least <xref linkend="functions"/> describes how to create a
+ custom ITE function, which can be used in tests.</para>
+</chapter>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/toolkitExtension.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/toolkitExtension.xml
index 56359715d..1a320a9e7 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/toolkitExtension.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/toolkitExtension.xml
@@ -2,7 +2,27 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xl="http://www.w3.org/1999/xlink">
<?dbhtml dir="toolkitExtension"?>
- <title>Creating toolkit extensions</title>
+ <title>Creating toolkit extensions for custom UI widgets</title>
+ <para>When developing graphical applications, it is often necessary or
+ convenient to alter or combine the functionality of existing toolkit
+ components, or even to write entirely new ones, as the requirements or concept
+ of the software may dictate. These new components generally cannot be tested
+ "out of the box", as the behavior of custom components cannot be predicted, or
+ they may deviate from established standards of "look and feel". In order to
+ overcome this limitation, there is an extension API, which you can use to be
+ able to test your custom components.</para>
+ <para>The following sections describe the steps involved in writing
+ extensions.</para>
+ <para>AUTs are started, controlled and observed using its remote control
+ component. In order for the AUT Agent to know how to control each element of a
+ GUI, we have outfitted the AUT Agent with a pluggable interface for graphic
+ components. An adapter factory containing one or more components must be
+ implemented for and deployed with the AUT. On the client side, each GUI
+ toolkit that the ITE supports is described in a toolkit plug-in.</para>
+ <para>We have opened up an interface to our users to allow flexible
+ customizations. You can extend existing functionality, or provide support for
+ in-house graphic components by implementing your own
+ <emphasis role="strong">Tester Classes.</emphasis></para>
<para>
The following chapter describes the general steps to take for
creating an ITE toolkit extension with custom defined components and

Back to the top