Bug 548518: contribute the quick search (from Pivotal) to the platform
Change-Id: Iafe32467ebf571e501e93551349406517a8462a0
Signed-off-by: Kris De Volder <kdevolder@pivotal.io>
diff --git a/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36.htm b/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36.htm
index 6e844ce..842a7fb 100644
--- a/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36.htm
+++ b/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36.htm
@@ -10,10 +10,24 @@
<h1>Searching</h1>
-<p>Text strings and files can be searched for in the Workbench. In this section,
- <strong>Search </strong><img src="../images/search.svg" alt="Search button" border="0">
- will be used to perform a text search across the resources that are shown in
- the navigation view. Instruction will also be given on how to use the Search
- view to work with the results.</p>
+<p>Text strings and files can be searched for in the Workbench in two different ways:</p>
+<ul>
+ <li>Using the <strong>Search Button</strong><img src="../images/search.svg" alt="Search button" border="0">
+ and Search view</li>
+ <li>Using the Quick Text Search Dialog</li>
+</ul>
+
+<p>In this section, we discuss both.</p>
+
+<p>First, we start showing how
+<strong>Search </strong><img src="../images/search.svg" alt="Search button" border="0">
+can be used to perform a text search across the resources that are shown in
+the navigation view. Instruction will also be given on how to use the Search
+view to work with the results.</p>
+
+<p>Second, we will also explain how to use the <a href="qs-36c.htm">Quick Text Search</a> as an alternative to
+the standard search. The Quick Text Search is a popup dialog especially suited to find and jump to different
+places in your workspace quickly.
+</p>
</body></html>
diff --git a/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36b.htm b/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36b.htm
index ea75588..d434585 100644
--- a/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36b.htm
+++ b/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36b.htm
@@ -66,5 +66,10 @@
border="0">
</blockquote>
+<p>
+ In the next section we will show how to use the Quick Text Search Dialog as an
+ alternative to Search Dialog and Search View.
+</p>
+
</body>
</html>
diff --git a/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36c.htm b/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36c.htm
new file mode 100644
index 0000000..b0717d0
--- /dev/null
+++ b/bundles/org.eclipse.platform.doc.user/gettingStarted/qs-36c.htm
@@ -0,0 +1,76 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
+<HEAD>
+
+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2013. 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">
+<title>Starting a Quick Text Search</title>
+
+</HEAD>
+<body>
+<h1>Starting a Quick Text Search</h1>
+
+<p>Quick Text Search is a convenient alternative to Search Dialong and Search View.
+It provides a popup dialog that is especially well-suited to jump around the workspace
+quickly using textual matches.
+</p>
+
+<p>A Quick Text Search can usually be started by pressing its keyboard shortut CTRL-ALT-SHIFT-L (
+or CMD-ALT-SHIFT-L on Mac). This will popup the following dialog:
+</p>
+
+<p>
+ <img src="../images/quick-text-search.png" alt="Quick Text Search dialog" border="0">
+</p>
+
+<p>To run a workspace-wide Quick Text Search, simply type text in the main search field and you'll see
+ the list of possible matches updated live as you type. You can also select some text in a Eclipse view
+ or editor prior to opening the dialog. The selected text will be entered automatically into the
+ search box.</p>
+
+<p>The dialog has these features:</p>
+
+<ul>
+ <li>A main search box in which you can enter a search string. The string can contain <code>*</code> and <code>?</code>
+ wildcard characters. These characters will be interpreted in the usual way (<code>*</code> matches any
+ sequence of characters and <code>?</code> matches any single character).
+ </li>
+ <li>The 'In:' input allows limiting the search scope to files who's path/name matches any of
+ a list of patterns. The syntax is the same as that used in '.gitignore' inclusion patterns.
+ Multiple patterns can be entered and are separated by commas. The patterns are matched
+ against workspace paths. So you can use a pattern like <code>/project-name/**</code> to search files
+ in a specific project.
+ </li>
+ <li>
+ A table of 'Matching Items'. You can select items in the table by clicking on them or
+ using the arrow up/down keys. The contents of the table is updated in real time, as you type
+ in the search box.
+ </li>
+ <li>
+ A 'Open' button. Clicking this will open the currently selected match in a editor.
+ If no match is currently selected, the first match will be opened instead.
+ This action can also be invoked by pressing
+ the 'Enter' key rather than clicking the button. By default the dialog is 'modal'
+ and it will close upon invoking this action.
+ </li>
+ <li>
+ A pull-down menu provides options to:
+ <ul>
+ <li>Switch between case-sensitive versus case-insensitive matching</li>
+ <li>Keep the dialog open (i.e. the dialog becomes 'non-modal' and does not close after selecting an item and
+ opening it.</li>
+ </ul>
+ </li>
+ <li>
+ A 'Refresh' button. This can be useful to manually trigger the dialog to refresh its matches.
+ This may be especially useful if you are using the dialog in a 'non-modal'
+ way (because the non-modal dialog may remain open for extended periods of time, but its matches are not
+ automatically refreshed if the file content is changed).
+ </li>
+</ul>
+
+</BODY>
+</HTML>
diff --git a/bundles/org.eclipse.platform.doc.user/images/quick-text-search.png b/bundles/org.eclipse.platform.doc.user/images/quick-text-search.png
new file mode 100644
index 0000000..39e956f
--- /dev/null
+++ b/bundles/org.eclipse.platform.doc.user/images/quick-text-search.png
Binary files differ
diff --git a/bundles/org.eclipse.platform.doc.user/reference/ref-26.htm b/bundles/org.eclipse.platform.doc.user/reference/ref-26.htm
index 7170df6..ad884ab 100644
--- a/bundles/org.eclipse.platform.doc.user/reference/ref-26.htm
+++ b/bundles/org.eclipse.platform.doc.user/reference/ref-26.htm
@@ -69,12 +69,14 @@
<h3 class="related">Related concepts</h3>
-<a href="../concepts/csearchview.htm">Search view</a>
+<a href="../concepts/csearchview.htm">Search view</a><br>
+<a href="../gettingStarted/qs-36c.htm">Quick Text Search Dialog</a>
<h3 class="related">Related tasks</h3>
<a href="../tasks/tasks-84b.htm">Searching for files</a><br>
<a href="../tasks/tasks-84.htm">Searching for text within a file</a>
+
<h3 class="related">Related reference</h3>
<a href="ref-45.htm">File search</a>
diff --git a/bundles/org.eclipse.platform.doc.user/reference/ref-45.htm b/bundles/org.eclipse.platform.doc.user/reference/ref-45.htm
index 0b9dff7..358f4b4 100644
--- a/bundles/org.eclipse.platform.doc.user/reference/ref-45.htm
+++ b/bundles/org.eclipse.platform.doc.user/reference/ref-45.htm
@@ -60,8 +60,15 @@
pre-defined working sets, previously selected resources or projects enclosing
the selected resources.</p>
+<h1>Quick Text Search</h1>
+
+<p>As an alternative to the Search Dialog and Search View, you can also use the <a href="../gettingStarted/qs-36c">Quick Text Search Dialog</a> to search for
+textual matches in the workspace and quickly jump to them. It is described in detail <a href="../gettingStarted/qs-36c">here</a>.
+</p>
+
<h3 class="related">Related concepts</h3>
<a href="../concepts/csearchview.htm">Search view</a><br>
+<a href="../gettingStarted/qs-36c.htm">Quick Text Search Dialog</a><br>
<h3 class="related">Related tasks</h3>
<a href="../tasks/tasks-84b.htm">Searching for files</a><br>
diff --git a/bundles/org.eclipse.platform.doc.user/tasks/tasks-84.htm b/bundles/org.eclipse.platform.doc.user/tasks/tasks-84.htm
index c398ed3..99076f5 100644
--- a/bundles/org.eclipse.platform.doc.user/tasks/tasks-84.htm
+++ b/bundles/org.eclipse.platform.doc.user/tasks/tasks-84.htm
@@ -47,6 +47,10 @@
<b>Window > Show View > Other... > General > Search</b></a>.
</p>
+<p>As an alternative to using the Search Dialog and Search View you can also use the <a href="../gettingStarted/qs-36c.htm">Quick Text Search</a>
+dialog. The Quicksearch Dialog is especially suited to jump around the workspace
+quickly using textual matches.</p>
+
<h3 class="related">Related concepts</h3>
<a href="../concepts/csearchview.htm">Search view</a>
