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

Bug 175016

Summary:	[plan] Help content generated on-the-fly
Product:	[Eclipse Project] Platform	Reporter:	DJ Houghton <dj.houghton>
Component:	User Assistance	Assignee:	platform-ua-inbox <platform-ua-inbox>
Status:	RESOLVED FIXED	QA Contact:
Severity:	enhancement
Priority:	P3	Keywords:	plan
Version:	3.3
Target Milestone:	3.3
Hardware:	All
OS:	All
Whiteboard:

Description DJ Houghton

2007-02-21 14:34:12 EST

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. [UA]

Comment 1 Chris Goldthorpe

2007-05-07 16:26:04 EDT

The description of this plan item has changed. The revised plan item description is below.

More flexibility for filtering, such as OR and IF/ELSE clauses in filter condition, and ability to plug-in any type of filter. Adopt help's extension features and content replace for all other forms of user assistance (e.g. welcome, cheat sheets). Also provide a better mechanism to control how UA content is arranged and ordered (for example, the order of books in the table of contents). 

As of M7 all items listed above were complete.

Comment 2 Chris Goldthorpe

2007-05-07 16:27:51 EDT

Here is the correct version of the updated description

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. [UA]