Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarkus Tiede2015-01-07 10:30:24 +0000
committerMarkus Tiede2015-01-07 10:30:24 +0000
commitfd0f5d3983fdcdac85b3fddbd8a1e215893dd20b (patch)
treeea4f1d2ea73d6019f001c79df7669e7fb5a82816 /org.eclipse.jubula.documentation/developerManual
parent86bd6a5dc51616c4682978b66ae618d9ce289009 (diff)
downloadorg.eclipse.jubula.core-fd0f5d3983fdcdac85b3fddbd8a1e215893dd20b.tar.gz
org.eclipse.jubula.core-fd0f5d3983fdcdac85b3fddbd8a1e215893dd20b.tar.xz
org.eclipse.jubula.core-fd0f5d3983fdcdac85b3fddbd8a1e215893dd20b.zip
Non-sprint task - XML structure improvements: XML, EPL and doctype definition added; invalid structural containments fixed; basic pre-build validation for book.xml added.
Diffstat (limited to 'org.eclipse.jubula.documentation/developerManual')
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml10
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml10
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/functions/functions.xml10
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/gefToolkitExtension.xml10
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionAccessibilityPluginExample.xml44
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionCreatingAccessibilityPlugin.xml14
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/introduction/introduction.xml10
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/keyboardLayout/keyboardLayout.xml10
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionExtensionExamples.xml10
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionITEExtension.xml18
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRemoteControlExtension.xml20
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRequirements.xml10
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/toolkitExtension.xml10
13 files changed, 145 insertions, 41 deletions
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
index e185f410e..060e9aca8 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/book.xml
@@ -1,5 +1,13 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<book id="developerManual" version="5.0" xmlns="http://docbook.org/ns/docbook"
+<!--
+ Copyright (c) 2015 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
+ -->
+<!DOCTYPE book>
+<book xml:id="developerManual" 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" >
<title>Jubula Developer Manual</title>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml
index 01b7d1bbd..3021e6652 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/chapter.xml
@@ -1,4 +1,12 @@
-<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">
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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 xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink" xml:id="clientAPI" version="5.0">
<?dbhtml dir="clientAPI"?>
<title>Writing UI tests via API</title>
<para>...</para>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/functions/functions.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/functions/functions.xml
index 92154d12c..da1bfbba2 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/functions/functions.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/functions/functions.xml
@@ -1,4 +1,12 @@
-<chapter id="functions" version="5.0" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="functions" 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="functions"?>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/gefToolkitExtension.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/gefToolkitExtension.xml
index c397be9c6..611ba6280 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/gefToolkitExtension.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/gefToolkitExtension.xml
@@ -1,4 +1,12 @@
-<chapter id="creating-gef-toolkit-extensions" version="5.0" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="creating-gef-toolkit-extensions" 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="gefToolkitExtension"?>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionAccessibilityPluginExample.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionAccessibilityPluginExample.xml
index dc2968958..3ac37e06d 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionAccessibilityPluginExample.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionAccessibilityPluginExample.xml
@@ -1,19 +1,27 @@
-<section id="gefreference" 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">
- <title>Accessibility plug-in example</title>
- <para>
- A sample accessibility plug-in for certain elements of the Logic
- Diagram sample plug-in project (contributed from the GEF plug-ins
- to Eclipse’s New Project Wizard) are included in the installation.
- A default implementation can be found in the directory
- <emphasis role="input">examples/development/gef</emphasis>. There you will find a
- zip-file containing a full accessibility plug-in example.
- </para>
- You can import the sample accessibility plug-in into an Eclipse workspace in order to examine the general structure.
- The Java documentation of the source code, which is included in the target platform definition, contains information about
- <emphasis role="input">IEditPartIdentifier</emphasis> from the package named
- <para>
- <emphasis>org.eclipse.jubula.rc.rcp.gef.identifier</emphasis>.
- </para>
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Copyright (c) 2015 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="gefreference" 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">
+ <title>Accessibility plug-in example</title>
+ <para>
+ A sample accessibility plug-in for certain elements of the Logic
+ Diagram sample plug-in project (contributed from the GEF plug-ins
+ to Eclipse's New Project Wizard) are included in the installation.
+ A default implementation can be found in the directory
+ <emphasis role="input">examples/development/gef</emphasis>
+ . There you will find a
+ zip-file containing a full accessibility plug-in example.
+ </para>
+ <para>
+ You can import the sample accessibility plug-in into an Eclipse
+ workspace in order to examine the general structure.
+ The Java documentation of the source code, which is included in the
+ target platform definition, contains information about
+ <emphasis role="input">IEditPartIdentifier</emphasis>
+ from the package named <emphasis>org.eclipse.jubula.rc.rcp.gef.identifier</emphasis>.
+ </para>
</section> \ No newline at end of file
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionCreatingAccessibilityPlugin.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionCreatingAccessibilityPlugin.xml
index 2a6f6bedb..9612be231 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionCreatingAccessibilityPlugin.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/gefToolkitExtension/sectionCreatingAccessibilityPlugin.xml
@@ -1,8 +1,16 @@
-<section id="creating-an-accessibility-plug-in" version="5.0" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="creating-an-accessibility-plug-in" 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">
<title>Creating an accessibility plug-in</title>
- <section id="setting-up-your-workspace">
+ <section xml:id="setting-up-your-workspace">
<title>Setting up your Workspace</title>
<para>
Although you can use the IDE of your choice to develop your
@@ -37,7 +45,7 @@
</listitem>
</orderedlist>
</section>
- <section id="walkthrough">
+ <section xml:id="walkthrough">
<title>Walkthrough</title>
<para>
The first step for implementing your accessibility plug-in is to
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 ff07a4f37..9dceed5cd 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/introduction/introduction.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/introduction/introduction.xml
@@ -1,4 +1,12 @@
-<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">
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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 xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink" xml:id="introduction" version="5.0">
<?dbhtml dir="introduction"?>
<title>Introduction</title>
<para>This manual aims for Java and OSGi bundle developers. It describes how
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/keyboardLayout/keyboardLayout.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/keyboardLayout/keyboardLayout.xml
index 6fc90c961..b01bcd8b7 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/keyboardLayout/keyboardLayout.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/keyboardLayout/keyboardLayout.xml
@@ -1,4 +1,12 @@
-<chapter id="keyboardLayout" version="5.0" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="keyboardLayout" 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="keyboardLayout"?>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionExtensionExamples.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionExtensionExamples.xml
index 6f45ccc64..62ddaaf18 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionExtensionExamples.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionExtensionExamples.xml
@@ -1,4 +1,12 @@
-<section id="extensionExamples" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="extensionExamples" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xl="http://www.w3.org/1999/xlink">
<title>ITE and remote control extension examples</title>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionITEExtension.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionITEExtension.xml
index b57d65da6..3a773ae41 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionITEExtension.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionITEExtension.xml
@@ -1,4 +1,12 @@
-<section id="iteExtension" version="5.0" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="iteExtension" 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">
<title>ITE extension</title>
@@ -7,7 +15,7 @@
We describe the steps to create the toolkit plug-in and how it can
be exported.
</para>
- <section id="creating-the-toolkit-plug-in">
+ <section xml:id="creating-the-toolkit-plug-in">
<title>Creating the toolkit plug-in</title>
<para>
The following steps have to be done to extend the ITE toolkit:
@@ -125,7 +133,7 @@
the examples.
</para>
</section>
- <section id="deploying-the-toolkit-plug-in">
+ <section xml:id="deploying-the-toolkit-plug-in">
<title>Deploying the toolkit plug-in</title>
<para>
Once the toolkit feature has been created, it must be deployed
@@ -135,7 +143,7 @@
it is important that you have write access to the ITE so that
the installed feature can be accessed during test execution.
</para>
- <section id="create-an-update-site-for-the-toolkit-feature">
+ <section xml:id="create-an-update-site-for-the-toolkit-feature">
<title>Create an update site for the toolkit feature</title>
<orderedlist>
<listitem>
@@ -167,7 +175,7 @@
</listitem>
</orderedlist>
</section>
- <section id="install-the-toolkit-feature-from-the-update-site">
+ <section xml:id="install-the-toolkit-feature-from-the-update-site">
<title>Install the toolkit feature from the update site</title>
<orderedlist>
<listitem>
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRemoteControlExtension.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRemoteControlExtension.xml
index 6e8a655c6..9f2199604 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRemoteControlExtension.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRemoteControlExtension.xml
@@ -1,4 +1,12 @@
-<section id="remoteControlExtension" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="remoteControlExtension" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xl="http://www.w3.org/1999/xlink">
<title>Remote control extension</title>
@@ -12,7 +20,7 @@
component. You need to write a fragment for your component, which
contains the Tester Class and a corresponding adapter factory.
</para>
- <section id="creating-the-fragment">
+ <section xml:id="creating-the-fragment">
<title>Creating the fragment</title>
<para>
The following steps have to be done to extend the remote
@@ -92,7 +100,7 @@
in <xref linkend="extensionExamples"/>, we describe in general how
to create an adapter and Tester Classes.
</para>
- <section id="creating-an-adapter">
+ <section xml:id="creating-an-adapter">
<title>Creating an adapter</title>
<para>
To use an adapter you have to implement the interface
@@ -132,7 +140,7 @@
step is to implement one or more Tester Class.
</para>
</section>
- <section id="creating-a-tester-class">
+ <section xml:id="creating-a-tester-class">
<title>Creating a Tester Class</title>
<para>
The functionally important aspect of a Tester Class is that it
@@ -221,7 +229,7 @@
</listitem>
</itemizedlist>
</section>
- <section id="creating-an-container-adapter">
+ <section xml:id="creating-an-container-adapter">
<title>Creating an container adapter</title>
<para>
This is a JavaFX exclusive way to extend the functionality of Jubula. You
@@ -248,7 +256,7 @@
</para>
</section>
</section>
- <section id="deploying-the-fragment">
+ <section xml:id="deploying-the-fragment">
<title>Deploying the fragment</title>
<para>
Once you have written your fragment, you still need to make all
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRequirements.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRequirements.xml
index cebfaa835..a519128f0 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRequirements.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/sectionRequirements.xml
@@ -1,4 +1,12 @@
-<section id="requirements" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="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>
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 1a320a9e7..a072fcadc 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/toolkitExtension.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/toolkitExtension/toolkitExtension.xml
@@ -1,4 +1,12 @@
-<chapter id="toolkitExtension" version="5.0" xmlns="http://docbook.org/ns/docbook"
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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="toolkitExtension" 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="toolkitExtension"?>

Back to the top