Differences

This shows you the differences between two versions of the page.

--- java:infocenter [2014/04/05 23:37] – rlunaro
+++ java:infocenter [2022/12/02 21:02] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-====== InfoCenter -- Let's go for the third attempt ======
+====== InfoCenter -- Four and final attempt ======
-I always found interesting the [[http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fua_help_setup_preferences.htm|eclipse infocenter]]: it's the help system of eclipse, and can be shipped independently of eclipse, as an standalone web application.
+Eventually I've found the steps for getting the [[http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fua_help_setup_preferences.htm|eclipse infocenter]] as an standalone application.
-I find this very useful in order to get some documentation available and with a search engine, for a documentation of a corporate website or for instance for documenting the help of an application.
+===== Step 1: download the file of this guy =====
+This guy:
-===== Installation =====
+http://www.ipov.net/apps/blog/2011/01/eclipse-infocenter-help-as-web-app/
-[[http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fua_help_setup_preferences.htm|Here]] are the installation instructions. In a nutshell:
+have done all the staff of isolating the infocenter as an standalone application for us. So the only thing we have to do is download the jar file who has provided and install it in a tomcat directory.
-  * Go to [[www.eclipse.org/downloads]] and locate the eclipse platform runtime library
+Then we have to start tomcat and point our browser to http://localhost:8080/infocenter/index.jsp: in my case I've installed the contents of the war file in the directory ''infocenter''.
-  * Unpack it and go to the ''plugins'' directory
-  * there you will find various files with the beginning ''org.eclipse.help'': copy them to a new location. I've picked for my test ''~/tmp/infocenter'':
-<code>
-cp org.eclipse.help.* ~/tmp/infocenter
-</code>
+===== Step 2: Adding your onw data to the existing data =====
+The help documentation is stored with the plugin information, under ''WEB-INF/plugins''. The infocenter software scans all the plugins for a file called ''plugin.xml'' and use the information stored in it to display one of the contents.
+**Adding our own content is easy:**
+**3.1** Move to the plugins directory (in my case ''TOMCAT_HOME/webapps/infocenter/WEB-INF/plugins'') and create a directory for your contents:
+<code bash>
+$ mkdir com.supermanhamuerto.doc-1.0.0
+</code>
-====== InfoCenter -- Second Try and Failed ======
+I've called this directory upon this website, but you can pick up whatever name you want.
-===== Resume of achievements =====
+**3.2** Create a ''plugin.xml'' file with the following content:
-Doesn't work. I've tried to deploy in a Jboss and it fails: probably it lacks content, but something should appear on screen instead of an error, isn't??? I am starting to think that this is due to an error: possible I am missing something in the deployment or the instructions aren't so complete as they seem. Anyway, I will focus on these readings I've found in internet and if they doesn't work, I will declare this project as ended and failed.
+<code xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<plugin
+   name="La tortilla de patatas, ese desconocido"
+   id="com.supermanhamuerto.doc"
+   version="1.0.0"
+   provider-name="Superman Ha Muerto" >
+   <extension point="org.eclipse.help.toc">
+      <toc file="toc.xml" type="toc" primary="true" />
+   </extension>
+</plugin>
-  * http://www.eclipsezone.com/eclipse/forums/t99336.html
+</code>
-  * http://blog.maxant.co.uk/pebble/2008/06/09/1213043100000.html
-===== Introduction =====
+Of course, the values "name", "id", "version", etc. can be configured with your own values.
-I run into several problems in the first attempt to create an infocenter for myself. As you may know, the "infocenter" is the eclipse help system, and I want to run my own infocenter, in other words, with my own content.
+**3.3** create this ''toc.xml'' file referred in the previous section. I've put the following content:
-The problem in the first approximation (to empty the eclipse and installing a plugin with my help contents) is that it is not easy to delete the contents of eclipse. [[InfocenterFirstTry|You can learn here from my own errors]].
+<code xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<toc label="La tortilla de patatas" href='toplevel.html'>
+  <topic label="Section 1" href="section1.html"/>
+</toc>
+</code>
-But alas! There is a posibility to run the infocenter as a web application. At the end, the infocenter is a web application... it would be fantastic to extract that application from eclipse and run it as an standalone application in a webserver isn't?? At the end, the security guys will be pleased for not deploy an entire eclipse into production --even if is the internal server--.
+Obviously, it can be more complex: http://www.gulfsoft.com/blog_new/index.php?name=News&file=article&sid=429
-**Such solution exists**, and better than that, is backed up by eclipse. See this:
+**3.4** And finally provide this ''toplevel.html'' and ''section1.html'' elements. They are usual html pages.
-[[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/ua_help_war.htm]]
+My directory has the following files:
-I will detail here the steps I've done to achieve such a high end:
+<code bash>
+~/tmp/eclipse-juno/plugins/com.supermanhamuerto.doc_1.0.0$ ls
-I've used the eclipse helios version in a Windows XP platform. I don't if the platform affect to the result, but just to be sure....
+plugin.xml  section1.html  toc.xml  toplevel.html
+</code>
-===== To the point =====
-I've assumed that eclipse is installed in the directory ECLIPSE_HOME.
-You have to identify the version of eclipse you are running. To do so, the usual eclipse -> about eclipse. Take those "Build id:" numbers that appear. In may case are of the form "20100917-0705".
-==== Locate the resources needed ====
-You will need to point your browser to the equinox download site: [[http://download.eclipse.org/equinox/]]. Therefore, you will have to download two files: ''org.eclipse.equinox.http.servletbridge_VERSION.jar'' and ''org.eclipse.equinox.servletbridge_VERSION.jar''. To locate those files you will have to do the following:
-  - Locate the version of equinox sdk that more closely matches with your version of eclipse. In my case, 3.5.2, because is the only one of 2010.
-  - Download all the package "equinox-sdk-VERSION.zip"
-  - Unzip the contents and locate the jar files you need
-  - Reserve them for later use
-As the document says, locate the jar file "org.eclipse.help.webapp_NUMBER_VERSION.jar" in the plugins directory ECLIPSE_HOME/plugins.
-Copy it to another directory and uncompress it((To uncompress, just rename it from .jar -> .jar.zip) and extract all the files)).
-You will find a directory web-archive. Under web-archive, a directory ''org.eclipse.help.infocenter-feature''.
-Import it as a project in eclipse. Here are the steps, no so well commented in the eclipse documentation:
-  * File -> Import
-  * Select "import existing project into workspace"
-  * In the window that appears, select "Select root directory"
-A new project will appear in you eclipse, clled org.eclipse.help.infocenter-feature.
-Following the instructions, I've right-clicked on the created project and check export -> select "plug-in develpment -> deployable features". When it request a directory, select YOUR_DECOMPRESSED_JAR/web-archive/help/WEB-INF. Click on finish.
-Now, you have to move the file ''org.eclipse.equinox.servletbridge_VERSION.jar'' to the directory ''web-archive\help\WEB-INF\lib''. If the directory "lib" doesn't exist, you have to create.
-And then, you have to move the file ''org.eclipse.equinox.http.servletbridge_1.0.100.v20090520-1800.jar'' to the ''web-archive\help\WEB-INF\plugins'' directory.
-==== Creating a WAR file ====
-All the contents under ''help'' constitute a WAR file. You can use it to deploy to whatever appserver you want. I've used jboss, and just did the following:
-  * Copy the ''help'' file under JBOSS_HOME/server/xxx/deploy and rename the directory to ''help.war''
+After this, just wait until tomcat rescans the application or simply restart tomcat again: when it's done, the infocenter will index the new content and it will appear again.
-  * Point my browser to http://localhost:8080/help
+You should see your new content by refreshing the browser:
+{{ :java:20140415_infocenter2.png?direct&300 |}}
@@ Line 95: / Line 76: @@
-~~DISCUSSION~~
+~~DISQUS~~