140 likes | 234 Views
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
E N D
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 • Simple • Composite • Dynamic Content • Tag content with XML attributes • Content is filtered, included, or extended based on user environment
Types of Eclipse Help • Active help • Embedded help • Context-sensitive help
Eclipse Help Configuration Options • Rich Client Platform (RCP) help • Standalone help • Infocenter help
Help Dependency Options • Couple with application bundles • Separate help from application bundles
Eclipse Help Capabilities • Cross plug-in referencing (Active help) • Product plug-in referencing (Embedded help) • Support for: • Localization • Video • ToolTips
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
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
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
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
Requirements for All Online End-user Documentation • Ready for WebSphere (RFWS) considerations • Eclipse acknowledgement statement