|
|
|
Re: eclipse help system [message #474600 is a reply to message #474559] |
Tue, 07 October 2008 16:33 |
Chris Goldthorpe Messages: 815 Registered: July 2009 |
Senior Member |
|
|
Yes, you can override it. Here's an example from the UA test suite of
how to customize various properties including help_home.
Scenario D: Customization
D1: Help preferences
Create a file plugin_customization.ini in the root of Eclipse
installation. Edit the file and paste the following key/values pairs:
org.eclipse.help/baseTOCS=/org.eclipse.platform.doc.isv/toc. xml,/org.eclipse.jdt.doc.isv/toc.xml
org.eclipse.help/ignoredTOCS=/org.eclipse.platform.doc.user/ toc.xml,/org.eclipse.jdt.doc.user/toc.xml,/org.eclipse.pde.d oc.user/toc.xml
org.eclipse.help/HELP_DATA=
org.eclipse.help.base/topic_css=/org.eclipse.ua.tests/non_ju nit/css/topic.css
org.eclipse.help.base/nav_css=/org.eclipse.ua.tests/non_juni t/css/nav.css
org.eclipse.help.base/narrow_css=/org.eclipse.ua.tests/non_j unit/css/narrow.css
org.eclipse.help.base/disabled_css=/org.eclipse.ua.tests/non _junit/css/disabled.css
org.eclipse.help.base/help_home=http://www.eclipse.org
org.eclipse.help.base/banner=/org.eclipse.help.webapp/advanc ed/banner.html
org.eclipse.help.base/banner_height=60
org.eclipse.help.base/help_home=http://www.eclipse.org
org.eclipse.help.base/linksView=false
org.eclipse.help.base/bookmarksView=false
org.eclipse.help.base/windowTitlePrefix=false
org.eclipse.help.base/advanced.toolbarBackground=green
org.eclipse.help.base/advanced.viewBackground=yellow
org.eclipse.help.base/advanced.toolbarFont=bold 1.0em sans-serif
org.eclipse.help.base/advanced.viewFont=italic 1.0em sans-serif
org.eclipse.help.base/showDisabledActivityTopics=never
org.eclipse.help.base/activeHelp=false
<!-- You can skip this step
Download the eclipse automated test framework and install into your
Eclipse installation.
Download the eclipse automated tests and copy the plugin
org.eclipse.ua.tests into your Eclipse plugins directory.
-->
Launch Eclipse, pointing to the preferences customization, e.g. eclipse
-pluginCustomization plugin_customization.ini
From the workbench menu: Help->Help Contents. This should open the help
browser. Verify existence of banner frame above search toolbar.
The page displayed in the content frame should be eclipse.org page.
There should be only two Eclipse books displayed Plugin Developer Guide
and JDT Development Guide, in that order. Other Eclipse books should not
appear.
Search for "workbench". Verify there are no hits from Workbench User
Guide that is not present.
Verify there is only Contents, Index and Search tabs at the bottom of
navigation frame, other views (Links and Bookmarks) are not present.
Verify the browser title shows product name.
|
|
|
Re: eclipse help system [message #474601 is a reply to message #474600] |
Wed, 08 October 2008 12:16 |
Eclipse User |
|
|
|
Originally posted by: grazmadze.napr.gov.ge
Hi Chris. I tried to use plugin_customization.ini with only line:
org.eclipse.help.base/help_home = /help/my_help_home.html
where 'help' is a folder in eclipse's plugins folder. I got
'The topic that you have requested is not available. The link may be
wrong, or you may not have the corresponding product feature installed.
This online help only includes documentation for features that are
installed.'
Can't I use simple file instead of a valid URL?
We are going to use only eclipse help system. We started with this article
http://www-128.ibm.com/developerworks/opensource/library/os- echelp/index.html
Thanks.
Chris Goldthorpe wrote:
> Yes, you can override it. Here's an example from the UA test suite of
> how to customize various properties including help_home.
>
> Scenario D: Customization
> D1: Help preferences
> Create a file plugin_customization.ini in the root of Eclipse
> installation. Edit the file and paste the following key/values pairs:
>
> org.eclipse.help/baseTOCS=/org.eclipse.platform.doc.isv/toc. xml,/org.eclipse.jdt.doc.isv/toc.xml
>
> org.eclipse.help/ignoredTOCS=/org.eclipse.platform.doc.user/ toc.xml,/org.eclipse.jdt.doc.user/toc.xml,/org.eclipse.pde.d oc.user/toc.xml
>
> org.eclipse.help/HELP_DATA=
>
> org.eclipse.help.base/topic_css=/org.eclipse.ua.tests/non_ju nit/css/topic.css
>
> org.eclipse.help.base/nav_css=/org.eclipse.ua.tests/non_juni t/css/nav.css
> org.eclipse.help.base/narrow_css=/org.eclipse.ua.tests/non_j unit/css/narrow.css
>
> org.eclipse.help.base/disabled_css=/org.eclipse.ua.tests/non _junit/css/disabled.css
>
>
> org.eclipse.help.base/help_home=http://www.eclipse.org
>
> org.eclipse.help.base/banner=/org.eclipse.help.webapp/advanc ed/banner.html
> org.eclipse.help.base/banner_height=60
> org.eclipse.help.base/help_home=http://www.eclipse.org
> org.eclipse.help.base/linksView=false
> org.eclipse.help.base/bookmarksView=false
> org.eclipse.help.base/windowTitlePrefix=false
> org.eclipse.help.base/advanced.toolbarBackground=green
> org.eclipse.help.base/advanced.viewBackground=yellow
> org.eclipse.help.base/advanced.toolbarFont=bold 1.0em sans-serif
> org.eclipse.help.base/advanced.viewFont=italic 1.0em sans-serif
> org.eclipse.help.base/showDisabledActivityTopics=never
> org.eclipse.help.base/activeHelp=false
>
>
> <!-- You can skip this step
> Download the eclipse automated test framework and install into your
> Eclipse installation.
>
> Download the eclipse automated tests and copy the plugin
> org.eclipse.ua.tests into your Eclipse plugins directory.
> -->
>
>
> Launch Eclipse, pointing to the preferences customization, e.g. eclipse
> -pluginCustomization plugin_customization.ini
>
> From the workbench menu: Help->Help Contents. This should open the help
> browser. Verify existence of banner frame above search toolbar.
>
> The page displayed in the content frame should be eclipse.org page.
>
> There should be only two Eclipse books displayed Plugin Developer Guide
> and JDT Development Guide, in that order. Other Eclipse books should not
> appear.
>
> Search for "workbench". Verify there are no hits from Workbench User
> Guide that is not present.
>
> Verify there is only Contents, Index and Search tabs at the bottom of
> navigation frame, other views (Links and Bookmarks) are not present.
>
> Verify the browser title shows product name.
>
>
|
|
|
|
Re: eclipse help system [message #474603 is a reply to message #474602] |
Thu, 09 October 2008 12:22 |
Eclipse User |
|
|
|
Originally posted by: grazmadze.napr.gov.ge
Hi Chris,
unfortunately it does not work for me. I got the same warning.
Here is directory hierarchy and files I referred
c:\
---- eclipse
|----- plugins
|----- org.eclipse.help.base_3.3.1.v20070813_33x
|----- doc
help_home.html
....
....
org.eclipse.help.base_3.3.1.v20070813_33x.jar
....
plugin_customization.ini file content is
org.eclipse.help.base/help_home=/org.eclipse.help.base_3.3.1 .v20070813_33x/doc/help_home.html
If I write path with some backslash e.g.
org.eclipse.help.base/help_home=\help
I get
HTTP ERROR: 404
ProxyServlet: /help/topichelp
RequestURI=/help/topichelp
Powered by Jetty://
If I keep empty right side of '=', I get empty welcome page without
content and any warning.
And with any valid URL I get web page content.
Thank you for time and attention.
Chris Goldthorpe wrote:
> If you do something like this
>
> org.eclipse.help.base/help_home = /<plugin_name>/<path_within_plugin>
>
> it should work for you.
>
|
|
|
|
Re: eclipse help system [message #474612 is a reply to message #474606] |
Mon, 13 October 2008 12:00 |
Eclipse User |
|
|
|
Originally posted by: grazmadze.napr.gov.ge
Sorry, found the problem. It was a plug-in manifest issue. Thanks Chris.
Chris Goldthorpe wrote:
> Try
> org.eclipse.help.base/help_home=/org.eclipse.help.base/doc/h elp_home.html
>
> instead of
>
> org.eclipse.help.base/help_home=/org.eclipse.help.base_3.3.1 .v20070813_33x/doc/help_home.html
>
>
> help uses the id of the plugin, not the name of the folder or jar file
> where it lives.
>
|
|
|
Re: eclipse help system [message #474613 is a reply to message #474606] |
Mon, 13 October 2008 12:56 |
Eclipse User |
|
|
|
Originally posted by: grazmadze.napr.gov.ge
Hi Chris, I forgot to mention that a plug-in manifest issue was the last
one and before I corrected plugin's id. Thank you again.
Chris Goldthorpe wrote:
> Try
> org.eclipse.help.base/help_home=/org.eclipse.help.base/doc/h elp_home.html
>
> instead of
>
> org.eclipse.help.base/help_home=/org.eclipse.help.base_3.3.1 .v20070813_33x/doc/help_home.html
>
>
> help uses the id of the plugin, not the name of the folder or jar file
> where it lives.
|
|
|
|
|
Re: eclipse help system [message #620066 is a reply to message #474559] |
Tue, 07 October 2008 16:33 |
Chris Goldthorpe Messages: 815 Registered: July 2009 |
Senior Member |
|
|
Yes, you can override it. Here's an example from the UA test suite of
how to customize various properties including help_home.
Scenario D: Customization
D1: Help preferences
Create a file plugin_customization.ini in the root of Eclipse
installation. Edit the file and paste the following key/values pairs:
org.eclipse.help/baseTOCS=/org.eclipse.platform.doc.isv/toc. xml,/org.eclipse.jdt.doc.isv/toc.xml
org.eclipse.help/ignoredTOCS=/org.eclipse.platform.doc.user/ toc.xml,/org.eclipse.jdt.doc.user/toc.xml,/org.eclipse.pde.d oc.user/toc.xml
org.eclipse.help/HELP_DATA=
org.eclipse.help.base/topic_css=/org.eclipse.ua.tests/non_ju nit/css/topic.css
org.eclipse.help.base/nav_css=/org.eclipse.ua.tests/non_juni t/css/nav.css
org.eclipse.help.base/narrow_css=/org.eclipse.ua.tests/non_j unit/css/narrow.css
org.eclipse.help.base/disabled_css=/org.eclipse.ua.tests/non _junit/css/disabled.css
org.eclipse.help.base/help_home=http://www.eclipse.org
org.eclipse.help.base/banner=/org.eclipse.help.webapp/advanc ed/banner.html
org.eclipse.help.base/banner_height=60
org.eclipse.help.base/help_home=http://www.eclipse.org
org.eclipse.help.base/linksView=false
org.eclipse.help.base/bookmarksView=false
org.eclipse.help.base/windowTitlePrefix=false
org.eclipse.help.base/advanced.toolbarBackground=green
org.eclipse.help.base/advanced.viewBackground=yellow
org.eclipse.help.base/advanced.toolbarFont=bold 1.0em sans-serif
org.eclipse.help.base/advanced.viewFont=italic 1.0em sans-serif
org.eclipse.help.base/showDisabledActivityTopics=never
org.eclipse.help.base/activeHelp=false
<!-- You can skip this step
Download the eclipse automated test framework and install into your
Eclipse installation.
Download the eclipse automated tests and copy the plugin
org.eclipse.ua.tests into your Eclipse plugins directory.
-->
Launch Eclipse, pointing to the preferences customization, e.g. eclipse
-pluginCustomization plugin_customization.ini
From the workbench menu: Help->Help Contents. This should open the help
browser. Verify existence of banner frame above search toolbar.
The page displayed in the content frame should be eclipse.org page.
There should be only two Eclipse books displayed Plugin Developer Guide
and JDT Development Guide, in that order. Other Eclipse books should not
appear.
Search for "workbench". Verify there are no hits from Workbench User
Guide that is not present.
Verify there is only Contents, Index and Search tabs at the bottom of
navigation frame, other views (Links and Bookmarks) are not present.
Verify the browser title shows product name.
|
|
|
Re: eclipse help system [message #620067 is a reply to message #474600] |
Wed, 08 October 2008 12:16 |
Eclipse User |
|
|
|
Originally posted by: grazmadze.napr.gov.ge
Hi Chris. I tried to use plugin_customization.ini with only line:
org.eclipse.help.base/help_home = /help/my_help_home.html
where 'help' is a folder in eclipse's plugins folder. I got
'The topic that you have requested is not available. The link may be
wrong, or you may not have the corresponding product feature installed.
This online help only includes documentation for features that are
installed.'
Can't I use simple file instead of a valid URL?
We are going to use only eclipse help system. We started with this article
http://www-128.ibm.com/developerworks/opensource/library/os- echelp/index.html
Thanks.
Chris Goldthorpe wrote:
> Yes, you can override it. Here's an example from the UA test suite of
> how to customize various properties including help_home.
>
> Scenario D: Customization
> D1: Help preferences
> Create a file plugin_customization.ini in the root of Eclipse
> installation. Edit the file and paste the following key/values pairs:
>
> org.eclipse.help/baseTOCS=/org.eclipse.platform.doc.isv/toc. xml,/org.eclipse.jdt.doc.isv/toc.xml
>
> org.eclipse.help/ignoredTOCS=/org.eclipse.platform.doc.user/ toc.xml,/org.eclipse.jdt.doc.user/toc.xml,/org.eclipse.pde.d oc.user/toc.xml
>
> org.eclipse.help/HELP_DATA=
>
> org.eclipse.help.base/topic_css=/org.eclipse.ua.tests/non_ju nit/css/topic.css
>
> org.eclipse.help.base/nav_css=/org.eclipse.ua.tests/non_juni t/css/nav.css
> org.eclipse.help.base/narrow_css=/org.eclipse.ua.tests/non_j unit/css/narrow.css
>
> org.eclipse.help.base/disabled_css=/org.eclipse.ua.tests/non _junit/css/disabled.css
>
>
> org.eclipse.help.base/help_home=http://www.eclipse.org
>
> org.eclipse.help.base/banner=/org.eclipse.help.webapp/advanc ed/banner.html
> org.eclipse.help.base/banner_height=60
> org.eclipse.help.base/help_home=http://www.eclipse.org
> org.eclipse.help.base/linksView=false
> org.eclipse.help.base/bookmarksView=false
> org.eclipse.help.base/windowTitlePrefix=false
> org.eclipse.help.base/advanced.toolbarBackground=green
> org.eclipse.help.base/advanced.viewBackground=yellow
> org.eclipse.help.base/advanced.toolbarFont=bold 1.0em sans-serif
> org.eclipse.help.base/advanced.viewFont=italic 1.0em sans-serif
> org.eclipse.help.base/showDisabledActivityTopics=never
> org.eclipse.help.base/activeHelp=false
>
>
> <!-- You can skip this step
> Download the eclipse automated test framework and install into your
> Eclipse installation.
>
> Download the eclipse automated tests and copy the plugin
> org.eclipse.ua.tests into your Eclipse plugins directory.
> -->
>
>
> Launch Eclipse, pointing to the preferences customization, e.g. eclipse
> -pluginCustomization plugin_customization.ini
>
> From the workbench menu: Help->Help Contents. This should open the help
> browser. Verify existence of banner frame above search toolbar.
>
> The page displayed in the content frame should be eclipse.org page.
>
> There should be only two Eclipse books displayed Plugin Developer Guide
> and JDT Development Guide, in that order. Other Eclipse books should not
> appear.
>
> Search for "workbench". Verify there are no hits from Workbench User
> Guide that is not present.
>
> Verify there is only Contents, Index and Search tabs at the bottom of
> navigation frame, other views (Links and Bookmarks) are not present.
>
> Verify the browser title shows product name.
>
>
|
|
|
|
Re: eclipse help system [message #620069 is a reply to message #474602] |
Thu, 09 October 2008 12:22 |
Eclipse User |
|
|
|
Originally posted by: grazmadze.napr.gov.ge
Hi Chris,
unfortunately it does not work for me. I got the same warning.
Here is directory hierarchy and files I referred
c:\
---- eclipse
|----- plugins
|----- org.eclipse.help.base_3.3.1.v20070813_33x
|----- doc
help_home.html
....
....
org.eclipse.help.base_3.3.1.v20070813_33x.jar
....
plugin_customization.ini file content is
org.eclipse.help.base/help_home=/org.eclipse.help.base_3.3.1 .v20070813_33x/doc/help_home.html
If I write path with some backslash e.g.
org.eclipse.help.base/help_home=\help
I get
HTTP ERROR: 404
ProxyServlet: /help/topichelp
RequestURI=/help/topichelp
Powered by Jetty://
If I keep empty right side of '=', I get empty welcome page without
content and any warning.
And with any valid URL I get web page content.
Thank you for time and attention.
Chris Goldthorpe wrote:
> If you do something like this
>
> org.eclipse.help.base/help_home = /<plugin_name>/<path_within_plugin>
>
> it should work for you.
>
|
|
|
|
Re: eclipse help system [message #620081 is a reply to message #474606] |
Mon, 13 October 2008 12:00 |
Eclipse User |
|
|
|
Originally posted by: grazmadze.napr.gov.ge
Sorry, found the problem. It was a plug-in manifest issue. Thanks Chris.
Chris Goldthorpe wrote:
> Try
> org.eclipse.help.base/help_home=/org.eclipse.help.base/doc/h elp_home.html
>
> instead of
>
> org.eclipse.help.base/help_home=/org.eclipse.help.base_3.3.1 .v20070813_33x/doc/help_home.html
>
>
> help uses the id of the plugin, not the name of the folder or jar file
> where it lives.
>
|
|
|
Re: eclipse help system [message #620083 is a reply to message #474606] |
Mon, 13 October 2008 12:56 |
Eclipse User |
|
|
|
Originally posted by: grazmadze.napr.gov.ge
Hi Chris, I forgot to mention that a plug-in manifest issue was the last
one and before I corrected plugin's id. Thank you again.
Chris Goldthorpe wrote:
> Try
> org.eclipse.help.base/help_home=/org.eclipse.help.base/doc/h elp_home.html
>
> instead of
>
> org.eclipse.help.base/help_home=/org.eclipse.help.base_3.3.1 .v20070813_33x/doc/help_home.html
>
>
> help uses the id of the plugin, not the name of the folder or jar file
> where it lives.
|
|
|
Powered by
FUDForum. Page generated in 0.07308 seconds