From EPrints Documentation
Revision as of 15:12, 25 February 2010 by Tdb01r (talk | contribs)
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


EPrints::Paginate - Methods for rendering a paginated List

User Comments


User Comments

$xhtml = EPrints::Paginate->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:

User Comments


The maximum number of items to display on a page.

User Comments


The maximum number of page jump links to display.

User Comments


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.

User Comments

controls_before, controls_after

Additional links to display before/after the page navigation controls.

User Comments


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

User Comments

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.

User Comments


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

User Comments


prev/next/jump links

User Comments


description of list e.g. what search parameters produced it

User Comments


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

User Comments


list of rendered items

User Comments


prev/next/jump links (only if list contains >0 items)

User Comments


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).

User Comments