• This web contains the official documentation of the TWiki-6.0 Release, code named JerusalemRelease.
• It is a read-only web for reference. Please update documentation at TWiki.SearchResultsPagination.
Tags:
create new tag
, view all tags

Search Results Pagination

When a %SEARCH{...}% returns many results, you may want to paginate the results.

Overview

You can achieve search results pagination by tweaking a %SEARCH{...}% as follows. (New lines are inserted for readability in $SET(searchparams, ...). Please don't copy-paste it for real use.) As you can see, this is using the SpreadSheetPlugin.

...
%INCLUDE{"%SYSTEMWEB%.SearchResultsPagination" section="preamble"}%<nop>
%SEARCH{ 
"%URLPARAM{"search" encode="quote"}%"
...
start="%CALCULATE{$GET(start)}%"
limit="%CALCULATE{$GET(limit)}%"
footer="$percntCALCULATE{$SET(ntopics, $tntopics)$SET(nwebs, $nwebs)}$percnt"
}%
%CALCULATE{$SET(searchparams, search=%URLPARAM{"search" encode="quote"}%;
type=%URLPARAM{"type" encode="quote" default="%SEARCHDEFAULTTYPE%"}%;
scope=%URLPARAM{"scope" encode="quote"}%;
web=%URLPARAM{"web" encode="quote"}%;
nosearch=%URLPARAM{"nosearch" encode="quote"}%;)}%<nop>
%INCLUDE{"%SYSTEMWEB%.SearchResultsPagination" section="postamble"}%<nop>
...

This tweaking adds pagination link rows before and after the search results as follows:

«Prev   1   2   3   4   5   Next»

The section="preamble" and section="postamble" also support a style="" parameter to set the style of the pagination link row <div> tag. For example, to disable the pagination link row on top, write:
%INCLUDE{"%SYSTEMWEB%.SearchResultsPagination" section="preamble" style="display:none;"}%<nop>

Maximum 16 page links are shown — the "Next" link can be used to paginate beyond 16 pages if there are more than that. The pagination link rows are not shown if the number of results is below a one page threshold.

WebChanges, WebSearch, and WebSearchAdvanced are using this technique.

Results per page

By default, each page shows 50 results, which is defined by the SEARCHRESULTSPERPAGE preferences setting. To change it to 10, change the initial part as follows. (The second line is inserted.)

%INCLUDE{"%SYSTEMWEB%.SearchResultsPagination" section="preamble"}%<nop>
%CALCULATE{$SET(limit, %URLPARAM{"limit" default="10"}%)}%<nop>
%SEARCH{ 
If you specify limit=20 URL parameter manually, that's observed. If you specify limit=all URL parameter, all results are shown without pagination.

URL parameters

All hyper links in the pagination apparatus point to the same page with some URL parameters. The parameters are plus pagination parameters (namely start and limit). You need to $SET(searchparams, ...) having this in mind.

Multiple webs

%SEARCH{...}% may take the web parameter to have multiple webs specified. In that case, it's strange to do pagination hence suppressed.

SpreadSheetPlugin variables

This feature uses the following SpreadSheetPlugin variables. Please beware of variable clashes if you use SpreadSheetPlugin for your own use on a page doing search result pagination

  • limit
  • linksText
  • npages
  • ntopics
  • numlimit
  • nextText
  • nwebs
  • paginate
  • prevText
  • searchparams
  • start
  • stepsText

Related Topics: UserDocumentationCategory, SearchHelp, VarSEARCH, FormattedSearch, SearchPatternCookbook

Topic revision: r1 - 2013-02-13 - TWikiContributor
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.SearchResultsPagination.