Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Testing Help Runtime
Testing Help Runtime [message #527057] Tue, 13 April 2010 16:48 Go to next message
Miles Parker is currently offline Miles Parker
Messages: 1338
Registered: July 2009
Senior Member
[Moved from general platform discussion]

Hi,

I've been doing a lot of documentation lately, and though the tools are great, there is one aspect that is a little awkward. In order to see what the docs will look like to user, I have to launch an Eclipse runtime with my docs plugin and then from that launch the Help browser. This is especially inefficient because I'm on a mac so the help browser is external. I recognize that sometimes edits are available immediately, but that doesn't work for all changes. (I do wikitext generation for example.)

Is there a better usage pattern here? Anyway to launch the help browser directly from host development environment without going through intermediate step of Eclipse runtime?

thanks,

Miles
Re: Testing Help Runtime [message #528554 is a reply to message #527057] Tue, 20 April 2010 19:26 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
The only way right now to see your documents exactly as they will appear to the user is to start Eclipse. The help server processes the html files to add breadcrumbs, include css files etc.
Re: Testing Help Runtime [message #528556 is a reply to message #527057] Tue, 20 April 2010 19:34 Go to previous messageGo to next message
Miles Parker is currently offline Miles Parker
Messages: 1338
Registered: July 2009
Senior Member
Thanks Chris.. Is there any way to reload help content -- i.e. restart the help server w/o exiting the runtime, relaunching it and then relaunching help?
Re: Testing Help Runtime [message #528562 is a reply to message #528556] Tue, 20 April 2010 22:28 Go to previous messageGo to next message
Chris Austin is currently offline Chris Austin
Messages: 28
Registered: July 2009
Junior Member
Miles - what I do to minimize the restart time is run eclipse in infocenter mode. To do this, create a new Eclipse Application run configuration, and select org.eclipse.help.base.infocenterApplication under 'Run an application:' Then, under VM arguments, add the param -Dserver_port=10000 (or some other port you like that is open) and you can launch a browser to http://127.0.0.1:10000/help/index.jsp

Infocenter mode takes less time to startup, and it starts with help system already running.
Re: Testing Help Runtime [message #528779 is a reply to message #528562] Wed, 21 April 2010 13:55 Go to previous messageGo to next message
Miles Parker is currently offline Miles Parker
Messages: 1338
Registered: July 2009
Senior Member
Chris Austin wrote on Tue, 20 April 2010 22:28
Miles - what I do to minimize the restart time is run eclipse in infocenter mode. To do this, create a new Eclipse Application run configuration, and select org.eclipse.help.base.infocenterApplication under 'Run an application:' Then, under VM arguments, add the param -Dserver_port=10000 (or some other port you like that is open) and you can launch a browser to http://127.0.0.1:10000/help/index.jsp

Infocenter mode takes less time to startup, and it starts with help system already running.


Hey, that's excellent! Just what I was looking for with original post actually. With this approach, I can simply launch the app in a few seconds and then refresh my browser. BTW, for other folks trying this, it took a few minuted to figure out the dependencies that the app server needs. But assuming that you already have a dependency on the help items for your doc plugin, you need to add org.eclipse.help.webapp and org.eclipse.help.appserver then add the required dependencies. Also, don't forget to kill the prior app before launching a new one or you'll get a socket in use exception.

Re: Testing Help Runtime [message #540685 is a reply to message #528779] Wed, 16 June 2010 20:58 Go to previous messageGo to next message
Miles Parker is currently offline Miles Parker
Messages: 1338
Registered: July 2009
Senior Member
Miles Parker wrote on Wed, 21 April 2010 13:55
Chris Austin wrote on Tue, 20 April 2010 22:28
Miles - what I do to minimize the restart time is run eclipse in infocenter mode. To do this, create a new Eclipse Application run configuration, and select org.eclipse.help.base.infocenterApplication under 'Run an application:' Then, under VM arguments, add the param -Dserver_port=10000 (or some other port you like that is open) and you can launch a browser to http://127.0.0.1:10000/help/index.jsp




Hmmm... this was working but now its not. I'm on RC4. When I start up I get the below. It goes through startup and then just stops itself. Anyone have any ideas what might be going wrong here? (Probably something dumb.)

17:56:05.622 [Start Help Server] INFO org.mortbay.log - Logging to Logger[org.mortbay.log] via org.mortbay.log.Slf4jLog
17:56:05.643 [Start Help Server] DEBUG org.mortbay.log - Container Server@6ab30913 + SelectChannelConnector@0.0.0.0:10000 as connector
17:56:05.670 [Start Help Server] DEBUG org.mortbay.log - filterNameMap=null
17:56:05.670 [Start Help Server] DEBUG org.mortbay.log - pathFilters=null
17:56:05.670 [Start Help Server] DEBUG org.mortbay.log - servletFilterMap=null
17:56:05.670 [Start Help Server] DEBUG org.mortbay.log - servletPathMap={/*=org.eclipse.equinox.http.jetty.internal.H ttpServerManager$InternalHttpServiceServlet-2125581447}
17:56:05.670 [Start Help Server] DEBUG org.mortbay.log - servletNameMap={org.eclipse.equinox.http.jetty.internal.Http ServerManager$InternalHttpServiceServlet-2125581447=org.ecli pse.equinox.http.jetty.internal.HttpServerManager$InternalHt tpServiceServlet-2125581447}
17:56:05.671 [Start Help Server] DEBUG org.mortbay.log - Container Server@6ab30913 + org.mortbay.jetty.servlet.Context@75bc16f0{/help,null} as handler
17:56:05.671 [Start Help Server] DEBUG org.mortbay.log - Container ServletHandler@f8622f3 + org.eclipse.equinox.http.jetty.internal.HttpServerManager$In ternalHttpServiceServlet-2125581447 as servlet
17:56:05.671 [Start Help Server] DEBUG org.mortbay.log - Container ServletHandler@f8622f3 + (S=org.eclipse.equinox.http.jetty.internal.HttpServerManager $InternalHttpServiceServlet-2125581447,[/*]) as servletMapping
17:56:05.671 [Start Help Server] DEBUG org.mortbay.log - Container SessionHandler@2f60877b + ServletHandler@f8622f3 as handler
17:56:05.671 [Start Help Server] DEBUG org.mortbay.log - Container SessionHandler@2f60877b + org.mortbay.jetty.servlet.HashSessionManager@6a5eb489 as sessionManager
17:56:05.671 [Start Help Server] DEBUG org.mortbay.log - Container org.mortbay.jetty.servlet.Context@75bc16f0{/help,null} + SessionHandler@2f60877b as handler
17:56:05.672 [Start Help Server] INFO org.mortbay.log - jetty-6.1.x
17:56:05.680 [Start Help Server] DEBUG org.mortbay.log - Container Server@6ab30913 + org.mortbay.thread.QueuedThreadPool@7ca522a6 as threadpool
17:56:05.683 [Start Help Server] DEBUG org.mortbay.log - started org.mortbay.thread.QueuedThreadPool@7ca522a6
17:56:05.693 [Start Help Server] DEBUG org.mortbay.log - Container org.mortbay.jetty.servlet.Context@75bc16f0{/help,null} + ErrorHandler@3ef07355 as errorHandler
17:56:05.694 [Start Help Server] DEBUG org.mortbay.log - Container Server@6ab30913 + org.mortbay.jetty.servlet.HashSessionIdManager@7bd33a6b as sessionIdManager
17:56:05.694 [Start Help Server] DEBUG org.mortbay.log - Init SecureRandom.
17:56:05.695 [Start Help Server] DEBUG org.mortbay.log - started org.mortbay.jetty.servlet.HashSessionIdManager@7bd33a6b
17:56:05.696 [Start Help Server] DEBUG org.mortbay.log - started org.mortbay.jetty.servlet.HashSessionManager@6a5eb489
17:56:05.696 [Start Help Server] DEBUG org.mortbay.log - filterNameMap=null
17:56:05.696 [Start Help Server] DEBUG org.mortbay.log - pathFilters=null
17:56:05.696 [Start Help Server] DEBUG org.mortbay.log - servletFilterMap=null
17:56:05.696 [Start Help Server] DEBUG org.mortbay.log - servletPathMap={/*=org.eclipse.equinox.http.jetty.internal.H ttpServerManager$InternalHttpServiceServlet-2125581447}
17:56:05.697 [Start Help Server] DEBUG org.mortbay.log - servletNameMap={org.eclipse.equinox.http.jetty.internal.Http ServerManager$InternalHttpServiceServlet-2125581447=org.ecli pse.equinox.http.jetty.internal.HttpServerManager$InternalHt tpServiceServlet-2125581447}
17:56:05.697 [Start Help Server] DEBUG org.mortbay.log - starting ServletHandler@f8622f3
17:56:05.697 [Start Help Server] DEBUG org.mortbay.log - started ServletHandler@f8622f3
17:56:05.697 [Start Help Server] DEBUG org.mortbay.log - starting SessionHandler@2f60877b
17:56:05.697 [Start Help Server] DEBUG org.mortbay.log - started SessionHandler@2f60877b
17:56:05.697 [Start Help Server] DEBUG org.mortbay.log - starting org.mortbay.jetty.servlet.Context@75bc16f0{/help,null}
17:56:05.697 [Start Help Server] DEBUG org.mortbay.log - starting ErrorHandler@3ef07355
17:56:05.697 [Start Help Server] DEBUG org.mortbay.log - started ErrorHandler@3ef07355
17:56:05.699 [Start Help Server] DEBUG org.mortbay.log - started org.eclipse.equinox.http.jetty.internal.HttpServerManager$In ternalHttpServiceServlet-2125581447
17:56:05.699 [Start Help Server] DEBUG org.mortbay.log - started org.mortbay.jetty.servlet.Context@75bc16f0{/help,null}
17:56:05.699 [Start Help Server] DEBUG org.mortbay.log - starting Server@6ab30913
17:56:05.706 [Start Help Server] DEBUG org.mortbay.log - started org.mortbay.jetty.nio.SelectChannelConnector$1@744d76b4
17:56:05.718 [Start Help Server] INFO org.mortbay.log - Started SelectChannelConnector@0.0.0.0:10000
17:56:05.718 [Start Help Server] DEBUG org.mortbay.log - started SelectChannelConnector@0.0.0.0:10000
17:56:05.718 [Start Help Server] DEBUG org.mortbay.log - started Server@6ab30913
17:56:05.776 [Stop Help Server] DEBUG org.mortbay.log - stopped org.mortbay.jetty.nio.SelectChannelConnector$1@744d76b4
17:56:05.777 [Stop Help Server] DEBUG org.mortbay.log - stopped SelectChannelConnector@0.0.0.0:10000
17:56:05.777 [Stop Help Server] DEBUG org.mortbay.log - stopping Server@6ab30913
17:56:05.777 [Stop Help Server] DEBUG org.mortbay.log - stopping org.mortbay.jetty.servlet.Context@75bc16f0{/help,null}
17:56:05.777 [Stop Help Server] DEBUG org.mortbay.log - stopping SessionHandler@2f60877b
17:56:05.777 [Stop Help Server] DEBUG org.mortbay.log - stopping ServletHandler@f8622f3
17:56:05.779 [Stop Help Server] DEBUG org.mortbay.log - stopped org.eclipse.equinox.http.jetty.internal.HttpServerManager$In ternalHttpServiceServlet-2125581447
17:56:05.779 [Stop Help Server] DEBUG org.mortbay.log - stopped ServletHandler@f8622f3
17:56:05.779 [Stop Help Server] DEBUG org.mortbay.log - stopped org.mortbay.jetty.servlet.HashSessionManager@6a5eb489
17:56:05.779 [Stop Help Server] DEBUG org.mortbay.log - stopped SessionHandler@2f60877b
17:56:05.781 [Stop Help Server] DEBUG org.mortbay.log - stopping ErrorHandler@3ef07355
17:56:05.781 [Stop Help Server] DEBUG org.mortbay.log - stopped ErrorHandler@3ef07355
17:56:05.781 [Stop Help Server] DEBUG org.mortbay.log - stopped org.mortbay.jetty.servlet.Context@75bc16f0{/help,null}
17:56:05.781 [Stop Help Server] DEBUG org.mortbay.log - stopped org.mortbay.jetty.servlet.HashSessionIdManager@7bd33a6b
17:56:05.882 [Stop Help Server] DEBUG org.mortbay.log - stopped org.mortbay.thread.QueuedThreadPool@7ca522a6
17:56:05.882 [Stop Help Server] DEBUG org.mortbay.log - stopped Server@6ab30913
Re: Testing Help Runtime [message #541225 is a reply to message #540685] Fri, 18 June 2010 14:27 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
I can't see from the log why it is failing - the infocenter started with no problem for me using 3.6RC4. Maybe the port is in use.
Re: Testing Help Runtime [message #541229 is a reply to message #541225] Fri, 18 June 2010 14:46 Go to previous messageGo to next message
Miles Parker is currently offline Miles Parker
Messages: 1338
Registered: July 2009
Senior Member
Chris Goldthorpe wrote on Fri, 18 June 2010 14:27
I can't see from the log why it is failing - the infocenter started with no problem for me using 3.6RC4. Maybe the port is in use.


Yeah, I just tried it again and this time I got some kind of bundle issue. Looks like I've left something out, but rather than spend time on it I just ran with all plugins. That doesn't actually take that long since there is no UI. For the record, here's the error log:

!ENTRY org.eclipse.help.base 4 0 2010-06-16 17:59:39.215!MESSAGE Help cannot be displayed.  The embedded application server could not ru
n help web application.!STACK 0
java.lang.NullPointerException        at org.eclipse.help.internal.server.JettyHelpServer.checkBundle(JettyHel
pServer.java:112)
        at org.eclipse.help.internal.server.JettyHelpServer.start(JettyHelpServer.java:103)
        at org.eclipse.help.internal.server.WebappManager.start(WebappManager.java:38)
        at org.eclipse.help.internal.base.BaseHelpSystem.ensureWebappRunning(Bas
eHelpSystem.java:182)
Re: Testing Help Runtime [message #542066 is a reply to message #541229] Wed, 23 June 2010 13:23 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
It looks as though "org.eclipse.equinox.http.registry" is not getting loaded.
Re: Testing Help Runtime [message #624186 is a reply to message #540685] Fri, 18 June 2010 14:27 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
I can't see from the log why it is failing - the infocenter started with no problem for me using 3.6RC4. Maybe the port is in use.
Previous Topic:Welcome page blank when started with Help->Welcome
Next Topic:Re: Testing Help Runtime
Goto Forum:
  


Current Time: Wed Apr 16 23:56:15 EDT 2014

Powered by FUDForum. Page generated in 0.02963 seconds