/
VarTAGSEARCH.txt
41 lines (40 loc) · 3.77 KB
/
VarTAGSEARCH.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
%META:TOPICINFO{author="BaseUserMapping_333" date="1252340265" format="1.1" version="1.2"}%
%META:TOPICPARENT{name="TagsPlugin"}%
#VarTAGSEARCH
---+++ TAGSEARCH -- search the tags
* Inline tag search, shows a tag search result embedded in a topic
* Syntax: =%<nop>TAGSEARCH{...}%=
* Supported parameters:
| *Parameter:* | *Description:* | *Default:* |
| =query="tag"= <br /> =query="topic"= <br /> =query="user"= | This defines the primary dimension for your search. Every search has three dimensions: =tag=, =topic= and =user=. | ="tag"= |
| =tag="text"= <br /> =tag="all"= | Filter the =tag= dimension with this setting. Use =%= as a wildcard. | ="all"= |
| =user="wikiname"= <br /> =user="all"= | Filter the =user= dimension with this setting. Leave out the =%MAINWEB%= part here. | ="all"= |
| =web="Name"= <br /> =web="%USERSWEB%, Know"= <br /> =web="all"= | Comma-separated list of webs to search. The special word =all= means all webs (inlcuding those which have the =NOSEARCHALL= preference set to =on=). Use =%= as a wildcard. | ="all"= |
| =topic="Name"= <br /> =topic="<nop>TestTopic1, <nop>TestTopic2"= <br /> =topic="all"= | Comma-separated list of topics (without a webname) to search. The special word =all= means all topics. Use =%= as a wildcard. | ="all"= |
| =visibility="all"= <br /> =visibility="public"= <br /> =visibility="private"= <br /> =visibility="user"= | Filter by the public flag: either show all, only public or only private tags. =user= is a combination of "all public tags" and "my private tags". <br /> *Note:* You *must not* set a =user= parameter with =visibility=user=. | ="all"= |
| =header="..."= <br /> =format="..."= <br /> =footer="..."= | Custom format results: see table below for allowed variables. | depending on the =query= parameter, a simple list |
| =alt="..."= | If nothing is found, =alt= is returned instead of =header=, =format= and =footer=. | =empty= |
| =separator=", "= <br /> =sep=", "= | Separator _between_ search hits | =", "= |
| =order="tag"= <br /> =order="topic"= <br /> =order="user"= | This affects the sorting. | =none= |
| =limit="..."= | Numerical value. Limits the number of hits. | =not set= |
| =offset="..."= | Numerical value. May only be used in conjunction with =limit=. Number of hits to be skipped. | =not set= |
| =rendering="cloud"= | This is a shortcut which nests the output of =%<nop>TAGSEARCH%= into a =<nop>TAGCLOUD%= call. (This will override the =format=, =query= and =sep= parameter.) | =not set= |
* If two hits only differ in (tag|topic|user) and the =format= does not contain a (tag|topic|user) variable, the (two) hits clash into a single hit.
* Supported variables in custom formatting:
| *Name:* | *Expands To:* |
| =$item= | short for =$web.$topic= |
| =$web= | the web |
| =$topic= | the topic |
| =$cuid= | the cUID of the user |
| =$user= | the user in !WikiName format |
| =$tag= | the tag name|
| =$count= | tag count (the scope is always the whole database and *not* the current query) |
| =$num= | result number (consecutively numbered) |
| =$isAdmin= | =tagsplugin_isAdmin=, if the current logged in user is allowed to rename/merge/delete (is in the !TagAdminGroup), otherwise this is removed |
| =$public= | =1=, if the current tag is public, otherwise =0= |
| =$untaggable= | =tagsplugin_untaggable=, if the current logged in user is allowed to untag the current tag, otherwise this is removed |
| =$n= or =$n()= | New line. Use =$n()= if followed by alphanumeric character, e.g. write =Foo$n()Bar= instead of =Foo$nBar= |
| =$quot= | Double quote (="=) |
| =$percnt= | Percent sign (=%=) |
| =$dollar= | Dollar sign (=$=) |
* See %SYSTEMWEB%.TagsPluginViewsTagSearch for examples.