diff options
| author | Dani Megert | 2002-06-07 07:11:15 +0000 |
|---|---|---|
| committer | Dani Megert | 2002-06-07 07:11:15 +0000 |
| commit | 3d0280632bf91be994b9fd651d5788a174db80e6 (patch) | |
| tree | c2d932486f4e9649828a553e05520e81ad202468 /org.eclipse.search | |
| parent | bbb15213291157a7950a3dd4ab4aefb11ec75573 (diff) | |
| download | eclipse.platform.text-3d0280632bf91be994b9fd651d5788a174db80e6.tar.gz eclipse.platform.text-3d0280632bf91be994b9fd651d5788a174db80e6.tar.xz eclipse.platform.text-3d0280632bf91be994b9fd651d5788a174db80e6.zip | |
Fixed F3 bug 16721: Add and update extension point docs
Diffstat (limited to 'org.eclipse.search')
| -rw-r--r-- | org.eclipse.search/doc/org_eclipse_search_searchPages.html | 173 | ||||
| -rw-r--r-- | org.eclipse.search/doc/org_eclipse_search_searchResultSorters.html | 137 |
2 files changed, 156 insertions, 154 deletions
diff --git a/org.eclipse.search/doc/org_eclipse_search_searchPages.html b/org.eclipse.search/doc/org_eclipse_search_searchPages.html index 3a3bbbad77c..d6456d1d03a 100644 --- a/org.eclipse.search/doc/org_eclipse_search_searchPages.html +++ b/org.eclipse.search/doc/org_eclipse_search_searchPages.html @@ -1,93 +1,94 @@ -<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head> - <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Search Infrastructure Extension Points</title></head> - -<body link="#0000ff" vlink="#800080"> - -<center> -<h1> -Search Pages</h1></center> -<b><i>Identifier: </i></b>org.eclipse.search.searchPages -<p><b><i>Description</i>: </b>This extension point allows a plug-in to register -search pages for specialized searches. When the search action is performed on -a resource, the search infrastructure locates the most specific registered search -page for it. - -</p><p><b><i>Configuration Markup:</i></b> -</p><p><tt> <!ELEMENT page EMPTY></tt> -<br><tt> <!ATTLIST page</tt> +<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Eclipse Search Infrastructure Extension Point: Search Pages</title></head>
+
+<body link="#0000ff" vlink="#800080">
+
+<center>
+<h1>
+Search Pages</h1></center>
+<b><i>Identifier: </i></b>org.eclipse.search.searchPages
+<p><b><i>Description</i>: </b>This extension point allows a plug-in to register
+search pages for specialized searches. When the search action is performed on
+a resource, the search infrastructure locates the most specific registered search
+page for it.
+
+</p><p><b><i>Configuration Markup:</i></b>
+</p><p><tt> <!ELEMENT page EMPTY></tt>
+<br><tt> <!ATTLIST page</tt>
<br><tt> id CDATA
-#REQUIRED</tt> -<br><tt> label CDATA #REQUIRED</tt> -<br><tt> class CDATA #REQUIRED</tt> -<br><tt> icon CDATA #IMPLIED</tt> -<br><tt> sizeHint CDATA #REQUIRED</tt> -<br><tt> tabPosition CDATA #IMPLIED</tt> -<br><tt> extensions CDATA #IMPLIED</tt> +#REQUIRED</tt>
+<br><tt> label CDATA #REQUIRED</tt>
+<br><tt> class CDATA #REQUIRED</tt>
+<br><tt> icon CDATA #IMPLIED</tt>
+<br><tt> sizeHint CDATA #REQUIRED</tt>
+<br><tt> tabPosition CDATA #IMPLIED</tt>
+<br><tt> extensions CDATA #IMPLIED</tt>
<br><tt> showScopeSection CDATA #IMPLIED</tt><br>
-<tt> enabled CDATA #IMPLIED</tt><br>
-</p><ul><li><b>id</b> - a unique name that will be used to identify this search page</li> - -<li> -<b>label</b> - a translatable label that will be used in the search page tab</li> - -<li> -<b>class</b> - a name of the class that implements <tt>org.eclipse.search.ui.ISearchPage</tt>. -We recommend subclassing <tt>org.eclipse.jface.dialogs.DialogPage</tt>. -</li> - -<li> -<b>icon</b> - a relative name of the image that will be used for all resources -that match the specified extensions. If omitted, the -search page's tab will only contain a label.</li> - -<li> -<b>sizeHint</b> - a hint for the initial size of the page. This is a string -containing the width and height separated by comma (e.g. "50, 60"). In the case -this hint is omitted the page will be no larger than the other pages.</li> - -<li> +<tt> enabled CDATA #IMPLIED</tt>
+<br><tt> ></tt>
+</p><ul><li><b>id</b> - a unique name that will be used to identify this search page</li>
+
+<li>
+<b>label</b> - a translatable label that will be used in the search page tab</li>
+
+<li>
+<b>class</b> - a name of the class that implements <tt>org.eclipse.search.ui.ISearchPage</tt>.
+We recommend subclassing <tt>org.eclipse.jface.dialogs.DialogPage</tt>.
+</li>
+
+<li>
+<b>icon</b> - a relative name of the image that will be used for all resources
+that match the specified extensions. If omitted, the
+search page's tab will only contain a label.</li>
+
+<li>
+<b>sizeHint</b> - a hint for the initial size of the page. This is a string
+containing the width and height separated by comma (e.g. "50, 60"). In the case
+this hint is omitted the page will be no larger than the other pages.</li>
+
+<li>
<b>tabPosition</b> - an integer defining where the page is placed in the
page book. The value does not define the absolute position but the position
-relative to the other pages. The ordering of pages is as follows: <ol> - <li>if the tabPosition is not specified for a page then <tt>Integer.MAX_VALUE / 2</tt> is used</li> +relative to the other pages. The ordering of pages is as follows: <ol>
+ <li>if the tabPosition is not specified for a page then <tt>Integer.MAX_VALUE / 2</tt> is used</li>
<li>the page with the lower value comes first. If the values are equal
-then the pages are are ordered alphabetically according to their labels</li> - </ol> -</li> - -<li> -<b>extensions</b> - a comma separated list with file extensions on which the -search page can operate. Each extension must also include a weight (0 meaning -lowest weight) which enables the search infrastructure to find the best fitting -page. The weight is separated from the extension by a colon. -If a search page can search all possible resources then <tt>"*"</tt> can be used.</li> - -<li> -<b>showScopeSection</b> - if this attribute is missing or set to <tt>"false"</tt> then the -scope section is not shown in the Search dialog. To see the scope section this -attribute has to be set to <tt>"true"</tt>. Plug-ins which add their own Search page and -want to see the scope section have to add this to their plugin.xml.</li><li><b>enabled</b> - if this attribute is missing or set to <tt>"false"</tt>
+then the pages are are ordered alphabetically according to their labels</li>
+ </ol>
+</li>
+
+<li>
+<b>extensions</b> - a comma separated list with file extensions on which the
+search page can operate. Each extension must also include a weight (0 meaning
+lowest weight) which enables the search infrastructure to find the best fitting
+page. The weight is separated from the extension by a colon.
+If a search page can search all possible resources then <tt>"*"</tt> can be used.</li>
+
+<li>
+<b>showScopeSection</b> - if this attribute is missing or set to <tt>"false"</tt> then the
+scope section is not shown in the Search dialog. To see the scope section this
+attribute has to be set to <tt>"true"</tt>. Plug-ins which add their own Search page and
+want to see the scope section have to add this to their plugin.xml.</li><li><b>enabled</b> - if this attribute is missing or set to <tt>"false"</tt>
then the page is not initially shown in the Search dialog. The page can
-be activated by the user via the "Customize..." button on the Search dialog.</li>
- - -</ul> -<b><i>Examples:</i></b> -<p>The following is an example of a search page extension definition: -</p><p><tt> <extension point="org.eclipse.search.searchPages"></tt> -<br><tt> <page</tt> -<br><tt> id="org.eclipse.search.ui.text.TextSearchPage"</tt> -<br><tt> label="Text Search"</tt> -<br><tt> icon="icons/full/obj16/tsearch_pref.gif"</tt> -<br><tt> sizeHint="250,160"</tt> -<br><tt> tabPosition="1"</tt> -<br><tt> extensions="*:1"</tt> -<br><tt> showScopeSection="true"</tt> -<br><tt> class="org.eclipse.search.ui.text.TextSearchPage"</tt> -<br><tt> </page></tt> -<br><tt> </extension></tt> - -</p><p><b><i>Supplied Implementation: </i></b>The search infrastructure provides - a search page for full-text search. -</p><p><a href="hglegal.htm"><img src="ngibmcpy.gif" alt="Copyright IBM Corp. 2000, 2001. All Rights Reserved." border="0" height="12" width="195"></a> +be activated by the user via the "Customize..." button on the Search dialog.</li>
+
+
+</ul>
+<b><i>Examples:</i></b>
+<p>The following is an example of a search page extension definition:
+</p><p><tt> <extension point="org.eclipse.search.searchPages"></tt>
+<br><tt> <page</tt>
+<br><tt> id="org.eclipse.search.ui.text.TextSearchPage"</tt>
+<br><tt> label="Text Search"</tt>
+<br><tt> icon="icons/full/obj16/tsearch_pref.gif"</tt>
+<br><tt> sizeHint="250,160"</tt>
+<br><tt> tabPosition="1"</tt>
+<br><tt> extensions="*:1"</tt>
+<br><tt> showScopeSection="true"</tt>
+<br><tt> class="org.eclipse.search.ui.text.TextSearchPage"</tt>
+<br><tt> </page></tt>
+<br><tt> </extension></tt>
+
+</p><p><b><i>Supplied Implementation: </i></b>The search infrastructure provides
+ a search page for full-text search.
+</p><p><a href="hglegal.htm"><img src="ngibmcpy.gif" alt="Copyright IBM Corp. 2000, 2002. All Rights Reserved." border="0" height="12" width="195"></a>
</p></body></html>
\ No newline at end of file diff --git a/org.eclipse.search/doc/org_eclipse_search_searchResultSorters.html b/org.eclipse.search/doc/org_eclipse_search_searchResultSorters.html index c3dcb0a4847..aadc3c500c5 100644 --- a/org.eclipse.search/doc/org_eclipse_search_searchResultSorters.html +++ b/org.eclipse.search/doc/org_eclipse_search_searchResultSorters.html @@ -1,68 +1,69 @@ -<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.75 [en] (WinNT; U) [Netscape]">
- <title>Search Infrastructure Extension Points</title>
-</head>
-<body link="#0000FF" vlink="#800080">
-
-<center>
-<h1>
-Result Sorters</h1></center>
-<b><i>Identifier: </i></b>org.eclipse.search.searchResultSorters
-<p><b><i>Description</i>: </b>This extension point allows a plug-in to
-contribute search result sorters to the search result view's <i>Sort</i>
-context menu.
-<p><b><i>Configuration Markup:</i></b>
-<p><tt> <!ELEMENT page EMPTY></tt>
-<br><tt> <!ATTLIST page</tt>
-<br><tt> id CDATA #REQUIRED</tt>
-<br><tt> pageId CDATA #REQUIRED</tt>
-<br><tt> label CDATA #REQUIRED</tt>
-<br><tt> tooltip CDATA #IMPLIED</tt>
-<br><tt> icon CDATA #IMPLIED</tt>
-<br><tt> class CDATA #REQUIRED</tt>
-<ul>
-<li>
-<b>id</b> - a unique name that will be used to identify this search
-result sorter.</li>
-
-<li>
-<b>pageId</b> - the ID of a registered search page for which the sorter
-will be activated. "*" activates the sorter for all pages.</li>
-
-<li>
-<b>label</b> - a translatable label that will be used as the menu item's
-label.</li>
-
-<li>
-<b>tooltip</b> - a translatable text that will be used as the menu
-item's tool tip . If omitted, the menu item will have no tool tip.</li>
-
-<li>
-<b>icon</b> - a relative name of the image that will be shown in the
-context menu along with the label. If omitted, the menu entry will only
-contain a label.</li>
-
-<li>
-<b>class</b> - a name of the class that extends <tt>org.eclipse.jface.viewers.ViewerSorter</tt>.</li>
-</ul>
-<b><i>Examples:</i></b>
-<p><tt>The following is an example of a search page extension definition:</tt>
-<p><tt> <extension point="org.eclipse.search.searchResultSorters"></tt>
-<br><tt> <sorter</tt>
-<br><tt> id="org.eclipse.search.internal.ui.FileNameSorter"</tt>
-<br><tt> pageId="*"</tt>
-<br><tt> label="%FileNameSorter.label"</tt>
-<br><tt> tooltip="%FileNameSorter.tooltip"</tt>
-<br><tt> icon="icons/full/ecl16/search_sort.gif"</tt>
-<br><tt> class="org.eclipse.search.internal.ui.FileNameSorter"></tt>
-<br><tt> </sorter></tt>
-<br><tt> </extension></tt>
-
-<p><b><i>Supplied Implementation: </i></b>The search infrastructure
-provides a sorter that sorts the matches by the resource name.
-<p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2001. All Rights Reserved." BORDER=0 height=12 width=195></a>
-</body>
-</html>
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.75 [en] (WinNT; U) [Netscape]"> + <title>Eclipse Search Infrastructure Extension Point: Result Sorters</title> +</head> +<body link="#0000FF" vlink="#800080"> + +<center> +<h1> +Result Sorters</h1></center> +<b><i>Identifier: </i></b>org.eclipse.search.searchResultSorters +<p><b><i>Description</i>: </b>This extension point allows a plug-in to +contribute search result sorters to the search result view's <i>Sort</i> +context menu. +<p><b><i>Configuration Markup:</i></b> +<p><tt> <!ELEMENT sorter EMPTY></tt> +<br><tt> <!ATTLIST sorter</tt> +<br><tt> id CDATA #REQUIRED</tt> +<br><tt> pageId CDATA #REQUIRED</tt> +<br><tt> label CDATA #REQUIRED</tt> +<br><tt> tooltip CDATA #IMPLIED</tt> +<br><tt> icon CDATA #IMPLIED</tt> +<br><tt> class CDATA #REQUIRED</tt> +<br><tt> ></tt> +<ul> +<li> +<b>id</b> - a unique name that will be used to identify this search +result sorter.</li> + +<li> +<b>pageId</b> - the ID of a registered search page for which the sorter +will be activated. "*" activates the sorter for all pages.</li> + +<li> +<b>label</b> - a translatable label that will be used as the menu item's +label.</li> + +<li> +<b>tooltip</b> - a translatable text that will be used as the menu +item's tool tip . If omitted, the menu item will have no tool tip.</li> + +<li> +<b>icon</b> - a relative name of the image that will be shown in the +context menu along with the label. If omitted, the menu entry will only +contain a label.</li> + +<li> +<b>class</b> - a name of the class that extends <tt>org.eclipse.jface.viewers.ViewerSorter</tt>.</li> +</ul> +<b><i>Examples:</i></b> +<p><tt>The following is an example of a search page extension definition:</tt> +<p><tt> <extension point="org.eclipse.search.searchResultSorters"></tt> +<br><tt> <sorter</tt> +<br><tt> id="org.eclipse.search.internal.ui.FileNameSorter"</tt> +<br><tt> pageId="*"</tt> +<br><tt> label="%FileNameSorter.label"</tt> +<br><tt> tooltip="%FileNameSorter.tooltip"</tt> +<br><tt> icon="icons/full/ecl16/search_sort.gif"</tt> +<br><tt> class="org.eclipse.search.internal.ui.FileNameSorter"></tt> +<br><tt> </sorter></tt> +<br><tt> </extension></tt> + +<p><b><i>Supplied Implementation: </i></b>The search infrastructure +provides a sorter that sorts the matches by the resource name. +<p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2002. All Rights Reserved." BORDER=0 height=12 width=195></a> +</body> +</html> |