VarMETASEARCH < System

You are here: Foswiki>System Web>Macros>VarMETASEARCH (19 Sep 2010, ProjectContributor) (raw view)EditAttach

#VarMETASEARCH
---+++ METASEARCH -- special search of meta data

<blockquote class="foswikiHelp">%X% =METASEARCH= is *deprecated* in favour of the new and much more powerful query type search. See [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSEARCH][SEARCH]] and QuerySearch.</blockquote>

   * 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 | All topics in a web |
     | =name= | form field to search, for =field= type searches. May be a regular expression (see [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSEARCH][SEARCH]]). | |
     | =value= | form field value, for =field= type searches. May be a regular expression (see [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSEARCH][SEARCH]]). | |
     | =title="Title"= | Text that is prefixed to any search results | empty |
     | =format="..."= | Custom format results. Supports same format strings as [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSEARCH][SEARCH]]. See *[[FormattedSearch]]* for usage &amp; examples | Results in table |
     | =default="none"= | Default text shown if no search hit | Empty |
   * Examples: <pre class="tml">
  %<nop>METASEARCH{
    type="topicmoved"
    web="%<nop>WEB%"
    topic="%<nop>TOPIC%"
    title="This topic used to exist and was moved to: "
  }%</pre> 
  You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:<pre class="tml">
  %<nop>METASEARCH{
    type="parent"
    web="%<nop>WEB%"
    topic="%<nop>TOPIC%"
    title="Children: "
  }%

  %<nop>METASEARCH{
    type="field"
    name="Country"
    value="China"
  }%</pre>
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSEARCH][SEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarMETA][META]]

<!-- %JQREQUIRE{"chili"}% -->

Topic revision: r1 - 19 Sep 2010, ProjectContributor

System

Webs
Main
Sandbox
System
Testweb

Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback