Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 106200

Summary:	[plan item] UA content generated on-the-fly
Product:	[Eclipse Project] Platform	Reporter:	Mike Wilson <Mike_Wilson>
Component:	User Assistance	Assignee:	platform-ua-inbox <platform-ua-inbox>
Status:	RESOLVED FIXED	QA Contact:
Severity:	enhancement
Priority:	P1	CC:	aiproulx, gebarry, gunnar, jantley, jhayes, khalsted, philippe_mulet
Version:	3.1	Keywords:	plan
Target Milestone:	3.3 M3
Hardware:	All
OS:	All
Whiteboard:

Description Mike Wilson

2005-08-05 12:35:07 EDT

In Eclipse 3.1, three different user-assistance vehicles are used to help users in various contexts: the 
initial user experience shows the 'Welcome' content; cheat sheets assist during long tasks; Help shows the 
traditional help topics. These vehicles use similar concepts but have separate/duplicate code bases. They 
should be reworked so that a single content delivery mechanism is used in various contexts, allowing 
content producers to benefit from a single way of contributing content, making all the content searchable, 
and making it presentable in various contexts. This should also take into account whether content is local 
or remote. [Help]

Comment 1 Mike Wilson

2005-10-28 15:34:56 EDT

Marking as LATER to match the edits being done for the next plan revision.

Comment 2 Dejan Glozic

2006-09-21 10:48:03 EDT

Reopening based on the 3.3 UA plan item (also changed the title to reflect what we intend to do).

From the plan:

Currently it is not possible to write all your help content in your own format, and have it converted into HTML, TOC, keyword index, and context help on-the-fly. For the table of contents you must supply the information in the toc XML format, you cannot use any other format or write code to contribute tocs. The same restriction exists with keyword index content. This item consists of adding API for toc and keyword index providers, and ensuring that a full end-to-end generated doc set is possible. We will use DITA as a showcase XML content format.

Comment 3 Curtis d'Entremont

2006-11-14 18:29:57 EST

I consider this plan item complete.

The new API adds toc, keyword index, context-sensitive help, and content extensions (the markup for contributing into an anchor or replacing an element). This is in addition to the existing producer for help topics and search participants.

Comment 4 Philipe Mulet

2007-03-26 07:28:32 EDT

Which milestone was this resolved into ?