-
-
-
-
+
+
+
Help
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm
index 024bdc80ec9..cb7e49448d3 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm
@@ -1,16 +1,11 @@
-
-
+
+
-
-
-
-
+ "Copyright (c) IBM Corporation and others 2010, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.">
+
+
+
Using AbstractHelpScope to filter an information center
@@ -39,7 +34,7 @@
The example above shows the bare minimum required to embed a command in an HTML link.
The Eclipse documentation supplements this with two extra pieces of information.
-First a class attribute is specified to allow for tuning the look of the link
+First a class attribute is specified to allow for tuning the look of the link
via CSS. Second, an image tag is included before the link text. The image serves
to distinguish command links from ordinary links to other HTML pages. Supplementing
our initial example with these two extra features will look like this:
@@ -54,7 +53,7 @@
Authoring a Command Link
In the examples above, the About dialog command does not require any parameters, so the
-serialization is merely its command id: org.eclipse.ui.help.aboutAction.
+serialization is merely its command id: org.eclipse.ui.help.aboutAction.
Below is another example showing a command with a parameter. Note the command id is
followed by the parameter id and value in parentheses:
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm
index 33db60218f3..34206ae025f 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm
@@ -1,10 +1,9 @@
-
+
-
-
-
+
+
Adding criteria to help content
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm
index 4242b890a5e..fc554d0fd66 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm
@@ -1,11 +1,10 @@
-
+
-
-
-
-
+
+
+
Help server and file locations
@@ -86,7 +85,7 @@
National Language and Translated Documentation
resource, like images which differ between system, should be placed under ws
or os directories for specific platform.
-
The href argument can also refer to content from another
plug-in. This is done by using a special cross plug-in referencing
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_manifest.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_manifest.htm
index b5db5c00e76..1e39d2aae40 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_manifest.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_manifest.htm
@@ -1,12 +1,14 @@
-
+
Help->Help Contents, you should see your example appear in the list
of books. If you click on the "Online Help Sample", you'll see your toc structure:
-
If you wish to use includes in your XHTML,
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context.htm
index 11fc37d2e8f..24635ddc9b2 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context.htm
@@ -1,11 +1,10 @@
-
+
window. However, it is still possible to configure context help presentation to
use infopops in the Help preferences. For example, here is an infopop that has been defined on
the General/Search page:
-
-
+
+
Since Eclipse 3.1, infopops have a link to show the currently displayed
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_xml.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_xml.htm
index db7eb64fd23..644fe0b0fb8 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_xml.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_xml.htm
@@ -1,11 +1,10 @@
-
+
When developing an information center sometimes not all of the books show as expected or
customizations do not have the desired effect. The about.html page can be used to get information
about installed plug-ins and help system preferences. If the home page of the help system is
-
http://<hostname>:<port>/help/index.jsp
the about page has a url of
-
http://<hostname>:<port>/help/about.html
+
https://<hostname>:<port>/help/index.jsp
the about page has a url of
+
https://<hostname>:<port>/help/about.html
Without any parameters the about page shows a list of all plug-ins installed on the system.
Parameters can be added to show other kinds of information as follows:
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_help_data.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_help_data.htm
index 97a632af447..7a8370ab77a 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_help_data.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_help_data.htm
@@ -1,18 +1,15 @@
-
-
+
+
-
+ "Copyright (c) IBM Corporation and others 2006, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.">
+
Help Data
-
-
-
@@ -33,7 +41,7 @@
Help System Customization
org.eclipse.help Plug-in:
-
+
Preference key
@@ -94,7 +102,7 @@
org.eclipse.help Plug-in:
org.eclipse.help.base Plug-in:
-
+
Preference key
@@ -377,7 +385,7 @@
org.eclipse.help.base Plug-in:
false
-
+
remoteHelpOn
Controls whether or not remote help is enabled.
@@ -490,7 +498,7 @@
org.eclipse.help.base Plug-in:
org.eclipse.help.appserver Plug-in:
Deprecated: This plug-in is no longer used by help. See table for alternative usage.
-
+
Preference key
@@ -524,7 +532,7 @@
org.eclipse.help.appserver Plug-in:
org.eclipse.tomcat Plug-in:
Deprecated: This plug-in is no longer used by help. No alternative commands available.
-
+
Preference key
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm
index e9db2cf64ee..805a3b95dfb 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm
@@ -1,11 +1,10 @@
-
+
-
-
-
-
+
+
+
Pre-indexing documentation
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_rcp.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_rcp.htm
index e706bc9e6d5..18cbde46ace 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_rcp.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_rcp.htm
@@ -1,11 +1,10 @@
-
+
-
-
-
-
+
+
+
Rich Client Platform (RCP) help
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm
index 7edc0f42cff..dff7812069f 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm
@@ -1,11 +1,10 @@
-
+
-
-
-
-
+
+
+
Standalone help
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_war.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_war.htm
index 64f0a024d77..7e100d1b555 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_war.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_war.htm
@@ -1,11 +1,10 @@
-
+
-
-
-
-
+
+
+
Deploying the information center as a Web Archive
@@ -18,30 +17,30 @@
In the Git repository locate the infocenter-web directory and underneath that there will be two directories titled infocenter-app and infocenter-product.
+
In the Git repository locate the infocenter-web directory and underneath that there will be two directories titled infocenter-app and infocenter-product.
Make sure you have the "m2e - Maven Integration for Eclipse" feature installed in your Eclipse IDE.
-
Import the infocenter-web Maven project using File->Import->Existing Project.
-
Add some documentation plugins to the infocenter-web/infocenter-app/src/main/webapp/WEB-INF/plugins directory.
-
Register the plugins in infocenter-web/infocenter-app/src/main/webapp/WEB-INF/configuration/org.eclipse.equinox.simpleconfigurator/bundles.info
+
Import the infocenter-web Maven project using File->Import->Existing Project.
+
Add some documentation plugins to the infocenter-web/infocenter-app/src/main/webapp/WEB-INF/plugins directory.
+
Register the plugins in infocenter-web/infocenter-app/src/main/webapp/WEB-INF/configuration/org.eclipse.equinox.simpleconfigurator/bundles.info
Install required Maven POMs from Eclipse Platform:
-Notes: If you look in the config.ini the help.war file under directory help/WEB_INF/configuration you will notice the line eclipse.product=org.eclipse.productname.
+Notes: If you look in the config.ini the help.war file under directory help/WEB_INF/configuration you will notice the line eclipse.product=org.eclipse.productname.
If your product has help system customizations in a product plugin you can activate these by changing this line to point to your product plugin.
Troubleshooting
@@ -49,14 +48,14 @@
Troubleshooting
HTTP 404 With Message "BridgeServlet: /help/"
-In the web.xml activate the init parameter enableFrameworkControls. This enables endpoints to control the embedded OSGi container. Call http://localhost:8080/help/sp_test.
+In the web.xml activate the init parameter enableFrameworkControls. This enables endpoints to control the embedded OSGi container. Call http://localhost:8080/help/sp_test.
-You should see the message "Servlet delegate registered - org.eclipse.equinox.http.servlet.HttpServiceServlet". You may instead see the message "Servlet delegate not registered.".
-This indicates that bundle activator from bundle org.eclipse.equinox.http.servletbridge was not started or that it accesses a different instance of class org.eclipse.equinox.servletbridge.BridgeServlet.
+You should see the message "Servlet delegate registered - org.eclipse.equinox.http.servlet.HttpServiceServlet". You may instead see the message "Servlet delegate not registered.".
+This indicates that bundle activator from bundle org.eclipse.equinox.http.servletbridge was not started or that it accesses a different instance of class org.eclipse.equinox.servletbridge.BridgeServlet.
-For all available framework control endpoints refer to org.eclipse.equinox.servletbridge.BridgeServlet.serviceFrameworkControls(HttpServletRequest, HttpServletResponse).
+For all available framework control endpoints refer to org.eclipse.equinox.servletbridge.BridgeServlet.serviceFrameworkControls(HttpServletRequest, HttpServletResponse).