Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Introduction to Eclipse Infocenter Aliza Merzel Joe Gelb
Who are we? <ul><li>Our Mission </li></ul><ul><li>To increase our customers’ profitability by significantly improving the ...
Clients and Partners Private and Confidential Suite Solutions©2009
Agenda <ul><li>Case for dynamic content delivery </li></ul><ul><li>Eclipse Infocenter as an inexpensive option </li></ul><...
Expectations of Content Consumers <ul><li>Find information quickly via web search </li></ul><ul><li>Bite-size information ...
Next Generation Publishing <ul><li>Metadata rich </li></ul><ul><li>Multiple language </li></ul><ul><li>Filter on the fly <...
Overview of Eclipse Infocenter <ul><li>Open source platform </li></ul><ul><li>Cross platform, cross browser </li></ul><ul>...
Example Infocenter: “Out of the box”
Example Infocenter: Customized
Tri-Pane <ul><li>Banner </li></ul><ul><li>Navigation </li></ul><ul><ul><li>Table of Contents </li></ul></ul><ul><ul><li>In...
Organization of Content <ul><li>Each “book” is its own plug-in and contains: </li></ul><ul><li>Topics (HTML, XHTML files) ...
Table of Contents and Index <ul><li>Paths are case sensitive </li></ul><ul><li>Don’t use spaces or anchors (#) in file nam...
Sample toc.xml file
Sample index.xml file
Sample contexts.xml file <ul><li><?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?> </li></ul><ul><li><?NLS TYPE=&...
Sample plugin.xml < plugin   name =&quot; Doc Plugin Language Test Guide &quot; id =&quot; com.suitesol. product .test_gui...
Search <ul><li>Only files referenced in ToC appear in Search results </li></ul><ul><li>Add <metadata keyword=“…”/> tags to...
Integrations with Search Engines <ul><li>Built-in search </li></ul><ul><li>Can plug in in other search engines to be calle...
UI Changes - Configurable <ul><li>Add key=value pairs to plugin_customization.ini </li></ul><ul><ul><li>Order of books in ...
UI Changes - Require Coding <ul><li>Order of toolbar buttons </li></ul><ul><li>Adding new buttons </li></ul><ul><li>Changi...
Setting up the server <ul><li>Instructions based on latest 3.3.2 release (Feb 2008) http://dita.xml.org/wiki/setting-up-th...
Deploying as a war <ul><li>Instructions can be found at:  http://dsdp.eclipse.org/help/latest/index.jsp?topic=/org.eclipse...
To Deploy and launch <ul><li>Copy entire output folder from the DITA-OT to the Eclipse plug-ins folder </li></ul><ul><li>S...
Updating the Infocenter server with content after it is published <ul><li>Create/update jar file with plugin </li></ul><ul...
Multilingual support <ul><li>Strings that appear in UI are all configurable </li></ul><ul><li>Each language has it own Web...
Multilingual Support <ul><li>Localized content is called “fragment” </li></ul><ul><ul><li>Instead of plugin.xml use fragme...
Sample fragment.xml < fragment   name =&quot; Sample Title &quot; plugin-id =&quot; com.suitesol.product.test_guide.doc_1 ...
EclipseHelp –Determine Language <ul><li>Eclipse help allows you to provide localized documentation in the same Infocenter ...
 
End of Introduction to Eclipse Infocenter   <ul><li>Be in touch! Joe Gelb [email_address] Aliza Merzel [email_address] </l...
Upcoming SlideShare
Loading in …5
×

C:\Users\User\Desktop\Eclipse Infocenter

1,389 views

Published on

  • Be the first to comment

  • Be the first to like this

C:\Users\User\Desktop\Eclipse Infocenter

  1. 1. Introduction to Eclipse Infocenter Aliza Merzel Joe Gelb
  2. 2. Who are we? <ul><li>Our Mission </li></ul><ul><li>To increase our customers’ profitability by significantly improving the efficiency of their information development and delivery processes. </li></ul><ul><li>Qualitative Advantage </li></ul><ul><li>Content Lifecycle Implementation (CLI) is Suite Solutions’ comprehensive approach – from concept to publication – to maximizing the value of your information assets. </li></ul><ul><li>Our professionals are with you at every phase, determining, recommending and implementing the most cost-effective, flexible and long term solution for your business. </li></ul>
  3. 3. Clients and Partners Private and Confidential Suite Solutions©2009
  4. 4. Agenda <ul><li>Case for dynamic content delivery </li></ul><ul><li>Eclipse Infocenter as an inexpensive option </li></ul><ul><li>Overview of Eclipse Infocenter </li></ul><ul><li>Organization of content </li></ul><ul><li>Customization options </li></ul><ul><li>Deployment </li></ul><ul><li>Multilingual support </li></ul>
  5. 5. Expectations of Content Consumers <ul><li>Find information quickly via web search </li></ul><ul><li>Bite-size information topics </li></ul><ul><li>Just in time delivery: what I need, when I need it – and quick! </li></ul><ul><li>Targeted content – show me what’s relevant to me </li></ul><ul><li>Multilingual – show me content in my language </li></ul><ul><li>Community feedback </li></ul><ul><li>Solution and task oriented </li></ul><ul><li>Consistency of information from support and documentation </li></ul><ul><li>Portability – give it to me on my smart phone </li></ul><ul><li>Drive towards dynamic content delivery </li></ul>
  6. 6. Next Generation Publishing <ul><li>Metadata rich </li></ul><ul><li>Multiple language </li></ul><ul><li>Filter on the fly </li></ul><ul><li>Generate PDF on demand </li></ul><ul><li>Bookmarks, annotations </li></ul><ul><li>Collect feedback </li></ul><ul><li>Collect metrics: content usage </li></ul><ul><li>Automated publishing and deployment platforms </li></ul><ul><li>Incremental updates </li></ul><ul><li>Integration with other systems </li></ul>
  7. 7. Overview of Eclipse Infocenter <ul><li>Open source platform </li></ul><ul><li>Cross platform, cross browser </li></ul><ul><li>Un-compiled format </li></ul><ul><li>Can be run on client or server </li></ul><ul><li>Allows for localized help in one platform </li></ul><ul><li>Use DITA-OT to generate package (plug-in) for deployment </li></ul><ul><li>Easy to update/add content </li></ul><ul><li>Provides tri-pane interface including TOC, index, search </li></ul><ul><li>Provides facility for context-sensitive help </li></ul><ul><li>Can be customized </li></ul><ul><li>Designed for applications developed in Eclipse, although it may be deployed as a stand alone help system </li></ul>
  8. 8. Example Infocenter: “Out of the box”
  9. 9. Example Infocenter: Customized
  10. 10. Tri-Pane <ul><li>Banner </li></ul><ul><li>Navigation </li></ul><ul><ul><li>Table of Contents </li></ul></ul><ul><ul><li>Index </li></ul></ul><ul><ul><li>Search </li></ul></ul><ul><ul><li>Favorites/Bookmarks </li></ul></ul><ul><li>Content </li></ul><ul><ul><li>Breadcrumbs are automatically generated </li></ul></ul>
  11. 11. Organization of Content <ul><li>Each “book” is its own plug-in and contains: </li></ul><ul><li>Topics (HTML, XHTML files) </li></ul><ul><li>Table of Contents files - toc.xml </li></ul><ul><li>Index files - index.xml </li></ul><ul><li>Context sensitivity content - contexts.xml </li></ul><ul><li>Project file - plugin.xml </li></ul><ul><li>MANIFEST.MF file </li></ul>
  12. 12. Table of Contents and Index <ul><li>Paths are case sensitive </li></ul><ul><li>Don’t use spaces or anchors (#) in file names </li></ul><ul><li>Breadcrumbs get broken </li></ul><ul><ul><li>Sync ToC doesn’t work </li></ul></ul><ul><li>To map the top level of the plugin to a topic </li></ul><ul><ul><li><toc label=&quot;Test of Output Processing“ topic=“cover-page.html&quot;> </li></ul></ul><ul><ul><li>This page can be HTML splash screen or DITA source </li></ul></ul><ul><ul><li>This would need to be made in processing of the plugin, whether DITA-OT or WebWorks, along with the link to it in the ToC </li></ul></ul><ul><li>A toc entry that is not linked to a file will show a list of child entries </li></ul>
  13. 13. Sample toc.xml file
  14. 14. Sample index.xml file
  15. 15. Sample contexts.xml file <ul><li><?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?> </li></ul><ul><li><?NLS TYPE=&quot;org.eclipse.help.contexts&quot;?> </li></ul><ul><li><contexts xmlns=&quot;urn:Eclipse-Contexts-Schema&quot;> </li></ul><ul><li><context id=&quot;myothernewtopicalias&quot;> </li></ul><ul><li><description>Single Step in Steps Element</description> </li></ul><ul><li><topic label=&quot;Single Step in Steps Element&quot; href=&quot;/com.webworks.eclipsehelp.Untitled/t_single_step.html&quot; /> </li></ul><ul><li></context> </li></ul><ul><li></contexts > </li></ul>
  16. 16. Sample plugin.xml < plugin name =&quot; Doc Plugin Language Test Guide &quot; id =&quot; com.suitesol. product .test_guide.doc_1 &quot; version =&quot; 1.0 &quot; provider-name =&quot; SuiteSol &quot; > < extension point =&quot; org.eclipse.help.toc &quot;> < toc file =&quot; toc.xml &quot; primary =&quot; true &quot;/> </ extension > < extension point =&quot; org.eclipse.help.index &quot;> < index file =&quot; index.xml &quot;/> </ extension > < extension point =&quot; org.eclipse.help.contexts &quot;> < contexts file =&quot; context.xml &quot;/> </ extension > </ plugin >
  17. 17. Search <ul><li>Only files referenced in ToC appear in Search results </li></ul><ul><li>Add <metadata keyword=“…”/> tags to topics for more search results </li></ul><ul><li>Search shows <title> tag in topics, not the <h1> </li></ul>
  18. 18. Integrations with Search Engines <ul><li>Built-in search </li></ul><ul><li>Can plug in in other search engines to be called in internal search </li></ul><ul><ul><li>http://help.eclipse.org/ganymede/topic/org.eclipse.platform.doc.isv/guide/ua_help_search_types.htm?resultof =%22%73%65%61%72%63%68%22%20%22%65%6e%67%69%6e%65%73%22%20%22%65%6e%67%69%6e%22%20 </li></ul></ul><ul><li>External search appliances </li></ul><ul><li>Index will be built when user searches for the first time or can be pre-built: </li></ul><ul><ul><li>http://help.eclipse.org/ganymede/topic/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm?resultof =%22%73%65%61%72%63%68%22%20%22%69%6e%64%65%78%22%20 </li></ul></ul><ul><li>When we rebuild an IC or plug-in for the IC, will URLs remain the same or change </li></ul><ul><ul><li>The urls should stay the same as long as the file names stay the same </li></ul></ul>
  19. 19. UI Changes - Configurable <ul><li>Add key=value pairs to plugin_customization.ini </li></ul><ul><ul><li>Order of books in ToC </li></ul></ul><ul><ul><li>Which panes to show </li></ul></ul><ul><ul><li>Colors, banner graphic </li></ul></ul><ul><li>Full list of available properties can be found at: </li></ul><ul><ul><li>http://org.eclipse.platform.doc.isv/guide/ua_help_setup_preferences.htm </li></ul></ul>
  20. 20. UI Changes - Require Coding <ul><li>Order of toolbar buttons </li></ul><ul><li>Adding new buttons </li></ul><ul><li>Changing functionality of existing buttons for example Next/Previous buttons </li></ul><ul><li>Changing look and feel of breadcrumbs </li></ul><ul><li>Some colors of the frameset </li></ul>
  21. 21. Setting up the server <ul><li>Instructions based on latest 3.3.2 release (Feb 2008) http://dita.xml.org/wiki/setting-up-the-eclipse-help-infocenter-for-publishing-dita-content </li></ul><ul><li>Download the platform runtime binary from: http://download.eclipse.org/eclipse/downloads/drops/R-3.4.2-200902111700/index.php </li></ul><ul><li>T he Platform Runtime Binary is not enough; comprehensive list of required plug-ins posted by Deborah Pickett on the dita-users email list http://tech.groups.yahoo.com/group/dita-users/message/10734 </li></ul>
  22. 22. Deploying as a war <ul><li>Instructions can be found at: http://dsdp.eclipse.org/help/latest/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/ua_help_war.htm </li></ul><ul><li>The resulting files can then be added to the webapps folder in Tomcat or compressed into a war file. </li></ul><ul><li>Infocenter can then be run by running Tomcat or another JavaBean application like DM SpringSourceServer </li></ul>
  23. 23. To Deploy and launch <ul><li>Copy entire output folder from the DITA-OT to the Eclipse plug-ins folder </li></ul><ul><li>Start the Infocenter server </li></ul><ul><ul><ul><li>java -classpath c:eclipsepluginsorg.eclipse.help.base_3.3.1.v20070813_33x.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome c:eclipse -port 8081 –product com.suitesol. ICbase.custom </li></ul></ul></ul><ul><li>Launch the help: </li></ul><ul><ul><ul><li>http://localhost:8081/help/index.jsp </li></ul></ul></ul><ul><li>To shut down the Infocenter server, replace </li></ul><ul><ul><ul><li>-command start with –command shutdown </li></ul></ul></ul>
  24. 24. Updating the Infocenter server with content after it is published <ul><li>Create/update jar file with plugin </li></ul><ul><li>Stop server </li></ul><ul><li>Replace jar file on server </li></ul><ul><li>Restart server </li></ul>
  25. 25. Multilingual support <ul><li>Strings that appear in UI are all configurable </li></ul><ul><li>Each language has it own WebappResources.properties file: org.eclipse.help.webapporgeclipsehelpinternalwebappWebappResources_[2 letter lang code].properties </li></ul><ul><li>Edit/Add strings </li></ul><ul><ul><li>key=value pairs </li></ul></ul><ul><ul><li>SendMail=Send this content </li></ul></ul><ul><li>Called from JSP: </li></ul><ul><ul><li>ServletResources.getString(&quot;SendMail&quot;, request) </li></ul></ul>
  26. 26. Multilingual Support <ul><li>Localized content is called “fragment” </li></ul><ul><ul><li>Instead of plugin.xml use fragment.xml </li></ul></ul><ul><ul><li>creates a relationship between the main (English) content and the translated content </li></ul></ul><ul><li>Localize content </li></ul><ul><ul><li>ToC, Index, Context xml files should all be translated </li></ul></ul><ul><ul><li>Under plugin directory, create directories for each language: </li></ul></ul><ul><ul><ul><li>-- fragment.xml </li></ul></ul></ul><ul><ul><ul><li>-- nl ------ lang code ---------- country code(optional) ------ all content files (html, css, graphics, etc) ------ index.xml ------ all toc xml files </li></ul></ul></ul><ul><ul><li>You can jar the directory and place that in the plugins instead </li></ul></ul><ul><li>Language is passed in as lang query string </li></ul><ul><ul><li>Order of preference: language/country > language > plugin </li></ul></ul>
  27. 27. Sample fragment.xml < fragment name =&quot; Sample Title &quot; plugin-id =&quot; com.suitesol.product.test_guide.doc_1 &quot; id =&quot; com.suitesol.product.test_guide.doc_1.ja &quot; plugin-version =&quot; 1.0 &quot; version =&quot; 1.0 &quot; provider-name =&quot; %providerName &quot; />
  28. 28. EclipseHelp –Determine Language <ul><li>Eclipse help allows you to provide localized documentation in the same Infocenter instance. Eclipse will determine the language of the user’s browser. </li></ul><ul><li>IE : Tools > Internet Options > General (Tab) > Languages (button) </li></ul><ul><li>Chrome : Customize > Under the Hood (tab) > Web Content, Change font and language Settings (button) > Languages (tab) </li></ul><ul><li>Opera : Tools > Preferences > General (tab) </li></ul><ul><li>FireFox : Tools > Content (tab) > Languages </li></ul><ul><li>You can override the browser language by adding ?lang=[lang code] to the url in the address bar </li></ul>
  29. 30. End of Introduction to Eclipse Infocenter <ul><li>Be in touch! Joe Gelb [email_address] Aliza Merzel [email_address] </li></ul><ul><li>Let us know how we can help you further… </li></ul><ul><ul><li>One-on-one support and training </li></ul></ul><ul><ul><li>CMS </li></ul></ul>

×