bundles/org.eclipse.platform.doc.user/tasks/help_scope.htm - platform/eclipse.platform.common - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
 <meta http-equiv="Content-Style-Type" content="text/css" />
 <link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css" />
 <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script>
 <title>Using help scopes</title>
 </head>
 <body>

 <h2>Using help scopes</h2>

 <p>Help scopes allow you to restrict the scope of a search and limit the topics which show in
 help contents. In the help view help the active scope only affects search results, in the help
 browser it also affects the table of contents and keyword index. A scope can be defined to include
 only specific books or topics from the table of contents. If the documentation set has been configured
 to allow scoping by criteria it is possible also to define scopes which satisfy specific criteria such
 as "platform" = "linux".
 </p>

 <h3>Defining a topic based scope in help contents</h3>
 <p>From help contents the scope is changed by clicking on the link labelled "Scope" next to the search type in area.</p>
 <p> <img src="../images/help_scope_link.png" alt="Scope selection link." border="0" /> </p>
 <p>This opens a scope selection dialog, click "New ..." to create a new scope.</p>
 <p> <img src="../images/help_scope_select.png" alt="Scope selection dialog." border="0" /> </p>
 <p>This opens a new scope dialog which allow you to select which topics to show. If the documentation
 set does not support scoping by criteria the dialog will be similar to the one below, in this case
 only the topics in the Workbench Users Guide will be shown.</p>
 <p> <img src="../images/help_scope_new.png" alt="New scope dialog." border="0" /> </p>

 <h3>Defining a scope using criteria</h3>
 If the documentation has been set up to allow for scoping using criteria an additional
 set of checkboxes is displayed
 to the right of the topic selection area. In the screen shot below the documentation set has two criteria
 which can be used to define a scope, platform and version. In this example the scope would include
 all topics which were in the one of the two books on Java Development and which were identified by
 the documentation writer as being applicable to Windows or Linux.
 <p> <img src="../images/help_scope_criteria.png" alt="New scope dialog with criteria." border="0" /> </p>

 <p><img border="0" src="../images/ngrelc.png" alt="Related concepts"/><br/>
 <a href="../concepts/help.htm">Help</a><br/>
 </p>

 <p><img border="0" src="../images/ngrelt.png" alt="Related tasks"/><br/>
 <a href="help_navigate.htm">Navigating help topics</a><br/>
 </p>

 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
	<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
	<meta http-equiv="Content-Style-Type" content="text/css" />
	<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css" />
	<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script>
	<title>Using help scopes</title>
	</head>
	<body>

	<h2>Using help scopes</h2>

	<p>Help scopes allow you to restrict the scope of a search and limit the topics which show in
	help contents. In the help view help the active scope only affects search results, in the help
	browser it also affects the table of contents and keyword index. A scope can be defined to include
	only specific books or topics from the table of contents. If the documentation set has been configured
	to allow scoping by criteria it is possible also to define scopes which satisfy specific criteria such
	as "platform" = "linux".
	</p>

	<h3>Defining a topic based scope in help contents</h3>
	<p>From help contents the scope is changed by clicking on the link labelled "Scope" next to the search type in area.</p>
	<p> <img src="../images/help_scope_link.png" alt="Scope selection link." border="0" /> </p>
	<p>This opens a scope selection dialog, click "New ..." to create a new scope.</p>
	<p> <img src="../images/help_scope_select.png" alt="Scope selection dialog." border="0" /> </p>
	<p>This opens a new scope dialog which allow you to select which topics to show. If the documentation
	set does not support scoping by criteria the dialog will be similar to the one below, in this case
	only the topics in the Workbench Users Guide will be shown.</p>
	<p> <img src="../images/help_scope_new.png" alt="New scope dialog." border="0" /> </p>

	<h3>Defining a scope using criteria</h3>
	If the documentation has been set up to allow for scoping using criteria an additional
	set of checkboxes is displayed
	to the right of the topic selection area. In the screen shot below the documentation set has two criteria
	which can be used to define a scope, platform and version. In this example the scope would include
	all topics which were in the one of the two books on Java Development and which were identified by
	the documentation writer as being applicable to Windows or Linux.
	<p> <img src="../images/help_scope_criteria.png" alt="New scope dialog with criteria." border="0" /> </p>

	<p><img border="0" src="../images/ngrelc.png" alt="Related concepts"/><br/>
	<a href="../concepts/help.htm">Help</a><br/>
	</p>

	<p><img border="0" src="../images/ngrelt.png" alt="Related tasks"/><br/>
	<a href="help_navigate.htm">Navigating help topics</a><br/>
	</p>

	</body>
	</html>