Help Scope

Identifier:
org.eclipse.help.base.scope

Since:
3.5

Description:
Support for user defined scopes in the help table of contents, index and search results.

Configuration Markup:

<!ELEMENT extension (scope)+>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

>


<!ELEMENT scope EMPTY>

<!ATTLIST scope

class CDATA #REQUIRED

id    CDATA #REQUIRED

>

Defines a scope class which contains methods to determine which UA elements are in scope.



API Information:
A class which implements AbstractScope contains functions to determine which elemements should be displayed when the scope is active. The help UI allows the user to specify any of the predefiend scopes.


Copyright (c) 2010 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html