create new tag
, view all tags
ALERT! NOTE: This is a DistributionDocument. Please help maintain high quality documentation: This is a wiki, please fix the documentation if you find errors or incomplete content. Put questions and suggestions concerning the documentation of this topic in the comments section below. Use the Support web for problems you are having using TWiki.

Search Results Pagination

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


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>
"%URLPARAM{"search" encode="quote"}%"
footer="$percntCALCULATE{$SET(ntopics, $tntopics)$SET(nwebs, $nwebs)}$percnt"
%CALCULATE{$SET(searchparams, search=%URLPARAM{"search" encode="url"}%;
type=%URLPARAM{"type" encode="url" default="%SEARCHDEFAULTTYPE%"}%;
scope=%URLPARAM{"scope" encode="url"}%;
web=%URLPARAM{"web" encode="url"}%;
nosearch=%URLPARAM{"nosearch" encode="url"}%;)}%<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" encode="entity"}%)}%<nop>
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

Comments & Questions about this Distribution Document Topic

Please use the Support forum if you have questions about TWiki features. This comment section is about the documentation of this topic.
Edit | Attach | Watch | Print version | History: r5 < r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r5 - 2014-12-16 - PeterThoeny
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.