Editing API:EPrints/Paginate

<!-- Pod2Wiki=_preamble_ 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Paginate.pm|package_name=EPrints::Paginate}}[[Category:API|PAGINATE]][[Category:API:EPrints/Paginate|PAGINATE]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''EPrints::Paginate''' - Methods for rendering a paginated List

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_description -->
==DESCRIPTION==
* $xhtml = EPrints::Paginate-&gt;paginate_list( $session, $basename, $list, %opts )
: Render a "paginated" view of the list i.e. display a "page" of items  with links to navigate through the list.

: $basename is the basename to use for pagination-specific CGI parameters, to avoid clashes.

: %opts is a hash of options which can be used to customise the  behaviour and/or rendering of the paginated list. See EPrints::Search  for a good example!

: '''Behaviour options:'''

** page_size	
:: The maximum number of items to display on a page.

** pagejumps
:: The maximum number of page jump links to display.

** params
:: A hashref of parameters to include in the prev/next/jump URLs,  e.g. to maintain the state of other controls on the page between jumps.

: '''Rendering options:'''

** controls_before, controls_after
:: Additional links to display before/after the page navigation controls.

** container
:: A containing XML DOM element for the list of items on the current page.

** render_result, render_result_params
:: A custom subroutine for rendering an individual item on the current  page. The subroutine will be called with $session, $item, and the parameter specified by the render_result_params option. The rendered item should be returned.

** phrase
:: The phrase to use to render the entire "page". Can make use of the following pins:

*** controls
::: prev/next/jump links

*** searchdesc
::: description of list e.g. what search parameters produced it

*** matches
::: total number of items in list, range of items displayed on current page

*** results
::: list of rendered items

*** controls_if_matches
::: prev/next/jump links (only if list contains &gt;0 items)

:: These can be overridden in the "pins" option (below).

** pins
:: Named "pins" to render on the page. These may override the default  "pins" (see above), or specify new "pins" (although you would need  to define a custom phrase in order to make use of them).

<!-- Pod2Wiki=head_copyright -->
==COPYRIGHT==
: Copyright 2000-2011 University of Southampton.

: This file is part of EPrints http://www.eprints.org/.

: EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

: EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.

: You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=_postamble_ -->
<!-- Edit below this comment -->