From: <de...@de...> - 2011-10-11 16:45:01
|
Author: PeterThoeny Date: 2011-10-11 11:44:54 -0500 (Tue, 11 Oct 2011) New Revision: 22371 Trac url: http://develop.twiki.org/trac/changeset/22371 Modified: twiki/branches/TWikiRelease05x01/core/data/TWiki/FormattedSearch.txt Log: Item6796: Adding docs on evaluation order of variables in a SEARCH format Modified: twiki/branches/TWikiRelease05x01/core/data/TWiki/FormattedSearch.txt =================================================================== --- twiki/branches/TWikiRelease05x01/core/data/TWiki/FormattedSearch.txt 2011-10-11 16:44:14 UTC (rev 22370) +++ twiki/branches/TWikiRelease05x01/core/data/TWiki/FormattedSearch.txt 2011-10-11 16:44:54 UTC (rev 22371) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1265789704" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1318351277" format="1.1" version="$Rev$"}% %META:TOPICPARENT{name="TWikiVariables"}% %STARTINCLUDE% ---+ TWiki Formatted Search @@ -11,7 +11,7 @@ ---++ Syntax -Two parameters can be used to specify a customized search result: +Three parameters can be used to customize a search result: ---+++ 1. =header="..."= parameter @@ -35,7 +35,6 @@ | =$nhits= | Number of hits if =multiple="on"=. Cumulative across all topics in current web. Identical to =$ntopics= unless =multiple="on"= | %INCLUDE{FormatTokens}% - ---+++ 3. =format="..."= parameter Use the format parameter to specify the format of one search hit. @@ -81,6 +80,14 @@ | =$nhits= | Number of hits if =multiple="on"=. Cumulative across all topics in current web. Identical to =$ntopics= unless =multiple="on"= | %INCLUDE{FormatTokens}% +#EvaluationOrder +---++ Evaluation order of variables + +By default, variables embedded in the format parameter are evaluated _before_ the =%<nop>SEARCH{}%=. This is OK for variables that do not change, such as =%<nop>SCRIPTURLPATH%=. Variables that should be evaluated once per search hit _must be escaped_. For example, to escape a conditional: +<br /> = %<nop>IF{ "..." then="..." else="..." }%= +<br /> write this: +<br /> = format="$percntIF{ \"...\" then=\"...\" else=\"...\" }$percnt= + ---++ Examples Here are some samples of formatted searches. The SearchPatternCookbook has other examples, such as [[SearchPatternCookbook#SearchUsernames][creating a picklist of usernames]], [[SearchPatternCookbook#SearchTopicChildren][searching for topic children]] and more. |