From f9a41d1598007e76911da88346e542a2b4cb6284 Mon Sep 17 00:00:00 2001 From: Martin Oberhuber < martin.oberhuber@windriver.com> Date: Mon, 11 Jun 2007 11:25:59 +0000 Subject: [PATCH] [doc] Add SD Wizard User Docs --- .../HelpContexts.xml | 39 +++++++++++++++++++ .../META-INF/MANIFEST.MF | 2 +- .../SDWizard.html | 39 +++++++++++++++++++ .../build.properties | 6 ++- .../plugin.xml | 24 ++++++++++++ .../ServiceDiscoveryWizardMainPage.java | 10 ++++- .../org.eclipse.tm.discovery.wizard/toc.xml | 16 ++++++++ 7 files changed, 133 insertions(+), 3 deletions(-) create mode 100644 discovery/org.eclipse.tm.discovery.wizard/HelpContexts.xml create mode 100644 discovery/org.eclipse.tm.discovery.wizard/SDWizard.html create mode 100644 discovery/org.eclipse.tm.discovery.wizard/plugin.xml create mode 100644 discovery/org.eclipse.tm.discovery.wizard/toc.xml diff --git a/discovery/org.eclipse.tm.discovery.wizard/HelpContexts.xml b/discovery/org.eclipse.tm.discovery.wizard/HelpContexts.xml new file mode 100644 index 00000000000..a2f7a7c6792 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.wizard/HelpContexts.xml @@ -0,0 +1,39 @@ + + + + + + Service Discovery allows detecting remote servers using different protocol and transports. + + + + + The address can be a multicast address or a multicast address can be suggested by checking the "multicast" checkbox. + + + + Transport to be used to query the remote device. + + + + Discovery protocol to be used to query the remote device. + + + + Message to be sent to the remote device to start the discovery process. It can be empty in some protocols. + + + + Maximum amount of time (in ms) between replies before ending the discovery session. + + + diff --git a/discovery/org.eclipse.tm.discovery.wizard/META-INF/MANIFEST.MF b/discovery/org.eclipse.tm.discovery.wizard/META-INF/MANIFEST.MF index 3287984bc5e..cdd9d3c5f48 100644 --- a/discovery/org.eclipse.tm.discovery.wizard/META-INF/MANIFEST.MF +++ b/discovery/org.eclipse.tm.discovery.wizard/META-INF/MANIFEST.MF @@ -1,7 +1,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName -Bundle-SymbolicName: org.eclipse.tm.discovery.wizard +Bundle-SymbolicName: org.eclipse.tm.discovery.wizard;singleton:=true Bundle-Version: 2.0.0.qualifier Bundle-Activator: org.eclipse.tm.internal.discovery.wizard.Activator Bundle-Localization: plugin diff --git a/discovery/org.eclipse.tm.discovery.wizard/SDWizard.html b/discovery/org.eclipse.tm.discovery.wizard/SDWizard.html new file mode 100644 index 00000000000..3d3ece4af01 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.wizard/SDWizard.html @@ -0,0 +1,39 @@ + + + + + + + +Service Discovery Wizard + + +

Service Discovery Wizard

+ +

+

Address

+Address of the device to be queried. +The address can be a multicast address or a multicast address can be suggested by checking the "multicast" checkbox. +

+

+

Transport

+Transport to be used to query the remote device. +

+

+

Protocol

+Discovery protocol to be used to query the remote device. +

+

+

Discovery Query

+Message to be sent to the remote device to start the discovery process. It can be empty in some protocols. +

+

+

Timeout

+Maximum amount of time (in ms) between replies before ending the discovery session. +

+
+ +When clicking the "Next" button, the discovery process will start, and the discovered services and their attributes will be shown in a tree. + + + diff --git a/discovery/org.eclipse.tm.discovery.wizard/build.properties b/discovery/org.eclipse.tm.discovery.wizard/build.properties index 3c938de06c5..5c25573d67b 100644 --- a/discovery/org.eclipse.tm.discovery.wizard/build.properties +++ b/discovery/org.eclipse.tm.discovery.wizard/build.properties @@ -13,5 +13,9 @@ output.. = bin/ bin.includes = META-INF/,\ about.html,\ plugin.properties,\ - . + .,\ + HelpContexts.xml,\ + SDWizard.html,\ + plugin.xml,\ + toc.xml src.includes = about.html diff --git a/discovery/org.eclipse.tm.discovery.wizard/plugin.xml b/discovery/org.eclipse.tm.discovery.wizard/plugin.xml new file mode 100644 index 00000000000..a8f37b6a3f8 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.wizard/plugin.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + diff --git a/discovery/org.eclipse.tm.discovery.wizard/src/org/eclipse/tm/internal/discovery/wizard/ServiceDiscoveryWizardMainPage.java b/discovery/org.eclipse.tm.discovery.wizard/src/org/eclipse/tm/internal/discovery/wizard/ServiceDiscoveryWizardMainPage.java index 08fa803a663..c384c1468a1 100644 --- a/discovery/org.eclipse.tm.discovery.wizard/src/org/eclipse/tm/internal/discovery/wizard/ServiceDiscoveryWizardMainPage.java +++ b/discovery/org.eclipse.tm.discovery.wizard/src/org/eclipse/tm/internal/discovery/wizard/ServiceDiscoveryWizardMainPage.java @@ -26,6 +26,7 @@ import org.eclipse.swt.widgets.Label; import org.eclipse.swt.widgets.Text; import org.eclipse.tm.discovery.protocol.ProtocolFactory; import org.eclipse.tm.discovery.transport.TransportFactory; +import org.eclipse.ui.PlatformUI; /** * Main wizard page for the service discovery process.
@@ -104,7 +105,7 @@ public class ServiceDiscoveryWizardMainPage extends WizardPage { }); addressText.setLayoutData(data); - + PlatformUI.getWorkbench().getHelpSystem().setHelp(addressText,"org.eclipse.tm.discovery.wizard.address"); //$NON-NLS-1$ Composite comp2 = new Composite(comp,SWT.NULL); GridLayout layout2 = new GridLayout(); @@ -180,6 +181,7 @@ public class ServiceDiscoveryWizardMainPage extends WizardPage { }); transportCombo.setLayoutData(data); + PlatformUI.getWorkbench().getHelpSystem().setHelp(transportCombo,"org.eclipse.tm.discovery.wizard.transport"); //$NON-NLS-1$ new Label(comp,SWT.NULL).setText(Messages.getString("ServiceDiscoveryWizardMainPage.ProtocolLabel")); //$NON-NLS-1$ @@ -221,6 +223,7 @@ public class ServiceDiscoveryWizardMainPage extends WizardPage { }); protocolCombo.setLayoutData(data); + PlatformUI.getWorkbench().getHelpSystem().setHelp(protocolCombo,"org.eclipse.tm.discovery.wizard.protocol"); //$NON-NLS-1$ new Label(comp,SWT.NULL).setText(Messages.getString("ServiceDiscoveryWizardMainPage.DiscoveryQueryLabel")); //$NON-NLS-1$ @@ -235,6 +238,7 @@ public class ServiceDiscoveryWizardMainPage extends WizardPage { queryCombo.select(0); queryCombo.setLayoutData(data); + PlatformUI.getWorkbench().getHelpSystem().setHelp(queryCombo,"org.eclipse.tm.discovery.wizard.query"); //$NON-NLS-1$ new Label(comp,SWT.NULL).setText(Messages.getString("ServiceDiscoveryWizardMainPage.TimeOutLabel")); //$NON-NLS-1$ @@ -243,11 +247,15 @@ public class ServiceDiscoveryWizardMainPage extends WizardPage { timeOutText.redraw(); timeOutText.setLayoutData(data); + PlatformUI.getWorkbench().getHelpSystem().setHelp(timeOutText,"org.eclipse.tm.discovery.wizard.timeout"); //$NON-NLS-1$ setPageComplete(false); setControl(comp); + PlatformUI.getWorkbench().getHelpSystem().setHelp(getControl(), "org.eclipse.tm.discovery.wizard.general"); //$NON-NLS-1$ + + } /** diff --git a/discovery/org.eclipse.tm.discovery.wizard/toc.xml b/discovery/org.eclipse.tm.discovery.wizard/toc.xml new file mode 100644 index 00000000000..43f21cb637d --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.wizard/toc.xml @@ -0,0 +1,16 @@ + + + + + + \ No newline at end of file