mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-07-03 07:05:24 +02:00
[doc] Add SD Wizard User Docs
This commit is contained in:
Martin Oberhuber
parent
bad92ee3cf
commit
f9a41d1598
7 changed files with 133 additions and 3 deletions
39
discovery/org.eclipse.tm.discovery.wizard/HelpContexts.xml
Normal file
39
discovery/org.eclipse.tm.discovery.wizard/HelpContexts.xml
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?NLS TYPE="org.eclipse.help.contexts"?>
|
||||
<!--
|
||||
Copyright (c) 2007 Symbian Software Ltd. and others.
|
||||
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
|
||||
|
||||
Contributors:
|
||||
Javier Montalvo Orus (Symbian) - initial API and implementation
|
||||
-->
|
||||
<contexts>
|
||||
<context id="general">
|
||||
<description> Service Discovery allows detecting remote servers using different protocol and transports.</description>
|
||||
<topic href="SDWizard.html" label="Service Discovery Wizard"/>
|
||||
</context>
|
||||
|
||||
<context id="address">
|
||||
<description>The address can be a multicast address or a multicast address can be suggested by checking the "multicast" checkbox.</description>
|
||||
</context>
|
||||
|
||||
<context id="transport">
|
||||
<description>Transport to be used to query the remote device.</description>
|
||||
</context>
|
||||
|
||||
<context id="protocol">
|
||||
<description>Discovery protocol to be used to query the remote device.</description>
|
||||
</context>
|
||||
|
||||
<context id="query">
|
||||
<description>Message to be sent to the remote device to start the discovery process. It can be empty in some protocols.</description>
|
||||
</context>
|
||||
|
||||
<context id="timeout">
|
||||
<description>Maximum amount of time (in ms) between replies before ending the discovery session.</description>
|
||||
</context>
|
||||
|
||||
</contexts>
|
||||
|
|
@ -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
|
||||
|
|
|
|||
39
discovery/org.eclipse.tm.discovery.wizard/SDWizard.html
Normal file
39
discovery/org.eclipse.tm.discovery.wizard/SDWizard.html
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<meta name="copyright" content="Copyright (c) 2007 Symbian Software Ltd. and others. This page is made available under license. For full details see the about.html file in the plugin that contains this page." >
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>Service Discovery Wizard</title>
|
||||
</head>
|
||||
<body id="sdwizard"><a name="sdwizard"><!-- --></a>
|
||||
<h1 class="topictitle1">Service Discovery Wizard</h1>
|
||||
|
||||
<p>
|
||||
<h3>Address</h3>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
<h3>Transport</h3>
|
||||
Transport to be used to query the remote device.
|
||||
</p>
|
||||
<p>
|
||||
<h3>Protocol</h3>
|
||||
Discovery protocol to be used to query the remote device.
|
||||
</p>
|
||||
<p>
|
||||
<h3>Discovery Query</h3>
|
||||
Message to be sent to the remote device to start the discovery process. It can be empty in some protocols.
|
||||
</p>
|
||||
<p>
|
||||
<h3>Timeout</h3>
|
||||
Maximum amount of time (in ms) between replies before ending the discovery session.
|
||||
</p>
|
||||
<br/>
|
||||
|
||||
When clicking the <strong>"Next"</strong> button, the discovery process will start, and the discovered services and their attributes will be shown in a tree.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -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
|
||||
|
|
|
|||
24
discovery/org.eclipse.tm.discovery.wizard/plugin.xml
Normal file
24
discovery/org.eclipse.tm.discovery.wizard/plugin.xml
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?eclipse version="3.2"?>
|
||||
<!--
|
||||
Copyright (c) 2007 Symbian Software Ltd. and others. 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
|
||||
|
||||
Contributors:
|
||||
Javier Montalvo Orus (Symbian) - initial API and implementation
|
||||
-->
|
||||
|
||||
<plugin>
|
||||
<extension point="org.eclipse.help.contexts">
|
||||
<contexts file="HelpContexts.xml"/>
|
||||
</extension>
|
||||
<extension point="org.eclipse.help.toc">
|
||||
<toc file="toc.xml"/>
|
||||
</extension>
|
||||
|
||||
</plugin>
|
||||
|
||||
|
||||
|
||||
|
|
@ -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.</br>
|
||||
|
|
@ -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$
|
||||
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
16
discovery/org.eclipse.tm.discovery.wizard/toc.xml
Normal file
16
discovery/org.eclipse.tm.discovery.wizard/toc.xml
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<?NLS TYPE="org.eclipse.help.toc"?>
|
||||
<!--
|
||||
Copyright (c) 2006, 2007 Wind River Systems, Inc.
|
||||
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
|
||||
|
||||
Contributors:
|
||||
Martin Oberhuber (Wind River) - initial API and implementation
|
||||
-->
|
||||
<toc link_to="../org.eclipse.rse.doc.user/toc.xml#rse_user_extensions"
|
||||
label="Service Discovery Wizard">
|
||||
<topic label="Service Discovery Wizard" href="SDWizard.html"/>
|
||||
</toc>
|
||||
Loading…
Add table
Reference in a new issue