diff --git a/org.eclipse.tm.terminal.view/HelpContexts.xml b/org.eclipse.tm.terminal.view/HelpContexts.xml new file mode 100644 index 00000000000..4100b7979da --- /dev/null +++ b/org.eclipse.tm.terminal.view/HelpContexts.xml @@ -0,0 +1,26 @@ + + + + + + The Terminal View supports direct connections to target boards via serial or network connections. + + + + + + The Terminal Settings Dialog provides the controls for making terminal connections. + + + + + \ No newline at end of file diff --git a/org.eclipse.tm.terminal.view/build.properties b/org.eclipse.tm.terminal.view/build.properties index 2b7e553fdbc..39325f488b7 100644 --- a/org.eclipse.tm.terminal.view/build.properties +++ b/org.eclipse.tm.terminal.view/build.properties @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) 2003, 2006 Wind River Systems, Inc. and others. +# Copyright (c) 2003, 2008 Wind River Systems, Inc. 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 @@ -21,6 +21,12 @@ bin.includes = META-INF/,\ plugin.xml,\ icons/,\ plugin.properties,\ - about.html,about.ini,about.mappings,about.properties,\ - eclipse32.png + about.html,\ + about.ini,\ + about.mappings,\ + about.properties,\ + eclipse32.png,\ + HelpContexts.xml,\ + doc/,\ + toc.xml src.includes = about.html diff --git a/org.eclipse.tm.terminal.view/doc/book.css b/org.eclipse.tm.terminal.view/doc/book.css new file mode 100644 index 00000000000..faa4199fe34 --- /dev/null +++ b/org.eclipse.tm.terminal.view/doc/book.css @@ -0,0 +1 @@ +@import "../../PRODUCT_PLUGIN/book.css"; diff --git a/org.eclipse.tm.terminal.view/doc/html/01_terminalview.html b/org.eclipse.tm.terminal.view/doc/html/01_terminalview.html new file mode 100644 index 00000000000..0771833c053 --- /dev/null +++ b/org.eclipse.tm.terminal.view/doc/html/01_terminalview.html @@ -0,0 +1,44 @@ + + + + + + + + +Terminal View + + + + +

Terminal View

+
+

+The Terminal view provides a raw serial or network connection to your target board. +This view is useful for monitoring output on a target's serial port or making a telnet +connection to a device. +

+ + +Multiple Terminal view instances can be active at the same time, connected +to a number of remote systems or disconnected and just holding their settings +ready for re-connect. + +

+
       | Next >
+ + diff --git a/org.eclipse.tm.terminal.view/doc/html/02_terminal_page.html b/org.eclipse.tm.terminal.view/doc/html/02_terminal_page.html new file mode 100644 index 00000000000..f1b20507d96 --- /dev/null +++ b/org.eclipse.tm.terminal.view/doc/html/02_terminal_page.html @@ -0,0 +1,67 @@ + + + + + + + + +Terminal View Quick Reference + + + +

Terminal View Quick Reference

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Button

Description

Open another instance of the Terminal view.

Connect to selected port.

Disconnect from selected port.

Open the Terminal Settings dialog. + Only available when disconnected.

Toggle the Command Input field, + for editing complex command lines on dumb terminals.

+
+

+

+ +
+ Each instance of the Terminal view can be connected to a different remote endpoint + (either serial or network). Of course, the number of serial connections is limited by the + number of serial ports. +
+ +

+
< Prev | Next >
+ + + diff --git a/org.eclipse.tm.terminal.view/doc/html/03_terminal_settings.html b/org.eclipse.tm.terminal.view/doc/html/03_terminal_settings.html new file mode 100644 index 00000000000..130e9e40b87 --- /dev/null +++ b/org.eclipse.tm.terminal.view/doc/html/03_terminal_settings.html @@ -0,0 +1,101 @@ + + + + + + + + +Terminal Settings Dialog + + + +

Terminal Settings Dialog

+ +
+Use the Terminal Settings dialog to configure your connection. +
+
+In the Connection Type field choose Serial, SSH or Telnet. +
+
+The View Title field allows giving a name to your Terminal View instance. +
+ +

Serial Connection

+ +
+If you choose a serial connection, the Settings area has seven options: + Port, Baud Rate, Data Bits, Stop Bits, Parity, Flow Control, + and Timeout. +
+ +
+When you have entered your settings, click OK. This initiates your connection.
+ +
+Your connection information appears in the header of the Terminal view. +A cursor appears in the view itself. Hit ENTER to get a >NET> +prompt.
+ +

+
+ + + + + +
+

NOTE:When using the Terminal view on Linux or Solaris, + serial ports ttyS0 and ttyS1 must have appropriate permissions + set in order to connect to them, unless you are running the Workbench as root. +

  
+
+ +

+

SSH Connection

+ +
+If you choose an SSH connection, the Settings area has six options. +In the Host and Port fields, enter the IP Address and port of the host +you wish to connect to. +The User field specifies the remote user id to use. +The Password field is optional, since SSH can re-use your private keys +as specified on the Eclipse Preferences, General, Network Page. +The Timeout can be changed for very slow networks. The +KeepAlive value specifies an interval in seconds, by which the Terminal +automatically sends a packet to the remote host in order to keep the connection +alive even in case of inactivity. +

When all settings are specified, click +OK. This initiates your connection.

+ + +

+

Telnet Connection

+ +
+If you choose a Telnet connection, the Settings area has three options. +In the Host field, enter the IP Address of the host you wish to connect to. +In the Port field, select the network port you wish to use. +The Timeout can be changed for very slow networks. Then click +OK. This initiates your connection.
+ +
+Your connection information appears in the header of the Terminal view. +A cursor appears in the view itself. Hit ENTER to get a >NET> prompt. +
+ +

+
< Prev | Next >
+ + + diff --git a/org.eclipse.tm.terminal.view/doc/html/04_terminal_emulation.html b/org.eclipse.tm.terminal.view/doc/html/04_terminal_emulation.html new file mode 100644 index 00000000000..0b987d5e87b --- /dev/null +++ b/org.eclipse.tm.terminal.view/doc/html/04_terminal_emulation.html @@ -0,0 +1,64 @@ + + + + + + + + +Terminal Emulation + + + +

Terminal Emulation

+ +
+The Terminal view is an ANSI-conformant terminal emulator. You can use the +Terminal view to telnet into a remote UNIX host. +
+ +
+To do so, set the TERM environment variable on the remote host to ansi. +This enables programs on the remote host, such as vi and Emacs, +to display text properly. +The Terminal view does not currently support other emulation modes, such as VT100. +
+ +
+The size of the terminal window as understood by the remote is automatically +adjusted as the size of your Terminal view changes. +The colors and font used by the Terminal can be configured in the +Eclipse Preferences, Appearance section. A separate Terminal Preference +Page allows inverting the terminal colors easily if desired. +
+ +

Optional Command Input Field

+ +
+The optional Command Input Field can be enabled when sending commands to a dumb +terminal that does not support cursor keys for editing. In such a case, the +Command Input Field provides a full editor that supports cursor navigation, copy +and paste, as well as a history of previous commands that can be accessed by +Ctrl+Space content assist. +
+ +
+If more space than the default single editing line is needed for very complex commands, +the Command Input Field can be enlarged by dragging its upper handle up with +the mouse. +
+ +

+
< Prev |
+ + + diff --git a/org.eclipse.tm.terminal.view/doc/html/notice.html b/org.eclipse.tm.terminal.view/doc/html/notice.html new file mode 100644 index 00000000000..ce5f8a404b9 --- /dev/null +++ b/org.eclipse.tm.terminal.view/doc/html/notice.html @@ -0,0 +1,30 @@ + + + + + + + + +Legal Notice + + + +

Legal Notice

+

+The material in this guide is Copyright (c) Wind River Systems, Inc. and others 2004, 2008. +

+

+Terms and conditions regarding the use of this guide. +

+ + \ No newline at end of file diff --git a/org.eclipse.tm.terminal.view/plugin.xml b/org.eclipse.tm.terminal.view/plugin.xml index 40cf63faad6..504ec8b41e3 100644 --- a/org.eclipse.tm.terminal.view/plugin.xml +++ b/org.eclipse.tm.terminal.view/plugin.xml @@ -1,7 +1,7 @@ + + + + + + + + + diff --git a/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalSettingsDlg.java b/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalSettingsDlg.java index 6f44eeda7ed..77edd0fa318 100644 --- a/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalSettingsDlg.java +++ b/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalSettingsDlg.java @@ -14,6 +14,7 @@ * Michael Scharf (Wind River) - split into core, view and connector plugins * Martin Oberhuber (Wind River) - fixed copyright headers and beautified * Martin Oberhuber (Wind River) - [168197] Replace JFace MessagDialog by SWT MessageBox + * Martin Oberhuber (Wind River) - [168186] Add Terminal User Docs *******************************************************************************/ package org.eclipse.tm.internal.terminal.view; @@ -43,6 +44,7 @@ import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.Text; import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage; import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector; +import org.eclipse.ui.PlatformUI; class TerminalSettingsDlg extends Dialog { private Combo fCtlConnTypeCombo; @@ -163,6 +165,8 @@ class TerminalSettingsDlg extends Dialog { } protected Control createDialogArea(Composite parent) { Composite ctlComposite = (Composite) super.createDialogArea(parent); + PlatformUI.getWorkbench().getHelpSystem().setHelp(ctlComposite, TerminalViewPlugin.HELPPREFIX + "terminal_settings"); //$NON-NLS-1$ + setupPanel(ctlComposite); setupListeners(); initFields(); diff --git a/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalView.java b/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalView.java index cb52cf9bdbf..c9135cddcd5 100644 --- a/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalView.java +++ b/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalView.java @@ -18,6 +18,7 @@ * Michael Scharf (Wind River) - [189774] Ctrl+V does not work in the command input field. * Michael Scharf (Wind River) - [217999] Duplicate context menu entries in Terminal * Anna Dushistova (MontaVista) - [227537] moved actions from terminal.view to terminal plugin + * Martin Oberhuber (Wind River) - [168186] Add Terminal User Docs *******************************************************************************/ package org.eclipse.tm.internal.terminal.view; @@ -65,6 +66,7 @@ import org.eclipse.ui.IViewReference; import org.eclipse.ui.IViewSite; import org.eclipse.ui.IWorkbenchPage; import org.eclipse.ui.PartInitException; +import org.eclipse.ui.PlatformUI; import org.eclipse.ui.part.ViewPart; public class TerminalView extends ViewPart implements ITerminalView, ITerminalListener { @@ -192,7 +194,7 @@ public class TerminalView extends ViewPart implements ITerminalView, ITerminalLi // The second argument to showView() is a unique String identifying the // secondary view instance. If it ever matches a previously used secondary // view identifier, then this call will not create a new Terminal view, - // which is undesireable. Therefore, we append the current time in + // which is undesirable. Therefore, we append the current time in // milliseconds to the secondary view identifier to ensure it is always // unique. This code runs only when the user clicks the New Terminal // button, so there is no risk that this code will run twice in a single @@ -367,6 +369,8 @@ public class TerminalView extends ViewPart implements ITerminalView, ITerminalLi setupContextMenus(); setupListeners(wndParent); + PlatformUI.getWorkbench().getHelpSystem().setHelp(wndParent, TerminalViewPlugin.HELPPREFIX + "terminal_page"); //$NON-NLS-1$ + onTerminalStatus(); onTerminalFontChanged(); } @@ -392,6 +396,7 @@ public class TerminalView extends ViewPart implements ITerminalView, ITerminalLi protected void setupControls(Composite wndParent) { ITerminalConnector[] connectors = makeConnectors(); fCtlTerminal = TerminalViewControlFactory.makeControl(this, wndParent, connectors); + String connectionType=fStore.get(STORE_CONNECTION_TYPE); for (int i = 0; i < connectors.length; i++) { connectors[i].load(getStore(connectors[i])); diff --git a/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalViewPlugin.java b/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalViewPlugin.java index 41017326ca9..63194117efd 100644 --- a/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalViewPlugin.java +++ b/org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalViewPlugin.java @@ -14,6 +14,7 @@ * Michael Scharf (Wind River) - split into core, view and connector plugins * Martin Oberhuber (Wind River) - fixed copyright headers and beautified * Anna Dushistova (MontaVista) - [227537] moved actions from terminal.view to terminal plugin + * Martin Oberhuber (Wind River) - [168186] Add Terminal User Docs *******************************************************************************/ package org.eclipse.tm.internal.terminal.view; @@ -31,6 +32,8 @@ import org.eclipse.ui.plugin.AbstractUIPlugin; public class TerminalViewPlugin extends AbstractUIPlugin { protected static TerminalViewPlugin fDefault; + public static final String HELPPREFIX = "org.eclipse.tm.terminal.view."; //$NON-NLS-1$ + /** * The constructor. */ diff --git a/org.eclipse.tm.terminal.view/toc.xml b/org.eclipse.tm.terminal.view/toc.xml new file mode 100644 index 00000000000..4409655e2b2 --- /dev/null +++ b/org.eclipse.tm.terminal.view/toc.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + \ No newline at end of file