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

Bug 37685

Summary:	[plan item] Improve scalability for large help books
Product:	[Eclipse Project] Platform	Reporter:	Jim des Rivieres <jeem>
Component:	User Assistance	Assignee:	Konrad Kolosowski <konradk>
Status:	RESOLVED FIXED	QA Contact:
Severity:	enhancement
Priority:	P3	Keywords:	plan
Version:	2.1
Target Milestone:	3.0 M1
Hardware:	All
OS:	All
Whiteboard:

Description Jim des Rivieres

2003-05-15 11:07:20 EDT

Improve scalability for large help books. Although the help system does deal 
well with large collections of topics distributed across many books, browser 
performance degrades severely when a large number of topics (2000+) are 
concentrated in a single book. This performance problem needs to be addressed, 
possibly by lazily loading navigation information. [Platform Help] [Theme: 
Responsive UI]

Comment 1 Konrad Kolosowski

2003-05-29 12:50:32 EDT

Implemented dynamic loading of navigation for large books in advanced Help 
UI.  Navigation for books smaller than 1000 topics are loaded as a whole.  
Books larger are loaded few levels (3) at a time.  The numbers (1000 and 3) 
are adjustable in help preferences.  When navigation needs to focus on a 
specific topic (after openning to a topic or synchronizing) the branch 
containing the topic is generated with surrounding topics according to number 
of levels in preferences.
If navigation tree is wide and generating 3 levels would result in too many 
topics, the algorithem may reduce the actual number of levels to 1.

When user expands a topic which children were not generated in the initial 
book navigation, a fragment of navigation is obtained from the server and 
attached to the existing navigation tree.

This feature improves dowload times when browsing large books, performance of 
the tree, time it takes to open help to a specific topic and synchronization.