Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin Barbe2016-10-10 12:57:03 +0000
committerKevin Barbe2016-10-10 12:57:51 +0000
commit228f3d4dd4e0ab2d0384d79828103e8d30664945 (patch)
tree2b876e8f3e7152715d614bc532e3c30934ec6eee /org.eclipse.jubula.documentation/developerManual
parentc452201c4e7dd268750f9197c0f3bfe8e10e5044 (diff)
downloadorg.eclipse.jubula.core-228f3d4dd4e0ab2d0384d79828103e8d30664945.tar.gz
org.eclipse.jubula.core-228f3d4dd4e0ab2d0384d79828103e8d30664945.tar.xz
org.eclipse.jubula.core-228f3d4dd4e0ab2d0384d79828103e8d30664945.zip
Added documentation for the Extension Wizard
Change-Id: Icb316030611844363fcabaa6c3bea000aa8072b9 Signed-off-by: Kevin Barbe <kevin.barbe@bredex.de>
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/extensionWizard/extensionWizard.xml20
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionInstallation.xml90
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionRequirements.xml36
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionUsage.xml203
5 files changed, 350 insertions, 0 deletions
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
index 060e9aca8..00f639660 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
@@ -16,6 +16,7 @@
<xi:include href="clientAPI/chapter.xml"/>
<xi:include href="toolkitExtension/toolkitExtension.xml"/>
<xi:include href="gefToolkitExtension/gefToolkitExtension.xml"/>
+ <xi:include href="extensionWizard/extensionWizard.xml"/>
<xi:include href="functions/functions.xml"/>
<xi:include href="keyboardLayout/keyboardLayout.xml"/>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/extensionWizard.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/extensionWizard.xml
new file mode 100644
index 000000000..b8c0799ca
--- /dev/null
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/extensionWizard.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Copyright (c) 2016 BREDEX GmbH. All rights reserved. This program and
+ the accompanying materials are made available under the terms of the Eclipse
+ Public License v1.0 which accompanies this distribution, and is available
+ at http://www.eclipse.org/legal/epl-v10.html -->
+<chapter xml:id="extensionWizard" 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="extensionWizard"?>
+ <title>Creating toolkit extensions using the Extension Wizard
+ </title>
+ <para>
+ The Jubula Extension Wizard is a plug-in for the Eclipse IDE that allows
+ you to create toolkit extensions easier and faster than before.
+ </para>
+
+ <xi:include href="sectionRequirements.xml" />
+ <xi:include href="sectionInstallation.xml" />
+ <xi:include href="sectionUsage.xml" />
+</chapter> \ No newline at end of file
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionInstallation.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionInstallation.xml
new file mode 100644
index 000000000..54a7a9f08
--- /dev/null
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionInstallation.xml
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Copyright (c) 2016 BREDEX GmbH. All rights reserved. This program and
+ the accompanying materials are made available under the terms of the Eclipse
+ Public License v1.0 which accompanies this distribution, and is available
+ at http://www.eclipse.org/legal/epl-v10.html -->
+<section xml:id="wizard-installation" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
+ <title>Installation</title>
+ <orderedlist>
+ <listitem>
+ <para>
+ Start the IDE and select from the main menu
+ <emphasis role="menupath">Help</emphasis> &gt;
+ <emphasis role="menupath">Install new software...</emphasis>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click the ” <emphasis>Add...</emphasis>” button in the
+ <emphasis>Install</emphasis> dialog that appears.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click the ”<emphasis>Archive</emphasis>” button in the
+ <emphasis>Add Repository</emphasis> dialog that appears.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Navigate to the jubula installation directory and choose the
+ "<emphasis role="input">org.eclipse.jubula.extensions.wizard.repo.zip</emphasis>"
+ file from the development directory.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ You can optionally give the repository a local name.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click ”<emphasis>OK</emphasis>” to exit the
+ <emphasis>Add Repository</emphasis> dialog. The active
+ dialog should now be <emphasis>Install</emphasis>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Tick the checkbox next to the <emphasis>Jubula Extension Development</emphasis>
+ category or the <emphasis>Jubula Extension Wizard</emphasis>
+ feature and click ”<emphasis>Next</emphasis>”.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Confirm the <emphasis>Installation Details</emphasis> by
+ clicking the ”<emphasis>Next</emphasis>” button again.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Accept the license agreement terms and click”<emphasis>Finish</emphasis>”.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A warning dialog may appear to warn you are installing
+ unsigned content. Click ”<emphasis>OK</emphasis>”.
+ Then the installation process begins.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click the ”<emphasis>Restart Now</emphasis>” button to
+ perform a restart, when a dialog appears to prompt the
+ restart that will safely finish the update / installation.
+ After the restart the <emphasis>Jubula Extension Wizard</emphasis>
+ will be available in the "<emphasis>New Project</emphasis>" menu.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ <para role="warning">
+ The Jubula Extension Wizard is not supposed to
+ be installed into the Jubula ITE or into Eclipse for Testers,
+ see<xref linkend="wizard-requirements" />.
+ </para>
+
+</section> \ No newline at end of file
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionRequirements.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionRequirements.xml
new file mode 100644
index 000000000..e8e420e43
--- /dev/null
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionRequirements.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Copyright (c) 2016 BREDEX GmbH. All rights reserved. This program and
+ the accompanying materials are made available under the terms of the Eclipse
+ Public License v1.0 which accompanies this distribution, and is available
+ at http://www.eclipse.org/legal/epl-v10.html -->
+<section xml:id="wizard-requirements" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
+ <title>Requirements</title>
+ <para>
+ To install and run the Jubula Extension Wizard you need:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Jubula 8.3.0 or later
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Either the Eclipse IDE for Java EE Developers or for Eclipse
+ Commiters, Version 4.5.2 (Mars.2) or later
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ JDK 8.0
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ An internet connection to install the Wizard and to resolve the
+ extension's target platform.
+ </para>
+ </listitem>
+ </itemizedlist>
+</section> \ No newline at end of file
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionUsage.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionUsage.xml
new file mode 100644
index 000000000..70d5a5b21
--- /dev/null
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/extensionWizard/sectionUsage.xml
@@ -0,0 +1,203 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Copyright (c) 2016 BREDEX GmbH. All rights reserved. This program and
+ the accompanying materials are made available under the terms of the Eclipse
+ Public License v1.0 which accompanies this distribution, and is available
+ at http://www.eclipse.org/legal/epl-v10.html -->
+<section xml:id="wizard-usage" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
+ <title>Usage of the New Extension Wizard</title>
+ <para>
+ After the installation of the Jubula Extension Wizard was successful a
+ new extension project can be created.
+ </para>
+ <section xml:id="wizard-usage-open-wizard">
+ <title>Opening the wizard</title>
+ <orderedlist>
+ <listitem>
+ <para>
+ Select from the main menu
+ <emphasis role="menupath">File</emphasis> &gt;
+ <emphasis role="menupath">New</emphasis> &gt;
+ <emphasis role="menupath">Project...</emphasis>.
+ </para>
+
+ <para role="tip">
+ You can alternatively select
+ <emphasis role="menupath">New</emphasis> &gt;
+ <emphasis role="menupath">Project...</emphasis>
+ from the context menu of the
+ <emphasis>Project Explorer</emphasis>
+ or the <emphasis>Package Explorer</emphasis>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Expand the <emphasis>Jubula</emphasis> folder in the
+ <emphasis>New Project</emphasis> window that appears.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select
+ <emphasis>Jubula Extension Project</emphasis>
+ and click the "<emphasis>Next</emphasis>" button.
+ </para>
+ </listitem>
+
+ </orderedlist>
+ </section>
+ <section xml:id="wizard-usage-creating-an-extension">
+ <title>Creating an extension</title>
+ <orderedlist>
+ <listitem>
+ <para>
+ In the <emphasis>Project Name</emphasis> field enter a
+ project name prefix for your extension. The extension will
+ consist of three eclipse projects, therefore the entered
+ project name is being used as the prefix.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select the execution environment. Make sure to use Java 1.8
+ or later. If required, clicking on the "<emphasis>Configure JREs...</emphasis>"
+ link will open the <emphasis>Installed JREs</emphasis>
+ page of the Eclipse settings.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ After you have entered all the necessary information, click
+ "<emphasis>Next</emphasis>" to continue.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select the desired toolkit and click "<emphasis>Next</emphasis>".
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enter the extension features' <emphasis>ID</emphasis>,
+ <emphasis>Version</emphasis>, <emphasis>Name</emphasis> and
+ <emphasis>Vendor</emphasis>. In most cases the pre-entered
+ texts should be suitable.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select a <emphasis>component type</emphasis> from the
+ dropdown menu. The component will inherit all standard
+ actions of the component type. If you would e.g. like to
+ add support for a component that behaves as a button,
+ <emphasis>guidancer.concrete.Button</emphasis> should be
+ chosen. The most basic type is
+ <emphasis>guidancer.abstract.Widget</emphasis>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ After choosing the type you can:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Choose a component that is already supported and
+ add additional actions to that component.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enter or choose a component that is not supported
+ by Jubula, yet.
+ </para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem>
+ <para>
+ If you do not have a target platform for Jubula extension
+ development, yet, tick "<emphasis>Create a Jubula target platform file</emphasis>".
+ You need a valid target platform to code and build your
+ extension properly.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click "<emphasis>Next</emphasis>" to continue.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enter a <emphasis>class name</emphasis> for the
+ <emphasis>tester class</emphasis>.
+ The tester class will contain all action's methods.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ By pressing the "<emphasis>New...</emphasis>" button you can
+ create a new action.
+ </para>
+ </listitem>
+ <listitem>
+ <orderedlist>
+ <listitem>
+ <para>
+ To rename an action, simply click on the action's
+ current name, enter the new name and hit enter.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ To delete an action, select it and click on
+ the "<emphasis>Delete</emphasis>" button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ To change the order in which the action's methods
+ will occur in the tester class, use the
+ "<emphasis>Up</emphasis>" and "<emphasis>Down</emphasis>"
+ buttons to move a selected action up or down respectively.
+ </para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem>
+ <para>
+ To add parameters to an action, select the action and click
+ on the "<emphasis>Param...</emphasis>" button. In the
+ opening <emphasis>Action Parameters</emphasis> window you
+ can create, delete and change the order of parameters
+ just like you would in the actions list.
+ If only special values should be allowed for a parameter
+ you can enter value sets. Enter all allowed values each
+ separated by a commma. Make sure that the entered value set
+ consists of values of the parameter's type only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ By clicking "<emphasis>Finish</emphasis>" the wizard will
+ close and the extension will be created.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ After the generation has finished and you have selected to
+ create a target platform file, the file will be opened in
+ the target platform editor. In the top right corner click
+ "<emphasis>Set as Target Platform</emphasis>" to use
+ the target platform in your workspace.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ For information about how to deploy your extension, see
+ <xref linkend="deploying-the-toolkit-plug-in"/>.
+ </para>
+ </listitem>
+ </orderedlist>
+ </section>
+</section> \ No newline at end of file

Back to the top