none
authorPeterThoeny <PeterThoeny>
Sun, 18 Jan 2004 10:49:03 +0000 (10:49 +0000)
committerPeterThoeny <PeterThoeny>
Sun, 18 Jan 2004 10:49:03 +0000 (10:49 +0000)
Main/WebSearchAdvanced.mdwn [new file with mode: 0644]
TWiki/SearchHelp.mdwn [new file with mode: 0644]
TWiki/WebHome.mdwn
TWiki/WebSearch.mdwn
TWiki/WebSearchAdvanced.mdwn [new file with mode: 0644]

diff --git a/Main/WebSearchAdvanced.mdwn b/Main/WebSearchAdvanced.mdwn
new file mode 100644 (file)
index 0000000..8b13789
--- /dev/null
@@ -0,0 +1 @@
+
diff --git a/TWiki/SearchHelp.mdwn b/TWiki/SearchHelp.mdwn
new file mode 100644 (file)
index 0000000..4a2f138
--- /dev/null
@@ -0,0 +1,63 @@
+# <a name="Search Help"></a><a name=" Search Help"></a> Search Help
+
+<div>
+  <ul>
+    <li><a href="#Basic Search Form"> Basic Search Form</a></li>
+    <li><a href="#Advanced Search Form"> Advanced Search Form</a></li>
+    <li><a href="#Formatted Searches"> Formatted Searches</a></li>
+    <li><a href="#Search Preferences"> Search Preferences</a></li>
+  </ul>
+</div>
+
+## <a name="Basic Search Form"></a> Basic Search Form
+
+The [[WebSearch]] form offers basic search features:
+
+- Search field: Enter one or more keywords
+- All webs flag: Check the flag if you want to search all public webs, not just the current web
+- Scope: Select if you want to search the topic title, text body or both
+
+The search is keyword based like in a typical search engine:
+
+- Specify word(s) you want to find
+- Multiple words form an **AND** search, `intranet web service` returns all pages that have the three words anywhere in the page
+- Optionally specify plus signs for **AND** search, like `intranet +web +service`
+- Enclose words in double quotes to form a **literal search**, like `"web service"`
+- Specify a minus sign to **exclude** a word, like `soap -shampoo`
+- Use double quotes if you want to search for a leading minus sign, like `"-nowarn"`
+- **Stop words** are excluded from a keyword search:
+  - Stop words are common words and characters such as `"how"` and `"where"`, defined in the SEARCHSTOPWORDS setting in the [[TWikiPreferences]]
+  - If you want to search for a word in the stop word list, prefix the word with a plus sign
+- **Example:** To search for all topics that contain `"SOAP"`, `"WSDL"`, a literal `"web service"`, but not `"shampoo"`,%BR% enter this: `soap +wsdl "web service" -shampoo`
+
+## <a name="Advanced Search Form"></a> Advanced Search Form
+
+The [[WebSearchAdvanced]] form offers more control over search.
+
+TWiki supports three types of searches:
+
+- `keyword`: The basic search type
+- `literal`: Simple search where text is searched literally
+- `regex`: A [[RegularExpression]] search for power users
+
+TWiki's regex search is a set of regular expression patterns:
+
+- Patterns are delimited by a semicolon
+- An AND search is performed for the list of patterns
+- An exclamation point preceeding a pattern indicates an AND NOT search; use it to exclude a pattern, like `!web service`
+- If you want to search for a semicolon or an exclamation point, escape them with a leading backslash, like `\!shampoo`
+- **Example:** To search for all topics that contain `"SOAP"`, `"WSDL"`, a literal `"web service"`, but not `"shampoo"`,%BR% enter this: `soap;wsdl;web service;!shampoo`
+
+## <a name="Formatted Searches"></a> Formatted Searches
+
+You can embed a nicely [[formatted search|Main/FormattedSearch]] in a topic by using the `%SEARCH{}%` variable described in [[TWikiVariables]].
+
+## <a name="Search Preferences"></a> Search Preferences
+
+The [[TWikiPreferences]] has these settings:
+
+- `SEARCHDEFAULTTTYPE`: Default search type for search forms which calls the `search` script
+- `SEARCHVARDEFAULTTYPE`: Default search type for `%SEARCH{}` variable
+- `SEARCHSTOPWORDS`: List of stop words
+
+-- TWiki:Main.PeterThoeny - 18 Jan 2004
index 8da1d34..4437158 100644 (file)
@@ -6,7 +6,13 @@
     <td align="center" valign="top" width="200"><a href="http://TWiki.org/"><img alt="Powered by TWiki" border="0" height="64" src="http://www.dementia.org/twiki//view/TWiki/TWikiLogos/twikiRobot131x64.gif" width="131" /></a><br /> The official TWiki<sup>TM</sup><br />site is <a href="http://twiki.org/" target="_top">http://twiki.org/</a></td>
   </tr>
 </table>
-
+<div>
+  <ul>
+    <li><a href="#TWiki User's Guide"> TWiki User's Guide</a></li>
+    <li><a href="#TWiki Reference Manual"> TWiki Reference Manual</a></li>
+    <li><a href="#TWikiSiteTools"> TWikiSiteTools</a></li>
+  </ul>
+</div>
 <table>
   <tr valign="top">
     <td><a name="UsersGuide"></a><h2><a name="TWiki User's Guide"></a> TWiki User's Guide </h2>
@@ -27,6 +33,7 @@
             <li>[[Main/TWikiTutorial]]: A compact, 20-minute TWiki primer </li>
             <li>[[Main/TWikiSite]]: Instant overview - first, there was Wiki </li>
             <li>[[Main/TWikiTopics]]: Customize, rename, move, or delete TWiki topics </li>
+            <li>[[Main/SearchHelp]]: Tips and help on search </li>
             <li>[[Main/GoodStyle]]: Working tips for an open collaboration environment </li>
             <li>[[Main/TWikiShorthand]]: All of the TWiki shorthand basics </li>
             <li>[[Main/TextFormattingRules]]: Scan all TWiki text formatting rules on one page </li>
index 8c19ba4..b42759a 100644 (file)
@@ -1,66 +1,31 @@
-<form action="http://www.dementia.org/twiki//search/%INCLUDINGWEB%/">
-  <ul>
-    <li><b>Simple search</b>: <table border="0" cellpadding="0" cellspacing="0">
-        <tr>
-          <td><input checked name="scope" type="radio" value="text" /> Topic text (body)     </td>
-          <td><input name="web" type="checkbox" /> All webs (not only %INCLUDINGWEB% web) </td>
-        </tr>
-        <tr>
-          <td><input name="scope" type="radio" value="topic" /> Topic name </td>
-          <td><input name="bookview" type="checkbox" /> [[TWiki/BookView]]</td>
-        </tr>
-      </table><input name="search" size="32" type="text" /> <input type="submit" value="Search text" /><br /><strong><em>%T% Note:</em></strong> %WIKITOOLNAME% search is literal, e.g. if you search for <code>sushi bar</code><br /> it will search literally for "sushi bar". </li>
-  </ul>
-</form>
-
-<form action="http://www.dementia.org/twiki//search/%INCLUDINGWEB%/">
-  <ul>
-    <li><b>Advanced search</b>: <table border="0" cellpadding="0" cellspacing="0">
-        <tr>
-          <td><input checked name="scope" type="radio" value="text" /> Topic text (body)     </td>
-          <td> Search </td>
-          <td><select name="web"><option value="all">all public</option>
-              <option>%INCLUDINGWEB%</option></select></td>
-        </tr>
-      </table>
-    </li>
-  </ul>
-  <p>  web(s) </p>
-  <table>
-    <tr>
-      <td><input name="scope" type="radio" value="topic" /> Topic name </td>
-      <td> Sort by </td>
-      <td><select name="order"><option value="topic">Topic name</option>
-          <option value="modified">Last modified time</option>
-          <option value="editby">Last editor</option></select> in <input name="reverse" type="checkbox" /> reversed order </td>
-    </tr>
-  </table><input name="search" size="32" type="text" /> <input type="submit" value="Search text" /><br />
-  <table>
+<form action="http://www.dementia.org/twiki//view/%INCLUDINGWEB%/%INCLUDINGTOPIC%">
+  <table border="0" cellpadding="0" cellspacing="3">
     <tr>
-      <td> Make search: </td>
-      <td><input name="casesensitive" type="checkbox" /> Case sensitive </td>
-      <td><input name="regex" type="checkbox" /> [[TWiki/RegularExpression]] search (semicolon ';' for <em>and</em>) </td>
+      <td><input name="search" size="32" type="text" value="" /><input type="submit" value="Search" />%BR% <input name="web" type="checkbox" /> All public webs </td>
+      <td>
+        <ul>
+          <li>[[Main/SearchHelp]]</li>
+          <li>[[INCLUDINGWEB/WebSearchAdvanced]]</li>
+        </ul>
+      </td>
     </tr>
     <tr>
-      <td> Don't show: </td>
-      <td><input name="nosearch" type="checkbox" /> search string </td>
-      <td><input name="nosummary" type="checkbox" /> summaries     <input name="nototal" type="checkbox" /> total matches </td>
-    </tr>
-    <tr>
-      <td> Do show: </td>
-      <td><input name="bookview" type="checkbox" /> [[TWiki/BookView]]</td>
-      <td><input name="showlock" type="checkbox" /> locked topic   <input name="limit" size="5" type="text" value="all" /> topics (result count) </td>
+      <td><input checked name="scope" type="radio" value="text" /> Text body   <input name="scope" type="radio" value="topic" /> Topic title   <input name="scope" type="radio" value="all" /> Both </td>
     </tr>
   </table>
 </form>
 
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of search template (missing sections? There should be 4 %SPLIT% tags)
+
 - **[Topic index](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=\.*)**: List of %INCLUDINGWEB% topics in alphabetical order. <br />**|[All](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=\.*)|[A](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ea)|[B](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eb)|[C](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ec)|[D](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ed)|[E](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ee)|[F](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ef)|[G](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eg)|[H](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eh)|[I](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ei)|[J](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ej)|[K](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ek)|[L](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5El)|[M](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Em)|[N](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5En)|[O](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eo)|[P](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ep)|[Q](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eq)|[R](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Er)|[S](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Es)|[T](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Et)|[U](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eu)|[V](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ev)|[W](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ew)|[X](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ex)|[Y](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ey)|[Z](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ez)| <br /> | [All](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&bookview=on&search=\.*)** topics in [[BookView]] **|**
 
-- **Jump to topic**: If you already know the name of the topic, enter the name of the topic at the second line of this page.
+- **Jump to topic**: If you already know the name of the topic, enter the name of the topic into the [[GoBox]] at the top
 
-- ** [[WebChanges]]**: Find out what topics in %INCLUDINGWEB% have changed recently.
+- ** [[WebChanges]]**: Find out what topics in %INCLUDINGWEB% have changed recently
 
 - **[[How to edit text|TWiki/GoodStyle]]**:
   - Make changes to topics in [[GoodStyle]],
   - Learn the [[TextFormattingRules]], and
-  - Have a look at the [[TextFormattingFAQ]].
+  - Have a look at the [[TextFormattingFAQ]]
diff --git a/TWiki/WebSearchAdvanced.mdwn b/TWiki/WebSearchAdvanced.mdwn
new file mode 100644 (file)
index 0000000..a9882d5
--- /dev/null
@@ -0,0 +1,53 @@
+<form action="http://www.dementia.org/twiki//search/%INCLUDINGWEB%/">
+  <ul>
+    <li><b>Advanced search</b>: <table border="0" cellpadding="0" cellspacing="0">
+        <tr>
+          <td><input checked name="scope" type="radio" value="text" /> Topic text (body)     </td>
+          <td> Search </td>
+          <td><select name="web"><option value="all">all public</option>
+              <option>%INCLUDINGWEB%</option></select></td>
+        </tr>
+      </table>
+    </li>
+  </ul>
+  <p>  web(s) </p>
+  <table>
+    <tr>
+      <td><input name="scope" type="radio" value="topic" /> Topic name </td>
+      <td> Sort by </td>
+      <td><select name="order"><option value="topic">Topic name</option>
+          <option value="modified">Last modified time</option>
+          <option value="editby">Last editor</option></select> in <input name="reverse" type="checkbox" /> reversed order </td>
+    </tr>
+  </table><input name="search" size="32" type="text" /> <input type="submit" value="Search text" /><br />
+  <table>
+    <tr>
+      <td> Make search: </td>
+      <td><input name="casesensitive" type="checkbox" /> Case sensitive </td>
+      <td><input name="regex" type="checkbox" /> [[TWiki/RegularExpression]] search (semicolon ';' for <em>and</em>) </td>
+    </tr>
+    <tr>
+      <td> Don't show: </td>
+      <td><input name="nosearch" type="checkbox" /> search string </td>
+      <td><input name="nosummary" type="checkbox" /> summaries     <input name="nototal" type="checkbox" /> total matches </td>
+    </tr>
+    <tr>
+      <td> Do show: </td>
+      <td><input name="bookview" type="checkbox" /> [[TWiki/BookView]]</td>
+      <td><input name="showlock" type="checkbox" /> locked topic   <input name="limit" size="5" type="text" value="all" /> topics (result count) </td>
+    </tr>
+  </table>
+</form>
+
+- **[Topic index](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=\.*)**: List of %INCLUDINGWEB% topics in alphabetical order. <br />**|[All](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=\.*)|[A](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ea)|[B](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eb)|[C](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ec)|[D](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ed)|[E](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ee)|[F](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ef)|[G](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eg)|[H](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eh)|[I](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ei)|[J](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ej)|[K](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ek)|[L](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5El)|[M](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Em)|[N](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5En)|[O](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eo)|[P](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ep)|[Q](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eq)|[R](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Er)|[S](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Es)|[T](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Et)|[U](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Eu)|[V](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ev)|[W](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ew)|[X](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ex)|[Y](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ey)|[Z](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&search=%5Ez)| <br /> | [All](http://www.dementia.org/twiki//search/%INCLUDINGWEB%/?scope=topic&regex=on&bookview=on&search=\.*)** topics in [[BookView]] **|**
+
+- **Jump to topic**: If you already know the name of the topic, enter the name of the topic into the [[GoBox]] at the top
+
+- ** [[WebChanges]]**: Find out what topics in %INCLUDINGWEB% have changed recently
+
+- **[[How to edit text|TWiki/GoodStyle]]**:
+  - Make changes to topics in [[GoodStyle]],
+  - Learn the [[TextFormattingRules]], and
+  - Have a look at the [[TextFormattingFAQ]]
+
+-- TWiki:Main.PeterThoeny - 18 Jan 2004