From: <de...@de...> - 2009-01-28 13:02:56
|
Author: SopanShewale Date: 2009-01-28 07:02:50 -0600 (Wed, 28 Jan 2009) New Revision: 17793 Trac url: http://develop.twiki.org/trac/changeset/17793 Modified: twiki/branches/TWikiRelease04x02/data/Main/TWikiAdminUser.txt twiki/branches/TWikiRelease04x02/data/TWiki/FormattedSearch.txt twiki/branches/TWikiRelease04x02/data/TWiki/VarSEARCH.txt twiki/branches/TWikiRelease04x02/lib/TWiki/Search.pm Log: Item6176: programming required code for AddFooterParameterToSEARCH proposal Modified: twiki/branches/TWikiRelease04x02/data/Main/TWikiAdminUser.txt =================================================================== --- twiki/branches/TWikiRelease04x02/data/Main/TWikiAdminUser.txt 2009-01-27 11:05:34 UTC (rev 17792) +++ twiki/branches/TWikiRelease04x02/data/Main/TWikiAdminUser.txt 2009-01-28 13:02:50 UTC (rev 17793) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1111931141" format="1.0" version="$Rev: 14936 $"}% +%META:TOPICINFO{author="BaseUserMapping_333" date="1232963534" format="1.1" version="1.2"}% ---+ TWiki Administrator User The %TOPIC% has been added to TWiki 4.2.0 to make it possible to login without needing to create a TWiki User, @@ -28,3 +28,5 @@ --- + +%META:SKILLS{name="Cprogramming" category="Programming" comment="" rating="4"}% Modified: twiki/branches/TWikiRelease04x02/data/TWiki/FormattedSearch.txt =================================================================== --- twiki/branches/TWikiRelease04x02/data/TWiki/FormattedSearch.txt 2009-01-27 11:05:34 UTC (rev 17792) +++ twiki/branches/TWikiRelease04x02/data/TWiki/FormattedSearch.txt 2009-01-28 13:02:50 UTC (rev 17793) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1228163901" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="BaseUserMapping_333" date="1233147054" format="1.1" reprev="1.2" version="1.2"}% %META:TOPICPARENT{name="TWikiVariables"}% %STARTINCLUDE% ---+ TWiki Formatted Search @@ -23,8 +23,19 @@ | =$web= | Name of the web | %INCLUDE{FormatTokens}% ----+++ 2. =format="..."= parameter +---+++ 2. =footer="..."= parameter +Use the footer parameter to specify the footer of a search result. It should correspond to the format of the format parameter. This parameter is optional. <br /> Example: =footer="| <nop>*Topic:*<nop> | <nop>*Summary:*<nop> |"= + +Variables that can be used in the header string: + +| *Name:* | *Expands To:* | +| =$web= | Name of the web | +%INCLUDE{FormatTokens}% + + +---+++ 3. =format="..."= parameter + Use the format parameter to specify the format of one search hit. <br /> Example: =format="| $topic | $summary |"= @@ -74,11 +85,11 @@ *Write this:* -=%<nop>SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * <nop>*Topic: Summary:*" format=" * [<nop>[$topic]]: $summary" }%= +=%<nop>SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * <nop>*Topic: Summary:*" format=" * [<nop>[$topic]]: $summary" footer=" * <nop>*Topic: Summary:*" }%= *To get this:* -%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * *Topic: Summary:*" format=" * [[$topic]]: $summary" }% +%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * *Topic: Summary:*" format=" * [[$topic]]: $summary" footer=" * *Topic: Summary:*" }% ---+++ Table showing form field values of topics with a form Modified: twiki/branches/TWikiRelease04x02/data/TWiki/VarSEARCH.txt =================================================================== --- twiki/branches/TWikiRelease04x02/data/TWiki/VarSEARCH.txt 2009-01-27 11:05:34 UTC (rev 17792) +++ twiki/branches/TWikiRelease04x02/data/TWiki/VarSEARCH.txt 2009-01-28 13:02:50 UTC (rev 17793) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1168735612" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="BaseUserMapping_333" date="1233147448" format="1.1" version="1.2"}% %META:TOPICPARENT{name="TWikiVariables"}% #VarSEARCH @@ -28,6 +28,7 @@ | =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="..."= <br /> =format="..."= | Custom format results: see *[[FormattedSearch]]* for usage, variables & examples | Results in table | + | =footer="..."= <br /> =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 =%<nop>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= | @@ -37,4 +38,4 @@ * Example: =%<nop>SEARCH{"wiki" web="%USERSWEB%" scope="topic"}%= * Example with format: =%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"}%= _(displays results in a table with header - [[FormattedSearch][details]])_ * %H% Hint: If the TWiki:Plugins.TablePlugin is installed, you may set a =%<nop>TABLE{}%= variable just before the =%<nop>SEARCH{}%= to alter the output of a search. Example: =%<nop>TABLE{ tablewidth="90%" }%= - * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarMETASEARCH][METASEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarTOPICLIST][TOPICLIST]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarWEBLIST][WEBLIST]], FormattedSearch, QuerySearch, SearchHelp, SearchPatternCookbook, RegularExpression + * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarMETASEARCH][METASEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarTOPICLIST][TOPICLIST]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarWEBLIST][WEBLIST]], FormattedSearch, QuerySearch, SearchHelp, SearchPatternCookbook, RegularExpression \ No newline at end of file Modified: twiki/branches/TWikiRelease04x02/lib/TWiki/Search.pm =================================================================== --- twiki/branches/TWikiRelease04x02/lib/TWiki/Search.pm 2009-01-27 11:05:34 UTC (rev 17792) +++ twiki/branches/TWikiRelease04x02/lib/TWiki/Search.pm 2009-01-28 13:02:50 UTC (rev 17793) @@ -352,6 +352,7 @@ my $doExpandVars = TWiki::isTrue( $params{expandvariables} ); my $format = $params{format} || ''; my $header = $params{header}; + my $footer = $params{footer}; my $inline = $params{inline}; my $limit = $params{limit} || ''; my $doMultiple = TWiki::isTrue( $params{multiple} ); @@ -366,6 +367,14 @@ # Note: This is done for Cairo compatibility || ( !$header && $format && $inline ); + # Note: a defined footer overrides noFooter + my $noFooter = + !defined($footer) + && TWiki::isTrue( $params{nofooter}, $nonoise ) + + # Note: This is done for Cairo compatibility + || ( !$header && $format && $inline ); + my $noSearch = TWiki::isTrue( $params{nosearch}, $nonoise ); my $noSummary = TWiki::isTrue( $params{nosummary}, $nonoise ); my $zeroResults = @@ -738,6 +747,11 @@ } } + if ( defined $footer ) { + $afterText = TWiki::expandStandardEscapes($footer); + $afterText =~ s/\$web/$web/gos; # expand name of web + } + # output the list of topics in $web my $ntopics = 0; my $headerDone = $noHeader; |