head 1.3; access; symbols; locks; strict; comment @# @; 1.3 date 2007.01.16.04.12.03; author TWikiContributor; state Exp; branches; next 1.2; 1.2 date 2006.10.25.00.22.00; author TWikiContributor; state Exp; branches; next 1.1; 1.1 date 2006.06.25.16.26.29; author TWikiContributor; state Exp; branches; next ; desc @buildrelease @ 1.3 log @buildrelease @ text @%META:TOPICINFO{author="TWikiContributor" date="1168735612" format="1.1" version="3"}% %META:TOPICPARENT{name="TWikiVariables"}% #VarSEARCH ---+++ SEARCH{"text"} -- search content * Inline search, shows a search result embedded in a topic * Syntax: =%SEARCH{"text" ...}%= * Supported parameters: | *Parameter:* | *Description:* | *Default:* | | ="text"= | Search term. Is a keyword search, literal search or regular expression search, depending on the =type= parameter. SearchHelp has more | required | | =search="text"= | (Alternative to above) | N/A | | =web="Name"=
=web="%MAINWEB%, Know"=
=web="all"= | Comma-separated list of webs to search. You can specifically *exclude* webs from an =all= search using a minus sign - for example, =web="all,-Secretweb"=. The special word =all= means all webs that do *not* have the =NOSEARCHALL= variable set to =on= in their %WEBPREFSTOPIC%. Note that TWikiAccessControls are respected when searching webs; it is *much* better to use them than =NOSEARCHALL=. | Current web | | =topic="%WEBPREFSTOPIC%"=
=topic="*Bug"= | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. __Note__ this is a list of *topic names* and must *not* include web names. | All topics in a web | | =excludetopic="Web*"=
=excludetopic="%HOMETOPIC%, WebChanges"= | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. __Note__ this is a list of *topic names* and must *not* include web names. | None | | =type="keyword"=
=type="literal"=
=type="regex"= | Do a keyword search like =soap "web service" -shampoo=; a literal search like =web service=; or RegularExpression search like =soap;web service;!shampoo= | =%SEARCHVAR- DEFAULTTYPE%= [[TWikiPreferences][preferences]] setting (%SEARCHVARDEFAULTTYPE%) | | =scope="topic"=
=scope="text"=
=scope="all"= | Search topic name (title); the text (body) of topic; or all (both) | ="text"= | | =order="topic"=
=order="created"=
=order="modified"=
=order="editby"=
=order=
 "formfield(name)"= | Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; if you want to sort across webs, create a [[FormattedSearch][formatted]] table and sort it with TablePlugin's initsort. Note that dates are sorted most recent date *last* (i.e at the bottom of the table). | Sort by topic name | | =limit="all"=
=limit="16"= | Limit the number of results returned. This is done after sorting if =order= is specified | All results | | =date="..."= | limits the results to those pages with latest edit time in the given TimeInterval. | All results | | =reverse="on"= | Reverse the direction of the search | Ascending search | | =casesensitive="on"= | Case sensitive search | Ignore case | | =bookview="on"= | BookView search, e.g. show complete topic text | Show topic summary | | =nonoise="on"= | Shorthand for =nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on"= | Off | | =nosummary="on"= | Show topic title only | Show topic summary | | =nosearch="on"= | Suppress search string | Show search string | | =noheader="on"= | Suppress default search header
*Topics: Changed: By:* , unless a =header= is explicitly specified | Show default search header, unless search is inline and a format is specified (Cairo compatibility) | | =nototal="on"= | Do not show number of topics found | Show number | | =zeroresults="off"= | Suppress all output if there are no hits | =zeroresults="on"=, displays: "Number of topics: 0" | | =noempty="on"= | Suppress results for webs that have no hits. | Show webs with no hits | | =header="..."=
=format="..."= | Custom format results: see *[[FormattedSearch]]* for usage, variables & examples | Results in table | | =expandvariables="on"= | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin =%CALC{}%= instead of the formula | Raw text | | =multiple="on"= | Multiple hits per topic. Each hit can be [[FormattedSearch][formatted]]. The last token is used in case of a regular expression ";" _and_ search | Only one hit per topic | | =nofinalnewline="on"= | If =on=, the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate. | =off= | | =recurse="on"= | Recurse into subwebs, if subwebs are enabled. | =off= | | =separator=", "= | Line separator _between_ search hits | ="$n"= (Newline) | | =newline="%BR%"= | Line separator _within_ a search hit. Useful if the format="" parameter contains a $pattern() that captures more than one line, i.e. contents of a textfield in a form.| ="$n"= (Newline) | * Example: =%SEARCH{"wiki" web="%MAINWEB%" scope="topic"}%= * Example with format: =%SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%= _(displays results in a table with header - [[FormattedSearch][details]])_ * %H% Hint: If the TWiki:Plugins.TablePlugin is installed, you may set a =%TABLE{}%= variable just before the =%SEARCH{}%= to alter the output of a search. Example: =%TABLE{ tablewidth="90%" }%= * Related: [[#VarMETASEARCH][METASEARCH]], [[#VarTOPICLIST][TOPICLIST]], [[#VarWEBLIST][WEBLIST]], FormattedSearch, SearchHelp, SearchPatternCookbook, RegularExpression @ 1.2 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.2" version="2"}% d26 1 a26 1 | =noheader="on"= | Suppress search header
*Topics: Changed: By:* | Show search header, unless seach is inline and a format is specified (Cairo compatibility) | d40 1 a40 2 * Related: [[#VarMETASEARCH][METASEARCH]], [[#VarTOPICLIST][TOPICLIST]], [[#VarWEBLIST][WEBLIST]], FormattedSearch @ 1.1 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.2" version="1"}% d35 2 a36 1 | =separator=", "= | Line separator between hits | Newline ="$n"= | @