wiki-archive/twiki/data/TWiki/VarMETASEARCH.txt

29 lines
2.0 KiB
Plaintext

%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.2" version="1"}%
%META:TOPICPARENT{name="TWikiVariables"}%
#VarMETASEARCH
---+++ METASEARCH -- special search of meta data
* Syntax: =%<nop>METASEARCH{...}%=
* Supported parameters:
| *Parameter:* | *Description:* | *Default:* |
| =type="topicmoved"= | What sort of search is required? <br /> ="topicmoved"= if search for a topic that may have been moved <br /> ="parent"= if searching for topics that have a specific parent i.e. its children <br /> ="field"= if searching for topics that have a particular form field value (use the =name= and =value= parameters to specify which field to search) | required |
| =web="%<nop>WEB%"= | Wiki web to search: A web, a list of webs separated by whitespace, or =all= webs. | current web |
| =topic="%<nop>TOPIC%"= | The topic the search relates to, for =topicmoved= and =parent= searches | current topic |
| =name= | form field to search, for =field= type searches. May be a regular expression (see [[#VarSEARCH][SEARCH]]). | |
| =value= | form field value, for =field= type searches. May be a regular expression (see [[#VarSEARCH][SEARCH]]). | |
| =title="Title"= | Text that is prefixed to any search results | empty |
| =default="none"= | Default text shown if no search hit | empty |
* Example: =%<nop>METASEARCH{type="topicmoved" web="%<nop>WEB%" topic="%<nop>TOPIC%" title="This topic used to exist and was moved to: "}%=
* Example: You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:<br /> =%<nop>METASEARCH{type="parent" web="%<nop>WEB%" topic="%<nop>TOPIC%" title="Children: "}%=
* Example: =%<nop>METASEARCH{type="field" name="Country" value="China"}%=
* Related: [[#VarSEARCH][SEARCH]], [[#VarMETA][META]]
%STOPINCLUDE%
__Related Topics:__ UserDocumentationCategory
%META:TOPICINFO{author="TWikiContributor" date="1130377817" format="1.1" version="1"}%
%META:TOPICPARENT{name="TWikiVariables"}%
__Note:__ This topic is included by TWikiVariables
-----
%STARTSECTION{type="include"}%