1 / 14

Eclipse User Assistance Options

Eclipse User Assistance Options. May 2008. Eclipse User Assistance Options. Welcome Specialized pages that introduce a platform to new users Display the first time a product is launched Can display in stand-by or full-screen mode Help Active Embedded Context-sensitive Cheat Sheets

eitan
Download Presentation

Eclipse User Assistance Options

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Eclipse User Assistance Options May 2008

  2. Eclipse User Assistance Options • Welcome • Specialized pages that introduce a platform to new users • Display the first time a product is launched • Can display in stand-by or full-screen mode • Help • Active • Embedded • Context-sensitive • Cheat Sheets • Simple • Composite • Dynamic Content • Tag content with XML attributes • Content is filtered, included, or extended based on user environment

  3. Types of Eclipse Help • Active help • Embedded help • Context-sensitive help

  4. Eclipse Help Configuration Options • Rich Client Platform (RCP) help • Standalone help • Infocenter help

  5. Help Dependency Options • Couple with application bundles • Separate help from application bundles

  6. Eclipse Help Capabilities • Cross plug-in referencing (Active help) • Product plug-in referencing (Embedded help) • Support for: • Localization • Video • ToolTips

  7. Active Help • Ability to invoke Eclipse code from within online documentation • Requires JavaScript within documentation to call application code • Final product looks like hyperlinks on-screen

  8. Example of Active Help

  9. Embedded Help • Ability to create links to Eclipse workbench commands from within online documentation • Requires JavaScript within documentation to call application code • Several predefined Eclipse commands exist in the workbench

  10. Example of Embedded Help

  11. Context-sensitive Help Content • Provides help for a specific element when the user focuses on that element and presses F1 • Infopops are available in context-sensitive Help format • Context-sensitive help must include: • Content (source) in HTML file format • Contexts.xml file for context IDs • Index.xml file for index

  12. Example of Infopop in Context-sensitive Help

  13. Dynamic Content • Content can change based upon user environment • XML tagging is used to: • filter out documents and sections of documents • include sections from other documents • extend documents with additional or different information

  14. Requirements for All Online End-user Documentation • Ready for WebSphere (RFWS) considerations • Eclipse acknowledgement statement

More Related