news.eclipse.platform.ua

[news.eclipse.platform.ua] Use HELP_DATA to both hide and set ordering for books in nav frame

nospam_kowalskilee@xxxxxxx (Lee Anne Kowalski) — Sat, 27 Jun 2009 21:39:26 GMT

Hi Erlend,

No worries about newbie questions, that's what this group is for!

To hide and to set ordering for the books in the nav frame, use the HELP_DATA customization preference.

Descriptions of the customization preferences available for the help system is located here: http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/ua_help_setup_preferences.htm

And details about the HELP_DATA file format are here:
http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/ua_help_setup_help_data.htm

For an infocenter, you'd set the plugin_customization parameter to point to a plugin_customization.ini file, and in that file is where you set the different customization parameters such as HELP_DATA, banner, etc.

Depending on which way you prefer, you can specify the plugin_customization parameter on the startup command for the infocenter, like: -plugincustomization plugin_customization.ini

or in the plugin.xml file for your "product plug-in", like:

And the plugin_customization.ini file would have a line like:
org.eclipse.help/HELP_DATA=helpdata.xml
to point to your helpdata.xml file.

On your other questions about the URL format, I'll have to leave that for someone else to answer.

Hope this helps,
Lee Anne

Erlend Leganger wrote:

I apologize for the newbie questions, but I'm trying to get to know Eclipse UA with the intent to use it to provide help for a standard (non-Eclipse) application. I have searched a bit, but haven't found the answers I need.

I have come so far that I have created two help books, they are stored in eclipse/plugins/mydoc.ops and /mydoc.tech respectively. When I then start the InfoCenter and point my web browser at localhost:8080/help/index.jsp, I see the books Workbench User Guide, Java development user guide, Platform Plug-in Developer Guide, JDT Plug-in Developer Guide, Plug-in Development Environment Guide and then finally my two books MyDoc - Ops and MyDoc - Tech.

And now for the questions: - How can I control which books are displayed in the navigation pane? I want to show my books only and not include the Eclipse specific books. - How can I control the order of the books in the navigation pane? - Can I change the initial URL from localhost:8080/help/index.jsp to for example localhost:8080/mydoc/index.jsp? - Is it possible to get an automatic redirect from localhost:8080 to the correct URL? If I go to localhost:8080 now, I get an 404 telling me that no context is matched.

My configuration is Eclipse 3.4.2 on Windows7, slimmed down for Help purposes using the procedure in http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm. I suspect I need to work with the files in the plugins directory, so I have included a complete list of the files at http://pastebin.com/m58290423 (it's 800+ lines long).
Again sorry for the noob questions, hope you can help.
- Erlend Leganger

[news.eclipse.platform.ua] Basic Eclipse UA questions

eleganger@xxxxxxx (Erlend Leganger) — Fri, 26 Jun 2009 21:03:11 GMT

I apologize for the newbie questions, but I'm trying to get to know Eclipse UA with the intent to use it to provide help for a standard (non-Eclipse) application. I have searched a bit, but haven't found the answers I need.

I have come so far that I have created two help books, they are stored in eclipse/plugins/mydoc.ops and /mydoc.tech respectively. When I then start the InfoCenter and point my web browser at localhost:8080/help/index.jsp, I see the books Workbench User Guide, Java development user guide, Platform Plug-in Developer Guide, JDT Plug-in Developer Guide, Plug-in Development Environment Guide and then finally my two books MyDoc - Ops and MyDoc - Tech.

And now for the questions: - How can I control which books are displayed in the navigation pane? I want to show my books only and not include the Eclipse specific books. - How can I control the order of the books in the navigation pane? - Can I change the initial URL from localhost:8080/help/index.jsp to for example localhost:8080/mydoc/index.jsp? - Is it possible to get an automatic redirect from localhost:8080 to the correct URL? If I go to localhost:8080 now, I get an 404 telling me that no context is matched.

My configuration is Eclipse 3.4.2 on Windows7, slimmed down for Help purposes using the procedure in http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm. I suspect I need to work with the files in the plugins directory, so I have included a complete list of the files at http://pastebin.com/m58290423 (it's 800+ lines long).

Again sorry for the noob questions, hope you can help.

- Erlend Leganger

[news.eclipse.platform.ua] Re: intro xml - html tags inside text element

stella_levin2003@xxxxxxx (Stella ) — Mon, 22 Jun 2009 12:51:53 GMT

I implemented it with static html pages instead, like the following: introcontent.xml url="how_to_run.html" />

how_to_run.html





How to run

tralala
trululu

[news.eclipse.platform.ua] intro xml - html tags inside text element

stella_levin2003@xxxxxxx (Stella ) — Mon, 22 Jun 2009 09:39:46 GMT

Hi, thanks a lot for previous answer, it helped.
My question is about usage of html tags in text part of intro xml.
I find in the manual that it can include li, p, b tags.
I tried different combination of the following page, but it didn't work:

How to run tralala trululu Define the test name to work with: set u = "unit name" Create working directory and make it to be a current directory mkdir test; cd test Invocate test: test -name $u -data . The result is that it display the header "How to run" and the first line without tags "tralala". After that all the rest doesn't appear. Thanks, Stella

[news.eclipse.platform.ua] Re: Standalone infocenter home page and locale

marcos.lois@xxxxxxx (Marcos Lois Bermúdez) — Sat, 20 Jun 2009 18:08:15 GMT

Chris Goldthorpe escribió:

I'll answer the second question first. This is not so easy to implement, see https://bugs.eclipse.org/bugs/show_bug.cgi?id=268568 for something which almost works, you may be able to to tweak the solution so it works completely.

Hi, thanks for the reply, i read the discusion on bug and related ones, and get conclusion to create a servlet and define a extension point for it, this servlet will make the redirection, i try it soon as posible, i'm very sorprising that the web.xml descriptor are ignored for welcome pages, i will surf a bit more in equinox servlet bridge to figure what this happen.

I did not completely understand the first question - are you talking about the parameter which is passed in when you start the infocenter?

Excuse my litle description, i mean the ?locale=es parameter that can be added to infocenter URL to switch it locale, for example i'm a spanish guy my browser locale is es_ES, but documentation not always is avaliable or is out of date in spanish, and i fall back to english, so let the users to change this easy will be great for centric infocenter, so i try to implement it on upper banner with a locale selection based on locales configured in eclipse help base.

A lot of thanks for your reply, this stupid think tell me more headdache, and i can't realy fin it on bug serarch.

Marcos Lois Bermúdez wrote:
Hello,
After some tests i finally have a standalone infocenter so i created a war and it works nicely, but i have some problems with it.

- The first problem that i have is with locales, when the infocenter is run, i think that the only manner to change the locale is pass the locale URL parameter, of course configuring valid locales in properties of infocenter, so can i display the list of supported locales in the top banner?

- The second problem, the most important to me, so i can understand how eclipse servlet bridge works is that when i access the http://infocenter/help i see a blank page, only the help is show when i put ../help/index.jsp y try to configure it on web.xml but seems that tomcat (i use it for test the war) is ignoring my welcome page. Is posible to define the default page to show when no jsp is in URL?
Regards.

[news.eclipse.platform.ua] Re: Standalone infocenter home page and locale

cgold@xxxxxxx (Chris Goldthorpe) — Fri, 19 Jun 2009 18:00:22 GMT

I'll answer the second question first. This is not so easy to implement, see https://bugs.eclipse.org/bugs/show_bug.cgi?id=268568 for something which almost works, you may be able to to tweak the solution so it works completely.

I did not completely understand the first question - are you talking about the parameter which is passed in when you start the infocenter?

Marcos Lois Bermúdez wrote:

Hello,
After some tests i finally have a standalone infocenter so i created a war and it works nicely, but i have some problems with it.

- The first problem that i have is with locales, when the infocenter is run, i think that the only manner to change the locale is pass the locale URL parameter, of course configuring valid locales in properties of infocenter, so can i display the list of supported locales in the top banner?

- The second problem, the most important to me, so i can understand how eclipse servlet bridge works is that when i access the http://infocenter/help i see a blank page, only the help is show when i put ../help/index.jsp y try to configure it on web.xml but seems that tomcat (i use it for test the war) is ignoring my welcome page. Is posible to define the default page to show when no jsp is in URL?
Regards.

[news.eclipse.platform.ua] Re: cannot find intro page of exported product; image in intro.xml

cgold@xxxxxxx (Chris Goldthorpe) — Fri, 19 Jun 2009 17:49:43 GMT

1. Unfortunately we do not have an editor for intro content. This has been requested before.

2. I'm not sure why intro is not finding introcontent.xml but the first place I would look is build.properties to see if it is included in the list of files that get exported in a binary build. Also plug-ins with intro content should be exported unjarred.

3. The tag is not the usual way of adding images, usually it is done in the CSS. If you take a look at the intro contributions in org.eclipse.platform you can see how images are created in the platform contributions.

Stella wrote:

Hi, I try to define my own intro content. I have several questions: 1) Is there a convenient editor to create intro content, like for plugin.xml or for cheat-sheet page? When I create it manually - it looks ugly. 2) I define my intro page in plugin.xml as the following. When I export the ploduct - it cannot find the introcontent.xml file. When I change content to "$nl$/introcontent.xml - it still cannot find it. point="org.eclipse.ui.intro.config"> content="introcontent.xml" id="org.xxx.yyy.configid" introId="org.xxx.yyy.intro"> home-page-id="root"> kind="html" os="linux"> 3) I try to add image to my intro like below. It cannot find an image. Thanks, Stella

[news.eclipse.platform.ua] Standalone infocenter home page and locale

marcos.lois@xxxxxxx (Marcos Lois Bermúdez) — Fri, 19 Jun 2009 09:30:42 GMT

Hello,

After some tests i finally have a standalone infocenter so i created a war and it works nicely, but i have some problems with it.

- The first problem that i have is with locales, when the infocenter is run, i think that the only manner to change the locale is pass the locale URL parameter, of course configuring valid locales in properties of infocenter, so can i display the list of supported locales in the top banner?

- The second problem, the most important to me, so i can understand how eclipse servlet bridge works is that when i access the http://infocenter/help i see a blank page, only the help is show when i put ../help/index.jsp y try to configure it on web.xml but seems that tomcat (i use it for test the war) is ignoring my welcome page. Is posible to define the default page to show when no jsp is in URL?

Regards.

[news.eclipse.platform.ua] Re: Eclipse Help System WAR file does not pick up plugin_customization

ly_robert@xxxxxxx (robert ly) — Thu, 18 Jun 2009 20:51:31 GMT

Nevermind, i found the answer to this in an older thread. You have to include the plugin ID and extension ID for the eclipse.product property. The docs only mention that you need plugin ID I believe...

[news.eclipse.platform.ua] Eclipse Help System WAR file does not pick up plugin_customization

ly_robert@xxxxxxx (robert ly) — Thu, 18 Jun 2009 20:38:06 GMT

I am migrating some plugins that were previously hosted in the IEHS standalone Eclipse help system to a Eclipse 3.4 Help system WAR deployment. I set the eclipse.product property in config.ini to the plugin that contains my plugin_customization.ini (eclipse.product=com.emc.ic.help), but the customizations are not picked up. They worked fine in the IEHS deployment. Here is the plugin_customization file:

org.eclipse.help.base/banner=/com.emc.ic.help/banner.htm
org.eclipse.help.base/banner_height=110
org.eclipse.help.base/windowTitlePrefix=false
org.eclipse.help.base/linksView=false
org.eclipse.help.base/help_home=/com.emc.ic.help/using_system/about_the_system.html
org.eclipse.help/baseTOCS=/com.emc.ic.help/toc.xml

So, I went ahead and modified preferences.ini in org.eclipse.help.base to get the banner to show up. That worked fine, but I assume this isn't ideal. So I went to go do the same thing in the org.eclipse.help plugin to get my plugins to be ordered, and even when modifying the preferences.ini inside that plugin, I can't get my books to be ordered correctly.

Also, I clear my Tomcat cache every time I make a change. Any ideas? The documentation on the WAR deployment is very sparse.