Bugzilla – Full Text Bug Listing
| Summary: | [UA] [plan item] Support dynamic and reusable content in User Assistance components. | ||
|---|---|---|---|
| Product: | [Eclipse Project] Platform | Reporter: | Mike Wilson <Mike_Wilson> |
| Component: | User Assistance | Assignee: | Platform-Help-Inbox <platform-help-inbox> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | P4 | CC: | aiproulx, eclipse, gunnar, jantley, jmockler, khalsted, kpeter, mark.melvin, mkomor, vimalvachhani |
| Version: | 3.1 | Keywords: | plan |
| Target Milestone: | --- | ||
| Hardware: | All | ||
| OS: | All | ||
| Whiteboard: | |||
|
Description
Mike Wilson
Our teams' dependencies on this one include having this functionality for the help system webapp as well as the integrated UA pieces (cheat sheets, contextual help, etc). We would want to use this functionality for standalone/infocenter scenarios as well, so need function available in minimal set of code plug-ins that are used for standalone/infocenter scenarios. --Lee Anne Kowalski IBM User Assistance Technologies Here are some additional items that we believe are related to this one. If there are other opinions that these are better discussed as separate requirements, please let me know and I will open separate entries for these: - Hide/suppress links in text if the topic targets they link to are not installed. Scenario: there are a number of configurations that are valid--a user can optionally include code components in many different valid configurations. The UI code can dynamically respond and hide/show UI features based on what it knows is loaded at install or runtime. However, currently, a help system topic once it is written in XHTML is "static" and cannot dynamically change its content by that time. Topic authors cannot know in advance when writing the topic file which ones will be present to provide links between topics. They then only provide links to those topics they are 100% sure of, and as the trend is for an increasingly componentized world, this is a smaller set of 100% guaranteed links. To get around ths, the links have to be resolved as close to the user's end as possible (install time or system configuration time or system start-up). - Allow product-level suppression/substitution of topics at points in time same as above (install; system configuration; or system start-up). Today, if your product extends and overrides the functionality of someone else's plug-in, you would like to have your help topics for your plug-in be the only ones that your users see, and override the help topics that they had contributed. Your product wants to suppress or replace that content at a topic level. - Automatically generate "parent summary" topics for parent topics that don't have associated HTML topic files (hrefs). These summay topics can be generated from the titles of the children topics--for example, a bulleted list of the hrefs of the children topics with their titles as the text of the links. This is related to Bugzilla 105322 (https://bugs.eclipse.org/bugs/show_bug.cgi? id=105322) --Lee Anne Kowalski IBM User Assistance Technologies Name changed to match the edits being made for the plan revision. The original plan item has been implement - we provide content manipulation for Help documents, and also filtering for Welcome and cheatsheets. Lee Anne, your additional requirements are something we could not commit for 3.2. You are free to transfer them in to a feature request for release 3.3. |