Tag Definitions %PAGINATOR%

Creates a paginator for navigating through pages of list items

The Paginator tag is used to manage and navigate through the returned results of a LIST tag when many list items could potentially be produced, ie, search results. If being used in conjunction with a LIST tag to produce search results, then the src parameter of that LIST must be set to '_search'.


Attribute Definitions
ParameterTypeDescription
typeul
ol
dl
The list type that is rendered. Any type of valid XHTML list can be used here.
classStringThe 'class' attribute to add to the rendered HTML tags as determined by type.
idStringThe 'id' attribute to add to the rendered HTML.
listidStringThe id of the LIST tag that contains the pages to be used in this tag.
itemtemplateStringThe snippet that is used to render each item in the list.
activeitemtemplateStringThe snippet that is used to render the current search results page.
previoustemplateStringThe snippet that displays the previous item, if the user goes back one page.
nexttemplateStringThe snippet that displays the next item, if the user goes forward one page.
noresultstemplateStringThe snippet that displays a message indicating that there are no items to display.
hasresultstemplateStringThe snippet that displays a message indicating that there are items in this list.

Example

In this example a list is rendered showing the results of a search. 6 items per page are shown. To navigate through the list of pages the URL parameter 'spnr' is used:

  1. %LIST(id=list1, type=ul, maxitems=6, 
    usepaginator=yes, itemtemplate=searchresultlink,
    pageparamfield=spnr, src=_search, queryfield=squery)%
  2. %PAGINATOR(LISTID=list1, TYPE=ul, 
    itemtemplate=paginatorlink,
    activetemplate=paginatoractive,
    previoustemplate=paginatorprevious,
    nexttemplate=paginatornext,
    noresultstemplate=paginatornoresults,
    hasresultstemplate=paginatorhasresults)%


See Also:

Video Guides

How To...

Tag Definitions