summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Goldthorpe2011-10-18 19:42:28 (EDT)
committerChris Goldthorpe2011-10-18 19:42:28 (EDT)
commit989d7d2ef1adaed5185c5bb54ab71234c27056b0 (patch)
treea6ea53c6117dc0b3872e4d128f2b5dcce4d1cb77
parentd4f5cd9ab4cbe5c6b5a9757582d2277fc8476a09 (diff)
downloadeclipse.platform.common-989d7d2ef1adaed5185c5bb54ab71234c27056b0.zip
eclipse.platform.common-989d7d2ef1adaed5185c5bb54ab71234c27056b0.tar.gz
eclipse.platform.common-989d7d2ef1adaed5185c5bb54ab71234c27056b0.tar.bz2
Bug 349851 - [Doc] Document -displayHelpWindow parameter to standalone
help
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/images/readmeviewcommand.pngbin2956 -> 2956 bytes
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm0
-rw-r--r--bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm6
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd.htm0
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm0
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm0
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_expressions.htm0
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm0
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm0
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm0
-rw-r--r--[-rwxr-xr-x]bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_services.htm0
11 files changed, 5 insertions, 1 deletions
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/images/readmeviewcommand.png b/bundles/org.eclipse.platform.doc.isv/guide/images/readmeviewcommand.png
index cef3257..cef3257 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/images/readmeviewcommand.png
+++ b/bundles/org.eclipse.platform.doc.isv/guide/images/readmeviewcommand.png
Binary files differ
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm b/bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm
index 4199ded..4199ded 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm b/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm
index d7ed51e..2af01bc 100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm
@@ -111,7 +111,11 @@ The <code>org.eclipse.help.standalone.Help</code> class has a main method you ca
use to launch stand-alone help from the command line. The command line arguments
syntax is:
</p>
-<pre><em><span style="font-style: normal">-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]</span></em></pre>
+<pre><em><span style="font-style: normal">-command start | shutdown | ((displayHelp | displayHelpWindow) [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]</span></em></pre>
+<p>The command <code>start</code> starts a headless help server. <code>shutdown</code> shuts down the server.
+The command <code>displayHelp</code> starts the server and causes the help UI to display in an Eclipse shell.
+<code>displayHelpWindow</code> is similar to <code>displayHelp</code>, the difference being that the help server
+will shut down when the shell is closed.<p>
<P>A simple way to display help is to invoke</P>
<pre>java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp</pre><P>from within d:\myApp\eclipse directory, where <code>version</code> is the plug-in's version. To display a specific TOC file or topic use</P>
<PRE>java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm</PRE>
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd.htm b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd.htm
index 1490810..1490810 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd.htm
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm
index c5e55c3..c5e55c3 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm
index c566af2..c566af2 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_expressions.htm b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_expressions.htm
index 1561492..1561492 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_expressions.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_expressions.htm
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm
index a37f33f..a37f33f 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm
index 2b9dc69..2b9dc69 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm b/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm
index 2851b3c..2851b3c 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_services.htm b/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_services.htm
index 4fd85e3..4fd85e3 100755..100644
--- a/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_services.htm
+++ b/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_services.htm